Skip to content

Commit a79051a

Browse files
authored
feat(MessageBox): add accessibleName default text (#2208)
1 parent 98c4162 commit a79051a

File tree

3 files changed

+16
-2
lines changed

3 files changed

+16
-2
lines changed

packages/main/src/components/MessageBox/MessageBox.test.tsx

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
import { fireEvent, render, screen } from '@shared/tests';
2-
import { createPassThroughPropsTest } from '@shared/tests/utils';
32
import '@ui5/webcomponents-icons/dist/add.js';
43
import { Icon } from '@ui5/webcomponents-react/dist/Icon';
54
import { MessageBox } from '@ui5/webcomponents-react/dist/MessageBox';

packages/main/src/components/MessageBox/__snapshots__/MessageBox.test.tsx.snap

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
exports[`MessageBox Confirm - Cancel 1`] = `
44
<DocumentFragment>
55
<ui5-dialog
6+
accessible-name="Confirmation Confirm"
67
class="MessageBox-messageBox"
78
opened=""
89
style="z-index: 128; display: flex; top: 384px; left: 512px;"
@@ -60,6 +61,7 @@ exports[`MessageBox Confirm - Cancel 1`] = `
6061
exports[`MessageBox Confirm 1`] = `
6162
<DocumentFragment>
6263
<ui5-dialog
64+
accessible-name="Confirmation My Message Box Content"
6365
class="MessageBox-messageBox"
6466
opened=""
6567
style="z-index: 104; display: flex; top: 384px; left: 512px;"
@@ -117,6 +119,7 @@ exports[`MessageBox Confirm 1`] = `
117119
exports[`MessageBox Custom Action Text 1`] = `
118120
<DocumentFragment>
119121
<ui5-dialog
122+
accessible-name="Confirmation My Message Box Content"
120123
class="MessageBox-messageBox"
121124
ui5-dialog=""
122125
>
@@ -172,6 +175,7 @@ exports[`MessageBox Custom Action Text 1`] = `
172175
exports[`MessageBox Don't crash on unknown type 1`] = `
173176
<DocumentFragment>
174177
<ui5-dialog
178+
accessible-name=" Unknown Type!"
175179
class="MessageBox-messageBox"
176180
opened=""
177181
style="z-index: 144; display: flex; top: 384px; left: 512px;"
@@ -212,6 +216,7 @@ exports[`MessageBox Don't crash on unknown type 1`] = `
212216
exports[`MessageBox Error 1`] = `
213217
<DocumentFragment>
214218
<ui5-dialog
219+
accessible-name="Error My Message Box Content"
215220
class="MessageBox-messageBox"
216221
opened=""
217222
style="z-index: 116; display: flex; top: 384px; left: 512px;"
@@ -261,6 +266,7 @@ exports[`MessageBox Error 1`] = `
261266
exports[`MessageBox Highlight 1`] = `
262267
<DocumentFragment>
263268
<ui5-dialog
269+
accessible-name="Highlight My Message Box Content"
264270
class="MessageBox-messageBox"
265271
opened=""
266272
style="z-index: 124; display: flex; top: 384px; left: 512px;"
@@ -310,6 +316,7 @@ exports[`MessageBox Highlight 1`] = `
310316
exports[`MessageBox Information 1`] = `
311317
<DocumentFragment>
312318
<ui5-dialog
319+
accessible-name="Information My Message Box Content"
313320
class="MessageBox-messageBox"
314321
opened=""
315322
style="z-index: 120; display: flex; top: 384px; left: 512px;"
@@ -359,6 +366,7 @@ exports[`MessageBox Information 1`] = `
359366
exports[`MessageBox No Title 1`] = `
360367
<DocumentFragment>
361368
<ui5-dialog
369+
accessible-name="Confirmation No Title"
362370
class="MessageBox-messageBox"
363371
opened=""
364372
style="z-index: 140; display: flex; top: 384px; left: 512px;"
@@ -416,6 +424,7 @@ exports[`MessageBox No Title 1`] = `
416424
exports[`MessageBox Not open 1`] = `
417425
<DocumentFragment>
418426
<ui5-dialog
427+
accessible-name="Custom Success Custom Success"
419428
class="MessageBox-messageBox"
420429
ui5-dialog=""
421430
>
@@ -463,6 +472,7 @@ exports[`MessageBox Not open 1`] = `
463472
exports[`MessageBox Show 1`] = `
464473
<DocumentFragment>
465474
<ui5-dialog
475+
accessible-name="Custom Custom"
466476
class="MessageBox-messageBox"
467477
opened=""
468478
style="z-index: 132; display: flex; top: 384px; left: 512px;"
@@ -520,6 +530,7 @@ exports[`MessageBox Show 1`] = `
520530
exports[`MessageBox Success 1`] = `
521531
<DocumentFragment>
522532
<ui5-dialog
533+
accessible-name="Success My Message Box Content"
523534
class="MessageBox-messageBox"
524535
opened=""
525536
style="z-index: 108; display: flex; top: 384px; left: 512px;"
@@ -569,6 +580,7 @@ exports[`MessageBox Success 1`] = `
569580
exports[`MessageBox Success w/ custom title 1`] = `
570581
<DocumentFragment>
571582
<ui5-dialog
583+
accessible-name="Custom Success Custom Success"
572584
class="MessageBox-messageBox"
573585
opened=""
574586
style="z-index: 136; display: flex; top: 384px; left: 512px;"
@@ -618,6 +630,7 @@ exports[`MessageBox Success w/ custom title 1`] = `
618630
exports[`MessageBox Warning 1`] = `
619631
<DocumentFragment>
620632
<ui5-dialog
633+
accessible-name="Warning My Message Box Content"
621634
class="MessageBox-messageBox"
622635
opened=""
623636
style="z-index: 112; display: flex; top: 384px; left: 512px;"

packages/main/src/components/MessageBox/index.tsx

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ export interface MessageBoxPropTypes
7878
/**
7979
* Defines the content of the `MessageBox`.
8080
*
81-
* **Note:** Although this prop accepts HTML Elements, it is strongly recommended that you only use text in order to preserve the intended design.
81+
* **Note:** Although this prop accepts HTML Elements, it is strongly recommended that you only use text in order to preserve the intended design and a11y capabilities.
8282
*/
8383
children: ReactNode | ReactNodeArray;
8484
/**
@@ -151,6 +151,7 @@ const MessageBox = forwardRef((props: MessageBoxPropTypes, ref: Ref<Ui5DialogDom
151151
emphasizedAction,
152152
onClose,
153153
initialFocus,
154+
accessibleName,
154155
...rest
155156
} = props;
156157
const dialogRef = useConsolidatedRef<Ui5DialogDomRef>(ref);
@@ -349,6 +350,7 @@ const MessageBox = forwardRef((props: MessageBoxPropTypes, ref: Ref<Ui5DialogDom
349350
className={messageBoxClassNames}
350351
onAfterClose={open ? handleOnClose : stopPropagation}
351352
{...restWithoutOmitted}
353+
accessibleName={accessibleName ?? `${titleToRender() ?? ''} ${typeof children === 'string' ? children : ''}`}
352354
initialFocus={getInitialFocus()}
353355
>
354356
{!props.header && (

0 commit comments

Comments
 (0)