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

Jump to bottom

Add tabIndex prop to React Icon component #849

Merged
merged 8 commits into from
Oct 7, 2022
Merged

Add tabIndex prop to React Icon component #849

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
9aae31a
add focusable prop to svg
broccolinisoup Oct 4, 2022
8e0204a
add changeset and write tests
broccolinisoup Oct 4, 2022
7089450
update snapshots and tests and add docs
broccolinisoup Oct 6, 2022
230deec
tabIndex prop introduced
broccolinisoup Oct 7, 2022
9c0871e
update tree shaking snapshot
broccolinisoup Oct 7, 2022
4449ebf
changeset update & remove type
broccolinisoup Oct 7, 2022
34964e6
Merge branch 'main' into broccolinisoup/icon-svg-focusable
broccolinisoup Oct 7, 2022
2898981
Minor copy edits
colebemis Oct 7, 2022
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/sixty-nails-juggle.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@primer/octicons': minor
---

Add focusable prop to react icons
17 changes: 17 additions & 0 deletions lib/octicons_react/src/__tests__/octicon.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,23 @@ describe('An icon component', () => {
expect(container.querySelector('svg')).toHaveAttribute('aria-label', 'icon')
})

it('respects the focusable prop', () => {
const {container} = render(<AlertIcon focusable="true" />)
expect(container.querySelector('svg')).toHaveAttribute('focusable', true)
})

it('sets focusable false if ariaLabel prop is not present', () => {
const {container} = render(<AlertIcon />)
expect(container.querySelector('svg')).toHaveAttribute('aria-hidden', 'true')
expect(container.querySelector('svg')).toHaveAttribute('focusable', 'false')
})

it('sets focusable prop to given value if ariaLabel prop is present', () => {
const {container} = render(<AlertIcon aria-label="icon" focusable="auto" />)
expect(container.querySelector('svg')).toHaveAttribute('aria-hidden', 'false')
expect(container.querySelector('svg')).toHaveAttribute('focusable', 'auto')
})

it('respects the className prop', () => {
const {container} = render(<AlertIcon className="foo" />)
expect(container.querySelector('svg')).toHaveAttribute('class', 'foo')
Expand Down
3 changes: 2 additions & 1 deletion lib/octicons_react/src/createIconComponent.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ export function createIconComponent(name, defaultClassName, getSVGData) {
const svgDataByHeight = getSVGData()
const heights = Object.keys(svgDataByHeight)

function Icon({'aria-label': ariaLabel, className, fill = 'currentColor', size, verticalAlign}) {
function Icon({'aria-label': ariaLabel, focusable = false, className, fill = 'currentColor', size, verticalAlign}) {
const height = sizeMap[size] || size
const naturalHeight = closestNaturalHeight(heights, height)
const naturalWidth = svgDataByHeight[naturalHeight].width
Expand All @@ -20,6 +20,7 @@ export function createIconComponent(name, defaultClassName, getSVGData) {
return (
<svg
aria-hidden={ariaLabel ? 'false' : 'true'}
focusable={ariaLabel ? focusable : false}
broccolinisoup marked this conversation as resolved.
Show resolved Hide resolved
aria-label={ariaLabel}
role="img"
className={className}
Expand Down
1 change: 1 addition & 0 deletions lib/octicons_react/src/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ type Size = 'small' | 'medium' | 'large'

export interface OcticonProps {
'aria-label'?: string
focusable?: boolean | 'auto'
joshblack marked this conversation as resolved.
Show resolved Hide resolved
children?: React.ReactElement<any>
className?: string
fill?: string
Expand Down