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

Ouverte
#3,165 3 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Évaluation

Difficulté
4/5
Temps estimé
1-2 jours
Accessibilité débutants
57/100
Type d'issue
Fonctionnalité
Clarté
Plutôt claire
Activité
Active
Stack technique
typescript

Piste de recherche

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.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

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

Langage dominant
TypeScript
Étoiles
397
Forks
109
Métriques de merge des PR
Aucune PR mergée en 30 j

Préparer son environnement

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de patternfly/patternfly-elements

Toutes les issues de patternfly/patternfly-elements

Issues similaires

Plus d'issues TypeScript

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.