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",
"jsxImportSource": "typedoc"
}

Index

Type aliases

Children

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

Component

Component<P>: (props: P) => Element | null | undefined

Type parameters

  • P

Type declaration

    • (props: P): Element | null | undefined
    • Parameters

      • props: P

      Returns Element | null | undefined

Variables

Fragment

Fragment: typeof Fragment = ...

Functions

Raw

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

    Parameters

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

    Returns null

createElement

renderElement

  • renderElement(element: undefined | null | Element): string

Generated using TypeDoc