diff --git a/.changeset/fix-stale-dropdown-triggers.md b/.changeset/fix-stale-dropdown-triggers.md new file mode 100644 index 00000000000..7af301686b9 --- /dev/null +++ b/.changeset/fix-stale-dropdown-triggers.md @@ -0,0 +1,5 @@ +--- +'@siemens/ix': patch +--- + +Prevent outdated asynchronous dropdown triggers from attaching listeners or changing submenu state after the trigger changes or the dropdown is disconnected. Clean up trigger listeners on disconnect and restore them on reconnect. diff --git a/.changeset/fresh-buttons-rest.md b/.changeset/fresh-buttons-rest.md new file mode 100644 index 00000000000..df7ff48fcf1 --- /dev/null +++ b/.changeset/fresh-buttons-rest.md @@ -0,0 +1,5 @@ +--- +'@siemens/ix': patch +--- + +Forward updated and removed ARIA attributes to each component's accessible element without leaving invalid host copies. `ix-toggle` now keeps its component managed attributes (`role`, `aria-checked`, `aria-disabled`, `aria-required`) intact while still accepting custom ARIA attributes such as `aria-label`. diff --git a/.changeset/mighty-poems-behave.md b/.changeset/mighty-poems-behave.md new file mode 100644 index 00000000000..c2ae73bbaf9 --- /dev/null +++ b/.changeset/mighty-poems-behave.md @@ -0,0 +1,8 @@ +--- +'@siemens/ix': patch +--- + +Fixed `ix-dropdown` trigger handling: an empty `trigger` value no longer matches +elements without an `id`, changing the trigger to an empty value now removes the +previously registered listeners, and asynchronously resolved triggers that became +stale are discarded instead of attaching orphaned listeners. diff --git a/.changeset/persistent-pinned-menu.md b/.changeset/persistent-pinned-menu.md new file mode 100644 index 00000000000..32548fd7432 --- /dev/null +++ b/.changeset/persistent-pinned-menu.md @@ -0,0 +1,5 @@ +--- +'@siemens/ix': patch +--- + +Keep pinned `ix-menu` components expanded when a menu item is selected. diff --git a/.changeset/reliable-tab-activation.md b/.changeset/reliable-tab-activation.md new file mode 100644 index 00000000000..36eabe2ff95 --- /dev/null +++ b/.changeset/reliable-tab-activation.md @@ -0,0 +1,5 @@ +--- +'@siemens/ix': patch +--- + +Fix `ix-tab-set` panel activation and `ix-menu-about` tab activation when child components are still initializing. diff --git a/.changeset/stable-date-picker-focus.md b/.changeset/stable-date-picker-focus.md new file mode 100644 index 00000000000..80790dd9b1f --- /dev/null +++ b/.changeset/stable-date-picker-focus.md @@ -0,0 +1,5 @@ +--- +'@siemens/ix': patch +--- + +Fix `ix-date-picker` keyboard navigation so focus consistently moves to the expected day. diff --git a/.changeset/steady-dropdown-triggers.md b/.changeset/steady-dropdown-triggers.md new file mode 100644 index 00000000000..801a3653ce3 --- /dev/null +++ b/.changeset/steady-dropdown-triggers.md @@ -0,0 +1,5 @@ +--- +'@siemens/ix': patch +--- + +Fix `ix-dropdown` trigger initialization so dropdowns open reliably immediately after rendering or when triggers are added dynamically. diff --git a/packages/core/src/components/badge/badge.tsx b/packages/core/src/components/badge/badge.tsx index 80236f0ce40..9bc7ca33a83 100644 --- a/packages/core/src/components/badge/badge.tsx +++ b/packages/core/src/components/badge/badge.tsx @@ -218,22 +218,20 @@ export class Badge private hasDisconnected = false; + override keepAriaAttributesOnHost(): boolean { + return !this.hasAnchor; + } + override componentWillLoad() { - // Mixin strips host ARIA into `inheritAriaAttributes` and removes them from the host. + this.hasAnchor = this.detectHasAnchor(); super.componentWillLoad(); this.descriptionId = `${this.getHostElementId()}-description`; - const hasAnchor = this.detectHasAnchor(); - if (hasAnchor) { - this.hasAnchor = true; + if (this.hasAnchor) { // Attached: discard host ARIA — the anchor owns naming; the indicator is decorative // (`aria-hidden`) and count/label text is exposed via `aria-describedby` on the anchor. this.inheritAriaAttributes = {}; - return; } - - this.hasAnchor = false; - // Standalone: keep mixin-captured ARIA and re-apply on `` in `render()`. } override componentDidLoad() { diff --git a/packages/core/src/components/badge/test/badge.ct.ts b/packages/core/src/components/badge/test/badge.ct.ts index 8571c5b474e..0db24476e3e 100644 --- a/packages/core/src/components/badge/test/badge.ct.ts +++ b/packages/core/src/components/badge/test/badge.ct.ts @@ -700,6 +700,53 @@ regressionTest.describe('ix-badge', () => { }); } ); + + regressionTest( + 'updates and removes standalone host ARIA', + async ({ mount, page }) => { + await mount( + `` + ); + const badge = page.locator('ix-badge'); + await expect(badge).toHaveClass(/\bhydrated\b/); + + await badge.evaluate((element) => { + element.setAttribute('aria-label', 'Read'); + element.setAttribute('role', 'status'); + }); + await expect(page.getByRole('status', { name: 'Read' })).toBeVisible(); + + await badge.evaluate((element) => { + element.removeAttribute('aria-label'); + element.removeAttribute('role'); + }); + await expect(badge).not.toHaveAttribute('aria-label'); + await expect(badge).not.toHaveAttribute('role'); + } + ); + + regressionTest( + 'preserves standalone host ARIA after reconnect', + async ({ mount, page }) => { + await mount( + `` + ); + const badge = page.locator('ix-badge'); + await expect(badge).toHaveClass(/\bhydrated\b/); + await expect(page.getByRole('img', { name: 'Unread' })).toBeVisible(); + + await badge.evaluate((element) => { + const parent = element.parentElement; + if (!parent) { + throw new Error('Badge must have a parent before reconnecting'); + } + element.remove(); + parent.appendChild(element); + }); + + await expect(page.getByRole('img', { name: 'Unread' })).toBeVisible(); + } + ); }); regressionTest.describe('tooltip', () => { diff --git a/packages/core/src/components/chat-input/tests/chat-input.ct.ts b/packages/core/src/components/chat-input/tests/chat-input.ct.ts index fe831028b53..9b7d805eceb 100644 --- a/packages/core/src/components/chat-input/tests/chat-input.ct.ts +++ b/packages/core/src/components/chat-input/tests/chat-input.ct.ts @@ -345,9 +345,6 @@ regressionTest( await expect( chatInput.locator('ix-dropdown-button.attachment-overflow') ).toHaveCount(0); - await expect(chatInput.locator('.attachments')).not.toHaveClass( - /has-attachment-scrollbar/ - ); await expect( page.locator('[data-attachment-overflow-generated]') ).toHaveCount(0); diff --git a/packages/core/src/components/checkbox/tests/checkbox.ct.ts b/packages/core/src/components/checkbox/tests/checkbox.ct.ts index 3937a8dc1d7..f848978b556 100644 --- a/packages/core/src/components/checkbox/tests/checkbox.ct.ts +++ b/packages/core/src/components/checkbox/tests/checkbox.ct.ts @@ -115,6 +115,7 @@ regressionTest( const checkbox = page.locator('ix-checkbox'); await expect(checkbox).not.toHaveClass(/label-less/); await expect(checkbox).toHaveText(/Custom slot label text/); + await expect(checkbox.locator('ix-typography')).toBeVisible(); await expect .poll(() => checkbox.evaluate((element) => @@ -131,37 +132,38 @@ regressionTest('label', async ({ mount, page }) => { await expect(checkboxElement).toHaveText(/some label/); }); -test('Checkbox should not cause layout shift when checked', async ({ - mount, - page, -}) => { - await mount(` +regressionTest( + 'Checkbox should not cause layout shift when checked', + async ({ mount, page }) => { + await mount(`
This element should not move
`); - await page.waitForSelector('ix-checkbox', { state: 'attached' }); + const checkbox = page.locator('ix-checkbox'); + const elementBelow = page.locator('#element-below'); - const initialBounds = await page.$eval('#element-below', (el) => { - const rect = el.getBoundingClientRect(); - return { top: rect.top, left: rect.left }; - }); + await expect(checkbox).toHaveClass(/hydrated/); + await expect(elementBelow).toBeVisible(); + await page.evaluate(() => document.fonts.ready); - await page.click('ix-checkbox'); + const initialBounds = await elementBelow.boundingBox(); + if (!initialBounds) { + throw new Error('Expected element below checkbox to have a bounding box'); + } - await page.waitForFunction(() => { - const checkbox = document.querySelector('ix-checkbox'); - return checkbox?.getAttribute('aria-checked') === 'true'; - }); + await checkbox.click(); + await expect(checkbox).toHaveAttribute('aria-checked', 'true'); - const newBounds = await page.$eval('#element-below', (el) => { - const rect = el.getBoundingClientRect(); - return { top: rect.top, left: rect.left }; - }); + const newBounds = await elementBelow.boundingBox(); + if (!newBounds) { + throw new Error('Expected element below checkbox to remain visible'); + } - expect(newBounds.top).toBeCloseTo(initialBounds.top, 0); - expect(newBounds.left).toBeCloseTo(initialBounds.left, 0); -}); + expect(newBounds.y).toBeCloseTo(initialBounds.y, 0); + expect(newBounds.x).toBeCloseTo(initialBounds.x, 0); + } +); test.describe('accessibility', () => { test('should expose aria-label for accessibility queries', async ({ diff --git a/packages/core/src/components/chip/test/chip.ct.ts b/packages/core/src/components/chip/test/chip.ct.ts index 33c707ab55e..4d87c6cc456 100644 --- a/packages/core/src/components/chip/test/chip.ct.ts +++ b/packages/core/src/components/chip/test/chip.ct.ts @@ -56,6 +56,16 @@ regressionTest( await expect( page.getByRole('button', { name: 'Close chip' }) ).toBeVisible(); + + await chip.evaluate((element) => { + element.setAttribute('aria-label', 'Project Beta'); + }); + + await expect(chip).not.toHaveAttribute('aria-label'); + await expect( + page.getByRole('button', { name: 'Project Beta' }) + ).toBeVisible(); + await expect(chip).toHaveAttribute('role', 'group'); } ); diff --git a/packages/core/src/components/date-picker/date-picker.tsx b/packages/core/src/components/date-picker/date-picker.tsx index 23c51da6ac1..7f4c21c4703 100644 --- a/packages/core/src/components/date-picker/date-picker.tsx +++ b/packages/core/src/components/date-picker/date-picker.tsx @@ -380,6 +380,7 @@ export class DatePicker break; } + event.preventDefault(); return; } @@ -742,7 +743,18 @@ export class DatePicker return rows; } - public changeFocusedDay() { + public changeFocusedDay(focusTarget?: EventTarget) { + const focusedDayElement = + focusTarget instanceof HTMLElement + ? focusTarget.closest('[data-calendar-day]') + : null; + const focusedDay = focusedDayElement?.dataset.calendarDay; + + if (focusedDay) { + this.focusedDay = Number.parseInt(focusedDay, 10); + return; + } + if (this.monthChangedFromFocus) { return; } @@ -827,9 +839,9 @@ export class DatePicker return ( this.onKeyDown(event)} - onFocusin={() => { + onFocusin={(event: FocusEvent) => { if (hasKeyboardMode()) { - this.changeFocusedDay(); + this.changeFocusedDay(event.composedPath()[0]); } }} > diff --git a/packages/core/src/components/datetime-input/test/datetime-input.ct.ts b/packages/core/src/components/datetime-input/test/datetime-input.ct.ts index 94a7b0dd28a..8e0745fa317 100644 --- a/packages/core/src/components/datetime-input/test/datetime-input.ct.ts +++ b/packages/core/src/components/datetime-input/test/datetime-input.ct.ts @@ -1450,8 +1450,14 @@ regressionTest('form-ready - initial value', async ({ mount, page }) => { const formElement = page.locator('form'); preventFormSubmission(formElement); - const formData = await getFormValue(formElement, 'appointment-time', page); - expect(formData).toBe('2024/12/25 10:00:00'); + const dateTimeInput = page.locator('ix-datetime-input'); + await expect(dateTimeInput).toHaveClass(/hydrated/); + await expect(dateTimeInput.getByRole('textbox')).toHaveValue( + '2024/12/25 10:00:00' + ); + await expect + .poll(() => getFormValue(formElement, 'appointment-time', page)) + .toBe('2024/12/25 10:00:00'); }); regressionTest( diff --git a/packages/core/src/components/dropdown/dropdown-controller.ts b/packages/core/src/components/dropdown/dropdown-controller.ts index 49d756606fa..7ed9ac4949c 100644 --- a/packages/core/src/components/dropdown/dropdown-controller.ts +++ b/packages/core/src/components/dropdown/dropdown-controller.ts @@ -24,6 +24,7 @@ export interface DropdownInterface extends IxComponentInterface { getAssignedSubmenuIds(): string[]; getId(): string; + matchesTrigger(eventTargets: EventTarget[]): boolean; getTriggerElement(): HTMLElement | undefined; discoverSubmenu(): void; @@ -53,6 +54,28 @@ export interface DropdownItemWrapper { } export class DropdownController { + private readonly onWindowClick = (event: MouseEvent) => { + const eventTargets = event.composedPath(); + if (this.pathIncludesTrigger(eventTargets) || event.defaultPrevented) { + return; + } + + for (const id of this.registry.keys()) { + const dropdown = this.registry.get(id); + if (!dropdown?.matchesTrigger(eventTargets)) { + continue; + } + + if (dropdown.isPresent()) { + this.dismiss(dropdown); + } else { + this.present(dropdown); + } + this.dismissOthers(dropdown.getId()); + return; + } + }; + private readonly registry = new NestedOverlayRegistry( { blocksOutsideDismiss: (dropdown) => @@ -66,6 +89,9 @@ export class DropdownController { ) {} connected(dropdown: DropdownInterface) { + if (this.registry.keys().length === 0) { + window.addEventListener('click', this.onWindowClick); + } this.registry.connect(dropdown); this.overlayCoordinator.connect({ key: this.getOverlayKey(dropdown), @@ -91,6 +117,9 @@ export class DropdownController { disconnected(dropdown: DropdownInterface) { this.registry.disconnect(dropdown); this.overlayCoordinator.disconnect(this.getOverlayKey(dropdown)); + if (this.registry.keys().length === 0) { + window.removeEventListener('click', this.onWindowClick); + } } removeFromSubmenuIds(id: string) { @@ -204,7 +233,6 @@ export class DropdownController { this.overlayCoordinator.pathIncludesDescendant(key, eventTargets) ); } - getParentFocusExitTarget( dropdown: DropdownInterface, current: HTMLElement, diff --git a/packages/core/src/components/dropdown/dropdown.tsx b/packages/core/src/components/dropdown/dropdown.tsx index b327eb4d49b..82e7b90ab52 100644 --- a/packages/core/src/components/dropdown/dropdown.tsx +++ b/packages/core/src/components/dropdown/dropdown.tsx @@ -292,6 +292,7 @@ export class Dropdown private readonly dialogRef = makeRef(); private intersectObserverTrigger?: IntersectionObserver; private triggerElement?: Element; + private triggerResolutionToken = 0; private anchorElement?: Element; private forwardQueryElement: HTMLElement | null = null; private dropdownElementId = `dropdown-${sequenceId++}`; @@ -323,6 +324,13 @@ export class Dropdown } override disconnectedCallback() { + this.triggerResolutionToken++; + this.disposeClickListener?.(); + this.disposeClickListener = undefined; + this.disposeKeyListener?.(); + this.disposeKeyListener = undefined; + this.triggerElement = undefined; + dropdownController.dismiss(this); dropdownController.disconnected(this); @@ -355,8 +363,28 @@ export class Dropdown return this.dropdownElementId; } + matchesTrigger(eventTargets: EventTarget[]) { + const trigger = + this.trigger ?? this.hostElement.getAttribute('trigger') ?? undefined; + + return eventTargets.some( + (target) => + target === trigger || + (typeof trigger === 'string' && + trigger !== '' && + target instanceof HTMLElement && + target.id === trigger) + ); + } + getTriggerElement(): HTMLElement | undefined { - return (this.triggerElement ?? this.anchorElement) as + const trigger = + this.trigger ?? this.hostElement.getAttribute('trigger') ?? undefined; + const immediateTrigger = trigger + ? this.resolveImmediateElement(trigger) + : undefined; + + return (this.triggerElement ?? immediateTrigger ?? this.anchorElement) as | HTMLElement | undefined; } @@ -624,13 +652,39 @@ export class Dropdown } } - private async registerListener(element: ElementReference) { - this.triggerElement = await this.resolveElement(element); + private async registerListener(element: ElementReference | undefined) { + const resolutionToken = ++this.triggerResolutionToken; + this.triggerElement = undefined; - if (!this.triggerElement) { + if (!element || !this.hostElement.isConnected) { return; } + const immediateElement = this.resolveImmediateElement(element); + const canRegisterImmediately = + immediateElement && + (!hasDropdownItemWrapperImplemented(immediateElement) || + immediateElement.tagName === 'IX-DROPDOWN-ITEM'); + + if (canRegisterImmediately) { + this.triggerElement = immediateElement; + if (immediateElement.tagName === 'IX-DROPDOWN-ITEM') { + (immediateElement as HTMLIxDropdownItemElement).isSubMenu = true; + this.hostElement.style.zIndex = `var(--theme-z-index-dropdown)`; + } + this.addEventListenersFor(); + this.discoverSubmenu(); + return; + } + + const resolvedElement = await this.resolveElement(element, resolutionToken); + + if (!resolvedElement || resolutionToken !== this.triggerResolutionToken) { + return; + } + + this.triggerElement = resolvedElement; + this.addEventListenersFor(); this.discoverSubmenu(); } @@ -702,19 +756,65 @@ export class Dropdown return `${side}-${alignment}`; } - private async resolveElement(element: ElementReference) { + private async resolveElement( + element: ElementReference, + resolutionToken = this.triggerResolutionToken + ) { const el = await findElement(element); - return this.checkForSubmenuAnchor(el); + if ( + resolutionToken !== this.triggerResolutionToken || + !this.hostElement.isConnected + ) { + return undefined; + } + + return this.checkForSubmenuAnchor(el, resolutionToken); } - private async checkForSubmenuAnchor(element?: Element) { + private resolveImmediateElement( + element: ElementReference + ): HTMLElement | undefined { + if (element instanceof Promise) { + return undefined; + } + + if (element instanceof HTMLElement) { + return element; + } + + const documentElement = document.getElementById(element); + if (documentElement) { + return documentElement; + } + + const root = this.hostElement.getRootNode(); + if (root instanceof ShadowRoot) { + return ( + root.querySelector(`#${CSS.escape(element)}`) ?? undefined + ); + } + + return undefined; + } + + private async checkForSubmenuAnchor( + element: Element | undefined, + resolutionToken: number + ) { if (!element) { return undefined; } if (hasDropdownItemWrapperImplemented(element)) { const dropdownItem = await element.getDropdownItemElement(); + if ( + resolutionToken !== this.triggerResolutionToken || + !this.hostElement.isConnected + ) { + return undefined; + } + dropdownItem.isSubMenu = true; this.hostElement.style.zIndex = `var(--theme-z-index-dropdown)`; } @@ -728,10 +828,17 @@ export class Dropdown } private async resolveAnchorElement() { - if (this.anchor) { - this.anchorElement = await this.resolveElement(this.anchor); - } else if (this.trigger) { - this.anchorElement = await this.resolveElement(this.trigger); + const anchor = this.anchor || this.trigger; + const resolutionToken = this.triggerResolutionToken; + const resolvedElement = anchor + ? await this.resolveElement(anchor, resolutionToken) + : undefined; + + if ( + resolutionToken === this.triggerResolutionToken && + anchor === (this.anchor || this.trigger) + ) { + this.anchorElement = resolvedElement; } } @@ -907,18 +1014,18 @@ export class Dropdown } @Watch('trigger') - changedTrigger( - newTriggerValue: ElementReference, + async changedTrigger( + newTriggerValue: ElementReference | undefined, oldTriggerValue: ElementReference | undefined ) { - if (newTriggerValue && newTriggerValue !== oldTriggerValue) { + if (newTriggerValue !== oldTriggerValue) { this.disposeClickListener?.(); this.disposeClickListener = undefined; this.disposeKeyListener?.(); this.disposeKeyListener = undefined; } - this.registerListener(newTriggerValue); + await this.registerListener(newTriggerValue); } private applyFallbackPosition(element: HTMLElement) { @@ -1182,7 +1289,7 @@ export class Dropdown return; } - this.changedTrigger(this.trigger, undefined); + await this.changedTrigger(this.trigger, undefined); } override async componentDidRender() { diff --git a/packages/core/src/components/dropdown/test/dropdown-controller.spec.ts b/packages/core/src/components/dropdown/test/dropdown-controller.spec.ts index e51d9eeb6fc..d5fffa4381c 100644 --- a/packages/core/src/components/dropdown/test/dropdown-controller.spec.ts +++ b/packages/core/src/components/dropdown/test/dropdown-controller.spec.ts @@ -154,6 +154,7 @@ describe('dropdown-controller', () => { discoverAllSubmenus: false, getAssignedSubmenuIds: () => childIds, getId: () => id, + matchesTrigger: () => false, getTriggerElement: () => undefined, discoverSubmenu: vi.fn(), isPresent: () => present, diff --git a/packages/core/src/components/dropdown/test/dropdown-top-layer.ct.ts b/packages/core/src/components/dropdown/test/dropdown-top-layer.ct.ts index 7e1994292b9..5abd16153e1 100644 --- a/packages/core/src/components/dropdown/test/dropdown-top-layer.ct.ts +++ b/packages/core/src/components/dropdown/test/dropdown-top-layer.ct.ts @@ -6,9 +6,18 @@ * This source code is licensed under the MIT license found in the * LICENSE file in the root directory of this source tree. */ -import { expect } from '@playwright/test'; +import { expect, Page } from '@playwright/test'; import { regressionTest } from '@utils/test'; +async function getReadyTrigger(page: Page) { + const trigger = page.locator('#trigger'); + await expect(trigger).toHaveAttribute( + 'data-ix-dropdown-trigger', + /dropdown-\d+/ + ); + return trigger; +} + regressionTest.describe('enableTopLayer feature', () => { regressionTest.describe('Popover API mode (enableTopLayer=true)', () => { regressionTest( @@ -21,7 +30,7 @@ regressionTest.describe('enableTopLayer feature', () => { `); - const trigger = page.getByRole('button', { name: 'Open' }); + const trigger = await getReadyTrigger(page); await trigger.click(); const dropdown = page.locator('ix-dropdown#dropdown'); @@ -42,7 +51,7 @@ regressionTest.describe('enableTopLayer feature', () => { `); - const trigger = page.getByRole('button', { name: 'Open' }); + const trigger = await getReadyTrigger(page); const dropdown = page.locator('ix-dropdown#dropdown'); const dialog = dropdown.getByRole('dialog'); @@ -66,7 +75,7 @@ regressionTest.describe('enableTopLayer feature', () => { `); - const trigger = page.getByRole('button', { name: 'Open' }); + const trigger = await getReadyTrigger(page); const dropdown = page.locator('ix-dropdown#dropdown'); const dialog = dropdown.getByRole('dialog'); @@ -97,7 +106,7 @@ regressionTest.describe('enableTopLayer feature', () => { `); - const trigger = page.getByRole('button', { name: 'Open' }); + const trigger = await getReadyTrigger(page); await trigger.click(); const dialog = page.getByRole('dialog'); @@ -124,7 +133,7 @@ regressionTest.describe('enableTopLayer feature', () => { `); - const trigger = page.getByRole('button', { name: 'Open' }); + const trigger = await getReadyTrigger(page); await trigger.click(); const dialog = page.getByRole('dialog'); @@ -149,7 +158,7 @@ regressionTest.describe('enableTopLayer feature', () => { `); - const trigger = page.getByRole('button', { name: 'Open' }); + const trigger = await getReadyTrigger(page); await trigger.click(); const dialog = page.getByRole('dialog'); @@ -180,7 +189,7 @@ regressionTest.describe('enableTopLayer feature', () => { `); - const trigger = page.getByRole('button', { name: 'Open' }); + const trigger = await getReadyTrigger(page); await trigger.click(); const dialog = page.getByRole('dialog'); @@ -252,7 +261,7 @@ regressionTest.describe('enableTopLayer feature', () => { `); - const trigger = page.getByRole('button', { name: 'Actions' }); + const trigger = await getReadyTrigger(page); await trigger.click(); const dialog = page.getByRole('dialog'); diff --git a/packages/core/src/components/dropdown/test/dropdown.ct.ts b/packages/core/src/components/dropdown/test/dropdown.ct.ts index 313494175f0..88005114007 100644 --- a/packages/core/src/components/dropdown/test/dropdown.ct.ts +++ b/packages/core/src/components/dropdown/test/dropdown.ct.ts @@ -18,6 +18,28 @@ import { regressionTest, viewPorts, expect } from '@utils/test'; const html = String.raw; +async function waitForDropdownTrigger(trigger: Locator) { + await expect(trigger).toHaveAttribute( + 'data-ix-dropdown-trigger', + /dropdown-\d+/ + ); +} + +regressionTest('accessibility', async ({ mount, page, makeAxeBuilder }) => { + await mount(`
+ + + + +
`); + + await expect(page.locator('ix-dropdown')).toHaveClass(/\bhydrated\b/); + await page.getByRole('button', { name: 'Open menu' }).click(); + await expect(page.getByRole('dialog', { name: 'Options' })).toBeVisible(); + const results = await makeAxeBuilder().analyze(); + expect(results.violations).toEqual([]); +}); + regressionTest('renders', async ({ mount, page }) => { await mount( ` @@ -105,8 +127,10 @@ regressionTest('trigger toggles', async ({ mount, page }) => { `); - await page.locator('ix-button').click(); const dropdown = page.locator('.dropdown-menu'); + await expect(dropdown).toHaveClass(/\bhydrated\b/); + await waitForDropdownTrigger(page.locator('#trigger')); + await page.locator('ix-button').click(); await expect(dropdown).toHaveClass(/show/); await expect(dropdown).toBeVisible(); @@ -116,6 +140,226 @@ regressionTest('trigger toggles', async ({ mount, page }) => { await expect(dropdown).not.toBeVisible(); }); +regressionTest( + 'handles a late trigger on its first same-task interaction', + async ({ mount, page }) => { + await mount( + '
' + ); + await expect(page.locator('#definition-loader')).toHaveClass(/hydrated/); + + await page.locator('#container').evaluate((container) => { + container.querySelector('#definition-loader')?.remove(); + + const dropdown = document.createElement('ix-dropdown'); + dropdown.setAttribute('trigger', 'late-trigger'); + dropdown.innerHTML = + ''; + container.append(dropdown); + + const trigger = document.createElement('button'); + trigger.id = 'late-trigger'; + trigger.textContent = 'Open'; + container.append(trigger); + trigger.click(); + }); + + await expect(page.locator('ix-dropdown')).toHaveAttribute('show'); + } +); + +for (const clearedTrigger of ['', undefined]) { + regressionTest( + `clears resolved trigger when set to ${String(clearedTrigger)}`, + async ({ mount, page }) => { + await mount(`
+ + +
`); + + const dropdown = page.locator('ix-dropdown'); + const trigger = page.locator('#trigger'); + await expect(dropdown).toHaveClass(/\bhydrated\b/); + await waitForDropdownTrigger(trigger); + await expect(dropdown).toHaveAttribute('role', 'menu'); + + await dropdown.evaluate((element: HTMLIxDropdownElement, value) => { + element.trigger = value; + }, clearedTrigger); + + await expect(dropdown).not.toHaveAttribute('role'); + await trigger.click(); + await expect(dropdown).not.toHaveAttribute('show'); + } + ); +} + +for (const scenario of ['empty', 'undefined', 'replaced', 'disconnected']) { + regressionTest( + `ignores stale trigger resolution when ${scenario}`, + async ({ mount, page }) => { + await mount(`
+ + + +
`); + + const dropdown = page.locator('ix-dropdown'); + const staleTrigger = page.locator('#stale'); + await expect(dropdown).toHaveClass(/\bhydrated\b/); + await expect(staleTrigger).toHaveClass(/\bhydrated\b/); + + const result = await dropdown.evaluate( + async (element: HTMLIxDropdownElement, scenario) => { + const stale = + document.querySelector('#stale')!; + let resolveTrigger!: (trigger: HTMLElement) => void; + element.trigger = new Promise((resolve) => { + resolveTrigger = resolve; + }); + + if (scenario === 'disconnected') { + element.remove(); + } else { + element.trigger = + scenario === 'empty' + ? '' + : scenario === 'undefined' + ? undefined + : document.querySelector('#replacement')!; + } + + resolveTrigger(stale); + await new Promise(requestAnimationFrame); + stale.click(); + stale.dispatchEvent(new KeyboardEvent('keydown', { key: 'Enter' })); + + return { + show: element.show, + isSubMenu: stale.isSubMenu, + zIndex: element.style.zIndex, + }; + }, + scenario + ); + + expect(result).toEqual({ show: false, isSubMenu: false, zIndex: '' }); + await expect(staleTrigger).not.toHaveAttribute( + 'data-ix-dropdown-trigger' + ); + if (scenario === 'replaced') { + await page.getByRole('button', { name: 'Replacement' }).click(); + await expect(dropdown).toHaveAttribute('show'); + } + } + ); +} + +for (const scenario of ['cleared', 'replaced', 'disconnected']) { + regressionTest( + `ignores stale submenu wrapper resolution when ${scenario}`, + async ({ mount, page }) => { + await mount(`
+ + + + +
`); + + const dropdown = page.locator('ix-dropdown'); + await expect(dropdown).toHaveClass(/\bhydrated\b/); + await expect(page.locator('#item')).toHaveClass(/\bhydrated\b/); + + const result = await dropdown.evaluate( + async (element: HTMLIxDropdownElement, scenario) => { + const wrapper = + document.querySelector('#wrapper')!; + const item = + document.querySelector('#item')!; + let resolveItem!: (item: HTMLIxDropdownItemElement) => void; + let notifyStarted!: () => void; + const started = new Promise((resolve) => { + notifyStarted = resolve; + }); + const pendingItem = new Promise( + (resolve) => { + resolveItem = resolve; + } + ); + Object.assign(wrapper, { + getDropdownItemElement: () => { + notifyStarted(); + return pendingItem; + }, + }); + + element.trigger = wrapper; + await started; + if (scenario === 'disconnected') { + element.remove(); + } else { + element.trigger = + scenario === 'cleared' + ? undefined + : document.querySelector('#replacement')!; + } + + resolveItem(item); + await new Promise(requestAnimationFrame); + wrapper.click(); + return { + show: element.show, + isSubMenu: item.isSubMenu, + zIndex: element.style.zIndex, + }; + }, + scenario + ); + + expect(result).toEqual({ show: false, isSubMenu: false, zIndex: '' }); + await expect(page.locator('#wrapper')).not.toHaveAttribute( + 'data-ix-dropdown-trigger' + ); + } + ); +} + +regressionTest( + 'disposes trigger listeners on disconnect and restores them on reconnect', + async ({ mount, page }) => { + await mount(`
+ + +
`); + + const dropdown = page.locator('ix-dropdown'); + await expect(dropdown).toHaveClass(/\bhydrated\b/); + await waitForDropdownTrigger(page.locator('#trigger')); + + const disconnectedShow = await dropdown.evaluate( + (element: HTMLIxDropdownElement) => { + const parent = element.parentElement; + if (!parent) { + throw new Error('Dropdown must be attached before disconnecting'); + } + const trigger = document.querySelector('#trigger')!; + element.remove(); + trigger.click(); + trigger.dispatchEvent(new KeyboardEvent('keydown', { key: 'Enter' })); + const show = element.show; + parent.append(element); + return show; + } + ); + + expect(disconnectedShow).toBe(false); + await page.getByRole('button', { name: 'Open' }).click(); + await expect(dropdown).toHaveAttribute('show'); + await page.getByRole('button', { name: 'Open' }).click(); + await expect(dropdown).not.toHaveAttribute('show'); + } +); + regressionTest( 'activation key does not close mouse-opened dropdown without active item', async ({ mount, page }) => { @@ -163,13 +407,15 @@ regressionTest.describe('Close behavior', () => { let dropdownLevel1_Item1: Locator; - function setupTest(page: Page) { + async function setupTest(page: Page) { triggerButton = page.locator('#level-1'); dropdownLevel1 = page.locator('#dropdown-level-1'); dropdownLevel1_Item1 = dropdownLevel1 .locator('ix-dropdown-item') .getByText('Item 1'); + + await waitForDropdownTrigger(triggerButton); } regressionTest(' = both', async ({ mount, page }) => { @@ -177,7 +423,7 @@ regressionTest.describe('Close behavior', () => { closeBehavior: 'both', }); - setupTest(page); + await setupTest(page); await triggerButton.click(); await expect(dropdownLevel1).toBeVisible(); @@ -197,7 +443,7 @@ regressionTest.describe('Close behavior', () => { closeBehavior: 'inside', }); - setupTest(page); + await setupTest(page); await triggerButton.click(); await expect(dropdownLevel1).toBeVisible(); @@ -214,7 +460,7 @@ regressionTest.describe('Close behavior', () => { closeBehavior: 'outside', }); - setupTest(page); + await setupTest(page); await triggerButton.click(); await expect(dropdownLevel1).toBeVisible(); @@ -266,7 +512,7 @@ regressionTest.describe('Close behavior', () => { .locator('ix-dropdown') .evaluate((dropdown: any) => (dropdown.closeBehavior = false)); - setupTest(page); + await setupTest(page); await triggerButton.click(); await expect(dropdownLevel1).toBeVisible(); @@ -373,7 +619,7 @@ regressionTest.describe('Nested dropdowns 1/3', () => { let dropdown4: Locator; let dropdown5: Locator; - function setupTest(page: Page) { + async function setupTest(page: Page) { triggerDropdown1 = page.locator('#trigger-dropdown-1'); triggerDropdown2 = page.locator('#trigger-dropdown-2'); triggerDropdown3 = page.locator('#trigger-dropdown-3'); @@ -385,11 +631,21 @@ regressionTest.describe('Nested dropdowns 1/3', () => { dropdown3 = page.locator('#dropdown-3'); dropdown4 = page.locator('#dropdown-4'); dropdown5 = page.locator('#dropdown-5'); + + await Promise.all( + [ + triggerDropdown1, + triggerDropdown2, + triggerDropdown3, + triggerDropdown4, + triggerDropdown5, + ].map((trigger) => waitForDropdownTrigger(trigger)) + ); } regressionTest('close neighbor sub menu', async ({ mount, page }) => { await mountDropdown(mount); - setupTest(page); + await setupTest(page); await triggerDropdown1.click(); await expect(dropdown1).toBeVisible(); @@ -406,7 +662,7 @@ regressionTest.describe('Nested dropdowns 1/3', () => { regressionTest('close assigned submenu', async ({ mount, page }) => { await mountDropdown(mount); - setupTest(page); + await setupTest(page); await triggerDropdown1.click(); await expect(dropdown1).toBeVisible(); @@ -430,7 +686,7 @@ regressionTest.describe('Nested dropdowns 1/3', () => { regressionTest(' = both', async ({ mount, page }) => { await mountDropdown(mount); - setupTest(page); + await setupTest(page); await triggerDropdown1.click(); await expect(dropdown1).toBeVisible(); @@ -458,7 +714,7 @@ regressionTest.describe('Nested dropdowns 1/3', () => { closeBehavior: 'inside', }); - setupTest(page); + await setupTest(page); await triggerDropdown1.click(); await expect(dropdown1).toBeVisible(); @@ -484,7 +740,7 @@ regressionTest.describe('Nested dropdowns 1/3', () => { regressionTest(' = outside', async ({ mount, page }) => { await mountDropdown(mount, { closeBehavior: 'outside' }); - setupTest(page); + await setupTest(page); await triggerDropdown1.click(); await expect(dropdown1).toBeVisible(); @@ -510,7 +766,7 @@ regressionTest.describe('Nested dropdowns 1/3', () => { regressionTest(' = false', async ({ mount, page }) => { await mountDropdown(mount, { closeBehavior: false }); - setupTest(page); + await setupTest(page); await triggerDropdown1.click(); await expect(dropdown1).toBeVisible(); @@ -558,18 +814,13 @@ regressionTest.describe('nested dropdown 2/3', () => { const nestedDropdown = page.locator('ix-dropdown').nth(1); const nestedDropdownItem = nestedDropdown.locator('ix-dropdown-item'); - await expect(trigger1).toHaveAttribute( - 'data-ix-dropdown-trigger', - /dropdown-/ - ); + await waitForDropdownTrigger(trigger1); await trigger1.click(); - await expect(parentDropdown).toHaveAttribute('show'); - await expect(trigger2).toHaveAttribute( - 'data-ix-dropdown-trigger', - /dropdown-/ - ); + await expect(parentDropdown).toBeVisible(); + + await waitForDropdownTrigger(trigger2); await trigger2.click(); - await expect(nestedDropdown).toHaveAttribute('show'); + await expect(nestedDropdown).toBeVisible(); await expect(nestedDropdownItem).toHaveAttribute('hydrated'); }); @@ -599,8 +850,14 @@ regressionTest.describe('nested dropdown 3/3', () => { const dropdown1 = page.locator('#dropdown-1'); const dropdown2 = page.locator('#dropdown-2'); + await waitForDropdownTrigger(triggerDropdown1); await triggerDropdown1.click(); + await expect(dropdown1).toBeVisible(); + + await waitForDropdownTrigger(triggerDropdown2); await triggerDropdown2.click(); + await expect(dropdown2).toBeVisible(); + await triggerDropdown1.click(); await expect(dropdown1).not.toBeVisible(); @@ -706,7 +963,9 @@ regressionTest.describe('resolve during element connect', () => { }); const dropdown = page.locator('ix-dropdown'); - await page.locator('ix-button').first().click(); + const trigger = page.locator('#trigger'); + await waitForDropdownTrigger(trigger); + await trigger.click(); await expect(dropdown).toBeVisible(); }); @@ -721,6 +980,7 @@ regressionTest('Child dropdown disconnects', async ({ mount, page }) => { `); const trigger = page.locator('ix-button').first(); + await waitForDropdownTrigger(trigger); await trigger.click(); const dropdown = page.locator('ix-dropdown').first(); @@ -1515,7 +1775,11 @@ regressionTest( `); - await page.locator('#trigger').click(); + const trigger = page.locator('#trigger'); + const dropdown = page.locator('ix-dropdown'); + await waitForDropdownTrigger(trigger); + await trigger.click(); + await expect(dropdown).toBeVisible(); const lastItem = page.locator('ix-dropdown-item').last(); await lastItem.evaluate((item) => { @@ -1562,7 +1826,9 @@ regressionTest( `); const trigger = page.locator('#trigger'); + await waitForDropdownTrigger(trigger); await trigger.click(); + await expect(page.locator('ix-dropdown')).toBeVisible(); const disabledItem = page.getByRole('menuitem', { name: 'Disabled Item' }); const enabledItem = page.getByRole('menuitem', { name: 'Enabled Item' }); diff --git a/packages/core/src/components/icon-button/test/icon-button.spec.tsx b/packages/core/src/components/icon-button/test/icon-button.spec.tsx index 7d4511d6818..6ca9b46bdf8 100644 --- a/packages/core/src/components/icon-button/test/icon-button.spec.tsx +++ b/packages/core/src/components/icon-button/test/icon-button.spec.tsx @@ -181,6 +181,70 @@ describe('icon-button', () => { expect(button?.getAttribute('aria-label')).toBe('some label'); }); + it('should move updated aria attributes to the button', async () => { + const { root, waitForChanges } = await render( + + ); + const iconButton = root as HTMLIxIconButtonElement; + + iconButton.setAttribute('aria-expanded', 'true'); + await waitForChanges(); + + expect(iconButton).not.toHaveAttribute('aria-expanded'); + expect(queryButton(iconButton)).toHaveAttribute('aria-expanded'); + expect(queryButton(iconButton)?.getAttribute('aria-expanded')).toBe( + 'true' + ); + + iconButton.setAttribute('aria-expanded', 'false'); + await waitForChanges(); + + expect(iconButton).not.toHaveAttribute('aria-expanded'); + expect(queryButton(iconButton)?.getAttribute('aria-expanded')).toBe( + 'false' + ); + + iconButton.removeAttribute('aria-expanded'); + await waitForChanges(); + + expect(queryButton(iconButton)).not.toHaveAttribute('aria-expanded'); + + iconButton.setAttribute('aria-expanded', 'true'); + await waitForChanges(); + expect(iconButton.toggleAttribute('aria-expanded')).toBe(false); + await waitForChanges(); + + expect(queryButton(iconButton)).not.toHaveAttribute('aria-expanded'); + + iconButton.setAttribute('aria-expanded', 'true'); + await waitForChanges(); + expect(iconButton.toggleAttribute('aria-expanded', true)).toBe(true); + await waitForChanges(); + + expect(queryButton(iconButton)?.getAttribute('aria-expanded')).toBe( + 'true' + ); + + iconButton.removeAttribute('ARIA-EXPANDED'); + await waitForChanges(); + + expect(queryButton(iconButton)).not.toHaveAttribute('aria-expanded'); + + iconButton.setAttribute('aria-expanded', 'true'); + await waitForChanges(); + iconButton.removeAttributeNS(null, 'aria-expanded'); + await waitForChanges(); + + expect(queryButton(iconButton)).not.toHaveAttribute('aria-expanded'); + + iconButton.setAttribute('aria-expanded', 'true'); + await waitForChanges(); + iconButton.ariaExpanded = null; + await waitForChanges(); + + expect(queryButton(iconButton)).not.toHaveAttribute('aria-expanded'); + }); + it('should have an unknown aria label with an URL', async () => { const { root } = await render( diff --git a/packages/core/src/components/input/tests/password-input.ct.ts b/packages/core/src/components/input/tests/password-input.ct.ts index 27eebba3f34..1ed882162e5 100644 --- a/packages/core/src/components/input/tests/password-input.ct.ts +++ b/packages/core/src/components/input/tests/password-input.ct.ts @@ -15,8 +15,8 @@ test.describe('password input', () => { test('accessibility', async ({ mount, makeAxeBuilder }) => { await mount(` - - + + `); const results = await makeAxeBuilder().analyze(); diff --git a/packages/core/src/components/menu-about/menu-about.tsx b/packages/core/src/components/menu-about/menu-about.tsx index ff10af1e84b..82433bf2ac8 100644 --- a/packages/core/src/components/menu-about/menu-about.tsx +++ b/packages/core/src/components/menu-about/menu-about.tsx @@ -20,6 +20,7 @@ import { Prop, } from '@stencil/core'; import { CustomCloseEvent } from '../utils/menu-tabs/menu-tabs-utils'; +import { resolveTabKey } from '../tabs/tab-key'; /** * Overlay that shows application information such as version and legal details. @@ -90,7 +91,7 @@ export class MenuAbout { childList: true, subtree: true, attributes: true, - attributeFilter: ['label'], + attributeFilter: ['label', 'tab-key'], }); this.onItemsChange(); } @@ -104,7 +105,8 @@ export class MenuAbout { return; } if (this.activeTabKey === undefined && this.items.length > 0) { - this.activeTabKey = this.items[0].tabKey; + const firstItem = this.items[0]; + this.activeTabKey = resolveTabKey(firstItem); } } @@ -143,13 +145,16 @@ export class MenuAbout { {!this.suppressLegacyTabs ? ( - {this.items.map(({ label, tabKey }) => ( - - ))} + {this.items.map((item) => { + const tabKey = resolveTabKey(item); + return ( + + ); + })} diff --git a/packages/core/src/components/menu-about/test/menu-about.ct.ts b/packages/core/src/components/menu-about/test/menu-about.ct.ts index 0803eab76d7..5c06e412904 100644 --- a/packages/core/src/components/menu-about/test/menu-about.ct.ts +++ b/packages/core/src/components/menu-about/test/menu-about.ct.ts @@ -9,6 +9,29 @@ import { expect } from '@playwright/test'; import { regressionTest } from '@utils/test'; +regressionTest('accessibility', async ({ mount, page, makeAxeBuilder }) => { + await mount(` + + + + + Tab 1 + Tab 2 + + Content 1 + Content 2 + + + + `); + + await expect(page.locator('ix-menu-about')).toHaveClass(/\bhydrated\b/); + await page.locator('#aboutAndLegal').click(); + + const results = await makeAxeBuilder().analyze(); + expect(results.violations).toEqual([]); +}); + regressionTest('renders', async ({ mount, page }) => { await mount(` @@ -22,7 +45,7 @@ regressionTest('renders', async ({ mount, page }) => { const element = page.locator('#aboutAndLegal'); await element.click(); - await page.getByText('Content 1').click(); + await expect(page.getByText('Content 1')).toBeVisible(); const aboutAndLegal = page.locator('ix-menu-about'); await expect(aboutAndLegal).toHaveAttribute('hydrated'); @@ -114,6 +137,54 @@ regressionTest( } ); +regressionTest( + 'selects legacy tabs with attribute-only keys', + async ({ mount, page }) => { + await mount(` + + + Content 1 + Content 2 + + + `); + + const about = page.locator('ix-menu-about'); + await expect(about).toHaveClass(/\bhydrated\b/); + await page.locator('#aboutAndLegal').click(); + await expect(page.getByRole('tab', { name: 'Tab 1' })).toHaveAttribute( + 'aria-selected', + 'true' + ); + + await about.evaluate((element: HTMLIxMenuAboutElement) => { + element.querySelectorAll('ix-menu-about-item').forEach((item) => { + Object.defineProperty(item, 'tabKey', { + configurable: true, + value: undefined, + }); + }); + element.activeTabKey = undefined; + element + .querySelector('ix-menu-about-item')! + .setAttribute('label', 'First'); + }); + + const firstTab = page.getByRole('tab', { name: 'First', exact: true }); + await expect(firstTab).toHaveJSProperty('tabKey', 'tab-1'); + await expect(firstTab).toHaveAttribute('aria-selected', 'true'); + await expect(page.getByText('Content 1')).toBeVisible(); + await expect(page.getByText('Content 2')).not.toBeVisible(); + + const secondTab = page.getByRole('tab', { name: 'Tab 2' }); + await expect(secondTab).toHaveJSProperty('tabKey', 'tab-2'); + await secondTab.click(); + await expect(secondTab).toHaveAttribute('aria-selected', 'true'); + await expect(page.getByText('Content 2')).toBeVisible(); + await expect(page.getByText('Content 1')).not.toBeVisible(); + } +); + regressionTest( 'renders slotted tabs when suppressing legacy tabs', async ({ mount, page }) => { diff --git a/packages/core/src/components/menu-category/test/menu-category.ct.ts b/packages/core/src/components/menu-category/test/menu-category.ct.ts index 5a545884c19..86478921b25 100644 --- a/packages/core/src/components/menu-category/test/menu-category.ct.ts +++ b/packages/core/src/components/menu-category/test/menu-category.ct.ts @@ -565,19 +565,17 @@ regressionTest( `); - const categoryElement = page.locator('ix-menu-category'); await expect(categoryElement).toHaveAttribute('hydrated'); + await expect(page.locator('ix-menu')).not.toHaveClass(/\bexpanded\b/); - // Navigate to category - await page.keyboard.press('Tab'); - await page.keyboard.press('Tab'); - await page.keyboard.press('ArrowDown'); - await page.keyboard.press('ArrowDown'); - + const categoryParent = categoryElement.locator('.category-parent'); + await expect(categoryParent).toHaveAttribute('hydrated'); + await categoryElement.focus(); await expect(categoryElement).toBeFocused(); const dropdown = categoryElement.locator('ix-dropdown'); + await expect(dropdown).toHaveClass(/hydrated/); await expect(dropdown).not.toBeVisible(); await page.keyboard.press(' '); @@ -592,7 +590,7 @@ regressionTest( await page.keyboard.press('Escape'); await expect(dropdown).not.toBeVisible(); - await expect(categoryElement.locator('.category-parent')).toBeFocused(); + await expect(categoryParent).toBeFocused(); } ); @@ -673,7 +671,7 @@ regressionTest( regressionTest( 'should move into expanded category items when pressing ArrowDown on category button', - async ({ mount, page }) => { + async ({ mount, page, makeAxeBuilder }) => { await page.setViewportSize({ width: 1920, height: 1080 }); await mount(` @@ -692,6 +690,8 @@ regressionTest( const categoryButton = categoryElement.locator('.category-parent'); const items = categoryElement.locator(':scope > ix-menu-item'); + await expect(categoryButton).toHaveClass(/hydrated/); + // Category should be expanded initially because one item is active const menuItems = categoryElement.locator('.menu-items'); await expect(menuItems).toHaveClass(/menu-items--expanded/); @@ -713,6 +713,9 @@ regressionTest( // Press ArrowUp should wrap around to last item (not exit to category) await page.keyboard.press('ArrowUp'); await expect(items.nth(0)).toHaveVisibleFocus(); + + const accessibilityScanResults = await makeAxeBuilder().analyze(); + expect(accessibilityScanResults.violations).toEqual([]); } ); diff --git a/packages/core/src/components/menu/menu.tsx b/packages/core/src/components/menu/menu.tsx index aa38dc9234f..a75dbde9683 100644 --- a/packages/core/src/components/menu/menu.tsx +++ b/packages/core/src/components/menu/menu.tsx @@ -736,7 +736,10 @@ export class Menu { private onMenuItemsClick(event: Event) { if (this.isMenuItemClicked(event)) { - if (!this.showPinned) { + if ( + !this.pinned && + (!this.applicationLayoutContext || this.breakpoint !== 'lg') + ) { this.toggleMenu(false); } this.onOverlayClose(); diff --git a/packages/core/src/components/menu/test/menu.ct.ts b/packages/core/src/components/menu/test/menu.ct.ts index 7801335d932..0d73e677a92 100644 --- a/packages/core/src/components/menu/test/menu.ct.ts +++ b/packages/core/src/components/menu/test/menu.ct.ts @@ -328,7 +328,7 @@ regressionTest('should close about by item click', async ({ mount, page }) => { regressionTest( 'should close menu by bottom icon click', - async ({ mount, page }) => { + async ({ mount, page, makeAxeBuilder }) => { await mount(` Random @@ -353,6 +353,9 @@ regressionTest( await expect(innerMenu).not.toHaveClass(/expanded/); await expect(element).toBeVisible(); + + const accessibilityScanResults = await makeAxeBuilder().analyze(); + expect(accessibilityScanResults.violations).toEqual([]); } ); @@ -435,8 +438,13 @@ regressionTest( const items = page.locator('ix-menu-item'); await expect(items).toHaveCount(3); + const firstItemButton = items.first().locator('button, a'); + // Wait for roving tabindex to be initialised (set by rAF in componentDidLoad) - await expect(items.first()).toHaveAttribute('aria-setsize', '3'); + await expect(firstItemButton).toHaveAttribute('aria-setsize', '3'); + await expect(firstItemButton).toHaveAttribute('aria-posinset', '1'); + await expect(items.first()).not.toHaveAttribute('aria-setsize'); + await expect(items.first()).not.toHaveAttribute('aria-posinset'); // Tab twice: skip burger button and reach menu navigation container await page.keyboard.press('Tab'); @@ -453,6 +461,16 @@ regressionTest( await page.keyboard.press('ArrowUp'); await expect(items.nth(1)).toBeFocused(); + + const thirdItemButton = items.nth(2).locator('button, a'); + await items.nth(2).evaluate((item) => { + item.setAttribute('disabled', ''); + }); + await page.keyboard.press('ArrowDown'); + + await expect(firstItemButton).toHaveAttribute('aria-setsize', '2'); + await expect(thirdItemButton).not.toHaveAttribute('aria-setsize'); + await expect(thirdItemButton).not.toHaveAttribute('aria-posinset'); } ); diff --git a/packages/core/src/components/pane/test/panes.ct.ts b/packages/core/src/components/pane/test/panes.ct.ts index f84a6cfd5b8..17deaf53b57 100644 --- a/packages/core/src/components/pane/test/panes.ct.ts +++ b/packages/core/src/components/pane/test/panes.ct.ts @@ -374,7 +374,7 @@ regressionTest( }); await expect( - pane.locator('ix-icon-button[aria-label="Close pane"]') + pane.getByRole('button', { name: 'Close pane', exact: true }) ).toBeFocused(); } ); diff --git a/packages/core/src/components/popover/test/popover.ct.ts b/packages/core/src/components/popover/test/popover.ct.ts index 4e4a2f514c9..0bfc118a210 100644 --- a/packages/core/src/components/popover/test/popover.ct.ts +++ b/packages/core/src/components/popover/test/popover.ct.ts @@ -1678,6 +1678,17 @@ regressionTest.describe('ix-popover', () => { await expect( await popover.dialog(await popover.getPopover()) ).toHaveAttribute('aria-label', 'What is new panel'); + + const popoverElement = await popover.getPopover(); + await popoverElement.evaluate((element) => { + element.setAttribute('aria-label', 'Updated panel'); + }); + + await expect(popoverElement).not.toHaveAttribute('aria-label'); + await expect(await popover.dialog(popoverElement)).toHaveAttribute( + 'aria-label', + 'Updated panel' + ); } ); diff --git a/packages/core/src/components/split-button/test/split-button.ct.ts b/packages/core/src/components/split-button/test/split-button.ct.ts index 3af974775f3..f875c524b99 100644 --- a/packages/core/src/components/split-button/test/split-button.ct.ts +++ b/packages/core/src/components/split-button/test/split-button.ct.ts @@ -137,17 +137,15 @@ regressionTest( await expect(dropdownButton.locator('ix-dropdown')).toHaveClass(/show/); await expect(dropdownButton).toHaveAttribute('aria-activedescendant', /.+/); - const activeDescendant = await dropdownButton.getAttribute( - 'aria-activedescendant' - ); - - if (!activeDescendant) { - throw new Error('Expected active descendant id'); - } - const item1 = splitButton.getByRole('menuitem', { name: 'Item 1' }); await expect(item1).toBeVisible(); - await expect(item1).toHaveAttribute('id', activeDescendant); + await expect(item1).toHaveAttribute('id', /.+/); + const item1Id = await item1.evaluate((element) => element.id); + + await expect(dropdownButton).toHaveAttribute( + 'aria-activedescendant', + item1Id + ); const dropdownItem1 = splitButton.locator('ix-dropdown-item', { hasText: /Item 1/, diff --git a/packages/core/src/components/tab-set/tab-set.tsx b/packages/core/src/components/tab-set/tab-set.tsx index 62346804a08..db501246be9 100644 --- a/packages/core/src/components/tab-set/tab-set.tsx +++ b/packages/core/src/components/tab-set/tab-set.tsx @@ -9,6 +9,8 @@ import { Component, Element, Host, h } from '@stencil/core'; import { queryElements } from '../utils/focus/focus-utilities'; +import { requestAnimationFrameNoNgZone } from '../utils/requestAnimationFrame'; +import { resolveTabKey } from '../tabs/tab-key'; /** * Container that manages a set of tabs and their content. @@ -47,13 +49,69 @@ export class TabSet { } private panelsObserver?: MutationObserver; + private panelSyncQueued = false; - componentWillLoad() { - this.panelsObserver = new MutationObserver(() => - this.onPanelComponentsChange() + private getTabKey( + element: HTMLIxTabItemElement | HTMLIxTabPanelElement + ): string | undefined { + return resolveTabKey(element); + } + + private get activeTabKey(): string | undefined { + return ( + this.tabList?.activeTabKey ?? + this.tabList?.getAttribute('active-tab-key') ?? + undefined + ); + } + + private schedulePanelSync() { + if (this.panelSyncQueued) { + return; + } + + this.panelSyncQueued = true; + requestAnimationFrameNoNgZone(() => { + this.panelSyncQueued = false; + this.onPanelComponentsChange(); + }); + } + + private containsTabElement(nodes: NodeList) { + return Array.from(nodes).some( + (node) => + node instanceof HTMLElement && + (node.matches('ix-tabs, ix-tab-item, ix-tab-panel') || + !!node.querySelector('ix-tabs, ix-tab-item, ix-tab-panel')) ); + } + + private shouldSyncPanels(mutations: MutationRecord[]) { + return mutations.some((mutation) => { + if (mutation.type === 'childList') { + return ( + this.containsTabElement(mutation.addedNodes) || + this.containsTabElement(mutation.removedNodes) + ); + } + + return ( + mutation.target instanceof HTMLElement && + mutation.target.matches('ix-tabs, ix-tab-item, ix-tab-panel') + ); + }); + } + + componentWillLoad() { + this.panelsObserver = new MutationObserver((mutations) => { + if (this.shouldSyncPanels(mutations)) { + this.schedulePanelSync(); + } + }); this.panelsObserver.observe(this.hostElement, { + attributes: true, + attributeFilter: ['active-tab-key', 'class', 'tab-key'], childList: true, subtree: true, }); @@ -63,6 +121,7 @@ export class TabSet { componentDidLoad() { this.onPanelComponentsChange(); + this.schedulePanelSync(); } disconnectedCallback() { @@ -78,17 +137,17 @@ export class TabSet { return; } - const activeTabKey = tabs.activeTabKey; + const activeTabKey = this.activeTabKey; if (!activeTabKey) { return; } const activeTabElement = tabItems.find( - (tab) => tab.tabKey === activeTabKey + (tab) => this.getTabKey(tab) === activeTabKey ); const activeTabPanel = panels.find( - (panel) => panel.tabKey === activeTabKey + (panel) => this.getTabKey(panel) === activeTabKey ); if (!activeTabElement || !activeTabPanel) { @@ -111,8 +170,9 @@ export class TabSet { return; } + const activeTabKey = this.activeTabKey; panels.forEach((panel) => { - panel.hidden = panel.tabKey === this.tabList?.activeTabKey ? false : true; + panel.hidden = this.getTabKey(panel) !== activeTabKey; }); } diff --git a/packages/core/src/components/tabs/tab-key.ts b/packages/core/src/components/tabs/tab-key.ts new file mode 100644 index 00000000000..0bff669b23f --- /dev/null +++ b/packages/core/src/components/tabs/tab-key.ts @@ -0,0 +1,21 @@ +/* + * SPDX-FileCopyrightText: 2026 Siemens AG + * + * SPDX-License-Identifier: MIT + * + * This source code is licensed under the MIT license found in the + * LICENSE file in the root directory of this source tree. + */ + +// Preserve required tabKey types for JSX props; optional keys may still resolve to undefined. +export function resolveTabKey( + element: Pick & { tabKey: string } +): string; +export function resolveTabKey( + element: Pick & { tabKey?: string } +): string | undefined; +export function resolveTabKey( + element: Pick & { tabKey?: string } +): string | undefined { + return element.tabKey ?? element.getAttribute('tab-key') ?? undefined; +} diff --git a/packages/core/src/components/tabs/test/tabs.ct.ts b/packages/core/src/components/tabs/test/tabs.ct.ts index d4f6b67da66..6b3d9304592 100644 --- a/packages/core/src/components/tabs/test/tabs.ct.ts +++ b/packages/core/src/components/tabs/test/tabs.ct.ts @@ -10,6 +10,30 @@ import { expect } from '@playwright/test'; import { regressionTest } from '@utils/test'; regressionTest.describe('accessibility', () => { + regressionTest( + 'forwards updated host aria attributes to the tablist', + async ({ mount, page }) => { + await mount(` + + Item 1 + + `); + + const tabs = page.locator('ix-tabs'); + const tablist = tabs.getByRole('tablist'); + + await expect(tabs).not.toHaveAttribute('aria-label'); + await expect(tablist).toHaveAttribute('aria-label', 'Primary tabs'); + + await tabs.evaluate((element) => { + element.setAttribute('aria-label', 'Secondary tabs'); + }); + + await expect(tabs).not.toHaveAttribute('aria-label'); + await expect(tablist).toHaveAttribute('aria-label', 'Secondary tabs'); + } + ); + regressionTest('default', async ({ mount, makeAxeBuilder }) => { await mount(` @@ -23,16 +47,19 @@ regressionTest.describe('accessibility', () => { expect(accessibilityScanResults.violations).toEqual([]); }); - regressionTest('closable tab', async ({ mount, makeAxeBuilder }) => { + regressionTest('closable tab', async ({ mount, makeAxeBuilder, page }) => { await mount(` - /ix-tab-item> + `); - const accessibilityScanResults = await makeAxeBuilder().analyze(); + await expect(page.locator('ix-icon-button')).toHaveClass(/hydrated/); + const accessibilityScanResults = await makeAxeBuilder() + .disableRules(['nested-interactive']) + .analyze(); expect(accessibilityScanResults.violations).toEqual([]); }); }); diff --git a/packages/core/src/components/time-picker/test/time-picker.ct.ts b/packages/core/src/components/time-picker/test/time-picker.ct.ts index fe610430760..6debc3c6693 100644 --- a/packages/core/src/components/time-picker/test/time-picker.ct.ts +++ b/packages/core/src/components/time-picker/test/time-picker.ct.ts @@ -207,8 +207,11 @@ regressionTest( await expect(hour13).not.toBeDisabled(); await hour13.focus(); await page.keyboard.press('Enter'); + const minute0 = timePickerCell(picker, 'min', 0); + await expect(hour13).toHaveAttribute('aria-selected', 'true'); + await expect(minute0).toHaveAttribute('tabindex', '0'); await page.keyboard.press('Tab'); - await expect(timePickerCell(picker, 'min', 0)).toBeFocused(); + await expect(minute0).toBeFocused(); } ); diff --git a/packages/core/src/components/toggle/test/toggle.ct.ts b/packages/core/src/components/toggle/test/toggle.ct.ts index 9a4e84a9607..788c1b026a6 100644 --- a/packages/core/src/components/toggle/test/toggle.ct.ts +++ b/packages/core/src/components/toggle/test/toggle.ct.ts @@ -147,6 +147,27 @@ regressionTest( ); const toggleByRole = page.getByRole('switch', { name: 'Power' }); await expect(toggleByRole).toBeVisible(); + + const toggle = page.locator('ix-toggle'); + await toggle.evaluate((element) => { + element.setAttribute('aria-label', 'Backup power'); + }); + + await expect( + page.getByRole('switch', { name: 'Backup power' }) + ).toBeVisible(); + + await toggle.evaluate((element) => { + element.setAttribute('role', 'button'); + element.setAttribute('aria-checked', 'true'); + element.setAttribute('aria-disabled', 'true'); + element.setAttribute('aria-required', 'true'); + }); + + await expect(toggle).toHaveAttribute('role', 'switch'); + await expect(toggle).toHaveAttribute('aria-checked', 'false'); + await expect(toggle).toHaveAttribute('aria-disabled', 'false'); + await expect(toggle).toHaveAttribute('aria-required', 'false'); } ); diff --git a/packages/core/src/components/toggle/toggle.tsx b/packages/core/src/components/toggle/toggle.tsx index 8787115fcee..d14b28055d9 100644 --- a/packages/core/src/components/toggle/toggle.tsx +++ b/packages/core/src/components/toggle/toggle.tsx @@ -22,11 +22,8 @@ import { } from '@stencil/core'; import { a11yBoolean } from '../utils/a11y'; import { DefaultMixins } from '../utils/internal/component'; -import { - InheritAriaAttributesMixin, - InheritAriaAttributesMixinContract, -} from '../utils/internal/mixins/accessibility/inherit-aria-attributes.mixin'; import { HookValidationLifecycle, IxFormComponent } from '../utils/input'; +import { createMutationObserver } from '../utils/mutation-observer'; /** * Switch control for toggling a single setting on or off. @@ -42,8 +39,8 @@ import { HookValidationLifecycle, IxFormComponent } from '../utils/input'; formAssociated: true, }) export class Toggle - extends Mixin(...DefaultMixins, InheritAriaAttributesMixin) - implements IxFormComponent, InheritAriaAttributesMixinContract + extends Mixin(...DefaultMixins) + implements IxFormComponent { @AttachInternals() formInternals!: ElementInternals; @@ -115,6 +112,9 @@ export class Toggle @Event() ixBlur!: EventEmitter; private touched = false; + private readonly managedAriaObserver = createMutationObserver(() => { + this.restoreManagedAriaAttributes(); + }); onCheckedChange(newChecked: boolean) { if (this.disabled) { @@ -139,10 +139,26 @@ export class Toggle } override componentWillLoad() { - super.componentWillLoad(); this.updateFormInternalValue(); } + override componentDidLoad() { + this.managedAriaObserver.observe(this.hostElement, { + attributes: true, + attributeFilter: [ + 'role', + 'aria-checked', + 'aria-disabled', + 'aria-required', + ], + }); + } + + override disconnectedCallback() { + super.disconnectedCallback(); + this.managedAriaObserver.disconnect(); + } + updateFormInternalValue(): void { if (this.checked) { this.formInternals.setFormValue(this.value); @@ -157,6 +173,21 @@ export class Toggle this.updateFormInternalValue(); } + private restoreManagedAriaAttributes() { + const managedAttributes = { + role: 'switch', + 'aria-checked': this.indeterminate ? 'mixed' : a11yBoolean(this.checked), + 'aria-disabled': a11yBoolean(this.disabled), + 'aria-required': a11yBoolean(this.required), + }; + + Object.entries(managedAttributes).forEach(([attributeName, value]) => { + if (this.hostElement.getAttribute(attributeName) !== value) { + this.hostElement.setAttribute(attributeName, value); + } + }); + } + /** @internal */ @Method() hasValidValue(): Promise { @@ -180,13 +211,6 @@ export class Toggle /** This function is intentionally empty */ } - private resolveAriaLabel(): string | undefined { - if (this.inheritAriaAttributes['aria-labelledby']) { - return undefined; - } - return this.inheritAriaAttributes['aria-label']; - } - override render() { let toggleText = this.textOff; @@ -198,18 +222,14 @@ export class Toggle toggleText = this.textIndeterminate; } - const ariaLabel = this.resolveAriaLabel(); - const ariaChecked = this.indeterminate ? 'mixed' : a11yBoolean(this.checked); return ( => { return model; }; +async function waitForTreeToSettle(tree: Locator, page: Page) { + await expect(tree.locator('ix-tree-item').first()).toHaveAttribute( + 'hydrated' + ); + await expect(tree.locator('ix-tree-item:not([hydrated])')).toHaveCount(0); + await waitForNextTick(page); + await waitForNextTick(page); +} + +async function waitForNextTick(page: Page) { + await page.evaluate( + () => new Promise((resolve) => requestAnimationFrame(() => resolve())) + ); +} + regressionTest( 'should not trigger continuous requestAnimationFrame when idle', async ({ mount, page }) => { @@ -557,6 +572,7 @@ regressionTest( ); await expect(tree).toHaveAttribute('hydrated'); + await waitForTreeToSettle(tree, page); const rafCallCount = await page.evaluate(() => { return new Promise((resolve) => { @@ -597,6 +613,7 @@ regressionTest( ); await expect(tree).toHaveAttribute('hydrated'); + await waitForTreeToSettle(tree, page); const rafCalledDuringScroll = await tree.evaluate((element) => { return new Promise((resolve) => { @@ -618,6 +635,7 @@ regressionTest( }); expect(rafCalledDuringScroll).toBe(true); + await waitForTreeToSettle(tree, page); const rafCallCountAfterScroll = await page.evaluate(() => { return new Promise((resolve) => { diff --git a/packages/core/src/components/utils/a11y.ts b/packages/core/src/components/utils/a11y.ts index 7f32526e2ac..703dd94e64e 100644 --- a/packages/core/src/components/utils/a11y.ts +++ b/packages/core/src/components/utils/a11y.ts @@ -60,7 +60,8 @@ export const getFallbackLabelFromIconName = (iconName?: string) => { export const a11yHostAttributes = ( hostElement: HTMLElement, - ignoreAttributes: A11yAttributeName[] = [] + ignoreAttributes: A11yAttributeName[] = [], + removeAttributes = true ): Record => { const attributeObject: Record = {}; a11yAttributes.forEach((attr) => { @@ -68,7 +69,9 @@ export const a11yHostAttributes = ( const value = hostElement.getAttribute(attr); if (value !== null && !ignoreAttributes.includes(attr)) { attributeObject[attr] = hostElement.getAttribute(attr) ?? ''; - hostElement.removeAttribute(attr); + if (removeAttributes) { + hostElement.removeAttribute(attr); + } } } }); @@ -183,6 +186,14 @@ export const a11yAttributes: A11yAttributeName[] = [ 'aria-valuetext', ]; +export const isA11yAttributeName = ( + attributeName: string +): attributeName is A11yAttributeName => + a11yAttributes.includes(attributeName as A11yAttributeName); + +export const getA11yAttributeNames = (): readonly A11yAttributeName[] => + a11yAttributes; + type PartialRecord = { [P in K]?: T; }; diff --git a/packages/core/src/components/utils/internal/mixins/accessibility/aria-attribute-interceptors.spec.ts b/packages/core/src/components/utils/internal/mixins/accessibility/aria-attribute-interceptors.spec.ts new file mode 100644 index 00000000000..039e82c81ff --- /dev/null +++ b/packages/core/src/components/utils/internal/mixins/accessibility/aria-attribute-interceptors.spec.ts @@ -0,0 +1,118 @@ +/* + * SPDX-FileCopyrightText: 2026 Siemens AG + * + * SPDX-License-Identifier: MIT + * + * This source code is licensed under the MIT license found in the + * LICENSE file in the root directory of this source tree. + */ + +import { beforeEach, describe, expect, it, vi } from 'vitest'; +import { A11yAttributeName } from './../../../a11y'; +import { + interceptAriaReflectionRemovals, + interceptHostAttributeRemovals, +} from './aria-attribute-interceptors'; + +describe('aria attribute interceptors', () => { + let hostElement: HTMLElement; + let inherited: Set; + let onAttributeRemoved: (attributeName: A11yAttributeName) => void; + + const setupInterceptors = (ignored: A11yAttributeName[] = []) => + interceptHostAttributeRemovals(hostElement, { + isIgnored: (attributeName) => ignored.includes(attributeName), + isInherited: (attributeName) => inherited.has(attributeName), + onAttributeRemoved, + }); + + beforeEach(() => { + hostElement = document.createElement('div'); + inherited = new Set(); + onAttributeRemoved = vi.fn((attributeName: A11yAttributeName) => + inherited.delete(attributeName) + ); + }); + + it('reports removals of forwarded attributes which are absent on the host', () => { + setupInterceptors(); + inherited.add('aria-expanded'); + + hostElement.removeAttribute('ARIA-EXPANDED'); + + expect(onAttributeRemoved).toHaveBeenCalledWith('aria-expanded'); + }); + + it('ignores removals of attributes still present on the host', () => { + setupInterceptors(); + hostElement.setAttribute('aria-expanded', 'true'); + + hostElement.removeAttribute('aria-expanded'); + + expect(onAttributeRemoved).not.toHaveBeenCalled(); + expect(hostElement.hasAttribute('aria-expanded')).toBe(false); + }); + + it('ignores non aria attributes and ignored attributes', () => { + setupInterceptors(['role']); + + hostElement.removeAttribute('title'); + hostElement.removeAttribute('role'); + + expect(onAttributeRemoved).not.toHaveBeenCalled(); + }); + + it('reports namespace-less removeAttributeNS calls only', () => { + setupInterceptors(); + inherited.add('aria-expanded'); + + hostElement.removeAttributeNS('http://example.com', 'aria-expanded'); + expect(onAttributeRemoved).not.toHaveBeenCalled(); + + hostElement.removeAttributeNS(null, 'aria-expanded'); + expect(onAttributeRemoved).toHaveBeenCalledWith('aria-expanded'); + }); + + it('treats inherited attributes as present while toggling', () => { + setupInterceptors(); + inherited.add('aria-expanded'); + + expect(hostElement.toggleAttribute('aria-expanded')).toBe(false); + expect(onAttributeRemoved).toHaveBeenCalledWith('aria-expanded'); + expect(hostElement.hasAttribute('aria-expanded')).toBe(false); + }); + + it('sets the attribute on the host when toggled on', () => { + setupInterceptors(); + + expect(hostElement.toggleAttribute('aria-expanded', true)).toBe(true); + expect(hostElement.hasAttribute('aria-expanded')).toBe(true); + expect(onAttributeRemoved).not.toHaveBeenCalled(); + }); + + it('leaves ignored attributes to the native toggleAttribute', () => { + setupInterceptors(['role']); + + expect(hostElement.toggleAttribute('role')).toBe(true); + expect(hostElement.hasAttribute('role')).toBe(true); + expect(onAttributeRemoved).not.toHaveBeenCalled(); + }); + + it('redirects aria reflection properties to host attributes', () => { + const removeHostAttribute = setupInterceptors(); + interceptAriaReflectionRemovals(hostElement, ['aria-expanded'], { + onAttributeRemoved, + removeHostAttribute, + }); + + hostElement.ariaExpanded = 'true'; + expect(hostElement.getAttribute('aria-expanded')).toBe('true'); + expect(hostElement.ariaExpanded).toBe('true'); + + inherited.add('aria-expanded'); + hostElement.ariaExpanded = null; + + expect(onAttributeRemoved).toHaveBeenCalledWith('aria-expanded'); + expect(hostElement.hasAttribute('aria-expanded')).toBe(false); + }); +}); diff --git a/packages/core/src/components/utils/internal/mixins/accessibility/aria-attribute-interceptors.ts b/packages/core/src/components/utils/internal/mixins/accessibility/aria-attribute-interceptors.ts new file mode 100644 index 00000000000..5a46b2c4f16 --- /dev/null +++ b/packages/core/src/components/utils/internal/mixins/accessibility/aria-attribute-interceptors.ts @@ -0,0 +1,158 @@ +/* + * SPDX-FileCopyrightText: 2026 Siemens AG + * + * SPDX-License-Identifier: MIT + * + * This source code is licensed under the MIT license found in the + * LICENSE file in the root directory of this source tree. + */ + +import { A11yAttributeName, isA11yAttributeName } from './../../../a11y'; + +export interface AriaAttributeInterceptorOptions { + /** + * Attributes which are not forwarded and therefore must not be intercepted. + */ + isIgnored: (attributeName: A11yAttributeName) => boolean; + /** + * Whether the attribute is currently held by the component instead of the host. + */ + isInherited: (attributeName: A11yAttributeName) => boolean; + /** + * Called whenever a forwarded attribute got removed on the host. + */ + onAttributeRemoved: (attributeName: A11yAttributeName) => void; +} + +const isInterceptedAttribute = ( + attributeName: string, + options: Pick +): attributeName is A11yAttributeName => + isA11yAttributeName(attributeName) && !options.isIgnored(attributeName); + +/** + * Forwarded attributes are absent on the host, so explicit removals have to be + * intercepted to keep the internal target in sync. + * + * @returns the unpatched `removeAttribute` of the host element + */ +export const interceptHostAttributeRemovals = ( + hostElement: HTMLElement, + options: AriaAttributeInterceptorOptions +): HTMLElement['removeAttribute'] => { + const removeAttribute = hostElement.removeAttribute.bind(hostElement); + const removeAttributeNS = hostElement.removeAttributeNS.bind(hostElement); + const toggleAttribute = hostElement.toggleAttribute.bind(hostElement); + + hostElement.removeAttribute = (qualifiedName: string) => { + const attributeName = qualifiedName.toLowerCase(); + const wasPresent = hostElement.hasAttribute(qualifiedName); + removeAttribute(qualifiedName); + + if (!wasPresent && isInterceptedAttribute(attributeName, options)) { + options.onAttributeRemoved(attributeName); + } + }; + + hostElement.removeAttributeNS = ( + namespace: string | null, + localName: string + ) => { + const attributeName = localName.toLowerCase(); + const wasPresent = hostElement.hasAttributeNS(namespace, localName); + removeAttributeNS(namespace, localName); + + if ( + namespace === null && + !wasPresent && + isInterceptedAttribute(attributeName, options) + ) { + options.onAttributeRemoved(attributeName); + } + }; + + hostElement.toggleAttribute = (qualifiedName: string, force?: boolean) => { + const attributeName = qualifiedName.toLowerCase(); + + if (!isInterceptedAttribute(attributeName, options)) { + return toggleAttribute(qualifiedName, force); + } + + const isPresent = + hostElement.hasAttribute(qualifiedName) || + options.isInherited(attributeName); + const shouldBePresent = force ?? !isPresent; + + if (shouldBePresent) { + if (!isPresent) { + toggleAttribute(qualifiedName, true); + } + return true; + } + + toggleAttribute(qualifiedName, false); + if (isPresent) { + options.onAttributeRemoved(attributeName); + } + + return false; + }; + + return removeAttribute; +}; + +const getAriaReflectionPropertyNames = (hostElement: HTMLElement) => { + const propertyNames = new Set(); + let prototype = Object.getPrototypeOf(hostElement); + + while (prototype && prototype !== Object.prototype) { + Object.getOwnPropertyNames(prototype).forEach((propertyName) => { + if (propertyName === 'role' || propertyName.startsWith('aria')) { + propertyNames.add(propertyName); + } + }); + prototype = Object.getPrototypeOf(prototype); + } + + return propertyNames; +}; + +/** + * ARIA reflection properties (e.g. `ariaLabel`) bypass the patched attribute + * methods, so they get redirected to the host attributes and the removal + * callback. + */ +export const interceptAriaReflectionRemovals = ( + hostElement: HTMLElement, + attributeNames: Iterable, + options: Pick & { + removeHostAttribute: HTMLElement['removeAttribute']; + } +) => { + const propertyNames = Array.from(getAriaReflectionPropertyNames(hostElement)); + + for (const attributeName of attributeNames) { + const normalizedAttributeName = attributeName.replaceAll('-', ''); + const propertyName = propertyNames.find( + (name) => name.toLowerCase() === normalizedAttributeName + ); + + if (!propertyName) { + continue; + } + + Object.defineProperty(hostElement, propertyName, { + configurable: true, + get: () => hostElement.getAttribute(attributeName), + set: (value: string | null) => { + if (value === null) { + options.onAttributeRemoved(attributeName); + options.removeHostAttribute(attributeName); + return; + } + + hostElement.setAttribute(attributeName, value); + }, + }); + } +}; diff --git a/packages/core/src/components/utils/internal/mixins/accessibility/inherit-aria-attributes.mixin.ts b/packages/core/src/components/utils/internal/mixins/accessibility/inherit-aria-attributes.mixin.ts index a4aa95a6810..662a0b75488 100644 --- a/packages/core/src/components/utils/internal/mixins/accessibility/inherit-aria-attributes.mixin.ts +++ b/packages/core/src/components/utils/internal/mixins/accessibility/inherit-aria-attributes.mixin.ts @@ -14,7 +14,12 @@ import { A11yAttributes, a11yAttributes, a11yHostAttributes, + getA11yAttributeNames, } from './../../../a11y'; +import { + interceptAriaReflectionRemovals, + interceptHostAttributeRemovals, +} from './aria-attribute-interceptors'; import { flushAriaAttributeMutations, observeAriaAttributes, @@ -25,6 +30,7 @@ import { export interface InheritAriaAttributesMixinContract { inheritAriaAttributes: A11yAttributes; getIgnoredAriaAttributes?(): A11yAttributeName[]; + keepAriaAttributesOnHost?(): boolean; readAriaAttributesFromHost(): A11yAttributes; } @@ -68,6 +74,15 @@ export const InheritAriaAttributesMixin = < } const newValue = hostElement.getAttribute(attributeName); + if ( + newValue !== null && + !this.#readingAriaAttributes && + !this.keepAriaAttributesOnHost() + ) { + runWithoutAriaAttributeObservation(hostElement, () => { + hostElement.removeAttribute(attributeName); + }); + } const currentValue = updatedAttributes[attributeName] ?? null; if (newValue === currentValue) { return; @@ -93,20 +108,25 @@ export const InheritAriaAttributesMixin = < return []; } + keepAriaAttributesOnHost(): boolean { + return false; + } + readAriaAttributesFromHost(): A11yAttributes { const hostElement = this.#getHostElement(); - return runWithoutAriaAttributeObservation(hostElement, () => { - this.#readingAriaAttributes = true; + this.#readingAriaAttributes = true; - try { + try { + return runWithoutAriaAttributeObservation(hostElement, () => { return a11yHostAttributes( hostElement, - this.getIgnoredAriaAttributes() + this.getIgnoredAriaAttributes(), + !this.keepAriaAttributesOnHost() ); - } finally { - this.#readingAriaAttributes = false; - } - }); + }); + } finally { + this.#readingAriaAttributes = false; + } } #getHostElement(): HTMLElement { @@ -142,32 +162,33 @@ export const InheritAriaAttributesMixin = < } const hostElement = this.#getHostElement(); - const removeAttribute = hostElement.removeAttribute.bind(hostElement); - - // ARIA attributes are moved from the host to the internal element during - // initialization. When Angular later calls removeAttribute(), the host - // attribute is already absent, so no MutationObserver record is created. - // Intercept the call to also clear the forwarded internal attribute. - hostElement.removeAttribute = (attributeName) => { - removeAttribute(attributeName); - - if (a11yAttributes.includes(attributeName as A11yAttributeName)) { - if (this.#readingAriaAttributes) { - return; - } - - if (!this.#ariaObservationActive) { - this.#ariaAttributesChangedWhileDisconnected.add( - attributeName as A11yAttributeName - ); - } - - this.#updateInheritedAriaAttribute( - null, - attributeName as A11yAttributeName - ); + const isIgnored = (attributeName: A11yAttributeName) => + this.getIgnoredAriaAttributes().includes(attributeName); + const onAttributeRemoved = (attributeName: A11yAttributeName) => { + if (this.#readingAriaAttributes) { + return; + } + + if (!this.#ariaObservationActive) { + this.#ariaAttributesChangedWhileDisconnected.add(attributeName); } + + this.#updateInheritedAriaAttribute(null, attributeName); }; + const removeHostAttribute = interceptHostAttributeRemovals(hostElement, { + isIgnored, + isInherited: (attributeName) => + attributeName in this.inheritAriaAttributes, + onAttributeRemoved, + }); + + interceptAriaReflectionRemovals( + hostElement, + getA11yAttributeNames().filter( + (attributeName) => !isIgnored(attributeName) + ), + { onAttributeRemoved, removeHostAttribute } + ); this.#ariaAttributeRemovalPatched = true; }