Options
All
  • Public
  • Public/Protected
  • All
Menu

Class DefaultTheme

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

Hierarchy

Implements

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[] = [{kind: [ReflectionKind.Class],isLeaf: false,directory: 'classes',template: 'reflection.hbs'}, {kind: [ReflectionKind.Interface],isLeaf: false,directory: 'interfaces',template: 'reflection.hbs'}, {kind: [ReflectionKind.Enum],isLeaf: false,directory: 'enums',template: 'reflection.hbs'}, {kind: [ReflectionKind.Module, ReflectionKind.ExternalModule],isLeaf: false,directory: 'modules',template: 'reflection.hbs'}]

Mappings of reflections kinds to templates used by this theme.

Static URL_PREFIX

URL_PREFIX: RegExp = /^(http|ftp)s?:\/\//

Accessors

application

owner

Methods

Protected bubble

getEntryPoint

getNavigation

getOptionDeclarations

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

listenToOnce

off

  • off(): any
  • off(eventMap: EventMap, context?: any): any
  • off(name: string, callback?: EventCallback, context?: any): any

on

  • on(eventMap: EventMap, context?: any): any
  • on(eventMap: EventMap, callback?: EventCallback, context?: any, priority?: number): any
  • on(name: string, callback: EventCallback, context?: any, priority?: number): any

Private onRendererBegin

once

  • once(eventMap: EventMap, context?: any): any
  • once(name: string, callback: EventCallback, context?: any, priority?: any): any
  • 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 any

  • Parameters

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

    Returns any

stopListening

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

    Returns this

Static applyAnchorUrl

  • Generate an anchor url for the given reflection and all of its children.

    Parameters

    • reflection: Reflection

      The reflection an anchor url should be created for.

    • container: Reflection

      The nearest reflection having an own document.

    Returns void

Static applyGroupClasses

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.

    • Default value 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