Skip to content

feat(ui5-toolbar): introduce overflowButtonAccessibleName property #13416

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

Open
NakataCode wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat(ui5-toolbar): introduce overflowButtonAccessibleName property #13416

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
29 changes: 29 additions & 0 deletions packages/main/cypress/specs/Toolbar.cy.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -831,3 +831,32 @@ describe("ToolbarButton", () => {
});
});

describe("Toolbar overflow button accessible name", () => {
it("should use the default i18n accessible name when overflowButtonAccessibleName is not set", () => {
cy.mount(
<Toolbar>
<ToolbarButton text="Add" icon="add" overflow-priority="AlwaysOverflow"></ToolbarButton>
</Toolbar>
);

cy.get("[ui5-toolbar]")
.shadow()
.find(".ui5-tb-overflow-btn")
.should("not.have.class", "ui5-tb-overflow-btn-hidden")
.should("have.attr", "accessible-name", "Additional Options");
});

it("should use the custom accessible name when overflowButtonAccessibleName is set", () => {
cy.mount(
<Toolbar overflow-button-accessible-name="More actions for Opportunity 123">
<ToolbarButton text="Add" icon="add" overflow-priority="AlwaysOverflow"></ToolbarButton>
</Toolbar>
);

cy.get("[ui5-toolbar]")
.shadow()
.find(".ui5-tb-overflow-btn")
.should("not.have.class", "ui5-tb-overflow-btn-hidden")
.should("have.attr", "accessible-name", "More actions for Opportunity 123");
});
});
13 changes: 12 additions & 1 deletion packages/main/src/Toolbar.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,6 +134,17 @@ class Toolbar extends UI5Element {
@property()
accessibleNameRef?: string;

/**
* Defines the accessible ARIA name of the overflow button of the component.
*
* **Note:** When not set, the built-in translation for "Additional Options" is used.
* @default undefined
* @public
* @since 2.22.0
*/
@property()
overflowButtonAccessibleName?: string;

/**
* Defines the toolbar design.
* @public
Expand Down Expand Up @@ -242,7 +253,7 @@ class Toolbar extends UI5Element {
accessibleName: this.ariaLabelText,
},
overflowButton: {
accessibleName: Toolbar.i18nBundle.getText(TOOLBAR_OVERFLOW_BUTTON_ARIA_LABEL),
accessibleName: this.overflowButtonAccessibleName || Toolbar.i18nBundle.getText(TOOLBAR_OVERFLOW_BUTTON_ARIA_LABEL),
tooltip: Toolbar.i18nBundle.getText(TOOLBAR_OVERFLOW_BUTTON_ARIA_LABEL),
accessibilityAttributes: {
expanded: this.popoverOpen,
Expand Down
13 changes: 13 additions & 0 deletions packages/main/test/pages/Toolbar.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -158,6 +158,19 @@

<br /><br />

<ui5-title level="H3">Toolbar with custom overflow button accessible name</ui5-title>
<br />

<section>
<ui5-toolbar overflow-button-accessible-name="More actions for Opportunity 123">
<ui5-toolbar-button icon="add" text="Left 1 (long)" width="150px"></ui5-toolbar-button>
<ui5-toolbar-button icon="decline" text="Left 2"></ui5-toolbar-button>
<ui5-toolbar-button icon="employee" text="Call me later" overflow-priority="AlwaysOverflow"></ui5-toolbar-button>
</ui5-toolbar>
</section>

<br /><br />

<ui5-title level="H3">Toolbar with "NeverOverflow" overflow priority item (divided visually by internal
separator)</ui5-title>
<br />
Expand Down
Loading