Class NavigationRenderer

Handles the rendering of items in the navigation sidebar

Hierarchy

NavigationRenderer

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new NavigationRenderer(options: PluginOptions, pages: PageDictionary, itemFactory: NavigationItemFactory): NavigationRenderer

- Defined in src/rendering/navigation-renderer.ts:20
Creates an instance of NavigationRenderer

Parameters
- options: PluginOptions
  
  Plugin options
- pages: PageDictionary
  
  Page dictionary
- itemFactory: NavigationItemFactory
  
  Navigation item factory
Returns NavigationRenderer

Properties

Private _hasAddedStandardNavigationTitle

_hasAddedStandardNavigationTitle: boolean

Private _itemFactory

_itemFactory: NavigationItemFactory

Private _options

_options: PluginOptions

Private _pages

_pages: PageDictionary

Methods

Private _buildBackButton

_buildBackButton(items: PluginNavigationItem[], event: PageEvent): void

- Defined in src/rendering/navigation-renderer.ts:150
Parameters
- items: PluginNavigationItem[]
- event: PageEvent
Returns void

Private _buildNavigationForPageGroups

_buildNavigationForPageGroups(event: PageEvent, groups: PageGroup[]): PluginNavigationItem[]

- Defined in src/rendering/navigation-renderer.ts:102
Parameters
- event: PageEvent
- groups: PageGroup[]
Returns PluginNavigationItem[]

Private _ensureStandardNavigationHasTitle

_ensureStandardNavigationHasTitle(event: PageEvent): void

- Defined in src/rendering/navigation-renderer.ts:121
Parameters
- event: PageEvent
Returns void

Private _ensureStandardNavigationVisible

_ensureStandardNavigationVisible(event: PageEvent, isPluginItem: boolean): void

- Defined in src/rendering/navigation-renderer.ts:128
Parameters
- event: PageEvent
- isPluginItem: boolean
Returns void

Private _getBackButtonTarget

_getBackButtonTarget(item: BaseItem): BaseItem

- Defined in src/rendering/navigation-renderer.ts:177
Parameters
- item: BaseItem
Returns BaseItem

Private _getGroupsForNavigation

_getGroupsForNavigation(currentPageModel: PluginPageUrlMappingModel, allGroups: PageGroup[]): PageGroup[]

- Defined in src/rendering/navigation-renderer.ts:77
Parameters
- currentPageModel: PluginPageUrlMappingModel
- allGroups: PageGroup[]
Returns PageGroup[]

Private _getPluginNavigationItems

_getPluginNavigationItems(event: PageEvent, isPluginItem: boolean): PluginNavigationItem[]

- Defined in src/rendering/navigation-renderer.ts:64
Parameters
- event: PageEvent
- isPluginItem: boolean
Returns PluginNavigationItem[]

Private _removeGlobalsNavigationItem

_removeGlobalsNavigationItem(event: PageEvent): void

- Defined in src/rendering/navigation-renderer.ts:136
Parameters
- event: PageEvent
Returns void

addPluginNavigation

addPluginNavigation(event: PageEvent): void

- Defined in src/rendering/navigation-renderer.ts:40
Ensures that there are navigation items for plugin pages in the sidebar

Parameters
- event: PageEvent
  
  TypeDoc Page evnet
Returns void

Generated using TypeDoc