6cb797a074
Before: ![Screenshot 2024-06-12 at 12 57 26](https://github.com/tldraw/tldraw/assets/1489520/2a9f6098-ef2a-4f52-88f5-d6e4311c067d) After: ![Screenshot 2024-06-12 at 12 59 16](https://github.com/tldraw/tldraw/assets/1489520/51733c2a-a2b4-4084-a89a-85bce5b47672) React components in docs now list their props, and appear under a new "Component" section instead of randomly under either `Function` or `Variable`. In order to have our docs generate this, a few criteria need to be met: 1. They need to be tagged with the `@react` tsdoc tag 2. Their props need to be a simple type alias, typically to an interface. Both of these rules are enforced with a new lint rule - any component tagged as `@public` will have these rules enforced. ### Change Type - [x] `docs` — Changes to the documentation, examples, or templates. - [x] `improvement` — Improving existing features
15 lines
285 B
JSON
15 lines
285 B
JSON
{
|
|
"$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
|
|
"extends": ["@microsoft/api-extractor/extends/tsdoc-base.json"],
|
|
|
|
"tagDefinitions": [
|
|
{
|
|
"tagName": "@react",
|
|
"syntaxKind": "modifier"
|
|
}
|
|
],
|
|
|
|
"supportForTags": {
|
|
"@react": true
|
|
}
|
|
}
|