Skip to content

PageHeader: A11y eng review remediations #2900

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
broccolinisoup merged 9 commits into from
Feb 16, 2023
Merged

PageHeader: A11y eng review remediations #2900

Changes from 1 commit
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
3b315c1
a11y remediations
broccolinisoup Feb 13, 2023
e74575e
Add changeset
broccolinisoup Feb 13, 2023
3438a4d
Add tests for a11y remediations
broccolinisoup Feb 13, 2023
70e5fae
add docs for a11y remediations
broccolinisoup Feb 13, 2023
ec5afc0
Update generated/components.json
broccolinisoup Feb 13, 2023
bdba740
wrap console.log with __DEV__ and add a todo
broccolinisoup Feb 15, 2023
fe4b4b6
Merge branch 'main' into a11y-page-header
broccolinisoup Feb 15, 2023
2f84bb8
fix merge issue
broccolinisoup Feb 16, 2023
2347578
update docs
broccolinisoup Feb 16, 2023
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
Prev Previous commit
Next Next commit
wrap console.log with __DEV__ and add a todo
  • Loading branch information
@broccolinisoup
broccolinisoup committed Feb 15, 2023
commit bdba7403dc6253e6c3b3d598b1aab2fe7f61cf9a
13 changes: 8 additions & 5 deletions src/PageHeader/PageHeader.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -440,11 +440,14 @@ const Navigation: React.FC<React.PropsWithChildren<NavigationProps>> = ({
'aria-label': ariaLabel,
'aria-labelledby': ariaLabelledBy,
}) => {
if (as === 'nav' && !ariaLabel && !ariaLabelledBy) {
// eslint-disable-next-line no-console
console.warn(
'Use `aria-label` or `aria-labelledby` prop to provide an accessible label to the `nav` landmark for assistive technology',
)
// TODO: use warning utility function when it is merged https://github.com/primer/react/pull/2901/
if (__DEV__) {
if (as === 'nav' && !ariaLabel && !ariaLabelledBy) {
// eslint-disable-next-line no-console
console.warn(
'Use `aria-label` or `aria-labelledby` prop to provide an accessible label to the `nav` landmark for assistive technology',
)
}
}
return (
<Box
Expand Down