Skip to content

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

Merged
merged 2 commits into from
Jun 17, 2025

Conversation

TylerJDev
Copy link
Member

Closes https://github.com/github/primer/issues/5285

Adds loading to SelectPanel props table

Changelog

New

  • Add loading to props table for SelectPanel

Rollout strategy

  • Patch release
  • Minor release
  • Major release; if selected, include a written rollout or migration plan
  • None; if selected, include a brief description as to why

Testing & Reviewing

Merge checklist

@Copilot Copilot AI review requested due to automatic review settings June 9, 2025 17:07
@TylerJDev TylerJDev requested a review from a team as a code owner June 9, 2025 17:07
@TylerJDev TylerJDev requested a review from joshblack June 9, 2025 17:07
Copy link

changeset-bot bot commented Jun 9, 2025

⚠️ No Changeset found

Latest commit: 5e64a5a

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@github-actions github-actions bot added the staff Author is a staff member label Jun 9, 2025
Copy link
Contributor

@Copilot Copilot AI left a 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, and description for loading.
  • 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 in items" or simply "based on the available items 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."

@TylerJDev TylerJDev added the skip changeset This change does not need a changelog label Jun 9, 2025
Copy link
Contributor

github-actions bot commented Jun 9, 2025

size-limit report 📦

Path Size
packages/react/dist/browser.esm.js 92.33 KB (0%)
packages/react/dist/browser.umd.js 92.37 KB (0%)

@TylerJDev TylerJDev added this pull request to the merge queue Jun 17, 2025
Merged via the queue into main with commit d651f95 Jun 17, 2025
35 checks passed
@TylerJDev TylerJDev deleted the tylerjdev/add-note-on-loading-selectpanel branch June 17, 2025 19:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
skip changeset This change does not need a changelog staff Author is a staff member
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants