Options
All
  • Public
  • Public/Protected
  • All
Menu

Class TocPlugin

A plugin that generates a table of contents for the current page.

The table of contents will start at the nearest module or dynamic module. This plugin sets the PageEvent.toc property.

Hierarchy

Implements

Index

Constructors

constructor

Properties

componentName

componentName: string

The name of this component as set by the @Component decorator.

Accessors

application

owner

Methods

Protected bubble

getOptionDeclarations

initialize

  • initialize(): void

listenTo

listenToOnce

off

  • off(): any
  • off(eventMap: EventMap, context?: any): any
  • off(name: string, callback?: EventCallback, context?: any): any

on

  • on(eventMap: EventMap, context?: any): any
  • on(eventMap: EventMap, callback?: EventCallback, context?: any, priority?: number): any
  • on(name: string, callback: EventCallback, context?: any, priority?: number): any

Private onRendererBeginPage

once

  • once(eventMap: EventMap, context?: any): any
  • once(name: string, callback: EventCallback, context?: any, priority?: any): any
  • Bind an event to only be triggered a single time. After the first time the callback is invoked, its listener will be removed. If multiple events are passed in using the space-separated syntax, the handler will fire once for each event, not once for a combination of all events.

    Parameters

    • eventMap: EventMap
    • Optional context: any

    Returns any

  • Parameters

    • name: string
    • callback: EventCallback
    • Optional context: any
    • Optional priority: any

    Returns any

stopListening

trigger

  • Trigger one or many events, firing all bound callbacks. Callbacks are passed the same arguments as trigger is, apart from the event name (unless you're listening on "all", which will cause your callback to receive the true name of the event as the first argument).

    Parameters

    Returns this

Static buildToc

  • Create a toc navigation item structure.

    Parameters

    • model: Reflection

      The models whose children should be written to the toc.

    • trail: Reflection[]

      Defines the active trail of expanded toc entries.

    • parent: NavigationItem

      The parent NavigationItem the toc should be appended to.

    • Optional restriction: string[]

      The restricted table of contents.

    Returns void

Generated using TypeDoc