Cierre de sesión

Describe todos los hooks y métodos disponibles para personalizar la pantalla logout de Universal Login.

La pantalla logout aparece cuando finaliza la sesión de un usuario y le pide que confirme la acción de cierre de sesión.

​

Importación

Cada pantalla tiene su propio conjunto de hooks y métodos. El SDK admite la importación parcial y la importación desde la raíz para cada pantalla.

• La importación parcial te permite incluir solo el código que necesitas para tu caso de uso.
• La importación desde la raíz te permite cargar todas las pantallas desde un único paquete, lo que resulta útil cuando quieres una compilación unificada que gestione todas las pantallas posibles.

Import Example

// importación raíz
import { useLogout } from '@auth0/auth0-acul-react';

// importación parcial
import {
  useLogout,
  // Hooks de contexto
  useUser,
  useTenant,
  useBranding,
  useClient,
  useOrganization,
  usePrompt,
  useScreen,
  useTransaction,
  useUntrustedData,
  // Hooks comunes
  useCurrentScreen,
  useAuth0Themes,
  useErrors,
  // Hooks de utilidad
  useChangeLanguage,
  // Métodos
  confirmLogout,
} from '@auth0/auth0-acul-react/logout';

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

​

Hooks de contexto

Hooks con ámbito de pantalla que proporcionan acceso de solo lectura a los datos de contexto de Auth0 en la pantalla logout. Impórtalos desde @auth0/auth0-acul-react/logout.

useBranding · () => BrandingMembers

Este hook proporciona configuraciones de marca, como el logotipo, los colores y los ajustes del tema que se muestran en la pantalla logout.

Example

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

useClient · () => ClientMembers

Este hook proporciona configuraciones relacionadas con el cliente, como id, name y logoUrl, para la pantalla logout.

Example

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

useOrganization · () => OrganizationMembers

Este hook proporciona información sobre la Organización del usuario si el cierre de sesión tiene ámbito de Organización. Devuelve null cuando no hay contexto de Organización.

Example

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

usePrompt · () => PromptMembers

Este hook contiene datos sobre la pantalla actual del flujo de autenticación.

Example

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

useScreen · () => ScreenMembers

Este hook contiene detalles específicos de la pantalla logout, incluida su configuración y contexto.

Example

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

useTenant · () => TenantMembers

Este hook contiene datos relacionados con el inquilino, como id y los metadatos asociados.

Example

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

useTransaction · () => TransactionMembers

Este hook proporciona datos específicos de la transacción para la pantalla logout, como las conexiones activas y el estado actual del flujo.

Example

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

useUntrustedData · () => UntrustedDataMembers

Este hook gestiona los datos no confiables que se pasan a la pantalla, como los parámetros de la cadena de consulta de la URL.

Example

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

useUser · () => UserMembers

Este hook proporciona detalles del usuario activo, incluidos username, email y los métodos de autenticación disponibles.

Example

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

useLogout · LogoutMembers

Este hook devuelve todos los métodos y el contexto disponibles en la pantalla logout.

​

Métodos

confirmLogout · Promise<void>

Este método confirma o cancela el cierre de sesión de la sesión actual.

Example

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

function LogoutScreen() {
  const { confirmLogout } = useLogout();
  return (
    <>
      <button onClick={() => confirmLogout({ action: 'accept' })}>
        Cerrar sesión
      </button>
      <button onClick={() => confirmLogout({ action: 'deny' })}>
        Seguir con la sesión iniciada
      </button>
    </>
  );
}

Parámetros del método

Mostrar Parámetros

options

ConfirmLogoutOptions.

action · "accept" | "deny" · requerido

Indica si se confirma ("accept") o se cancela ("deny") el cierre de sesión.

​

Hooks comunes y utilitarios

useAuth0Themes · Hooks

Este hook obtiene las opciones del tema actual con la configuración simplificada del contexto de marca.

useChangeLanguage · Hooks

Este hook devuelve una función para cambiar el idioma que se muestra en la pantalla actual de ACUL.

useCurrentScreen · Hooks

Este hook obtiene el contexto y el estado de la pantalla actual.

useErrors · Hooks

Este hook permite leer y gestionar los errores del servidor, del cliente y del desarrollador en la pantalla.