DocumentationReferencescomponent
DocumentationReferences({ types }: DocumentationReferencesProps): ReactNode| Param | Type | |
|---|---|---|
props | DocumentationReferencesProps | Props for DocumentationReferences — the referenced type names to render, one row each. required |
.types | ImmutableArray<string> | Type names referenced by a type alias's body — one row each, resolved to links at render time. readonly |
| Return | |
|---|---|
ReactNode | A <Section> containing the references table, or null when there are none. |
Render a type alias's referenced type names as a scrollable table — one row per referenced type.
- Self-contained: pulls its own copy of the tree map from
useTreeMap()so each name links to its documented page viaTreeLink(exact-match only; unresolved names stay plain text), with the row carrying the resolved element'sdescription. - Renders nothing when there are no referenced types.
Examples
<DocumentationReferences types={types} />