Class DefaultTheme

Default theme implementation of TypeDoc. If a theme does not provide a custom Theme implementation, this theme class will be used.

Hierarchy (view full)

Constructors

Properties

componentName: string

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

markedPlugin: MarkedPlugin
URL_PREFIX: RegExp = ...

Accessors

Methods

  • Remove one or many callbacks. If context is null, removes all callbacks with that function. If callback is null, removes all callbacks for the event. If name is null, removes all bound callbacks for all events.

    Returns this

  • Parameters

    • eventMap: undefined | EventMap
    • Optional context: any

    Returns this

  • Parameters

    • name: undefined | string
    • Optional callback: EventCallback
    • Optional context: any

    Returns this

  • 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

    Returns this

  • Parameters

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

    Returns this

  • 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 DefaultTheme

  • Return a url for the given reflection.

    Parameters

    • reflection: Models.Reflection

      The reflection the url should be generated for.

    • Optional relative: Models.Reflection

      The parent reflection the url generation should stop on.

    • separator: string = "."

      The separator used to generate the url.

    Returns string

    The generated url.

Generated using TypeDoc