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.

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

[ZOOT-1101][BpkDialogInner]: Adds optional aria-modal to the dialog #3400

Closed
wants to merge 12 commits into from

Conversation

michmaml
Copy link
Contributor

@michmaml michmaml commented Apr 30, 2024

Background:

It was discovered that it is possible to escape the modal with the screen reader. This can cause confusion if the content under the modal is unclear, and leaving the dialog may not be obvious, which can make travelers trapped behind an undismissable modal.

Action

In order to address the issue, it was decided to set an extra property to the modal that would prevent travelers from escaping the modal. To avoid breaking any other pages that use the modal, the property will be set as optional.

Changes

Fairly simple:

  1. Added aria-modal={ariaModal} to the modal, which has the ariaModal value set to false by default.
  2. Set the type of the variable as a boolean to prevent teams from setting the value to incorrect values.
Screen.Recording.2024-04-30.at.15.55.09.mov

  • Ensure the PR title includes the name of the component you are changing so it's clear in the release notes for consumers of the changes in the version e.g [KOA-123][BpkButton] Updating the colour
  • README.md (If you have created a new component)
  • Component README.md
  • Tests
  • Storybook examples created/updated
  • Type declaration (.d.ts) files updated
  • For breaking changes or deprecating components/properties, migration guides added to the description of the PR. If the guide has large changes, consider creating a new Markdown page inside the component's docs folder and link it here

@michmaml michmaml added the patch Patch production bug label Apr 30, 2024
@Skyscanner Skyscanner deleted a comment from github-actions bot Apr 30, 2024
@Skyscanner Skyscanner deleted a comment from github-actions bot Apr 30, 2024
@Skyscanner Skyscanner deleted a comment from github-actions bot Apr 30, 2024
@michmaml michmaml marked this pull request as ready for review April 30, 2024 15:14
@Skyscanner Skyscanner deleted a comment from github-actions bot Apr 30, 2024
@Skyscanner Skyscanner deleted a comment from github-actions bot Apr 30, 2024
@Skyscanner Skyscanner deleted a comment from github-actions bot Apr 30, 2024
Copy link

github-actions bot commented Apr 30, 2024

Warnings
⚠️

Package source files (e.g. packages/package-name/src/Component.js) were updated, but snapshots weren't. Have you checked that the tests still pass?

⚠️

Package source files (e.g. packages/package-name/src/Component.tsx) were updated, but type files weren't. Have you checked that no types have changed?

Browser support

If this is a visual change, make sure you've tested it in multiple browsers.

Generated by 🚫 dangerJS against 1c35ad1

Copy link

Visit https://backpack.github.io/storybook-prs/3400 to see this build running in a browser.

Copy link

Visit https://backpack.github.io/storybook-prs/3400 to see this build running in a browser.

Copy link

Visit https://backpack.github.io/storybook-prs/3400 to see this build running in a browser.

Copy link

Visit https://backpack.github.io/storybook-prs/3400 to see this build running in a browser.

Copy link

Visit https://backpack.github.io/storybook-prs/3400 to see this build running in a browser.

@michmaml michmaml closed this May 1, 2024
@michmaml michmaml deleted the zoot-1102 branch May 1, 2024 08:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
patch Patch production bug
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant