-
Notifications
You must be signed in to change notification settings - Fork 614
SelectPanel: Add loading
to props table
#6185
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR updates the SelectPanel documentation by adding the new loading
prop to its props table, ensuring users know how to control the loading spinner state.
- Introduces a
loading
entry in the SelectPanel props JSON. - Specifies
type
,defaultValue
, anddescription
forloading
. - Aligns docs with the new feature that infers loading based on
items
.
Comments suppressed due to low confidence (2)
packages/react/src/SelectPanel/SelectPanel.docs.json:196
- The defaultValue is set to "false", but the description indicates the loading state is inferred when not provided. Consider setting defaultValue to "undefined" (with inference behavior) or updating the description to match the explicit default behavior.
"defaultValue": "false",
packages/react/src/SelectPanel/SelectPanel.docs.json:197
- [nitpick] The phrase "based on the contents of
items
available" is a bit awkward. Consider rephrasing to "based on the contents available initems
" or simply "based on the availableitems
contents" for clarity.
"description": "Whether the panel is in a loading state. When `true`, the panel will display a loading spinner. If `loading` is not provided, the panel will infer the loading state based on the contents of `items` available."
size-limit report 📦
|
Closes https://github.com/github/primer/issues/5285
Adds
loading
toSelectPanel
props tableChangelog
New
loading
to props table forSelectPanel
Rollout strategy
Testing & Reviewing
Merge checklist