feat: add AriaStatus and AriaAlert to stable entrypoint - #8300
Conversation
🦋 Changeset detectedLatest commit: ec481d0 The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
|
There was a problem hiding this comment.
Pull request overview
This PR promotes the AriaStatus and AriaAlert live-region components from the experimental surface to the stable @primer/react entrypoint, updating Storybook organization and adding docs metadata plus a release changeset.
Changes:
- Re-export
AriaStatus/AriaAlert(and their props types) frompackages/react/src/index.ts, and update the exports snapshot accordingly. - Move Storybook titles for both components from
Experimental/Components/*toComponents/*(including Features). - Add docs metadata (
*.docs.json) for both components and a changeset for a minor release.
Show a summary per file
| File | Description |
|---|---|
| packages/react/src/live-region/AriaStatus.stories.tsx | Moves AriaStatus story into the stable “Components/*” namespace. |
| packages/react/src/live-region/AriaStatus.features.stories.tsx | Moves AriaStatus feature stories into the stable “Components/*/Features” namespace. |
| packages/react/src/live-region/AriaStatus.docs.json | Adds docs metadata for AriaStatus under the stable import path. |
| packages/react/src/live-region/AriaAlert.stories.tsx | Moves AriaAlert story into the stable “Components/*” namespace. |
| packages/react/src/live-region/AriaAlert.features.stories.tsx | Moves AriaAlert feature stories into the stable “Components/*/Features” namespace. |
| packages/react/src/live-region/AriaAlert.docs.json | Adds docs metadata for AriaAlert under the stable import path. |
| packages/react/src/index.ts | Adds stable exports for AriaStatus/AriaAlert and their prop types. |
| packages/react/src/tests/snapshots/exports.test.ts.snap | Updates export snapshot to include the newly stable exports. |
| .changeset/grumpy-actors-see.md | Adds a minor-release changeset for the new stable exports. |
Review details
💡 Add a code-review agent skill for context-aware, tailored reviews. Learn more in the docs.
- Files reviewed: 9/9 changed files
- Comments generated: 3
- Review effort level: Lite
| export {AriaStatus, AriaAlert} from './live-region' | ||
| export type {AriaStatusProps, AriaAlertProps} from './live-region' |
There was a problem hiding this comment.
Fixed in ec481d0 — AriaAlertProps<As extends ElementType = 'div'> now matches AriaStatusProps.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: joshblack <3901764+joshblack@users.noreply.github.com>
|
🤖 Lint issues have been automatically fixed and committed to this PR. |
Closes https://github.com/github/primer/issues/6971
Promote
AriaStatusandAriaAlertto stable in@primer/react. This stabilizes these components so we should pay attention to the API to see if we need to make any changes 👀Some things that came to mind include:
delayMsdebounce automatically?Changelog
New
Changed
AriaStatusandAriaAlertare now available directly from@primer/reactRemoved
Rollout strategy