[docs-infra] New API reference generator #1537
Draft
+1,533
−406
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
✅ Deploy Preview for base-ui ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
github-actions
bot
added
the
PR: out-of-date
mnajdova
reviewed
Mar 7, 2025
| @@ -41,12 +40,10 @@ | |||
| }, | |||
| "cssVariables": { | |||
| "--accordion-panel-height": { | |||
| "description": "The accordion panel's height.", | |||
| "type": "number" | |||
| "description": "The accordion panel's height." | |||
Comment on lines
+30
to
+32
| "type": "boolean | undefined", | ||
| "default": "false", | ||
| "required": true, |
There was a problem hiding this comment.
This is a bit strange. It says it's required, but we allow undefined as value. Is there a way to change the props that have default values not to be flagged as required?
| "description": "CSS class applied to the element, or a function that\nreturns a class based on the component’s state." | ||
| }, | ||
| "render": { | ||
| "type": "React.ReactElement | (props, state) => React.ReactElement", | ||
| "type": "React.ReactElement | ((props: unknown, state: unknown) => React.ReactElement)", |
There was a problem hiding this comment.
We probably need to specify the state & props for each component.
There was a problem hiding this comment.
Yeah, this doesn't look right. These aren't really the props of a component but attributes to be spread on the rendered HTML element. I'll try to display in a better way
michaldudak
commented
Mar 7, 2025
There was a problem hiding this comment.
I'm going to exclude internal components.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Using https://github.com/michaldudak/react-api-extractor