Options
All
  • Public
  • Public/Protected
  • All
Menu

Class NavigationItemFactory

Factory class for creating TypeDoc navigation items

Hierarchy

  • NavigationItemFactory

Index

Methods

buildBackButton

buildChildPageItems

buildItem

  • buildItem(label: string, url: string, isActive: boolean, isChild: boolean, isParent: boolean, isParentOfActive: boolean): PluginNavigationItem
  • Creates a TypeDoc navigation item

    Parameters

    • label: string

      Item text

    • url: string

      Item URL

    • isActive: boolean

      Whether the item is active

    • isChild: boolean

      Whether the item is a child page

    • isParent: boolean

      Whether the item is a parent

    • isParentOfActive: boolean

      Whether the item is a parent of the active page

    Returns PluginNavigationItem

    The created navigation item

buildLabelItem

buildPageGroupItems

buildPageItems

buildSectionItems

Generated using TypeDoc