Skip to content

Commit f6188c4

Browse files
authored
fix(overlays): announce info after opening based on platform (#30025)
Issue number: internal --------- <!-- Please do not submit updates to dependencies unless it fixes an issue. --> <!-- Please try to limit your pull request to one type (bugfix, feature, etc). Submit multiple pull requests if needed. --> ## What is the current behavior? <!-- Please describe the current behavior that you are modifying. --> PR #29951 would hide the overlays from screen readers while animating. This allows the element to navigate to its correct destination for screen readers to interact with. Otherwise, the focus rings would never appear. However, this ended up breaking the interaction for iOS. ## What is the new behavior? <!-- Please describe the behavior or changes that are being added by this PR. --> - Overlays are hidden from screen readers while animating only if the platform is `android`. Since the original issue only applied to Android devices. ## Does this introduce a breaking change? - [ ] Yes - [x] No <!-- If this introduces a breaking change: 1. Describe the impact and migration path for existing applications below. 2. Update the BREAKING.md file with the breaking change. 3. Add "BREAKING CHANGE: [...]" to the commit description when merging. See https://github.com/ionic-team/ionic-framework/blob/main/docs/CONTRIBUTING.md#footer for more information. --> ## Other information <!-- Any other information that is important to this PR such as screenshots of how the component looks before and after the change. --> Dev build: `8.4.1-dev.11732033492.170e160c` Test on iOS and Android devices.
1 parent 8ee42bb commit f6188c4

File tree

1 file changed

+15
-6
lines changed

1 file changed

+15
-6
lines changed

core/src/utils/overlays.ts

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@ import {
3232
removeEventListener,
3333
} from './helpers';
3434
import { printIonWarning } from './logging';
35+
import { isPlatform } from './platform';
3536

3637
let lastOverlayIndex = 0;
3738
let lastId = 0;
@@ -973,18 +974,26 @@ export const createTriggerController = () => {
973974
* If the overlay is being presented, it prevents focus rings from appearing
974975
* in incorrect positions due to the transition (specifically `transform`
975976
* styles), ensuring that when aria-hidden is removed, the focus rings are
976-
* correctly displayed in the final location of the elements.
977+
* correctly displayed in the final location of the elements. This only
978+
* applies to Android devices.
979+
*
980+
* If this solution is applied to iOS devices, then it leads to a bug where
981+
* the overlays cannot be accessed by screen readers. This is due to
982+
* VoiceOver not being able to update the accessibility tree when the
983+
* `aria-hidden` is removed.
977984
*
978985
* @param overlay - The overlay that is being animated.
979986
*/
980987
const hideAnimatingOverlayFromScreenReaders = (overlay: HTMLIonOverlayElement) => {
981988
if (doc === undefined) return;
982989

983-
/**
984-
* Once the animation is complete, this attribute will be removed.
985-
* This is done at the end of the `present` method.
986-
*/
987-
overlay.setAttribute('aria-hidden', 'true');
990+
if (isPlatform('android')) {
991+
/**
992+
* Once the animation is complete, this attribute will be removed.
993+
* This is done at the end of the `present` method.
994+
*/
995+
overlay.setAttribute('aria-hidden', 'true');
996+
}
988997
};
989998

990999
/**

0 commit comments

Comments
 (0)