Skip to content

fix(ui5-dialog): announce content for VoiceOver when used as message box #13596

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.

Sign up for GitHub

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

Closed
kskondov wants to merge 1 commit into from
Closed

fix(ui5-dialog): announce content for VoiceOver when used as message box #13596

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions packages/main/src/Dialog.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -198,6 +198,10 @@ class Dialog extends Popup {
_cachedMinHeight?: number;
_draggedOrResized = false;
_dragHandlerRegistered = false;
_liveTextTimeout?: ReturnType<typeof setTimeout>;

@property({ noAttribute: true })
_liveText = "";

/**
* Defines the header HTML Element.
Expand Down Expand Up @@ -327,9 +331,33 @@ class Dialog extends Popup {
return toLowercaseEnumValue(this.accessibleRole);
}

get _contentDescriptionText(): string {
return this.content
.map(el => {
return (el instanceof HTMLElement) ? el.textContent?.trim() : "";
})
.filter(Boolean)
.join(" ");
}

_show() {
super._show();
this._center();

// VoiceOver on macOS does not announce text from the dialog content,
// so aria-live region is used to announce text-only content when the dialog opens.
const text = this._contentDescriptionText;
if (text) {
this._liveTextTimeout = setTimeout(() => {
this._liveText = text;
}, 100);
}
}

closePopup(escPressed = false, preventRegistryUpdate = false, preventFocusRestore = false): void {
clearTimeout(this._liveTextTimeout);
this._liveText = "";
super.closePopup(escPressed, preventRegistryUpdate, preventFocusRestore);
}

onBeforeRendering() {
Expand Down
1 change: 1 addition & 0 deletions packages/main/src/DialogTemplate.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,7 @@ function beforeContent(this: Dialog) {

function afterContent(this: Dialog) {
return (<>
<span class="ui5-hidden-text" aria-live="assertive">{this._liveText}</span>
{!!this.footer.length &&
<footer class="ui5-popup-footer-root" part="footer">
<slot name="footer"></slot>
Expand Down
24 changes: 24 additions & 0 deletions packages/main/test/pages/Dialog.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,9 @@
<ui5-button id="message">Open Message Dialog</ui5-button>
<br>
<br>
<ui5-button id="messageBoxOpener">Open Message Dialog Focused Button </ui5-button>
<br>
<br>
<ui5-button id="prevent">Open Prevent closing Dialog</ui5-button>
<br>
<br>
Expand Down Expand Up @@ -113,6 +116,23 @@
</div>
</ui5-dialog>

<ui5-dialog id="messageBox" accessible-name-ref="messageBoxTitle messageBoxText" accessible-role="AlertDialog"
header-text="Confirmation" data-type="Confirm" class="messageBox">
<div slot="header" class="messageBoxHeader">
<ui5-icon class="messageBoxConfirmIcon" name="sys-help-2"></ui5-icon>
<span class="messageBoxSpacer"></span>
<ui5-title id="messageBoxTitle" wrapping-type="Normal" level="H1" size="H5">Confirmation</ui5-title>
</div>
<ui5-text id="messageBoxText">You can close the MessageBox by pressing "Escape" or selecting one of the footer
buttons.</ui5-text>
<div slot="footer" class="messageBoxFooter">
<ui5-button class="messageBoxCloser" data-action="OK" design="Emphasized">OK</ui5-button>
<ui5-button class="messageBoxCloser" data-action="Custom Action" design="Transparent">Custom Action</ui5-button>
<ui5-button class="messageBoxCloser" data-action="Cancel" design="Transparent">Cancel</ui5-button>
<ui5-button class="messageBoxCloser" data-action="3: custom action" design="Default">Custom Button</ui5-button>
</div>
</ui5-dialog>

<ui5-dialog id="msg-dialog" header-text="Message dialog" class="dialog1auto">
<p>Build enterprise-ready web applications, responsive to all devices and running on the browser of your choice.
That´s OpenUI5.</p>
Expand Down Expand Up @@ -950,6 +970,10 @@
window["msg-dialog"].open = true;
});

messageBoxOpener.addEventListener("click", function () {
window["messageBox"].open = true;
});

window["prevent-dialog"].addEventListener("ui5-before-close", function (event) {
if (preventClosing) {
event.preventDefault();
Expand Down
Loading