Skip to content
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.

Sign up for GitHub

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

Docs(ActionList): use internal AriaStatus to announce updates in example story #5096

Merged
merged 5 commits into from
Oct 10, 2024
+18 −8
Merged

Docs(ActionList): use internal AriaStatus to announce updates in example story #5096

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
0d7b2f1
Docs(ActionList): use internal LiveRegion to announce updates
francinelucca Oct 9, 2024
e6072aa
Docs(ActionList): use AriaStatus to announce status instead of LiveRe…
francinelucca Oct 9, 2024
1eb3164
Update packages/react/src/ActionList/ActionList.examples.stories.tsx
francinelucca Oct 10, 2024
ca7ce1b
Merge branch 'main' into 3474-prcactionlist-async-loading-status-not-…
francinelucca Oct 10, 2024
ec9074c
docs(ActionList): format
francinelucca Oct 10, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
58 changes: 33 additions & 25 deletions packages/react/src/ActionList/ActionList.examples.stories.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,8 @@ import TextInput from '../TextInput'
import Spinner from '../Spinner'
import Box from '../Box'
import Text from '../Text'
import VisuallyHidden from '../_VisuallyHidden'
import FormControl from '../FormControl'
import {LiveRegion, LiveRegionOutlet, Message} from '../internal/components/LiveRegion'
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In case it's helpful, we have a couple of newer helpers that you can use here, specifically AriaStatus and AriaAlert, depending on what you need 👀

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated to AriaStatus, thanks!!


const meta: Meta = {
title: 'Components/ActionList/Examples',
Expand Down Expand Up @@ -177,15 +177,24 @@ export function AsyncListWithSpinner(): JSX.Element {
const [results, setResults] = React.useState(branches.slice(0, 6))
const [loading, setLoading] = React.useState(false)
const [selected, setSelected] = React.useState('main')
const [filterVal, setFilterVal] = React.useState('')

// eslint-disable-next-line @typescript-eslint/no-explicit-any
const filter = async (event: any) => {
setLoading(true)
const filteredResults = await filterSlowly(event.target.value)
setResults(filteredResults.slice(0, 6))
setFilterVal(event.target.value)
setLoading(false)
}

const getStatusMessage = () => {
if (loading) return 'Loading results'
if (!filterVal) return 'Showing top 6 branches'
if (results.length === 0) return 'No branches match that query'
return `Branches filtered, showing ${results.length} branches`
}

return (
<>
<h1>Async List</h1>
Expand All @@ -194,31 +203,30 @@ export function AsyncListWithSpinner(): JSX.Element {
filter. This pattern can be found in branch selection menus via the SelectPanel component.
</p>

<FormControl sx={{m: 2, mb: 0, width: 'calc(100% - 16px)'}}>
<FormControl.Label>Search branches</FormControl.Label>
<TextInput onChange={filter} block />
</FormControl>
<div role="status">
{results.length === 0 ? (
<Text sx={{display: 'block', fontSize: 1, m: 2}}>No branches match that query</Text>
) : (
<VisuallyHidden>{results.length} branches match that query</VisuallyHidden>
)}
</div>
<LiveRegion>
<FormControl sx={{m: 2, mb: 0, width: 'calc(100% - 16px)'}}>
<FormControl.Label>Search branches</FormControl.Label>
<TextInput onChange={filter} block />
</FormControl>
{results.length === 0 && <Text sx={{display: 'block', fontSize: 1, m: 2}}>No branches match that query</Text>}

<ActionList selectionVariant="single" role="listbox" aria-label="Branch" sx={{height: 208, overflow: 'auto'}}>
{loading ? (
<Box sx={{display: 'flex', justifyContent: 'center', pt: 2}}>
<Spinner />
</Box>
) : (
results.map(name => (
<ActionList.Item key={name} role="option" selected={selected === name} onSelect={() => setSelected(name)}>
{name}
</ActionList.Item>
))
)}
</ActionList>
<LiveRegionOutlet />
<Message value={getStatusMessage()} />

<ActionList selectionVariant="single" role="listbox" aria-label="Branch" sx={{height: 208, overflow: 'auto'}}>
{loading ? (
<Box sx={{display: 'flex', justifyContent: 'center', pt: 2}}>
<Spinner />
</Box>
) : (
results.map(name => (
<ActionList.Item key={name} role="option" selected={selected === name} onSelect={() => setSelected(name)}>
{name}
</ActionList.Item>
))
)}
</ActionList>
</LiveRegion>
</>
)
}
Expand Down
Loading