Skip to main content

Documentation Index

Fetch the complete documentation index at: https://auth0-feat-ionic-capacitor-quickstart-modernization.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

The logout screen is displayed when a user’s session ends and prompts them to confirm the logout action.
Logout

​
Import

Each screen has its own set of hooks and methods. The SDK supports partial import and root import for each screen.
  • Using partial import allows you to include only the code you need for your specific use case.
  • Using root import allows you to load all screens from a single bundle useful when you want a unified build to handle all possible screens.
Import Example
// root import
import { useLogout } from '@auth0/auth0-acul-react';

// partial import
import {
  useLogout,
  // Context hooks
  useUser,
  useTenant,
  useBranding,
  useClient,
  useOrganization,
  usePrompt,
  useScreen,
  useTransaction,
  useUntrustedData,
  // Common hooks
  useCurrentScreen,
  useAuth0Themes,
  useErrors,
  // Utility hooks
  useChangeLanguage,
  // Methods
  confirmLogout,
} from '@auth0/auth0-acul-react/logout';

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

​
Context Hooks

Screen-scoped hooks that provide read-only access to Auth0 context data on the logout screen. Import them from @auth0/auth0-acul-react/logout.
​
useBranding
() => BrandingMembers
Provides branding configurations, such as logo, colors, and theme settings displayed on the logout screen.
Example
import { useBranding } from '@auth0/auth0-acul-react/logout';
function CustomTheme() {
  const branding = useBranding();
}
​
useClient
() => ClientMembers
Provides client-related configurations, such as id, name, and logoUrl, for the logout screen.
Example
import { useClient } from '@auth0/auth0-acul-react/logout';
function AppInfo() {
  const client = useClient();
}
​
useOrganization
() => OrganizationMembers
Provides information about the user’s organization if the logout is organization-scoped. Returns null when no organization context is present.
Example
import { useOrganization } from '@auth0/auth0-acul-react/logout';
function OrgSelector() {
  const organization = useOrganization();
  if (!organization) {
    return <p>No organization context</p>;
  }
}
​
usePrompt
() => PromptMembers
Contains data about the current prompt in the authentication flow.
Example
import { usePrompt } from '@auth0/auth0-acul-react/logout';
function FlowInfo() {
  const prompt = usePrompt();
}
​
useScreen
() => ScreenMembers
Contains details specific to the logout screen, including its configuration and context.
Example
import { useScreen } from '@auth0/auth0-acul-react/logout';
function ScreenDebug() {
  const screen = useScreen();
}
​
useTenant
() => TenantMembers
Contains data related to the tenant, such as id and associated metadata.
Example
import { useTenant } from '@auth0/auth0-acul-react/logout';
function TenantInfo() {
  const tenant = useTenant();
}
​
useTransaction
() => TransactionMembers
Provides transaction-specific data for the logout screen, such as active connections and current flow state.
Example
import { useTransaction } from '@auth0/auth0-acul-react/logout';
function TransactionInfo() {
  const transaction = useTransaction();
}
​
useUntrustedData
() => UntrustedDataMembers
Handles untrusted data passed to the screen, such as parameters from URL query strings.
Example
import { useUntrustedData } from '@auth0/auth0-acul-react/logout';
function PrefilledForm() {
  const untrustedData = useUntrustedData();
}
​
useUser
() => UserMembers
Details of the active user, including username, email, and available authentication methods.
Example
import { useUser } from '@auth0/auth0-acul-react/logout';
function UserProfile() {
  const user = useUser();
}

​
Methods

​
confirmLogout
void | Promise<void>
Confirms or cancels the logout action for the current session.
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>
    </>
  );
}

​
Common/Utility Hooks

​
useAuth0Themes
Hooks
Get the current theme options with flattened configuration from branding context.
​
useChangeLanguage
Hooks
Returns a function for changing the display language on the current ACUL screen.
​
useCurrentScreen
Hooks
Gets the current screen context and state.
​
useErrors
Hooks
Read and manage server, client, and developer errors on the screen.