DocumentationPropertiescomponent
DocumentationProperties({ properties }: DocumentationPropertiesProps): ReactNode| Param | Type | |
|---|---|---|
props | DocumentationPropertiesProps | Props for DocumentationProperties — the data members of a class/interface/object-literal type to render, one row each. required |
.properties | ImmutableArray<DocumentationParam> | Properties to render — one row each. readonly |
| Return | |
|---|---|
ReactNode |
Render a documented type's data members (properties, getters/setters) as a scrollable table — one row per property.
- 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). - Each property name carries a leading
.(e.g..caller); a union type renders one linked token per member, each on its own line, with a| undefinedmember dropped and marking the property 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. - These are the same structured entries an options-bag parameter is flattened from in
DocumentationParams, so the two stay in sync by construction. - Renders nothing when there are no properties.
Examples
<DocumentationProperties properties={properties} />