TypeDoc API - v0.28.2

    Class DefaultThemeRenderContext

    Index

    Accessors

    icons slugger

    Constructors

    constructor

    Methods

    getAnchor getNavigation getReflectionClasses markdown reflectionIcon relativeURL urlTo

    Properties

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

    Accessors

    Constructors

    Methods

    Properties

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

    Renders user comment markdown wrapped in a tsd-comment div

    documentTemplate: (
        ...r: [props: PageEvent<Models.DocumentReflection>],
    ) => Element = ...
    footer: (...r: []) => Element = ...
    header: (...r: [props: PageEvent<Models.Reflection>]) => Element = ...
    hierarchy: (
        ...r: [typeHierarchy: Models.DeclarationHierarchy],
    ) => undefined | Element = ...
    hierarchyTemplate: (
        ...r: [props: PageEvent<Models.ProjectReflection>],
    ) => Element = ...
    hook: <K extends keyof RendererHooks>(
        event: K,
        ...args: RendererHooks[K],
    ) => Element[] = ...

    Type declaration

    index: (...r: [props: Models.ContainerReflection]) => Element = ...
    indexTemplate: (...r: [props: PageEvent<Models.ProjectReflection>]) => Element = ...
    member: (
        ...r: [props: Models.DeclarationReflection | Models.DocumentReflection],
    ) => Element = ...
    memberDeclaration: (...r: [props: Models.DeclarationReflection]) => Element = ...
    memberGetterSetter: (...r: [props: Models.DeclarationReflection]) => Element = ...
    members: (...r: [props: Models.ContainerReflection]) => Element = ...
    memberSignatureBody: (
        ...r: [props: Models.SignatureReflection, { hideSources?: boolean }?],
    ) => Element = ...
    memberSignatures: (...r: [props: Models.DeclarationReflection]) => Element = ...
    memberSignatureTitle: (
        ...r: [
            props: Models.SignatureReflection,
            options: { hideName?: boolean },
        ],
    ) => Element = ...
    memberSources: (
        ...r: [props: Models.DeclarationReflection | Models.SignatureReflection],
    ) => Element = ...
    model: Models.Reflection
    moduleMemberSummary: (
        ...r: [member: Models.DeclarationReflection | Models.DocumentReflection],
    ) => Element = ...
    moduleReflection: (
        ...r: [mod: Models.DeclarationReflection | Models.ProjectReflection],
    ) => Element = ...
    navigation: (...r: [props: PageEvent<Models.Reflection>]) => Element = ...
    options: Configuration.Options

    page

    page: PageEvent<Models.Reflection>
    pageNavigation: (...r: [props: PageEvent<Models.Reflection>]) => Element = ...
    pageSidebar: (...r: [props: PageEvent<Models.Reflection>]) => Element = ...
    reflectionFlags: (...r: [props: Models.Reflection]) => Element = ...
    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: (
        ...r: [props: PageEvent<Models.ContainerReflection>],
    ) => Element = ...
    router: Router
    settings: (...r: []) => Element = ...
    sidebar: (...r: [props: PageEvent<Models.Reflection>]) => Element = ...
    sidebarLinks: (...r: []) => null | Element = ...
    theme: DefaultTheme
    toolbar: (...r: [props: PageEvent<Models.Reflection>]) => Element = ...
    type: (
        ...r: [type: Models.SomeType, options: { topLevelLinks: boolean }],
    ) => Element = ...
    typeAndParent: (...r: [props: Models.Type]) => Element = ...
    typeDeclaration: (
        ...r: [reflectionOwningType: Models.Reflection, type: Models.SomeType],
    ) => Children = ...

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

    typeDetails: (
        ...r: [
            reflectionOwningType: Models.Reflection,
            type: Models.SomeType,
            renderAnchors: boolean,
        ],
    ) => Children = ...

    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: (
        ...r: [reflectionOwningType: Models.Reflection, type: Models.SomeType],
    ) => Children = ...

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

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

    Settings

    Member Visibility

    On This Page

    Accessors
    Constructors
    Methods
    Properties
    MMNEPVFCICPMFPCPTTAAATR