Class DefaultThemeRenderContext

Constructors

constructor

Properties

breadcrumb commentSummary commentTags defaultLayout documentTemplate footer header hierarchy hierarchyTemplate hook i18n index indexTemplate internationalization member memberDeclaration memberGetterSetter memberReference memberSignatureBody memberSignatureTitle memberSignatures memberSources members navigation options page pageNavigation pageSidebar parameter reflectionFlags reflectionPreview reflectionTemplate settings sidebar sidebarLinks theme toolbar type typeAndParent typeParameters membersGroup?

Accessors

icons

Methods

getNavigation getReflectionClasses markdown relativeURL urlTo

Constructors

constructor

Properties

breadcrumb

breadcrumb: ((...r: [props: Models.Reflection]) => undefined | Element) = ...

commentSummary

commentSummary: ((...r: [props: Models.Reflection]) => undefined | Element) = ...

commentTags

commentTags: ((...r: [props: Models.Reflection]) => undefined | Element) = ...

defaultLayout

defaultLayout: ((...r: [template: RenderTemplate<PageEvent<Models.Reflection>>, props: PageEvent<Models.Reflection>]) => Element) = ...

documentTemplate

documentTemplate: ((...r: [props: PageEvent<Models.DocumentReflection>]) => Element) = ...

footer

footer: ((...r: []) => Element) = ...

header

header: ((...r: [props: PageEvent<Models.Reflection>]) => Element) = ...

hierarchy

hierarchy: ((...r: [props: DeclarationHierarchy]) => undefined | Element) = ...

hierarchyTemplate

hierarchyTemplate: ((...r: [props: PageEvent<Models.ProjectReflection>]) => Element) = ...

hook

hook: (<K>(event: K, ...args: RendererHooks[K]) => Element[]) = ...

Type declaration

    • <K>(event, ...args): Element[]

    • Emits an event to all currently subscribed listeners.

      Type Parameters

      Parameters

      • event: K

        the event to emit.

      • Rest...args: RendererHooks[K]

        any arguments required for the event.

      Returns Element[]

i18n

i18n: TranslationProxy

index

index: ((...r: [props: Models.ContainerReflection]) => Element) = ...

indexTemplate

indexTemplate: ((...r: [props: PageEvent<Models.ProjectReflection>]) => Element) = ...

internationalization

internationalization: Internationalization

member

member: ((...r: [props: Models.DeclarationReflection | Models.DocumentReflection]) => Element) = ...

memberDeclaration

memberDeclaration: ((...r: [props: Models.DeclarationReflection]) => Element) = ...

memberGetterSetter

memberGetterSetter: ((...r: [props: Models.DeclarationReflection]) => Element) = ...

memberReference

memberReference: ((...r: [props: Models.ReferenceReflection]) => Element) = ...

memberSignatureBody

memberSignatureBody: ((...r: [props: Models.SignatureReflection, {
    hideSources?: boolean;
}?]) => Element) = ...

memberSignatureTitle

memberSignatureTitle: ((...r: [props: Models.SignatureReflection, {
    arrowStyle?: boolean;
    hideName?: boolean;
    hideParamTypes?: boolean;
}?]) => Element) = ...

memberSignatures

memberSignatures: ((...r: [props: Models.DeclarationReflection]) => Element) = ...

memberSources

memberSources: ((...r: [props: Models.DeclarationReflection | Models.SignatureReflection]) => Element) = ...

members

members: ((...r: [props: Models.ContainerReflection]) => Element) = ...

navigation

navigation: ((...r: [props: PageEvent<Models.Reflection>]) => Element) = ...

options

options: Options

page

page: PageEvent<Models.Reflection>

pageNavigation

pageNavigation: ((...r: [props: PageEvent<Models.Reflection>]) => Element) = ...

pageSidebar

pageSidebar: ((...r: [props: PageEvent<Models.Reflection>]) => Element) = ...

parameter

parameter: ((...r: [props: Models.DeclarationReflection]) => Element) = ...

reflectionFlags

reflectionFlags: ((...r: [props: Models.Reflection]) => Element) = ...

reflectionPreview

reflectionPreview: ((...r: [props: Models.Reflection]) => 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

reflectionTemplate

reflectionTemplate: ((...r: [props: PageEvent<Models.ContainerReflection>]) => Element) = ...

settings

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

sidebar

sidebar: ((...r: [props: PageEvent<Models.Reflection>]) => Element) = ...

sidebarLinks

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

Readonlytheme

theme: DefaultTheme

toolbar

toolbar: ((...r: [props: PageEvent<Models.Reflection>]) => Element) = ...

type

type: ((...r: [type: Models.Type, options: {
    topLevelLinks: boolean;
}]) => Element) = ...

typeAndParent

typeAndParent: ((...r: [props: Models.Type]) => Element) = ...

typeParameters

typeParameters: ((...r: [typeParameters: Models.TypeParameterReflection[]]) => Element) = ...

OptionalmembersGroup

membersGroup?: Function

Deprecated

Since 0.26.3 members does group/category flattening internally

Accessors

icons

  • get icons(): Readonly<Record<
        | "search"
        | "anchor"
        | ReflectionKind
        | "checkbox"
        | "chevronDown"
        | "menu"
        | "chevronSmall", (() => Element)>>

  • Icons available for use within the page.

    Note: This creates a reference to icons declared by DefaultTheme.icons, to customize icons, that object must be modified instead.

    Returns Readonly<Record<
        | "search"
        | "anchor"
        | ReflectionKind
        | "checkbox"
        | "chevronDown"
        | "menu"
        | "chevronSmall", (() => Element)>>

Methods

getNavigation

getReflectionClasses

markdown

relativeURL

urlTo

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods