[docs-infra] Tweak buildReference script
#1062
Merged
+61
−15
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
Netlify deploy preview |
mj12albert
force-pushed
the
docs/select-props-override
branch
from
98dd7d5 to
b7a0518
Compare
mj12albert
force-pushed
the
docs/select-props-override
branch
from
6b009a3 to
d0e455c
Compare
mj12albert
changed the title
buildReference script and fix select docs
mj12albert
commented
Dec 12, 2024
| @@ -70,7 +70,7 @@ export async function buildReference() { | |||
| const descriptionData: PropsTranslations = JSON.parse(descriptionJsonContents); | |||
|
|
|||
| for (const prop in props) { | |||
| props[prop].description = descriptionData.propDescriptions[prop]?.description; | |||
| props[prop].description ??= descriptionData.propDescriptions[prop]?.description; | |||
There was a problem hiding this comment.
Fixes when a description is specified in overrides/*.json but not reflected in the generated one
There was a problem hiding this comment.
(Probably only happens to something that is not literally an "override" like children)
mj12albert
commented
Dec 12, 2024
| @@ -93,7 +93,7 @@ export async function buildReference() { | |||
| const json: ComponentDef = { | |||
| name: componentData.name, | |||
| description: descriptionData.componentDescription, | |||
| props, | |||
| props: Object.fromEntries(Object.entries(props).sort()), | |||
There was a problem hiding this comment.
If there are "overrides" the props would not be sorted alphabetically, e.g. https://master--base-ui.netlify.app/react/components/radio#root
There was a problem hiding this comment.
Would be good to leave this as a comment in code
mj12albert
added
scope: docs-infra
mj12albert
changed the title
buildReference script and fix select docsbuildReference script and fix select docs
mj12albert
changed the title
buildReference script and fix select docsbuildReference script
mj12albert
commented
Dec 12, 2024
| "props": { | ||
| "children": { | ||
| "type": "React.ReactElement | (value) => React.ReactElement", | ||
| "description": "Allows you to customize the rendering of the text.\n\nAccepts a `ReactElement` or a function that returns the element to render." |
There was a problem hiding this comment.
@vladmoroz If you're ok with this description I'll use the same for Slider.Value
There was a problem hiding this comment.
I’d say:
Override children if you need to customize how the value is displayed.
By default, renders the current value as is.
Accepts a `ReactElement` or a function that returns the element to render.
Also, shouldn't the children allow React.ReactNode instead of React.ReactElement? So then we'd say
Accepts a `ReactNode` or a function that returns the node to render.
vladmoroz
approved these changes
Dec 12, 2024
mj12albert
force-pushed
the
docs/select-props-override
branch
from
fc4f504 to
938d581
Compare
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.
Fixes #1061
Also fixes #990 (comment)