Options
All
  • Public
  • Public/Protected
  • All
Menu

Custom JSX module designed specifically for TypeDoc's needs. When overriding a default TypeDoc theme output, your implementation must create valid Element instances, which can be most easily done by using TypeDoc's JSX implementation. To use it, set up your tsconfig with the following compiler options:

{
"jsx": "react",
"jsxFactory": "JSX.createElement",
"jsxFragmentFactory": "JSX.Fragment"
}

Index

Interfaces

Type aliases

Variables

Functions

Type aliases

Children: Element | string | number | null | undefined | Children[]

Variables

Fragment: typeof Fragment = ...

Functions

  • Raw(_props: { html: string }): null
  • Used to inject HTML directly into the document.

    Parameters

    • _props: { html: string }
      • html: string

    Returns null

  • createElement(tag: string | typeof Fragment | JsxComponent<any>, props: null | object, ...children: Children[]): Element
  • renderElement(element: undefined | null | Element): string

Generated using TypeDoc