DocumentationKindcomponent
DocumentationKind({ kind = "unknown", ...props }: DocumentationKindProps): ReactElement| Param | Type | |
|---|---|---|
props | DocumentationKindProps | Props for DocumentationKind — a TagProps plus the documented symbol's kind. required |
.kind | string | The documentation kind (e.g. "component", "function", "class", "interface", "type", "constant", "method", "static method", "property", "static property"). required readonly |
| Return | |
|---|---|
ReactElement | A <Tag> showing the kind, tinted by its colour. |
Colour-coded tag for a documented symbol's kind.
- Thin wrapper over
<Tag>that maps the kind string to a raw colour variant.
Examples
<DocumentationKind kind="function" />