[feat]: add `aria-orientation` support to `TabsAriaController`

Offen
#3,165 3 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
4/5
Geschätzter Aufwand
1-2 Tage
Anfängerfreundlichkeit
57/100
Issue-Typ
Feature
Klarheit
Größtenteils klar
Aktivitätsstatus
Aktiv
Tech-Stack
typescript

Rechercherichtung

Start with core/pfe-core/controllers/tabs-aria-controller.ts and trace how pf-v5-tabs supplies its tablist and vertical state, then check how RovingTabindexController reads orientation. Implementing this spans controller ownership, component wiring, runtime orientation changes, and SSR behavior; the issue names controller tests as the place to cover horizontal, vertical, and switching orientation. Done when the tablist exposes the correct orientation and keyboard navigation follows it.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

accessibility feature priority: low

Summary

TabsAriaController does not set aria-orientation on the tablist, and nothing wires a tabs element's vertical/horizontal state into the accessibility tree.

Current state

TabsAriaController (core/pfe-core/controllers/tabs-aria-controller.ts) only:

  • sets role="tab" and role="tabpanel" on slotted children
  • sets aria-controls and aria-labelledby in hostUpdated()

It never touches the tablist itself. In pf-v5-tabs, the tablist is an inner <div id="tabs" role="tablist"> with no aria-orientation, while the element has a vertical boolean that only drives styling.

// tabs-aria-controller.ts
hostUpdated(): void {
  for (const [tab, panel] of this.#tabPanelMap) {
    panel.setAttribute('aria-labelledby', tab.id);
    tab.setAttribute('aria-controls', panel.id);
  }
}

Problems

  1. Missing ARIA state. A vertical tablist has no aria-orientation="vertical", so assistive tech reports the wrong orientation. Per the ARIA spec, aria-orientation defaults to horizontal on tablist, so a vertical tablist is actively announced incorrectly.

  2. Keyboard behavior is not orientation-aware. ATFocusController.onKeydown reads aria-orientation from the items container to decide which arrow keys move focus:

    const orientation = this.options.getOrientation?.() ?? this
        .#itemsContainerElement
        ?.getAttribute('aria-orientation') as
            'horizontal' | 'vertical' | 'grid' | 'undefined';
    

    Because the tablist never has the attribute and pf-v5-tabs does not pass getOrientation to RovingTabindexController, both Left/Right and Up/Down move focus in a horizontal tablist. The APG tabs pattern expects Left/Right for horizontal tablists and Up/Down for vertical ones.

  3. Duplicated ownership. role="tablist" is hardcoded in the pf-v5-tabs render while the rest of the tabs ARIA is managed by the controller. This split makes it easy for one side to drift from the other.

Proposed direction

  • Add tablist ARIA management to TabsAriaController, including aria-orientation.
  • Accept an orientation source in TabsAriaControllerOptions, for example orientation?: 'horizontal' | 'vertical' or getOrientation?: () => 'horizontal' | 'vertical', and reflect it to aria-orientation on the tablist (omit the attribute for the horizontal default, or set it explicitly, whichever the team prefers).
  • Give the controller a way to reference the tablist element. Since the host is not the tablist in pf-v5-tabs, this likely needs an option such as getTabList?: () => HTMLElement | null, or a documented contract that the host itself carries role="tablist".
  • Feed the same orientation to RovingTabindexController via getOrientation, or rely on the attribute once the controller sets it on the items container.
  • Consider moving role="tablist" ownership into the controller as part of this change.
  • Keep the SSR path safe (isServer guard) and add controller tests covering horizontal, vertical, and switching orientation at runtime.

Impacted components

  • core/pfe-core/controllers/tabs-aria-controller.ts
  • elements/pf-v5-tabs
  • <pf-v6-tabs> implementation in #3040

Related issues

  • #3040

Jira Issue: FELT-5230

Vorherrschende Sprache
TypeScript
Sterne
397
Forks
109
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Entwicklungsumgebung

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus patternfly/patternfly-elements

Alle Issues in patternfly/patternfly-elements

Ähnliche Issues

Weitere Issues zu TypeScript

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.