Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
6 changes: 6 additions & 0 deletions packages/pie/src/Pie.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,9 @@ const InnerPie = <RawDatum extends MayHaveLabel>({
legends = defaultProps.legends,
forwardLegendData,
role = defaultProps.role,
ariaLabel,
ariaLabelledBy,
ariaDescribedBy,
forwardedRef,
}: PieSvgProps<RawDatum> & {
forwardedRef: Ref<SVGSVGElement>
Expand Down Expand Up @@ -212,6 +215,9 @@ const InnerPie = <RawDatum extends MayHaveLabel>({
margin={margin}
defs={boundDefs}
role={role}
ariaLabel={ariaLabel}
ariaLabelledBy={ariaLabelledBy}
ariaDescribedBy={ariaDescribedBy}
ref={forwardedRef}
>
{layers.map((layer, i) => {
Expand Down
6 changes: 6 additions & 0 deletions packages/pie/src/PieCanvas.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,9 @@ const InnerPieCanvas = <RawDatum extends MayHaveLabel>({
legends = defaultProps.legends,
forwardLegendData,
role,
ariaLabel,
ariaLabelledBy,
ariaDescribedBy,
forwardedRef,
}: PieCanvasProps<RawDatum> & {
forwardedRef: Ref<HTMLCanvasElement>
Expand Down Expand Up @@ -290,6 +293,9 @@ const InnerPieCanvas = <RawDatum extends MayHaveLabel>({
onMouseLeave={isInteractive ? handleMouseLeave : undefined}
onClick={isInteractive ? handleClick : undefined}
role={role}
aria-label={ariaLabel}
aria-labelledby={ariaLabelledBy}
aria-describedby={ariaDescribedBy}
/>
)
}
Expand Down
21 changes: 19 additions & 2 deletions packages/pie/src/types.ts
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import { AriaAttributes } from 'react'
import * as React from 'react'
import {
Box,
Expand Down Expand Up @@ -146,7 +147,11 @@ export type PieSvgProps<RawDatum> = DataProps<RawDatum> &
animate?: boolean
motionConfig?: MotionProps['motionConfig']
transitionMode?: ArcTransitionMode
} & PieSvgCustomComponents<RawDatum>
} & PieSvgCustomComponents<RawDatum> & {
ariaLabel?: AriaAttributes['aria-label']
ariaLabelledBy?: AriaAttributes['aria-labelledby']
ariaDescribedBy?: AriaAttributes['aria-describedby']
}

export type CompletePieSvgProps<RawDatum> = DataProps<RawDatum> &
Dimensions &
Expand All @@ -157,18 +162,30 @@ export type CompletePieSvgProps<RawDatum> = DataProps<RawDatum> &
animate: boolean
motionConfig: MotionProps['motionConfig']
transitionMode: ArcTransitionMode
} & PieSvgCustomComponents<RawDatum>
} & PieSvgCustomComponents<RawDatum> & {
ariaLabel?: AriaAttributes['aria-label']
ariaLabelledBy?: AriaAttributes['aria-labelledby']
ariaDescribedBy?: AriaAttributes['aria-describedby']
}

export type PieCanvasProps<RawDatum> = DataProps<RawDatum> &
Dimensions &
Partial<CommonPieProps<RawDatum>> &
Pick<PieHandlers<RawDatum, HTMLCanvasElement>, 'onClick' | 'onMouseMove'> & {
pixelRatio?: number
} & {
ariaLabel?: AriaAttributes['aria-label']
ariaLabelledBy?: AriaAttributes['aria-labelledby']
ariaDescribedBy?: AriaAttributes['aria-describedby']
}

export type CompletePieCanvasProps<RawDatum> = DataProps<RawDatum> &
Dimensions &
CommonPieProps<RawDatum> &
Pick<PieHandlers<RawDatum, HTMLCanvasElement>, 'onClick' | 'onMouseMove'> & {
pixelRatio: number
} & {
ariaLabel?: AriaAttributes['aria-label']
ariaLabelledBy?: AriaAttributes['aria-labelledby']
ariaDescribedBy?: AriaAttributes['aria-describedby']
}
29 changes: 29 additions & 0 deletions packages/pie/tests/Pie.test.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -778,6 +778,35 @@ describe('Pie', () => {
})
})

describe('accessibility', () => {
it('should forward aria properties to the SVG element', () => {
const instance = create(
<Pie
width={400}
height={400}
data={sampleData}
ariaLabel="AriaLabel"
ariaLabelledBy="AriaLabelledBy"
ariaDescribedBy="AriaDescribedBy"
/>
).root

const svg = instance.findByType('svg')
expect(svg.props['aria-label']).toBe('AriaLabel')
expect(svg.props['aria-labelledby']).toBe('AriaLabelledBy')
expect(svg.props['aria-describedby']).toBe('AriaDescribedBy')
})

it('should not set aria properties if not provided', () => {
const instance = create(<Pie width={400} height={400} data={sampleData} />).root

const svg = instance.findByType('svg')
expect(svg.props['aria-label']).toBeUndefined()
expect(svg.props['aria-labelledby']).toBeUndefined()
expect(svg.props['aria-describedby']).toBeUndefined()
})
})

describe('layers', () => {
it('should support disabling a layer', () => {
const instance = create(
Expand Down