Ajouter la prise en charge de la prévisualisation du geste Retour

**Figure 1** : Aperçu de la prévisualisation du geste Retour sur un téléphone

Android 13 (niveau d'API 33) introduit la prévisualisation du geste Retour pour les appareils Android tels que les téléphones, les grands écrans et les pliables. Cette fonctionnalité fait partie d'une version pluriannuelle. Lorsqu'elle est complètement implémentée, elle permet aux utilisateurs de prévisualiser la destination ou un autre résultat d'un geste Retour avant de l'exécuter complètement. Ils peuvent ainsi décider de continuer ou de rester dans l'affichage actuel.

Par exemple, vous pouvez utiliser le geste Retour pour afficher un aperçu animé de l'écran d'accueil derrière votre application, comme illustré dans la figure 1. À partir d'Android 13, vous pouvez tester cette animation de retour à l'écran d'accueil en activant une option pour les développeurs (comme décrit sur cette page).

La prise en charge de la prévisualisation du geste Retour nécessite la mise à jour de votre application, l'utilisation de OnBackPressedCallback AppCompat 1.6.0-alpha05 (AndroidX) ou d'une API supérieure, ou l'utilisation de la nouvelle API de plate-forme OnBackInvokedCallback. La plupart des applications utilisent l'API AndroidX rétrocompatible.

Cette mise à jour fournit un chemin de migration pour intercepter correctement la navigation vers l'arrière, ce qui implique de remplacer les interceptions de KeyEvent.KEYCODE_BACK et toutes les classes avec des méthodes onBackPressed, telles que Activity et Dialog, par les nouvelles API système Back.

Atelier de programmation et vidéo Google I/O

En plus d'utiliser cette documentation, essayez notre atelier de programmation. Vous y découvrirez un exemple d'implémentation courante de WebView avec gestion de la prévisualisation du geste Retour via les API AndroidX Activity.

Vous pouvez également regarder notre vidéo Google I/O, qui montre d'autres exemples d'implémentation des API AndroidX et de plate-forme.

Mettre à jour une application qui utilise la navigation vers l'arrière par défaut

La mise à jour de votre application pour prendre en charge cette fonctionnalité est simple si votre application ne personnalise pas le comportement de retour (en d'autres termes, si elle laisse le système gérer les retours). Il vous suffit d'activer cette fonctionnalité comme décrit sur cette page.

Si votre application utilise des fragments ou le composant Navigation, passez également à AndroidX Activity 1.6.0-alpha05 ou une version ultérieure.

Mettre à jour une application qui personnalise la navigation vers l'arrière

Si votre application personnalise le comportement de retour, il existe différents chemins de migration selon qu'elle utilise AndroidX ou non, et selon la manière dont elle gère la navigation vers l'arrière.

Votre application utilise AndroidX	Comment votre application gère la navigation vers l'arrière	Processus de migration recommandé (lien sur cette page)
Oui	API AndroidX	Migrer une implémentation existante de navigation vers l'arrière AndroidX
Oui	API de plate-forme non compatibles	Migrer une application AndroidX contenant des API de navigation vers l'arrière non compatibles vers les API AndroidX
Non	API de plate-forme non compatibles, possibilité de migration	Migrer une application qui utilise des API de navigation vers l'arrière non compatibles vers des API de plate-forme
Non	API de plate-forme non compatibles, mais migration impossible	Différer l'activation jusqu'à ce que cette fonctionnalité devienne obligatoire

Migrer une implémentation AndroidX pour la navigation vers l'arrière

Ce cas d'utilisation est le plus courant (et le plus recommandé). Il s'applique aux applications nouvelles ou existantes qui implémentent la gestion de la navigation par gestes personnalisée avec OnBackPressedDispatcher, comme décrit dans la section Personnaliser la navigation vers l'arrière.

Si votre application appartient à cette catégorie, suivez les étapes ci-dessous pour ajouter la prise en charge de la prévisualisation du geste Retour :

Pour vous assurer que les API qui utilisent déjà des API OnBackPressedDispatcher (comme les fragments et le composant Navigation) fonctionnent de manière fluide avec la prévisualisation du geste Retour, passez à AndroidX Activity 1.6.0-alpha05.
```
// In your build.gradle file:
dependencies {

// Add this in addition to your other dependencies
implementation "androidx.activity:activity:1.6.0-alpha05"
```
Activez la prévisualisation du geste Retour, comme décrit sur cette page.

Migrer une application AndroidX contenant des API de navigation vers l'arrière non compatibles vers les API AndroidX

Si votre application utilise des bibliothèques AndroidX, mais implémente ou fait référence à des API de navigation vers l'arrière non compatibles, vous devrez migrer vers les API AndroidX pour prendre en charge le nouveau comportement.

Pour migrer des API non compatibles vers les API AndroidX :

Migrez la logique de traitement des retours système vers OnBackPressedDispatcher d'AndroidX avec l'implémentation de OnBackPressedCallback. Pour en savoir plus, consultez la page Personnaliser la navigation vers l'arrière.
Désactivez OnBackPressedCallback lorsque vous êtes prêt à arrêter l'interception du geste de retour.
Arrêtez toute interception d'événements de retour via OnBackPressed ou KeyEvent.KEYCODE_BACK.

Veillez à passer à AndroidX Activity 1.6.0-alpha05.

// In your build.gradle file:
dependencies {

// Add this in addition to your other dependencies
implementation "androidx.activity:activity:1.6.0-alpha05"

Une fois la migration de votre application effectuée, activez la prévisualisation du geste Retour (comme décrit sur cette page) pour voir l'animation système de retour à la page d'accueil.

Remarque : OnBackPressedCallback est toujours appelé, quelle que soit la valeur d'android:enableOnBackInvokedCallback. En d'autres termes, la désactivation de l'animation système n'affecte pas la logique de traitement des retours système de votre application si elle utilise OnBackPressedCallback.

Migrer une application qui utilise des API de navigation vers l'arrière non compatibles vers des API de plate-forme

Si votre application ne peut pas utiliser les bibliothèques AndroidX, et qu'elle implémente ou fait référence à la navigation vers l'arrière personnalisée à l'aide des API non compatibles, vous devez migrer vers l'API de plate-forme OnBackInvokedCallback.

Effectuez les étapes suivantes pour migrer des API non compatibles vers l'API de plate-forme :

Utilisez la nouvelle API OnBackInvokedCallback sur les appareils équipés d'Android 13 ou version ultérieure, et utilisez les API non compatibles sur les appareils équipés d'Android 12 ou version antérieure.
Enregistrez votre logique personnalisée des retours dans OnBackInvokedCallback avec onBackInvokedDispatcher. Cela empêche la fin de l'activité actuelle, et votre rappel peut réagir à l'action Retour une fois que l'utilisateur a terminé la navigation vers l'arrière du système.

Annulez l'enregistrement de OnBackInvokedCallback lorsque vous êtes prêt à arrêter d'intercepter le geste de retour. Sinon, les utilisateurs risquent de constater un comportement indésirable lors de l'utilisation de la navigation vers l'arrière du système (comme rester bloqués entre les affichages et être forcés de quitter l'application).

Voici un exemple de migration de logique hors de onBackPressed :

Kotlin

@Override
fun onCreate() {
    if (BuildCompat.isAtLeastT()) {
        onBackInvokedDispatcher.registerOnBackInvokedCallback(
            OnBackInvokedDispatcher.PRIORITY_DEFAULT
        ) {
            /**
             * onBackPressed logic goes here. For instance:
             * Prevents closing the app to go home screen when in the
             * middle of entering data to a form
             * or from accidentally leaving a fragment with a WebView in it
             *
             * Unregistering the callback to stop intercepting the back gesture:
             * When the user transitions to the topmost screen (activity, fragment)
             * in the BackStack, unregister the callback by using
             * OnBackInvokeDispatcher.unregisterOnBackInvokedCallback
             * (https://developer.android.com/reference/kotlin/android/window/OnBackInvokedDispatcher#unregisteronbackinvokedcallback)
             */
        }
    }
}

Java

@Override
void onCreate() {
  if (BuildCompat.isAtLeastT()) {
    getOnBackInvokedDispatcher().registerOnBackInvokedCallback(
        OnBackInvokedDispatcher.PRIORITY_DEFAULT,
        () -> {
          /**
           * onBackPressed logic goes here - For instance:
           * Prevents closing the app to go home screen when in the
           * middle of entering data to a form
           * or from accidentally leaving a fragment with a WebView in it
           *
           * Unregistering the callback to stop intercepting the back gesture:
           * When the user transitions to the topmost screen (activity, fragment)
           * in the BackStack, unregister the callback by using
           * OnBackInvokeDispatcher.unregisterOnBackInvokedCallback
           * (https://developer.android.com/reference/kotlin/android/view/OnBackInvokedDispatcher#unregisteronbackinvokedcallback)
           */
        }
    );
  }
}

Arrêtez toute interception d'événements de retour via OnBackPressed ou KeyEvent.KEYCODE_BACK pour Android 13 et versions ultérieures.
Une fois la migration de votre application effectuée, activez la prévisualisation du geste Retour (comme décrit sur cette page) pour qu'OnBackInvokedCallback prenne effet.

Activer la prévisualisation du geste Retour

Une fois que vous avez déterminé comment mettre à jour votre application en fonction de votre situation, vous pouvez facilement prendre en charge la prévisualisation du geste Retour.

Pour activer cette option, dans AndroidManifest.xml, dans la balise <application>, définissez l'indicateur android:enableOnBackInvokedCallback sur true.

<application
    ...
    android:enableOnBackInvokedCallback="true"
    ... >
...
</application>

Si vous ne fournissez pas de valeur, la valeur par défaut est false, et les actions suivantes se déclenchent :

L'animation système de la prévisualisation du geste Retour est désactivée.
OnBackInvokedCallback est ignoré, mais les appels OnBackPressedCallback continuent de fonctionner.

Bonnes pratiques concernant les rappels

Voici les bonnes pratiques à suivre pour utiliser les rappels système compatibles : BackHandler (pour Compose), OnBackPressedCallback ou OnBackInvokedCallback.

Déterminer l'état d'interface utilisateur qui activera et désactivera chaque rappel

L'état de l'UI est la propriété qui décrit l'UI. Nous vous recommandons de suivre ces étapes générales.

Déterminez l'état d'interface utilisateur qui activera et désactivera chaque rappel.
Définissez cet état à l'aide d'un type de conteneur de données observable, tel que StateFlow ou Compose State, puis activez ou désactivez le rappel lorsque l'état change.

Si votre application associait déjà une logique de retour à des instructions conditionnelles, cela peut signifier que vous réagissez à l'événement "Retour" une fois qu'il s'est déjà produit, ce que vous devez éviter avec les rappels plus récents. Si possible, déplacez le rappel en dehors de l'instruction conditionnelle et associez-le à un type de conteneur de données observables.

Utiliser des rappels système pour la logique d'UI

La logique d'UI détermine comment afficher l'interface utilisateur. Utilisez des rappels système pour exécuter une logique d'UI, par exemple pour afficher un pop-up ou exécuter une animation.

Si votre application active un rappel de retour système, les animations prédictives ne s'exécutent pas, et vous devez gérer l'événement "Retour". Ne créez pas de rappels uniquement pour exécuter une logique autre que celle de l'UI.

Par exemple, si vous n'interceptez les événements "Retour" que pour les consigner, consignez-les dans le cycle de vie de l'activité ou du fragment.

Pour les cas d'activité à activité ou de fragment à activité, consignez-les si isFinishing dans onDestroy est true dans le cycle de vie de l'activité.
Pour les cas de fragment à fragment, consignez-les si isRemoving dans onDestroy est true dans le cycle de vie de la vue du fragment, ou consignez-les à l'aide des méthodes onBackStackChangeStarted ou onBackStackChangeCommitted dans FragmentManager.OnBackStackChangedListener.

Créer des rappels à responsabilité unique

Cela est possible, car vous pouvez ajouter plusieurs rappels au dispatcher. Les rappels sont ajoutés à une pile dans laquelle le dernier rappel activé gère le geste Retour suivant, avec un rappel par geste Retour.

Tester l'animation de la prévisualisation du geste Retour

À partir de la version finale d'Android 13, vous devriez pouvoir activer une option de développeur afin de tester l'animation de retour à la page d'accueil, illustrée à la figure 1.

Pour tester cette animation, procédez comme suit :

Sur votre appareil, accédez à Paramètres > Système > Options pour les développeurs.
Sélectionnez Animations pour la prévisualisation du Retour.
Lancez votre application mise à jour et utilisez le geste Retour pour le voir en action.