Class DefaultThemeRenderContext

Constructors

Properties

analytics: ((...r) => undefined | Element) = ...

Type declaration

    • (...r): undefined | Element
    • Parameters

      • Rest ...r: []

      Returns undefined | Element

breadcrumb: ((...r) => undefined | Element) = ...

Type declaration

commentSummary: ((...r) => undefined | Element) = ...

Type declaration

commentTags: ((...r) => undefined | Element) = ...

Type declaration

defaultLayout: ((...r) => Element) = ...

Type declaration

footer: ((...r) => undefined | Element) = ...

Type declaration

    • (...r): undefined | Element
    • Parameters

      • Rest ...r: []

      Returns undefined | Element

header: ((...r) => Element) = ...

Type declaration

hierarchy: ((...r) => undefined | Element) = ...

Type declaration

hierarchyTemplate: ((...r) => Element) = ...

Type declaration

index: ((...r) => Element) = ...

Type declaration

indexTemplate: ((...r) => Element) = ...

Type declaration

member: ((...r) => Element) = ...

Type declaration

memberDeclaration: ((...r) => Element) = ...

Type declaration

memberGetterSetter: ((...r) => Element) = ...

Type declaration

memberReference: ((...r) => Element) = ...

Type declaration

memberSignatureBody: ((...r) => Element) = ...

Type declaration

memberSignatureTitle: ((...r) => Element) = ...

Type declaration

memberSignatures: ((...r) => Element) = ...

Type declaration

memberSources: ((...r) => Element) = ...

Type declaration

members: ((...r) => Element) = ...

Type declaration

membersGroup: ((...r) => Element) = ...

Type declaration

navigation: ((...r) => Element) = ...

Type declaration

options: Options
pageNavigation: ((...r) => Element) = ...

Type declaration

pageSidebar: ((...r) => Element) = ...

Type declaration

parameter: ((...r) => Element) = ...

Type declaration

reflectionFlags: ((...r) => Element) = ...

Type declaration

reflectionPreview: ((...r) => undefined | Element) = ...

Rendered just after the description for a reflection. This can be used to render a shortened type display of a reflection that the rest of the page expands on.

Note: Will not be called for variables/type aliases, as they are summarized by their type declaration, which is already rendered by DefaultThemeRenderContext.memberDeclaration

Type declaration

    • (...r): undefined | Element
    • Rendered just after the description for a reflection. This can be used to render a shortened type display of a reflection that the rest of the page expands on.

      Note: Will not be called for variables/type aliases, as they are summarized by their type declaration, which is already rendered by DefaultThemeRenderContext.memberDeclaration

      Parameters

      Returns undefined | Element

reflectionTemplate: ((...r) => Element) = ...

Type declaration

settings: ((...r) => Element) = ...

Type declaration

sidebar: ((...r) => Element) = ...

Type declaration

sidebarLinks: ((...r) => null | Element) = ...

Type declaration

toolbar: ((...r) => Element) = ...

Type declaration

type: ((...r) => Element) = ...

Type declaration

typeAndParent: ((...r) => Element) = ...

Type declaration

typeParameters: ((...r) => Element) = ...

Type declaration

Accessors

Methods

Generated using TypeDoc