1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
|
/**
* Custom JSX module designed specifically for TypeDoc's needs.
* When overriding a default TypeDoc theme output, your implementation must create valid {@link 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:
* ```json
* {
* "jsx": "react",
* "jsxFactory": "JSX.createElement",
* "jsxFragmentFactory": "JSX.Fragment"
* }
* ```
* @module
*/
import type { IntrinsicElements, JsxElement, JsxChildren, JsxComponent } from "./jsx.elements";
import { JsxFragment as Fragment } from "./jsx.elements";
export type { JsxElement as Element, JsxChildren as Children, JsxComponent, } from "./jsx.elements";
export { JsxFragment as Fragment } from "./jsx.elements";
/**
* Used to inject HTML directly into the document.
*/
export declare function Raw(_props: {
html: string;
}): null;
/**
* TypeScript's rules for looking up the JSX.IntrinsicElements and JSX.Element
* interfaces are incredibly strange. It will find them if they are included as
* a namespace under the createElement function, or globally, or, apparently, if
* a JSX namespace is declared at the same scope as the factory function.
* Hide this in the docs, hopefully someday TypeScript improves this and allows
* looking adjacent to the factory function and we can get rid of this phantom namespace.
* @hidden
*/
export declare namespace JSX {
export { IntrinsicElements, JsxElement as Element };
}
/**
* JSX factory function to create an "element" that can later be rendered with {@link renderElement}
* @param tag
* @param props
* @param children
*/
export declare function createElement(tag: typeof Fragment | string | JsxComponent<any>, props: object | null, ...children: JsxChildren[]): JsxElement;
export declare function setRenderSettings(options: {
pretty: boolean;
}): void;
export declare function renderElement(element: JsxElement | null | undefined): string;
|