Options
All
  • Public
  • Public/Protected
  • All
Menu

Class NavigationBuilder

Hierarchy

  • NavigationBuilder

Index

Constructors

constructor

Properties

Private entryPoint

entryPoint: any

Private multipleEntryPoints

multipleEntryPoints: any

Private project

project: any

Methods

build

  • Build the navigation structure.

    Parameters

    • hasReadmeFile: boolean

      True if the project has a readme

    Returns NavigationItem

    The root node of the generated navigation structure.

Protected buildChildren

  • Create navigation nodes for all container children of the given reflection.

    Parameters

    • reflection: DeclarationReflection

      The reflection whose children modules should be transformed into navigation nodes.

    • parent: NavigationItem

      The parent NavigationItem of the newly created nodes.

    Returns void

Protected buildGroups

  • Create navigation nodes for the given list of reflections. The resulting nodes will be grouped into an "internal" and an "external" section when applicable.

    Parameters

    • reflections: DeclarationReflection[]

      The list of reflections which should be transformed into navigation nodes.

    • parent: NavigationItem

      The parent NavigationItem of the newly created nodes.

    • Optional buildChildren: boolean

      Whether navigation nodes should also be built for the children of each reflection.

    Returns void

Protected containsExternals

  • Test whether the given list of modules contains an external module.

    Parameters

    Returns boolean

    TRUE if any of the modules is marked as being external.

Protected includeDedicatedUrls

  • Find the urls of all children of the given reflection and store them as dedicated urls of the given NavigationItem.

    Parameters

    Returns void

Protected sortReflections

  • Sort the given list of modules by name, groups external modules at the bottom.

    Parameters

    Returns void

Generated using TypeDoc