Déconnexion

Décrit tous les hooks et toutes les méthodes disponibles pour personnaliser l’écran logout dans Universal Login.

L’écran logout s’affiche lorsqu’une session utilisateur prend fin et invite l’utilisateur à confirmer la déconnexion.

​

Import

Chaque écran a son propre ensemble de hooks et de méthodes. Le SDK prend en charge les imports partiels et les imports à la racine pour chaque écran.

• Un import partiel vous permet d’inclure uniquement le code nécessaire à votre cas d’usage.
• Un import à la racine vous permet de charger tous les écrans à partir d’un seul bundle, ce qui est utile si vous souhaitez qu’une build unifiée prenne en charge tous les écrans possibles.

Import Example

// importation racine
import { useLogout } from '@auth0/auth0-acul-react';

// importation partielle
import {
  useLogout,
  // Hooks de contexte
  useUser,
  useTenant,
  useBranding,
  useClient,
  useOrganization,
  usePrompt,
  useScreen,
  useTransaction,
  useUntrustedData,
  // Hooks communs
  useCurrentScreen,
  useAuth0Themes,
  useErrors,
  // Hooks utilitaires
  useChangeLanguage,
  // Méthodes
  confirmLogout,
} from '@auth0/auth0-acul-react/logout';

function LogoutScreen() {
  const { confirmLogout } = useLogout();
  return (
    <button onClick={() => confirmLogout({ action: 'accept' })}>
      Sign Out
    </button>
  );
}

​

Hooks de contexte

Hooks associés à l’écran qui fournissent un accès en lecture seule aux données de contexte Auth0 dans l’écran logout. Importez-les depuis @auth0/auth0-acul-react/logout.

useBranding · () => BrandingMembers

Ce hook fournit la configuration d’image de marque, comme le logo, les couleurs et les paramètres de thème affichés dans l’écran logout.

Example

import { useBranding } from '@auth0/auth0-acul-react/logout';
function CustomTheme() {
  const branding = useBranding();
}

useClient · () => ClientMembers

Ce hook fournit la configuration liée à l’application, comme id, name et logoUrl, pour l’écran logout.

Example

import { useClient } from '@auth0/auth0-acul-react/logout';
function AppInfo() {
  const client = useClient();
}

useOrganization · () => OrganizationMembers

Ce hook fournit des renseignements sur l’organisation de l’utilisateur si la déconnexion est limitée à une organisation. Il retourne null lorsqu’aucun contexte d’organisation n’est présent.

Example

import { useOrganization } from '@auth0/auth0-acul-react/logout';
function OrgSelector() {
  const organization = useOrganization();
  if (!organization) {
    return <p>No organization context</p>;
  }
}

usePrompt · () => PromptMembers

Ce hook contient des données sur l’invite actuelle dans le flux d’authentification.

Example

import { usePrompt } from '@auth0/auth0-acul-react/logout';
function FlowInfo() {
  const prompt = usePrompt();
}

useScreen · () => ScreenMembers

Ce hook contient des renseignements propres à l’écran logout, y compris sa configuration et son contexte.

Example

import { useScreen } from '@auth0/auth0-acul-react/logout';
function ScreenDebug() {
  const screen = useScreen();
}

useTenant · () => TenantMembers

Ce hook contient des données liées au locataire, comme id et les métadonnées associées.

Example

import { useTenant } from '@auth0/auth0-acul-react/logout';
function TenantInfo() {
  const tenant = useTenant();
}

useTransaction · () => TransactionMembers

Ce hook fournit des données propres à la transaction pour l’écran logout, comme les connexions actives et l’état actuel du flux.

Example

import { useTransaction } from '@auth0/auth0-acul-react/logout';
function TransactionInfo() {
  const transaction = useTransaction();
}

useUntrustedData · () => UntrustedDataMembers

Ce hook gère les données non fiables transmises à l’écran, comme les paramètres provenant de la chaîne de requête de l’URL.

Example

import { useUntrustedData } from '@auth0/auth0-acul-react/logout';
function PrefilledForm() {
  const untrustedData = useUntrustedData();
}

useUser · () => UserMembers

Ce hook fournit des renseignements sur l’utilisateur actif, notamment username, email et les méthodes d’authentification disponibles.

Example

import { useUser } from '@auth0/auth0-acul-react/logout';
function UserProfile() {
  const user = useUser();
}

useLogout · LogoutMembers

Ce hook renvoie toutes les méthodes et tout le contexte disponibles pour l’écran logout.

​

Méthodes

confirmLogout · Promise<void>

Cette méthode confirme ou annule la déconnexion de la session en cours.

Example

import { useLogout } from '@auth0/auth0-acul-react/logout';

function LogoutScreen() {
  const { confirmLogout } = useLogout();
  return (
    <>
      <button onClick={() => confirmLogout({ action: 'accept' })}>
        Sign Out
      </button>
      <button onClick={() => confirmLogout({ action: 'deny' })}>
        Stay Signed In
      </button>
    </>
  );
}

Paramètres de la méthode

Afficher Paramètres

options

ConfirmLogoutOptions.

action · "accept" | "deny" · requis

Indique s’il faut confirmer ("accept") ou annuler ("deny") la déconnexion.

​

Hooks communs et utilitaires

useAuth0Themes · Hooks

Ce hook récupère les options du thème actuel avec la configuration aplatie issue du contexte d’image de marque.

useChangeLanguage · Hooks

Ce hook renvoie une fonction permettant de modifier la langue d’affichage de l’écran ACUL actuel.

useCurrentScreen · Hooks

Ce hook récupère le contexte et l’état de l’écran actuel.

useErrors · Hooks

Ce hook lit et gère les erreurs côté serveur, côté client et du développeur sur l’écran.