-
Notifications
You must be signed in to change notification settings - Fork 753
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Added screen reader alerts for various actions throughout the app.
- Loading branch information
1 parent
e8b9ede
commit b95ebc5
Showing
19 changed files
with
273 additions
and
16 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
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,60 @@ | ||
| // | ||
| // Copyright (c) Microsoft. All rights reserved. | ||
| // Licensed under the MIT license. | ||
| // | ||
| // Microsoft Bot Framework: http://botframework.com | ||
| // | ||
| // Bot Framework Emulator Github: | ||
| // https://github.com/Microsoft/BotFramwork-Emulator | ||
| // | ||
| // Copyright (c) Microsoft Corporation | ||
| // All rights reserved. | ||
| // | ||
| // MIT License: | ||
| // Permission is hereby granted, free of charge, to any person obtaining | ||
| // a copy of this software and associated documentation files (the | ||
| // "Software"), to deal in the Software without restriction, including | ||
| // without limitation the rights to use, copy, modify, merge, publish, | ||
| // distribute, sublicense, and/or sell copies of the Software, and to | ||
| // permit persons to whom the Software is furnished to do so, subject to | ||
| // the following conditions: | ||
| // | ||
| // The above copyright notice and this permission notice shall be | ||
| // included in all copies or substantial portions of the Software. | ||
| // | ||
| // THE SOFTWARE IS PROVIDED ""AS IS"", WITHOUT WARRANTY OF ANY KIND, | ||
| // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF | ||
| // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND | ||
| // NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE | ||
| // LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION | ||
| // OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION | ||
| // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. | ||
| // | ||
|
|
||
| import { ariaAlertService } from './ariaAlertService'; | ||
|
|
||
| describe('AriaAlertService', () => { | ||
| it('should create an aria alert and only one at a time', () => { | ||
| ariaAlertService.alert('I am an alert!'); | ||
| const alertElement = document.querySelector('span#alert-from-service') as HTMLSpanElement; | ||
|
|
||
| expect(alertElement).toBeTruthy(); | ||
| expect(alertElement.innerText).toBe('I am an alert!'); | ||
|
|
||
| ariaAlertService.alert('I am another alert!'); | ||
|
|
||
| const alertElements = document.querySelectorAll('span#alert-from-service'); | ||
|
|
||
| expect(alertElements.length).toBe(1); | ||
| }); | ||
|
|
||
| it('should not create an aria alert if there is no message', () => { | ||
| // make sure there are no leftover alerts from previous test(s) | ||
| const preExistingAlerts = document.querySelectorAll('span#alert-from-service'); | ||
| preExistingAlerts.forEach(alert => alert.remove()); | ||
| ariaAlertService.alert(undefined); | ||
| const alertElement = document.querySelector('span#alert-from-service') as HTMLSpanElement; | ||
|
|
||
| expect(alertElement).toBeFalsy(); | ||
| }); | ||
| }); |
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,57 @@ | ||
| // | ||
| // Copyright (c) Microsoft. All rights reserved. | ||
| // Licensed under the MIT license. | ||
| // | ||
| // Microsoft Bot Framework: http://botframework.com | ||
| // | ||
| // Bot Framework Emulator Github: | ||
| // https://github.com/Microsoft/BotFramwork-Emulator | ||
| // | ||
| // Copyright (c) Microsoft Corporation | ||
| // All rights reserved. | ||
| // | ||
| // MIT License: | ||
| // Permission is hereby granted, free of charge, to any person obtaining | ||
| // a copy of this software and associated documentation files (the | ||
| // "Software"), to deal in the Software without restriction, including | ||
| // without limitation the rights to use, copy, modify, merge, publish, | ||
| // distribute, sublicense, and/or sell copies of the Software, and to | ||
| // permit persons to whom the Software is furnished to do so, subject to | ||
| // the following conditions: | ||
| // | ||
| // The above copyright notice and this permission notice shall be | ||
| // included in all copies or substantial portions of the Software. | ||
| // | ||
| // THE SOFTWARE IS PROVIDED ""AS IS"", WITHOUT WARRANTY OF ANY KIND, | ||
| // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF | ||
| // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND | ||
| // NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE | ||
| // LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION | ||
| // OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION | ||
| // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. | ||
| // | ||
|
|
||
| let singleton: AriaAlertService; | ||
| class AriaAlertService { | ||
| constructor() { | ||
| singleton = this; | ||
| } | ||
|
|
||
| /** Creates an alert and inserts it into the DOM */ | ||
| public alert(msg: string): void { | ||
| if (!msg) { | ||
| return; | ||
| } | ||
| const prevAlert = document.querySelector('span#alert-from-service'); | ||
| prevAlert && prevAlert.remove(); | ||
| const alert = document.createElement('span'); | ||
| alert.innerText = msg; | ||
| alert.setAttribute('id', 'alert-from-service'); | ||
| alert.setAttribute('role', 'alert'); | ||
| alert.setAttribute('style', 'position: absolute; top: -9999px;'); | ||
| document.body.appendChild(alert); | ||
| } | ||
| } | ||
|
|
||
| /** Creates invisible alerts to be read by screen reader technologies */ | ||
| export const ariaAlertService = singleton || new AriaAlertService(); |
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,34 @@ | ||
| // | ||
| // Copyright (c) Microsoft. All rights reserved. | ||
| // Licensed under the MIT license. | ||
| // | ||
| // Microsoft Bot Framework: http://botframework.com | ||
| // | ||
| // Bot Framework Emulator Github: | ||
| // https://github.com/Microsoft/BotFramwork-Emulator | ||
| // | ||
| // Copyright (c) Microsoft Corporation | ||
| // All rights reserved. | ||
| // | ||
| // MIT License: | ||
| // Permission is hereby granted, free of charge, to any person obtaining | ||
| // a copy of this software and associated documentation files (the | ||
| // "Software"), to deal in the Software without restriction, including | ||
| // without limitation the rights to use, copy, modify, merge, publish, | ||
| // distribute, sublicense, and/or sell copies of the Software, and to | ||
| // permit persons to whom the Software is furnished to do so, subject to | ||
| // the following conditions: | ||
| // | ||
| // The above copyright notice and this permission notice shall be | ||
| // included in all copies or substantial portions of the Software. | ||
| // | ||
| // THE SOFTWARE IS PROVIDED ""AS IS"", WITHOUT WARRANTY OF ANY KIND, | ||
| // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF | ||
| // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND | ||
| // NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE | ||
| // LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION | ||
| // OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION | ||
| // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. | ||
| // | ||
|
|
||
| export * from './ariaAlertService'; |
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 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 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 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 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 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
Oops, something went wrong.