Gestion du Focus avec Animations CSS
Ce document capture les enseignements tirés de la résolution de problèmes de navigation clavier lorsque des composants flottants (Select, DropdownMenu, Popover) possèdent des animations CSS d'ouverture/fermeture.
Le Problème
Lorsque les éléments de contenu flottant ont des animations CSS qui démarrent avec opacity: 0 (comme les classes animate-in fade-in-0 de Tailwind), le navigateur peut rejeter les appels à element.focus() car l'élément est considéré comme invisible.
Symptômes
- Le composant s'ouvre correctement avec un clic de souris.
- La navigation clavier (flèches, Échap) ne fonctionne pas après une ouverture au clavier.
- Fonctionne parfaitement dans les démos sans classes d'animation.
- Ne fonctionne pas dans les démos avec classes d'animation.
Cause Racine
- Les animations CSS comme
fade-in-0démarrent l'élément avecopacity: 0. - Lorsque
focus()est appelé immédiatement après le rendu, l'élément est encore invisible. - Le navigateur rejette le focus sur les éléments invisibles.
- Le focus reste sur le bouton déclencheur au lieu de se déplacer vers le contenu.
- Les événements clavier vont au déclencheur (qui ne fait rien lorsqu'il est ouvert) au lieu du contenu.
Preuves par le Débogage Console
// Après ouverture du select, les événements clavier vont au déclencheur, pas au contenu :
Document keydown: ArrowDown Target: <button role="combobox" ...>
// L'élément actif est le déclencheur, pas le contenu :
Active: BUTTON summit-select-...-trigger
La Solution
Implémenter un mécanisme de tentatives pour le focus qui permet à l'animation de progresser au-delà de opacity: 0 avant d'abandonner.
Implémentation JavaScript
// src/SummitUI/Scripts/floating.js
/**
* Donne le focus à un élément avec un mécanisme de tentatives pour les éléments animés.
* Les éléments avec des animations CSS démarrant avec opacity:0 peuvent rejeter le focus initialement.
* Cette fonction réessaie jusqu'à 5 fois avec des délais de 20 ms pour permettre à l'animation
* de progresser au-delà de l'état invisible.
* @param {HTMLElement} element - Élément à focaliser
*/
export function focusElement(element) {
if (!element) return;
function tryFocus(attempts) {
element.focus();
// Si le focus n'a pas réussi et qu'il reste des tentatives, réessayer
if (document.activeElement !== element && attempts > 0) {
setTimeout(() => tryFocus(attempts - 1), 20);
}
}
// Première tentative après une frame pour laisser le CSS s'appliquer
requestAnimationFrame(() => tryFocus(5));
}
Points Clés
- Utiliser
requestAnimationFramed'abord - Garantit que le CSS a été appliqué avant de tenter le focus. - Vérifier
document.activeElement- Vérifie si le focus a réellement réussi. - Réessayer avec des délais - Intervalles de 20 ms pour laisser l'animation progresser.
- Tentatives limitées - 5 essais = 100 ms d'attente max, suffisant pour les animations typiques.
- Appliquer à toutes les fonctions de focus - Tant
focusElement(element)quefocusElementById(id)ont besoin de ce modèle.
Fonctions Mises à Jour
floating.js:focusElement(element)- Utilisé par SelectContentfloating.js:focusElementById(elementId)- Utilisé par DropdownMenuContent
Tests
Des sections "Avec Animations" ont été ajoutées aux pages de démonstration de test, ainsi que des tests Playwright correspondants.
Classes CSS d'Animation pour les Tests
/* tests/SummitUI.Tests.Manual/SummitUI.Tests.Manual/wwwroot/app.css */
@keyframes fadeInZoomIn {
from {
opacity: 0;
transform: scale(0.95);
}
to {
opacity: 1;
transform: scale(1);
}
}
@keyframes fadeOutZoomOut {
from {
opacity: 1;
transform: scale(1);
}
to {
opacity: 0;
transform: scale(0.95);
}
}
.animated-content[data-state="open"] {
animation: fadeInZoomIn 150ms ease-out forwards;
}
.animated-content[data-state="closed"] {
animation: fadeOutZoomOut 150ms ease-in forwards;
}
Cas de Test
Pour chaque composant (Select, DropdownMenu, Popover) :
| Test | Ce qu'il Vérifie |
|---|---|
Animated*_ShouldOpen_OnEnterKey | S'ouvre au clavier en présence d'animations. |
Animated*_ShouldNavigate_WithArrowKeys | Les touches fléchées fonctionnent après ouverture animée. |
Animated*_ShouldSelect/Activate_OnEnterKey | Peut sélectionner/activer un élément après ouverture animée. |
Animated*_ShouldClose_OnEscape | Échap déclenche l'animation de fermeture. |
Exécution des Tests d'Animation
dotnet run --project tests/SummitUI.Tests.Playwright -- --treenode-filter '/*/*/*/Animated*'
Fichiers Impliqués
| Fichier | Objectif |
|---|---|
src/SummitUI/Scripts/floating.js | Contient les fonctions focusElement et focusElementById. |
src/SummitUI/Components/Select/SelectContent.cs | Appelle FocusElementAsync à l'ouverture. |
src/SummitUI/Components/DropdownMenu/DropdownMenuContent.cs | Appelle FocusElementByIdAsync pour les éléments du menu. |
src/SummitUI/Components/Popover/PopoverContent.cs | Gère le focus pour le contenu du popover. |
Approches Alternatives Envisagées
- Délai initial plus long - Pourrait utiliser un délai de 50 à 100 ms avant la première tentative de focus, mais ajoute un délai perceptible.
- Focus avant le début de l'animation - Nécessiterait des modifications de l'ordre de rendu, complexe.
- Désactiver l'animation pendant le focus - Provoquerait un défaut visuel.
- Utiliser
visibilityau lieu deopacityen CSS - Nécessiterait des modifications dans la façon dont les animations sont créées.
Le mécanisme de tentatives a été choisi car :
- Il fonctionne avec n'importe quelle durée d'animation.
- Il ne nécessite pas de modifier la création du CSS.
- Il a un impact négligeable sur les performances.
- Il échoue gracieusement si le focus ne réussit jamais.
Modèles Connexes
Ce modèle est similaire à la façon dont bits-ui gère la présence animée dans les composants Svelte. L'idée clé est que les opérations DOM (comme le focus) peuvent devoir attendre que les animations CSS atteignent un état focalisable.