DocumentationParamscomponent
DocumentationParams({ params }: DocumentationParamsProps): ReactNode| Param | Type | |
|---|---|---|
props | DocumentationParamsProps | Props for DocumentationParams — the parameter list to render, one row per parameter. required |
.params | ImmutableArray<DocumentationParam> | Parameters to render — one row each, with options-bag params flattened into indented child rows. readonly |
| Return | |
|---|---|
ReactNode | A <Section> containing the parameters table, or null when there are none. |
Render a documented symbol's parameters as a scrollable table — one row per parameter.
- Self-contained: pulls its own copy of the tree map from
useTreeMap()so theTypecolumn can link each type to its documented page viaTreeLink(exact-match only; compound or builtin types stay plain text). - A union type renders one linked token per member, each on its own line; a
| undefinedmember is dropped and instead marks the parameter optional. - Descriptions render as inline markup, with a trailing
Defaults to …(linked when documented) orRequired.note — seeDocumentationDescription. A row with no hand-written description falls back to the referenced type's owndescription. - An options-bag parameter whose type resolves to a documented interface/object type is flattened into indented child rows (one per property), so readers see the individual fields inline.
- Renders nothing when there are no parameters.
Examples
<DocumentationParams params={params} />