TypeDoc API - v0.28.1

    Class DefaultTheme

    Base class of all themes.

    The theme class determines how a page is rendered. It is loosely coupled with a router class instance which is also created by the Renderer class.

    Hierarchy (View Summary)

    Index

    Accessors

    application owner

    Constructors

    constructor

    Methods

    buildNavigation defaultLayoutTemplate documentTemplate getNavigation getReflectionClasses getReflectionIcon getRenderContext hierarchyTemplate indexTemplate off on postRender preRender reflectionTemplate render trigger

    Properties

    componentName ContextClass icons markedPlugin router usedFileNames

    Accessors

    Constructors

    Methods

    • Stops listening to an event.

      Type Parameters

      • K extends never

      Parameters

      • event: K

        the event to stop listening to.

      • listener: (this: undefined, ...args: {}[K]) => void

        the function to remove from the listener array.

      Returns void

    • Starts listening to an event.

      Type Parameters

      • K extends never

      Parameters

      • event: K

        the event to listen to.

      • listener: (this: undefined, ...args: {}[K]) => void

        function to be called when an this event is emitted.

      • priority: number = 0

        optional priority to insert this hook with.

      Returns void

    • Emits an event to all currently subscribed listeners.

      Type Parameters

      • K extends never

      Parameters

      • event: K

        the event to emit.

      • ...args: {}[K]

        any arguments required for the event.

      Returns void

    Properties

    componentName: string

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

    ContextClass: typeof DefaultThemeRenderContext = DefaultThemeRenderContext
    icons: Icons

    The icons which will actually be rendered. The source of truth lives on the theme, and the DefaultThemeRenderContext.icons member will produce references to these.

    These icons will be written twice. Once to an icons.svg file in the assets directory which will be referenced by icons on the context, and once to an icons.js file so that references to the icons can be dynamically embedded within the page for use by the search dropdown and when loading the page on file:// urls.

    Custom themes may overwrite this entire object or individual properties on it to customize the icons used within the page, however TypeDoc currently assumes that all icons are svg elements, so custom themes must also use svg elements.

    markedPlugin: MarkedPlugin
    router: Router
    usedFileNames: Set<string> = ...

    Settings

    Member Visibility

    On This Page

    Accessors
    Constructors
    Methods
    Properties
    MMNEPVFCICPMFPCPTTAAATR