KC's Workspace
    Preparing search index...

    Class DefaultThemeRenderContext

    Index

    Constructors

    constructor

    Properties

    breadcrumbs commentShortSummary commentSummary commentTags defaultLayout displayParts documentTemplate footer getAnchor getNavigation getReflectionClasses header hierarchy hierarchyTemplate hook index indexTemplate markdown member memberDeclaration memberGetterSetter members memberSignatureBody memberSignatures memberSignatureTitle memberSources model moduleMemberSummary moduleReflection navigation options page pageNavigation pageSidebar reflectionFlags reflectionIcon reflectionPreview reflectionTemplate relativeURL router settings sidebar sidebarLinks theme toolbar type typeAndParent typeDeclaration typeDetails typeDetailsIfUseful typeParameters urlTo

    Accessors

    icons slugger

    Constructors

    Properties

    breadcrumbs: (props: Reflection) => JsxElement
    commentShortSummary: (props: Reflection) => JsxElement | undefined
    commentSummary: (props: Reflection) => JsxElement | undefined
    commentTags: (props: Reflection) => JsxElement | undefined
    defaultLayout: (
        template: RenderTemplate<PageEvent<Reflection>>,
        props: PageEvent<Reflection>,
    ) => JsxElement
    displayParts: (
        parts: readonly CommentDisplayPart[] | undefined,
    ) => JsxElement | undefined

    Renders user comment markdown wrapped in a tsd-comment div

    documentTemplate: (props: PageEvent<DocumentReflection>) => JsxElement
    footer: () => JsxElement
    getAnchor: (reflection: Reflection) => string | undefined
    getNavigation: () => NavigationElement[]
    getReflectionClasses: (refl: Reflection) => string
    header: (props: PageEvent<Reflection>) => JsxElement
    hierarchy: (
        typeHierarchy: DeclarationHierarchy | undefined,
    ) => JsxElement | undefined
    hierarchyTemplate: (props: PageEvent<ProjectReflection>) => JsxElement
    hook: <K extends keyof RendererHooks>(
        event: K,
        ...args: RendererHooks[K],
    ) => JsxElement[]

    Type Declaration

    index: (props: ContainerReflection) => JsxElement
    indexTemplate: (props: PageEvent<ProjectReflection>) => JsxElement
    markdown: (md: string | readonly CommentDisplayPart[] | undefined) => string
    member: (props: DocumentReflection | DeclarationReflection) => JsxElement
    memberDeclaration: (props: DeclarationReflection) => JsxElement
    memberGetterSetter: (props: DeclarationReflection) => JsxElement
    members: (props: ContainerReflection) => JsxElement
    memberSignatureBody: (
        props: SignatureReflection,
        r_1?: { hideSources?: boolean },
    ) => JsxElement
    memberSignatures: (props: DeclarationReflection) => JsxElement
    memberSignatureTitle: (
        props: SignatureReflection,
        options?: { hideName?: boolean },
    ) => JsxElement
    memberSources: (
        props: DeclarationReflection | SignatureReflection,
    ) => JsxElement
    model: Reflection
    moduleMemberSummary: (
        member: DocumentReflection | DeclarationReflection,
    ) => JsxElement
    moduleReflection: (mod: ProjectReflection | DeclarationReflection) => JsxElement
    navigation: (props: PageEvent<Reflection>) => JsxElement
    options: Options

    page

    page: PageEvent<Reflection>
    pageNavigation: (props: PageEvent<Reflection>) => JsxElement
    pageSidebar: (props: PageEvent<Reflection>) => JsxElement
    reflectionFlags: (props: Reflection) => JsxElement
    reflectionIcon: (reflection: Reflection) => JsxElement

    Do not override this method, override DefaultTheme.getReflectionIcon instead.

    reflectionPreview: (props: Reflection) => JsxElement | undefined

    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: (props: PageEvent<ContainerReflection>) => JsxElement
    relativeURL: (url: string, cacheBust?: boolean) => string

    Avoid this in favor of urlTo if possible

    router: Router
    settings: () => JsxElement
    sidebar: (props: PageEvent<Reflection>) => JsxElement
    sidebarLinks: () => JsxElement | null
    theme: DefaultTheme
    toolbar: (props: PageEvent<Reflection>) => JsxElement
    type: (
        type: SomeType | undefined,
        options?: { topLevelLinks: boolean },
    ) => JsxElement
    typeAndParent: (props: Type) => JsxElement
    typeDeclaration: (
        reflectionOwningType: Reflection,
        type: SomeType,
    ) => JsxChildren

    Wrapper around typeDetails which checks if it is useful and includes a "Type Declaration" header.

    typeDetails: (
        reflectionOwningType: Reflection,
        type: SomeType,
        renderAnchors: boolean,
    ) => JsxChildren

    Used to render additional details about a type. This is used to implement the @expand tag, comments on union members, comments on object type members...

    typeDetailsIfUseful: (
        reflectionOwningType: Reflection,
        type: SomeType | undefined,
    ) => JsxChildren

    Should call the typeDetails helper if rendering additional details about the type will provide the user with more information about the type.

    typeParameters: (typeParameters: TypeParameterReflection[]) => JsxElement
    urlTo: (reflection: Reflection) => string | undefined

    Accessors

    • get icons(): Readonly<Icons>

      Icons available for use within the page. When getting an icon for a reflection, reflectionIcon should be used so that themes which define multiple icon variants can correctly specify which icon they want to be used.

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

      Returns Readonly<Icons>

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors