Class DefaultThemeRenderContext

Hierarchy

DefaultThemeRenderContext

Constructors

constructor

new DefaultThemeRenderContext(theme, page, options): DefaultThemeRenderContext
Parameters
- theme: DefaultTheme
- page: PageEvent<Models.Reflection>
- options: Options
Returns DefaultThemeRenderContext
- Defined in src/lib/output/themes/default/DefaultThemeRenderContext.ts:53

Properties

analytics

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

Type declaration

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

breadcrumb

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

Type declaration

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

comment

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

Type declaration

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

defaultLayout

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

Type declaration

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

footer

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

Type declaration

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

header

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

Type declaration

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

hierarchy

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

Type declaration

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

icons

index

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

Type declaration

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

indexTemplate

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

Type declaration

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

member

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

Type declaration

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

memberDeclaration

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

Type declaration

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

memberGetterSetter

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

Type declaration

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

memberReference

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

Type declaration

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

memberSignatureBody

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

Type declaration

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

memberSignatureTitle

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

Type declaration

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

memberSignatures

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

Type declaration

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

memberSources

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

Type declaration

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

members

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

Type declaration

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

membersGroup

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

Type declaration

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

navigation

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

Type declaration

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

options

options: Options

page

page: PageEvent<Models.Reflection>

pageNavigation

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

Type declaration

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

pageSidebar

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

Type declaration

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

parameter

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

Type declaration

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

reflectionTemplate

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

Type declaration

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

settings

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

Type declaration

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

sidebar

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

Type declaration

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

sidebarLinks

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

Type declaration

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

toolbar

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

Type declaration

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

type

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

Type declaration

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

typeAndParent

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

Type declaration

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

typeParameters

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

Type declaration

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

Methods

attemptExternalResolution

attemptExternalResolution(type): 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: Models.ReferenceType
Returns undefined | string
- Defined in src/lib/output/themes/default/DefaultThemeRenderContext.ts:96

getReflectionClasses

getReflectionClasses(refl): string
Parameters
- refl: Models.DeclarationReflection
Returns string
- Defined in src/lib/output/themes/default/DefaultThemeRenderContext.ts:100

hook

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

markdown

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

relativeURL

relativeURL(url, cacheBust?): string
Avoid this in favor of urlTo if possible
Parameters
- url: string
- cacheBust: boolean = false
Returns string
- Defined in src/lib/output/themes/default/DefaultThemeRenderContext.ts:67

urlTo

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

Class DefaultThemeRenderContext

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

theme: DefaultTheme

page: PageEvent<Models.Reflection>

options: Options

Returns DefaultThemeRenderContext

Properties

analytics

Type declaration

Parameters

Rest ...r: []

Returns undefined | Element

breadcrumb

Type declaration

Parameters

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

Returns undefined | Element

comment

Type declaration

Parameters

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

Returns undefined | Element

defaultLayout

Type declaration

Parameters

Rest ...r: [template: RenderTemplate<PageEvent<Models.Reflection>>, props: PageEvent<Models.Reflection>]

Returns Element

footer

Type declaration

Parameters

Rest ...r: []

Returns undefined | Element

header

Type declaration

Parameters

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

Returns Element

hierarchy

Type declaration

Parameters

Rest ...r: [props: DeclarationHierarchy]

Returns undefined | Element

icons

index

Type declaration

Parameters

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

Returns Element

indexTemplate

Type declaration

Parameters

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

Returns Element

member

Type declaration

Parameters

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

Returns Element

memberDeclaration

Type declaration

Parameters

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

Returns Element

memberGetterSetter

Type declaration

Parameters

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

Returns Element

memberReference

Type declaration

Parameters

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

Returns Element

`Rest` ...r: []

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

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

`Rest` ...r: [template: RenderTemplate<PageEvent<Models.Reflection>>, props: PageEvent<Models.Reflection>]

`Rest` ...r: []

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

`Rest` ...r: []

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