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

constructor

Properties

componentName icons markedPlugin URL_PREFIX

Accessors

application owner

Methods

buildNavigation buildUrls defaultLayoutTemplate documentTemplate getNavigation getReflectionClasses getRenderContext getSlugger getUrls hierarchyTemplate indexTemplate initialize off on reflectionTemplate render trigger applyAnchorUrl getUrl

Constructors

constructor

Properties

componentName

componentName: string

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

icons

icons: {
    1: (() => Element);
    1024: (() => Element);
    1048576: (() => Element);
    128: (() => Element);
    131072: (() => Element);
    16: (() => Element);
    16384: (() => Element);
    2: (() => Element);
    2048: (() => Element);
    2097152: (() => Element);
    256: (() => Element);
    262144: (() => Element);
    32: (() => Element);
    32768: (() => Element);
    4: (() => Element);
    4096: (() => Element);
    4194304: (() => Element);
    512: (() => Element);
    524288: (() => Element);
    64: (() => Element);
    65536: (() => Element);
    8: (() => Element);
    8192: (() => Element);
    8388608: (() => Element);
    anchor: (() => Element);
    checkbox: (() => Element);
    chevronDown: (() => Element);
    chevronSmall: (() => Element);
    folder: (() => Element);
    menu: (() => Element);
    search: (() => Element);
} = ...

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.

InternalmarkedPlugin

markedPlugin: MarkedPlugin

StaticURL_PREFIX

URL_PREFIX: RegExp = ...

Accessors

application

owner

  • get owner(): O

  • Return the owner of this component.

    Returns O

Methods

buildNavigation

buildUrls

defaultLayoutTemplate

documentTemplate

getNavigation

getReflectionClasses

getRenderContext

getSlugger

getUrls

hierarchyTemplate

indexTemplate

Protectedinitialize

off

  • off<K>(event, listener): void

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

        • (this, ...args): void

        • Parameters

          • this: undefined
          • Rest...args: {}[K]

          Returns void

    Returns void

on

  • on<K>(event, listener, priority?): 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.

        • (this, ...args): void

        • Parameters

          • this: undefined
          • Rest...args: {}[K]

          Returns void

    • priority: number = 0

      optional priority to insert this hook with.

    Returns void

reflectionTemplate

render

trigger

  • trigger<K>(event, ...args): void

  • Emits an event to all currently subscribed listeners.

    Type Parameters

    • K extends never

    Parameters

    • event: K

      the event to emit.

    • Rest...args: {}[K]

      any arguments required for the event.

    Returns void

StaticapplyAnchorUrl

StaticgetUrl

  • getUrl(reflection, relative?, separator?): string

  • Return a url for the given reflection.

    Parameters

    • reflection: Models.Reflection

      The reflection the url should be generated for.

    • Optionalrelative: 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.

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods