diff --git a/.changeset/grumpy-actors-see.md b/.changeset/grumpy-actors-see.md new file mode 100644 index 00000000000..2e8e06eaaa6 --- /dev/null +++ b/.changeset/grumpy-actors-see.md @@ -0,0 +1,5 @@ +--- +'@primer/react': minor +--- + +Promote AriaStatus and AriaAlert from experimental to stable diff --git a/packages/react/src/__tests__/__snapshots__/exports.test.ts.snap b/packages/react/src/__tests__/__snapshots__/exports.test.ts.snap index 068bacd8275..1577dbe7439 100644 --- a/packages/react/src/__tests__/__snapshots__/exports.test.ts.snap +++ b/packages/react/src/__tests__/__snapshots__/exports.test.ts.snap @@ -23,6 +23,10 @@ exports[`@primer/react > should not update exports without a semver change 1`] = "AnchoredOverlay", "type AnchoredOverlayProps", "AnchoredPositionHookSettings", + "AriaAlert", + "type AriaAlertProps", + "AriaStatus", + "type AriaStatusProps", "asSlot", "Autocomplete", "type AutocompleteInputProps", diff --git a/packages/react/src/index.ts b/packages/react/src/index.ts index 0c4ebf8767d..01e58ee1a5a 100644 --- a/packages/react/src/index.ts +++ b/packages/react/src/index.ts @@ -1,6 +1,8 @@ 'use client' export {default as theme, type ThemeColorPaths, type ThemeShadowPaths} from './theme' +export {AriaStatus, AriaAlert} from './live-region' +export type {AriaStatusProps, AriaAlertProps} from './live-region' export {default as BaseStyles} from './BaseStyles' export type {BaseStylesProps} from './BaseStyles' export {default as ThemeProvider} from './ThemeProvider' diff --git a/packages/react/src/live-region/AriaAlert.docs.json b/packages/react/src/live-region/AriaAlert.docs.json new file mode 100644 index 00000000000..404f5cea97e --- /dev/null +++ b/packages/react/src/live-region/AriaAlert.docs.json @@ -0,0 +1,22 @@ +{ + "id": "aria-alert", + "name": "AriaAlert", + "status": "alpha", + "a11yReviewed": false, + "importPath": "@primer/react", + "stories": [], + "props": [ + { + "name": "announceOnShow", + "type": "boolean", + "description": "Specify if the content of the element should be announced when this component is rendered and is not hidden", + "defaultValue": "false" + }, + { + "name": "hidden", + "type": "boolean", + "description": "Specify if the element is hidden", + "defaultValue": "false" + } + ] +} diff --git a/packages/react/src/live-region/AriaAlert.features.stories.tsx b/packages/react/src/live-region/AriaAlert.features.stories.tsx index f4313392318..a1c4eec856b 100644 --- a/packages/react/src/live-region/AriaAlert.features.stories.tsx +++ b/packages/react/src/live-region/AriaAlert.features.stories.tsx @@ -3,7 +3,7 @@ import {AriaAlert} from './AriaAlert' import {VisuallyHidden} from '../VisuallyHidden' export default { - title: 'Experimental/Components/AriaAlert/Features', + title: 'Components/AriaAlert/Features', component: AriaAlert, } diff --git a/packages/react/src/live-region/AriaAlert.stories.tsx b/packages/react/src/live-region/AriaAlert.stories.tsx index c2432993e63..759a8811bd1 100644 --- a/packages/react/src/live-region/AriaAlert.stories.tsx +++ b/packages/react/src/live-region/AriaAlert.stories.tsx @@ -3,7 +3,7 @@ import {useEffect, useState} from 'react' import {AriaAlert} from './AriaAlert' export default { - title: 'Experimental/Components/AriaAlert', + title: 'Components/AriaAlert', component: AriaAlert, } diff --git a/packages/react/src/live-region/AriaStatus.docs.json b/packages/react/src/live-region/AriaStatus.docs.json new file mode 100644 index 00000000000..c4df5eeb85b --- /dev/null +++ b/packages/react/src/live-region/AriaStatus.docs.json @@ -0,0 +1,27 @@ +{ + "id": "aria-status", + "name": "AriaStatus", + "status": "alpha", + "a11yReviewed": false, + "importPath": "@primer/react", + "stories": [], + "props": [ + { + "name": "announceOnShow", + "type": "boolean", + "description": "Specify if the content of the element should be announced when this component is rendered and is not hidden", + "defaultValue": "false" + }, + { + "name": "hidden", + "type": "boolean", + "description": "Specify if the element is hidden", + "defaultValue": "false" + }, + { + "name": "delayMs", + "type": "number", + "description": "Provide a delay in milliseconds before the announcement is made" + } + ] +} diff --git a/packages/react/src/live-region/AriaStatus.features.stories.tsx b/packages/react/src/live-region/AriaStatus.features.stories.tsx index 1ecb7661716..673dd4a64c8 100644 --- a/packages/react/src/live-region/AriaStatus.features.stories.tsx +++ b/packages/react/src/live-region/AriaStatus.features.stories.tsx @@ -4,7 +4,7 @@ import {AriaStatus} from './AriaStatus' import {VisuallyHidden} from '../VisuallyHidden' export default { - title: 'Experimental/Components/AriaStatus/Features', + title: 'Components/AriaStatus/Features', component: AriaStatus, } diff --git a/packages/react/src/live-region/AriaStatus.stories.tsx b/packages/react/src/live-region/AriaStatus.stories.tsx index 26d376bcc25..23d4145f862 100644 --- a/packages/react/src/live-region/AriaStatus.stories.tsx +++ b/packages/react/src/live-region/AriaStatus.stories.tsx @@ -3,7 +3,7 @@ import {useEffect, useState} from 'react' import {AriaStatus} from './AriaStatus' export default { - title: 'Experimental/Components/AriaStatus', + title: 'Components/AriaStatus', component: AriaStatus, }