Skip to content

ActionBar: Make aria-label mandatory #4501

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

Merged
pksjce merged 6 commits into from
Apr 18, 2024
Merged

ActionBar: Make aria-label mandatory #4501

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
aad8263
Make aria-label mandatory
pksjce Apr 15, 2024
f450e02
Add dev run time check for aria-label for additional guard
pksjce Apr 16, 2024
5de3224
Add aria-labelledby or aria-label to be present. Removed the runtime …
pksjce Apr 16, 2024
1b0dc57
Add proper aria-label in default story
pksjce Apr 17, 2024
e42acd2
Fix lint issues
pksjce Apr 18, 2024
c3ea83a
Create lucky-zebras-stare.md
pksjce Apr 18, 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
5 changes: 5 additions & 0 deletions .changeset/lucky-zebras-stare.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@primer/react": patch
---

ActionBar: Make it such that either aria-label or aria-labelledby is present
54 changes: 28 additions & 26 deletions packages/react/src/drafts/ActionBar/ActionBar.stories.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,43 +30,45 @@ export default {
} as Meta<typeof ActionBar>

export const Default = () => (
<ActionBar>
<ActionBar.IconButton icon={BoldIcon} aria-label="Default"></ActionBar.IconButton>
<ActionBar.IconButton icon={ItalicIcon} aria-label="Default"></ActionBar.IconButton>
<ActionBar.IconButton icon={CodeIcon} aria-label="Default"></ActionBar.IconButton>
<ActionBar.IconButton icon={LinkIcon} aria-label="Default"></ActionBar.IconButton>
<ActionBar aria-label="Toolbar">
<ActionBar.IconButton icon={BoldIcon} aria-label="Bold"></ActionBar.IconButton>
<ActionBar.IconButton icon={ItalicIcon} aria-label="Italic"></ActionBar.IconButton>
<ActionBar.IconButton icon={CodeIcon} aria-label="Code"></ActionBar.IconButton>
<ActionBar.IconButton icon={LinkIcon} aria-label="Link"></ActionBar.IconButton>
<ActionBar.Divider />
<ActionBar.IconButton icon={FileAddedIcon} aria-label="Default"></ActionBar.IconButton>
<ActionBar.IconButton icon={SearchIcon} aria-label="Default"></ActionBar.IconButton>
<ActionBar.IconButton icon={FileAddedIcon} aria-label="Default"></ActionBar.IconButton>
<ActionBar.IconButton icon={SearchIcon} aria-label="Default"></ActionBar.IconButton>
<ActionBar.IconButton icon={FileAddedIcon} aria-label="Default"></ActionBar.IconButton>
<ActionBar.IconButton icon={SearchIcon} aria-label="Default"></ActionBar.IconButton>
<ActionBar.IconButton icon={FileAddedIcon} aria-label="Default"></ActionBar.IconButton>
<ActionBar.IconButton icon={SearchIcon} aria-label="Default"></ActionBar.IconButton>
<ActionBar.IconButton icon={FileAddedIcon} aria-label="File Added"></ActionBar.IconButton>
<ActionBar.IconButton icon={SearchIcon} aria-label="Search"></ActionBar.IconButton>
<ActionBar.IconButton icon={QuoteIcon} aria-label="Insert Quote"></ActionBar.IconButton>
<ActionBar.IconButton icon={ListUnorderedIcon} aria-label="Unordered List"></ActionBar.IconButton>
<ActionBar.IconButton icon={ListOrderedIcon} aria-label="Ordered List"></ActionBar.IconButton>
<ActionBar.IconButton icon={TasklistIcon} aria-label="Task List"></ActionBar.IconButton>
</ActionBar>
)

export const SmallActionBar = () => (
<ActionBar size="small">
<ActionBar.IconButton icon={BoldIcon} aria-label="Default"></ActionBar.IconButton>
<ActionBar.IconButton icon={ItalicIcon} aria-label="Default"></ActionBar.IconButton>
<ActionBar.IconButton icon={CodeIcon} aria-label="Default"></ActionBar.IconButton>
<ActionBar.IconButton icon={LinkIcon} aria-label="Default"></ActionBar.IconButton>
<ActionBar size="small" aria-label="Toolbar">
<ActionBar.IconButton icon={BoldIcon} aria-label="Bold"></ActionBar.IconButton>
<ActionBar.IconButton icon={ItalicIcon} aria-label="Italic"></ActionBar.IconButton>
<ActionBar.IconButton icon={CodeIcon} aria-label="Code"></ActionBar.IconButton>
<ActionBar.IconButton icon={LinkIcon} aria-label="Link"></ActionBar.IconButton>
<ActionBar.Divider />
<ActionBar.IconButton icon={FileAddedIcon} aria-label="Default"></ActionBar.IconButton>
<ActionBar.IconButton icon={SearchIcon} aria-label="Default"></ActionBar.IconButton>
<ActionBar.IconButton icon={FileAddedIcon} aria-label="File Added"></ActionBar.IconButton>
<ActionBar.IconButton icon={SearchIcon} aria-label="Search"></ActionBar.IconButton>
</ActionBar>
)

export const CommentBox = () => {
type CommentBoxProps = {'aria-label': string}

export const CommentBox = (props: CommentBoxProps) => {
const {'aria-label': ariaLabel} = props
const [view, setView] = React.useState<MarkdownViewMode>('edit')
const loadPreview = React.useCallback(() => {
//console.log('loadPreview')
}, [])
const [value, setValue] = React.useState('')
const [isOpen, setIsOpen] = React.useState(false)
const buttonRef = React.useRef(null)
const toolBarLabel = `${ariaLabel} toolbar`
return (
<Box
sx={{
Expand Down Expand Up @@ -103,7 +105,7 @@ export const CommentBox = () => {
/>
</Box>
<Box sx={{width: '50%'}}>
<ActionBar>
<ActionBar aria-label={toolBarLabel}>
<ActionBar.IconButton icon={HeadingIcon} aria-label="Heading"></ActionBar.IconButton>
<ActionBar.IconButton icon={BoldIcon} aria-label="Bold"></ActionBar.IconButton>
<ActionBar.IconButton icon={ItalicIcon} aria-label="Italic"></ActionBar.IconButton>
Expand Down Expand Up @@ -152,7 +154,7 @@ export const ActionBarWithMenuTrigger = () => {

return (
<Box>
<ActionBar>
<ActionBar aria-label="Toolbar">
<ActionBar.IconButton icon={BoldIcon} aria-label="Bold"></ActionBar.IconButton>
<ActionBar.IconButton icon={ItalicIcon} aria-label="Italic"></ActionBar.IconButton>
<ActionBar.IconButton icon={CodeIcon} aria-label="Code"></ActionBar.IconButton>
Expand Down Expand Up @@ -242,7 +244,7 @@ export const ActionbarToggle = () => {
<Box sx={bottomSectionStyles}>
{showEditView ? (
<Box>
<CommentBox />
<CommentBox aria-label="Comment box" />
<Box sx={{display: 'flex', flexDirection: 'row', justifyContent: 'flex-end', p: 2, gap: 2}}>
<Button
variant="primary"
Expand Down Expand Up @@ -273,7 +275,7 @@ export const MultipleActionBars = () => {
<Box sx={{p: 3}}>
{showFirstCommentBox ? (
<Box>
<CommentBox key={1} />
<CommentBox aria-label="First Comment Box" />
<Box sx={{display: 'flex', flexDirection: 'row', justifyContent: 'flex-end', p: 2, gap: 2}}>
<Button
variant="primary"
Expand All @@ -295,7 +297,7 @@ export const MultipleActionBars = () => {
<Box sx={{p: 3}}>
{showSecondCommentBox ? (
<Box>
<CommentBox key={2} />
<CommentBox aria-label="Second Comment Box" />
<Box sx={{display: 'flex', flexDirection: 'row', justifyContent: 'flex-end', p: 2, gap: 2}}>
<Button
variant="primary"
Expand Down
2 changes: 1 addition & 1 deletion packages/react/src/drafts/ActionBar/ActionBar.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import ActionBar from './'
import {BoldIcon, CodeIcon, ItalicIcon, LinkIcon} from '@primer/octicons-react'

const SimpleActionBar = () => (
<ActionBar>
<ActionBar aria-label="Toolbar">
<ActionBar.IconButton icon={BoldIcon} aria-label="Default"></ActionBar.IconButton>
<ActionBar.IconButton icon={ItalicIcon} aria-label="Default"></ActionBar.IconButton>
<ActionBar.Divider />
Expand Down
7 changes: 5 additions & 2 deletions packages/react/src/drafts/ActionBar/ActionBar.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,11 +36,14 @@ small (28px), medium (32px), large (40px)
*/
type Size = 'small' | 'medium' | 'large'

type A11yProps =
| {'aria-label': React.AriaAttributes['aria-label']; 'aria-labelledby'?: undefined}
| {'aria-label'?: undefined; 'aria-labelledby': React.AriaAttributes['aria-labelledby']}

export type ActionBarProps = {
size?: Size
'aria-label'?: React.AriaAttributes['aria-label']
children: React.ReactNode
}
} & A11yProps

export type ActionBarIconButtonProps = IconButtonProps

Expand Down