@auth0/auth0-acul-react - v1.0.0
    Preparing search index...

    Class ContextHooks<T>

    Factory class that creates context hooks for accessing Auth0 Universal Login data. These hooks provide access to various aspects of the authentication flow and tenant configuration.

    Type Parameters

    Index

    Constructors

    constructor

    Methods

    useUser useTenant useBranding useClient useOrganization usePrompt useUntrustedData useScreen useTransaction

    Constructors

    Methods

    • Hook to access user information and profile data.

      Returns T["user"]

      User object containing profile information, attributes, and user-specific data

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

    • Hook to access tenant configuration and settings.

      Returns T["tenant"]

      Tenant object containing domain, region, and tenant-specific configuration

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

    • Hook to access branding and theme configuration.

      Returns T["branding"]

      Branding object containing colors, logos, fonts, and visual customization settings

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

    • Hook to access Auth0 application (client) configuration.

      Returns T["client"]

      Client object containing application settings, callbacks, and client-specific data

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

    • Hook to access organization context and settings.

      Returns T["organization"]

      Organization object containing org-specific data, metadata, and configuration

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

    • Hook to access prompt configuration and flow settings.

      Returns T["prompt"]

      Prompt object containing flow configuration, screen settings, and prompt-specific data

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

    • Hook to access untrusted data from URL parameters and form submissions.

      Returns T["untrustedData"]

      Object containing untrusted user input that should be validated before use

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

    • Hook to access current screen information and metadata.

      Returns T["screen"]

      Screen object containing current screen name, configuration, and screen-specific data

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

    • Hook to access transaction state and authentication flow data.

      Returns T["transaction"]

      Transaction object containing flow state, session data, and transaction-specific information

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

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods