-
Notifications
You must be signed in to change notification settings - Fork 118
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(a11y): add label for screen readers (#1121)
Fixes #1096 BREAKING CHANGE: `description` prop in `<Settings/>` is renamed to `ariaDescription` Co-authored-by: Marco Vettorello <vettorello.marco@gmail.com>
- Loading branch information
Showing
13 changed files
with
371 additions
and
123 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
161 changes: 161 additions & 0 deletions
161
src/chart_types/xy_chart/state/chart_state.accessibility.test.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,161 @@ | ||
| /* | ||
| * Licensed to Elasticsearch B.V. under one or more contributor | ||
| * license agreements. See the NOTICE file distributed with | ||
| * this work for additional information regarding copyright | ||
| * ownership. Elasticsearch B.V. licenses this file to you under | ||
| * the Apache License, Version 2.0 (the "License"); you may | ||
| * not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, | ||
| * software distributed under the License is distributed on an | ||
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| * KIND, either express or implied. See the License for the | ||
| * specific language governing permissions and limitations | ||
| * under the License. | ||
| */ | ||
|
|
||
| import { Store } from 'redux'; | ||
|
|
||
| import { MockGlobalSpec, MockSeriesSpec } from '../../../mocks/specs'; | ||
| import { MockStore } from '../../../mocks/store/store'; | ||
| import { GlobalChartState } from '../../../state/chart_state'; | ||
| import { DEFAULT_A11_SETTINGS } from '../../../state/selectors/get_accessibility_config'; | ||
| import { getSettingsSpecSelector } from '../../../state/selectors/get_settings_specs'; | ||
|
|
||
| describe('test accessibility prop defaults', () => { | ||
| let store: Store<GlobalChartState>; | ||
| beforeEach(() => { | ||
| store = MockStore.default(); | ||
| MockStore.addSpecs( | ||
| [ | ||
| MockSeriesSpec.bar({ | ||
| data: [ | ||
| { x: 1, y: 10 }, | ||
| { x: 2, y: 5 }, | ||
| ], | ||
| }), | ||
| MockGlobalSpec.settings(), | ||
| ], | ||
| store, | ||
| ); | ||
| }); | ||
| it('should test defaults', () => { | ||
| const state = store.getState(); | ||
| const { | ||
| ariaDescription, | ||
| ariaUseDefaultSummary, | ||
| ariaLabelHeadingLevel, | ||
| ariaLabel, | ||
| ariaLabelledBy, | ||
| } = getSettingsSpecSelector(state); | ||
| expect(ariaDescription).toBeUndefined(); | ||
| expect(ariaUseDefaultSummary).toBeTrue(); | ||
| expect(ariaLabelHeadingLevel).toBe(DEFAULT_A11_SETTINGS.labelHeadingLevel); | ||
| expect(ariaLabel).toBeUndefined(); | ||
| expect(ariaLabelledBy).toBeUndefined(); | ||
| }); | ||
| }); | ||
| describe('custom description for screen readers', () => { | ||
| let store: Store<GlobalChartState>; | ||
| beforeEach(() => { | ||
| store = MockStore.default(); | ||
| MockStore.addSpecs( | ||
| [ | ||
| MockSeriesSpec.bar({ | ||
| data: [ | ||
| { x: 1, y: 10 }, | ||
| { x: 2, y: 5 }, | ||
| ], | ||
| }), | ||
| MockGlobalSpec.settings(), | ||
| ], | ||
| store, | ||
| ); | ||
| }); | ||
| it('should allow user to set a custom description for chart', () => { | ||
| MockStore.addSpecs( | ||
| [ | ||
| MockGlobalSpec.settings({ | ||
| ariaDescription: 'This is sample Kibana data', | ||
| }), | ||
| ], | ||
| store, | ||
| ); | ||
| const state = store.getState(); | ||
| const { ariaDescription } = getSettingsSpecSelector(state); | ||
| expect(ariaDescription).toBe('This is sample Kibana data'); | ||
| }); | ||
| it('should be able to disable generated descriptions', () => { | ||
| MockStore.addSpecs( | ||
| [ | ||
| MockGlobalSpec.settings({ | ||
| ariaUseDefaultSummary: false, | ||
| }), | ||
| ], | ||
| store, | ||
| ); | ||
| const state = store.getState(); | ||
| const { ariaUseDefaultSummary } = getSettingsSpecSelector(state); | ||
| expect(ariaUseDefaultSummary).toBe(false); | ||
| }); | ||
| }); | ||
| describe('custom labels for screen readers', () => { | ||
| let store: Store<GlobalChartState>; | ||
| beforeEach(() => { | ||
| store = MockStore.default(); | ||
| MockStore.addSpecs( | ||
| [ | ||
| MockSeriesSpec.bar({ | ||
| data: [ | ||
| { x: 1, y: 10 }, | ||
| { x: 2, y: 5 }, | ||
| ], | ||
| }), | ||
| MockGlobalSpec.settings(), | ||
| ], | ||
| store, | ||
| ); | ||
| }); | ||
| it('should allow label set by the user', () => { | ||
| MockStore.addSpecs( | ||
| [ | ||
| MockGlobalSpec.settings({ | ||
| ariaLabel: 'Label set by user', | ||
| }), | ||
| ], | ||
| store, | ||
| ); | ||
| const state = store.getState(); | ||
| const { ariaLabel } = getSettingsSpecSelector(state); | ||
| expect(ariaLabel).toBe('Label set by user'); | ||
| }); | ||
| it('should allow labelledBy set by the user', () => { | ||
| MockStore.addSpecs( | ||
| [ | ||
| MockGlobalSpec.settings({ | ||
| ariaLabelledBy: 'label-id', | ||
| }), | ||
| ], | ||
| store, | ||
| ); | ||
| const state = store.getState(); | ||
| const { ariaLabelledBy } = getSettingsSpecSelector(state); | ||
| expect(ariaLabelledBy).toBe('label-id'); | ||
| }); | ||
| it('should allow users to specify valid heading levels', () => { | ||
| MockStore.addSpecs( | ||
| [ | ||
| MockGlobalSpec.settings({ | ||
| ariaLabelHeadingLevel: 'h5', | ||
| }), | ||
| ], | ||
| store, | ||
| ); | ||
| const state = store.getState(); | ||
| const { ariaLabelHeadingLevel } = getSettingsSpecSelector(state); | ||
| expect(ariaLabelHeadingLevel).toBe('h5'); | ||
| }); | ||
| }); |
Oops, something went wrong.