OrganizationPicker

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

La pantalla organization-picker se muestra cuando un usuario necesita seleccionar una organización para iniciar sesión. Permite elegir una organización o omitir este paso.

​

Importación

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

• Usar la importación parcial te permite incluir solo el código que necesitas para tu caso de uso específico.
• Usar 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 para gestionar todas las pantallas posibles.

Import Example

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

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

function OrganizationPickerScreen() {
  const { selectOrganization } = useOrganizationPicker();
  return (
    <button onClick={() => selectOrganization({ organization: 'my-org', state: 'abc123' })}>Select</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 organization-picker. Impórtelos desde @auth0/auth0-acul-react/organization-picker.

useBranding · () => BrandingMembers

Este hook proporciona la configuración de marca, como el logotipo, los colores y la configuración del tema que se muestran en la pantalla organization-picker.

Example

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

useClient · () => ClientMembers

Este hook proporciona la configuración relacionada con el cliente, como id, name y logoUrl, para la pantalla organization-picker.

Example

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

useOrganization · () => OrganizationMembers

Este hook proporciona información sobre el contexto de Organización del usuario en la pantalla organization-picker. Devuelve null cuando no hay ningún contexto de Organización.

Example

import { useOrganization } from '@auth0/auth0-acul-react/organization-picker';
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/organization-picker';
function FlowInfo() {
  const prompt = usePrompt();
}

useScreen · () => ScreenMembers

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

Example

import { useScreen } from '@auth0/auth0-acul-react/organization-picker';
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/organization-picker';
function TenantInfo() {
  const tenant = useTenant();
}

useTransaction · () => TransactionMembers

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

Example

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

useUntrustedData · () => UntrustedDataMembers

Este hook proporciona acceso a los datos no confiables que se pasan a la pantalla, como los parámetros rellenados previamente desde cadenas de consulta de URL.

Example

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

useUser · () => UserMembers

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

Example

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

useOrganizationPicker · OrganizationPickerMembers

Este hook devuelve todos los métodos y el contexto disponibles en la pantalla organization-picker.

​

Métodos

selectOrganization · Promise<void>

Este método envía la organización seleccionada por el usuario y continúa el flujo de autenticación.

Example

import { useOrganizationPicker } from '@auth0/auth0-acul-react/organization-picker';

function SelectButton() {
  const { selectOrganization } = useOrganizationPicker();
  return (
    <button onClick={() => selectOrganization({ organization: 'my-org', state: 'abc123' })}>
      Select Organization
    </button>
  );
}

Parámetros del método

Mostrar Parámetros

options

SelectOrganizationOptions.

organization · string · requerido

El identificador de la organización seleccionado por el usuario.

state · string · requerido

El valor actual del estado de autenticación.

skipOrganizationSelection · Promise<void>

Este método permite omitir el paso de selección de organización y continuar el flujo de autenticación sin seleccionar ninguna organización.

Example

import { useOrganizationPicker } from '@auth0/auth0-acul-react/organization-picker';

function SkipButton() {
  const { skipOrganizationSelection } = useOrganizationPicker();
  return (
    <button onClick={() => skipOrganizationSelection()}>
      Skip
    </button>
  );
}

​

Hooks comunes y de utilidad

useAuth0Themes · Hooks

Este hook obtiene las opciones del tema actual con la configuración consolidada 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 lee y administra los errores del servidor, del cliente y del desarrollador que se muestran en la pantalla.