Class DefaultThemeRenderContext

Hierarchy

DefaultThemeRenderContext

Constructors

constructor

new DefaultThemeRenderContext(theme: DefaultTheme, options: Options): DefaultThemeRenderContext
Parameters
- theme: DefaultTheme
- options: Options
Returns DefaultThemeRenderContext
- Defined in src/lib/output/themes/default/DefaultThemeRenderContext.ts:51

Properties

analytics

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

Type declaration

- (...r: []): undefined | Element
- Parameters
  - Rest ...r: []
  Returns undefined | Element

breadcrumb

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

Type declaration

- (...r: [props: Reflection]): undefined | Element
- Parameters
  - Rest ...r: [props: Reflection]
  Returns undefined | Element

comment

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

Type declaration

- (...r: [props: Reflection]): undefined | Element
- Parameters
  - Rest ...r: [props: Reflection]
  Returns undefined | Element

defaultLayout

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

Type declaration

- (...r: [props: PageEvent<Reflection>]): Element
- Parameters
  - Rest ...r: [props: PageEvent<Reflection>]
  Returns Element

footer

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

Type declaration

- (...r: []): undefined | Element
- Parameters
  - Rest ...r: []
  Returns undefined | Element

header

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

Type declaration

- (...r: [props: PageEvent<Reflection>]): Element
- Parameters
  - Rest ...r: [props: PageEvent<Reflection>]
  Returns Element

hierarchy

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

Type declaration

- (...r: [props: DeclarationHierarchy]): undefined | Element
- Parameters
  - Rest ...r: [props: DeclarationHierarchy]
  Returns undefined | Element

icons

index

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

Type declaration

- (...r: [props: ContainerReflection]): Element
- Parameters
  - Rest ...r: [props: ContainerReflection]
  Returns Element

indexTemplate

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

Type declaration

- (...r: [props: PageEvent<ProjectReflection>]): Element
- Parameters
  - Rest ...r: [props: PageEvent<ProjectReflection>]
  Returns Element

member

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

Type declaration

- (...r: [props: DeclarationReflection]): Element
- Parameters
  - Rest ...r: [props: DeclarationReflection]
  Returns Element

memberDeclaration

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

Type declaration

- (...r: [props: DeclarationReflection]): Element
- Parameters
  - Rest ...r: [props: DeclarationReflection]
  Returns Element

memberGetterSetter

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

Type declaration

- (...r: [props: DeclarationReflection]): Element
- Parameters
  - Rest ...r: [props: DeclarationReflection]
  Returns Element

memberReference

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

Type declaration

- (...r: [props: ReferenceReflection]): Element
- Parameters
  - Rest ...r: [props: ReferenceReflection]
  Returns Element

memberSignatureBody

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

Type declaration

- (...r: [SignatureReflection, {
  hideSources?: boolean;
  }?]): Element
- Parameters
  - Rest ...r: [SignatureReflection, {
    hideSources?: boolean;
    }?]
  Returns Element

memberSignatureTitle

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

Type declaration

- (...r: [SignatureReflection, {
  arrowStyle?: boolean;
  hideName?: boolean;
  }?]): Element
- Parameters
  - Rest ...r: [SignatureReflection, {
    arrowStyle?: boolean;
    hideName?: boolean;
    }?]
  Returns Element

memberSignatures

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

Type declaration

- (...r: [props: DeclarationReflection]): Element
- Parameters
  - Rest ...r: [props: DeclarationReflection]
  Returns Element

memberSources

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

Type declaration

- (...r: [props: SignatureReflection | DeclarationReflection]): Element
- Parameters
  - Rest ...r: [props: SignatureReflection | DeclarationReflection]
  Returns Element

members

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

Type declaration

- (...r: [props: ContainerReflection]): Element
- Parameters
  - Rest ...r: [props: ContainerReflection]
  Returns Element

membersGroup

membersGroup: ((...r: [group: ReflectionGroup]) => Element) = ...

Type declaration

- (...r: [group: ReflectionGroup]): Element
- Parameters
  - Rest ...r: [group: ReflectionGroup]
  Returns Element

navigation

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

Type declaration

- (...r: [props: PageEvent<Reflection>]): Element
- Parameters
  - Rest ...r: [props: PageEvent<Reflection>]
  Returns Element

options

options: Options

parameter

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

Type declaration

- (...r: [props: DeclarationReflection]): Element
- Parameters
  - Rest ...r: [props: DeclarationReflection]
  Returns Element

primaryNavigation

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

Type declaration

- (...r: [props: PageEvent<Reflection>]): Element
- Parameters
  - Rest ...r: [props: PageEvent<Reflection>]
  Returns Element

reflectionTemplate

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

Type declaration

- (...r: [props: PageEvent<ContainerReflection>]): Element
- Parameters
  - Rest ...r: [props: PageEvent<ContainerReflection>]
  Returns Element

secondaryNavigation

secondaryNavigation: ((...r: [props: PageEvent<Reflection>]) => undefined | Element) = ...

Type declaration

- (...r: [props: PageEvent<Reflection>]): undefined | Element
- Parameters
  - Rest ...r: [props: PageEvent<Reflection>]
  Returns undefined | Element

settings

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

Type declaration

- (...r: []): Element
- Parameters
  - Rest ...r: []
  Returns Element

sidebarLinks

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

Type declaration

- (...r: []): null | Element
- Parameters
  - Rest ...r: []
  Returns null | Element

toolbar

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

Type declaration

- (...r: [props: PageEvent<Reflection>]): Element
- Parameters
  - Rest ...r: [props: PageEvent<Reflection>]
  Returns Element

type

type: ((...r: [type: Type]) => Element) = ...

Type declaration

- (...r: [type: Type]): Element
- Parameters
  - Rest ...r: [type: Type]
  Returns Element

typeAndParent

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

Type declaration

- (...r: [props: Type]): Element
- Parameters
  - Rest ...r: [props: Type]
  Returns Element

typeParameters

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

Type declaration

- (...r: [typeParameters: TypeParameterReflection[]]): Element
- Parameters
  - Rest ...r: [typeParameters: TypeParameterReflection[]]
  Returns Element

Methods

attemptExternalResolution

attemptExternalResolution(type: ReferenceType): undefined | string
Using this method will repeat work already done, instead of calling it, use type.externalUrl.

Deprecated
Will be removed in 0.24.
Parameters
- type: ReferenceType
Returns undefined | string
- Defined in src/lib/output/themes/default/DefaultThemeRenderContext.ts:83

hook

hook(name: keyof RendererHooks): Element[]
Parameters
- name: keyof RendererHooks
Returns Element[]
- Defined in src/lib/output/themes/default/DefaultThemeRenderContext.ts:57

markdown

markdown(md: undefined | string | readonly CommentDisplayPart[]): string
Parameters
- md: undefined | string | readonly CommentDisplayPart[]
Returns string
- Defined in src/lib/output/themes/default/DefaultThemeRenderContext.ts:67

relativeURL

relativeURL(url: undefined | string): undefined | string
Avoid this in favor of urlTo if possible
Parameters
- url: undefined | string
Returns undefined | string
- Defined in src/lib/output/themes/default/DefaultThemeRenderContext.ts:61

urlTo

urlTo(reflection: Reflection): string
Parameters
- reflection: Reflection
Returns string
- Defined in src/lib/output/themes/default/DefaultThemeRenderContext.ts:65

Class DefaultThemeRenderContext

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

theme: DefaultTheme

options: Options

Returns DefaultThemeRenderContext

Properties

analytics

Type declaration

Parameters

Rest ...r: []

Returns undefined | Element

breadcrumb

Type declaration

Parameters

Rest ...r: [props: Reflection]

Returns undefined | Element

comment

Type declaration

Parameters

Rest ...r: [props: Reflection]

Returns undefined | Element

defaultLayout

Type declaration

Parameters

Rest ...r: [props: PageEvent<Reflection>]

Returns Element

footer

Type declaration

Parameters

Rest ...r: []

Returns undefined | Element

header

Type declaration

Parameters

Rest ...r: [props: PageEvent<Reflection>]

Returns Element

hierarchy

Type declaration

Parameters

Rest ...r: [props: DeclarationHierarchy]

Returns undefined | Element

icons

index

Type declaration

Parameters

Rest ...r: [props: ContainerReflection]

Returns Element

indexTemplate

Type declaration

Parameters

Rest ...r: [props: PageEvent<ProjectReflection>]

Returns Element

member

Type declaration

Parameters

Rest ...r: [props: DeclarationReflection]

Returns Element

memberDeclaration

Type declaration

Parameters

Rest ...r: [props: DeclarationReflection]

Returns Element

memberGetterSetter

Type declaration

Parameters

Rest ...r: [props: DeclarationReflection]

Returns Element

memberReference

Type declaration

Parameters

Rest ...r: [props: ReferenceReflection]

Returns Element

memberSignatureBody

`Rest` ...r: []

`Rest` ...r: [props: Reflection]

`Rest` ...r: [props: Reflection]

`Rest` ...r: [props: PageEvent<Reflection>]

`Rest` ...r: []

`Rest` ...r: [props: PageEvent<Reflection>]

`Rest` ...r: [props: DeclarationHierarchy]

`Rest` ...r: [props: ContainerReflection]

`Rest` ...r: [props: PageEvent<ProjectReflection>]

`Rest` ...r: [props: DeclarationReflection]

`Rest` ...r: [props: DeclarationReflection]

`Rest` ...r: [props: DeclarationReflection]

`Rest` ...r: [props: ReferenceReflection]

`Rest` ...r: [SignatureReflection, {
hideSources?: boolean;
}?]

`Rest` ...r: [SignatureReflection, {
arrowStyle?: boolean;
hideName?: boolean;
}?]

`Rest` ...r: [props: DeclarationReflection]

`Rest` ...r: [props: SignatureReflection | DeclarationReflection]

`Rest` ...r: [props: ContainerReflection]

`Rest` ...r: [group: ReflectionGroup]

`Rest` ...r: [props: PageEvent<Reflection>]

`Rest` ...r: [props: DeclarationReflection]

`Rest` ...r: [props: PageEvent<Reflection>]

`Rest` ...r: [props: PageEvent<ContainerReflection>]

`Rest` ...r: [props: PageEvent<Reflection>]

`Rest` ...r: []

`Rest` ...r: []

`Rest` ...r: [props: PageEvent<Reflection>]