Skip to content

fix(ui5-view-settings-dialog): initially focus first item in filter options #12065

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

Open
wants to merge 18 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
37 changes: 37 additions & 0 deletions packages/fiori/cypress/specs/ViewSettingsDialog.cy.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -370,4 +370,41 @@ describe("ViewSettingsDialog Tests", () => {
cy.get("@vsd")
.invoke("prop", "open", false);
});

it("should focus first item in filter options", () => {
cy.mount(
<ViewSettingsDialog id="vsdFilter">
<FilterItem slot="filterItems" text="Filter 1">
<FilterItemOption id="focusedItem" slot="values" text="Some filter 1"></FilterItemOption>
<FilterItemOption slot="values" text="Some filter 2"></FilterItemOption>
<FilterItemOption slot="values" text="Some filter 3"></FilterItemOption>
</FilterItem>
<FilterItem slot="filterItems" text="Filter 2">
<FilterItemOption slot="values" text="Some filter 4"></FilterItemOption>
<FilterItemOption slot="values" text="Some filter 5"></FilterItemOption>
<FilterItemOption slot="values" text="Some filter 6"></FilterItemOption>
</FilterItem>
</ViewSettingsDialog>
);

cy.get("#vsdFilter")
.as("vsd");

cy.get("@vsd")
.invoke("prop", "open", true);

cy.get("@vsd")
.shadow()
.find("[ui5-li]")
.first()
.shadow()
.find("span[part=title]")
.realClick();

cy.get("@vsd")
.shadow()
.find("[ui5-li]")
.first()
.should("be.focused");
});
});
15 changes: 14 additions & 1 deletion packages/fiori/src/ViewSettingsDialog.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ import slot from "@ui5/webcomponents-base/dist/decorators/slot.js";
import customElement from "@ui5/webcomponents-base/dist/decorators/customElement.js";
import event from "@ui5/webcomponents-base/dist/decorators/event-strict.js";
import i18n from "@ui5/webcomponents-base/dist/decorators/i18n.js";
import query from "@ui5/webcomponents-base/dist/decorators/query.js";
import type I18nBundle from "@ui5/webcomponents-base/dist/i18nBundle.js";
import { isPhone } from "@ui5/webcomponents-base/dist/Device.js";
import jsxRenderer from "@ui5/webcomponents-base/dist/renderer/JsxRenderer.js";
Expand All @@ -13,6 +14,7 @@ import type List from "@ui5/webcomponents/dist/List.js";
import type { ListItemClickEventDetail, ListSelectionChangeEventDetail } from "@ui5/webcomponents/dist/List.js";
import announce from "@ui5/webcomponents-base/dist/util/InvisibleMessage.js";
import InvisibleMessageMode from "@ui5/webcomponents-base/dist/types/InvisibleMessageMode.js";
import { renderFinished } from "@ui5/webcomponents-base/dist/Render.js";

import ViewSettingsDialogMode from "./types/ViewSettingsDialogMode.js";
import "@ui5/webcomponents-icons/dist/sort.js";
Expand Down Expand Up @@ -248,6 +250,9 @@ class ViewSettingsDialog extends UI5Element {
@slot()
filterItems!: Array<FilterItem>;

@query("[ui5-list]")
_list!: List;

_dialog?: Dialog;
_sortOrder?: List;
_sortBy?: List;
Expand All @@ -265,6 +270,14 @@ class ViewSettingsDialog extends UI5Element {
}
}

onAfterRendering() {
if (this.isModeFilter) {
renderFinished().then(() => {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

if it's onAfterRendering, can't we assume that the render is finished?

Copy link
Contributor Author

@GDamyanov GDamyanov Aug 8, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We cannot guarantee that child elements are rendered. I test it without renderFinished() and the focus is not working.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's find a way to escape the "renderFinished" then

this._list?.focusFirstItem();
});
}
}

onInvalidation(changeInfo: ChangeInfo) {
if (changeInfo.type === "slot") {
this._confirmedSettings = this._settings;
Expand Down Expand Up @@ -506,7 +519,7 @@ class ViewSettingsDialog extends UI5Element {
}

afterDialogOpen(): void {
this._dialog?.querySelector<List>("[ui5-list]")?.focusFirstItem();
this._list?.focusFirstItem();

this._focusRecentlyUsedControl();

Expand Down
Loading