Options
All
  • Public
  • Public/Protected
  • All
Menu

Default theme implementation of TypeDoc. If a theme does not provide a custom [[BaseTheme]] implementation, this theme class will be used.

Hierarchy

  • Theme
    • DefaultTheme

Index

Constructors

constructor

Properties

basePath

basePath: string

The base path of this theme.

componentName

componentName: string

The name of this component as set by the @Component decorator.

resources

resources: Resources

Static MAPPINGS

MAPPINGS: TemplateMapping[] = ...

Mappings of reflections kinds to templates used by this theme.

Static URL_PREFIX

URL_PREFIX: RegExp = ...

Accessors

Private _listenId

  • get _listenId(): string

application

owner

  • get owner(): O

Methods

Protected bubble

getNavigation

getUrls

Protected initialize

  • initialize(): void

isOutputDirectory

  • isOutputDirectory(path: string): boolean
  • Test whether the given path contains a documentation generated by this theme.

    Parameters

    • path: string

      The path of the directory that should be tested.

    Returns boolean

    TRUE if the given path seems to be a previous output directory, otherwise FALSE.

listenTo

  • Inversion-of-control versions of on. Tell this object to listen to an event in another object... keeping track of what it's listening to for easier unbinding later.

    Parameters

    • obj: EventDispatcher
    • name: string | EventMap
    • Optional callback: EventCallback
    • Optional priority: number

    Returns DefaultTheme

listenToOnce

off

  • Remove one or many callbacks. If context is null, removes all callbacks with that function. If callback is null, removes all callbacks for the event. If name is null, removes all bound callbacks for all events.

    Returns DefaultTheme

  • Parameters

    • eventMap: undefined | EventMap
    • Optional context: any

    Returns DefaultTheme

  • Parameters

    • name: undefined | string
    • Optional callback: EventCallback
    • Optional context: any

    Returns DefaultTheme

on

  • on(eventMap: EventMap, context?: any): DefaultTheme
  • on(eventMap: EventMap, callback?: EventCallback, context?: any, priority?: number): DefaultTheme
  • on(name: string, callback: EventCallback, context?: any, priority?: number): DefaultTheme
  • Bind an event to a callback function. Passing "all" will bind the callback to all events fired.

    Parameters

    • eventMap: EventMap
    • Optional context: any

    Returns DefaultTheme

  • Parameters

    • eventMap: EventMap
    • Optional callback: EventCallback
    • Optional context: any
    • Optional priority: number

    Returns DefaultTheme

  • Parameters

    • name: string
    • callback: EventCallback
    • Optional context: any
    • Optional priority: number

    Returns DefaultTheme

Private onRendererBegin

  • onRendererBegin(event: RendererEvent): void
  • Triggered before the renderer starts rendering a project.

    Parameters

    • event: RendererEvent

      An event object describing the current render operation.

    Returns void

once

  • once(eventMap: EventMap, context?: any): DefaultTheme
  • once(name: string, callback: EventCallback, context?: any, priority?: any): DefaultTheme
  • Bind an event to only be triggered a single time. After the first time the callback is invoked, its listener will be removed. If multiple events are passed in using the space-separated syntax, the handler will fire once for each event, not once for a combination of all events.

    Parameters

    • eventMap: EventMap
    • Optional context: any

    Returns DefaultTheme

  • Parameters

    • name: string
    • callback: EventCallback
    • Optional context: any
    • Optional priority: any

    Returns DefaultTheme

stopListening

  • Tell this object to stop listening to either specific events ... or to every object it's currently listening to.

    Parameters

    • Optional obj: EventDispatcher
    • Optional name: string | EventMap
    • Optional callback: EventCallback

    Returns DefaultTheme

trigger

  • Trigger one or many events, firing all bound callbacks. Callbacks are passed the same arguments as trigger is, apart from the event name (unless you're listening on "all", which will cause your callback to receive the true name of the event as the first argument).

    Parameters

    • name: string | Event | EventMap
    • Rest ...args: any[]

    Returns DefaultTheme

Static applyAnchorUrl

Static applyGroupClasses

  • applyGroupClasses(group: ReflectionGroup): void
  • Generate the css classes for the given reflection group and apply them to the [[ReflectionGroup.cssClasses]] property.

    Parameters

    • group: ReflectionGroup

      The reflection group whose cssClasses property should be generated.

    Returns void

Static applyReflectionClasses

Static buildUrls

Static getMapping

Static getUrl

  • Return a url for the given reflection.

    Parameters

    • reflection: Reflection

      The reflection the url should be generated for.

    • Optional relative: Reflection

      The parent reflection the url generation should stop on.

    • separator: string = "."

      The separator used to generate the url.

    Returns string

    The generated url.

Static toStyleClass

  • toStyleClass(str: string): string
  • Transform a space separated string into a string suitable to be used as a css class, e.g. "constructor method" > "Constructor-method".

    Parameters

    • str: string

    Returns string

Generated using TypeDoc