Logout

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

L’écran logout s’affiche lorsque la session d’un utilisateur prend fin et lui demande de confirmer le logout.

​

Importation

Chaque écran possède son propre ensemble de hooks et de méthodes. Le SDK prend en charge l’importation partielle et l’importation racine pour chaque écran.

• L’importation partielle vous permet d’inclure uniquement le code nécessaire à votre cas d’utilisation.
• L’importation racine vous permet de charger tous les écrans à partir d’un seul bundle, ce qui est utile si vous souhaitez une compilation unifiée capable de gérer 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 propres à l’écran qui fournissent un accès en lecture seule aux données de contexte Auth0 sur l’écran logout. Importez-les depuis @auth0/auth0-acul-react/logout.

useBranding · () => BrandingMembers

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

Example

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

useClient · () => ClientMembers

Ce hook fournit des configurations liées au client, 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’organization de l’utilisateur si le logout est limité à une organization. Retourne null lorsqu’aucun contexte d’organization 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 le prompt actuel dans le flux d’authentication.

Example

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

useScreen · () => ScreenMembers

Ce hook contient des détails 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 tenant, 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 des chaînes de requête d’URL.

Example

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

useUser · () => UserMembers

Ce hook fournit les détails de l’utilisateur actif, y compris le username, le email et les méthodes d’authentication disponibles.

Example

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

useLogout · LogoutMembers

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

​

Méthodes

confirmLogout · Promise<void>

Cette méthode confirme ou annule le logout 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") le logout.

​

Hooks utilitaires communs

useAuth0Themes · Hooks

Ce hook récupère les options du thème actuel avec une configuration aplatie à partir du contexte de l’image de marque.

useChangeLanguage · Hooks

Ce hook renvoie une fonction permettant de changer la langue d’affichage sur 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 du serveur, du client et du développeur sur l’écran.