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

fix(toast): toast is now correctly excluded from focus trapping #24816

Merged
merged 3 commits into from
Feb 22, 2022

Conversation

liamdebeasi
Copy link
Contributor

@liamdebeasi liamdebeasi commented Feb 18, 2022

Pull request checklist

Please check if your PR fulfills the following requirements:

  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been reviewed and added / updated if needed (for bug fixes / features)
  • Build (npm run build) was run locally and any changes were pushed
  • Lint (npm run lint) has passed locally and any fixes were made for failures

Pull request type

Please check the type of change your PR introduces:

  • Bugfix
  • Feature
  • Code style update (formatting, renaming)
  • Refactoring (no functional changes, no api changes)
  • Build related changes
  • Documentation content changes
  • Other (please describe):

What is the current behavior?

Issue URL: resolves #24733

There are a few issues here:

  1. Opening an overlay adds a global focus event listener that activates focus trapping. However, we had special logic to prevent toast from adding that global listener. The problem is that this listener is added once globally, so if you open a focus trapping overlay before you open toast, you can defeat this special logic.

  2. The focus trapping utility doesn't actually exclude ion-toast like it says it should.

  3. The ion-menu check in overlays.ts was redundant because focus trapping there only ever runs on overlay components.

What is the new behavior?

  • Removed the OverlayListenerOptions options as it was easily defeated given the scenario above.
  • Updated focus trapping to run on the top-most, presented non-toast overlay (previously it included toast)
  • Removed the ion-menu specific check. There are tests in menu/test/focus-trap that verify that menu focus trapping with overlays still works.

Does this introduce a breaking change?

  • Yes
  • No

Other information

@liamdebeasi liamdebeasi requested a review from a team as a code owner February 18, 2022 16:28
@github-actions github-actions bot added the package: core @ionic/core package label Feb 18, 2022
@sean-perkins sean-perkins requested a review from a team February 18, 2022 17:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
package: core @ionic/core package
Projects
None yet
Development

Successfully merging this pull request may close these issues.

bug: focus trapping activates on toast if non-toast presented first
3 participants