Auth0 Web Universal Components

A comprehensive library of reusable UI components and utilities for Auth0 integrations, built with modern web technologies and designed for scalability.

📖 Documentation

For detailed information on how to use these components and get started with Auth0, please refer to the following resources:

• Auth0 Quickstarts: Official guides for creating and configuring your application on the Auth0 platform.
• Auth0 APIs: Comprehensive documentation for Auth0's APIs.
• Component Documentation: Live Storybook showcasing all available components, their props, and usage examples.
• Examples Folder: Practical, hands-on sample applications demonstrating how to integrate and use these components in a real project.

📦 Packages Overview

This project uses a monorepo architecture designed for multi-framework support. It is organized into two main types of packages:

• A framework-agnostic @auth0/web-ui-components-core package that contains all the core logic, services, and utilities.
• Framework-specific packages (like @auth0/web-ui-components-react) that provide UI components and hooks for a particular technology. This structure allows for the future addition of packages for other frameworks like Vue or Angular.

packages/core/

@auth0/web-ui-components-core - The foundational package containing core utilities and services.

What it provides:

• 📦 Internal Services: Handles all API logic for "My Account" and "My Org" components, using the "My Account" and "My Org" SDKs.
• 🌐 Internationalization (i18n): Contains all translation files for multi-language support and utils.
• 🛡️ Schema Validation: Defines and maintains types for schema validation.
• 🛠️ Shared Utilities: Provides shared functions, TypeScript types, and theme management utilities.

packages/react/

@auth0/web-ui-components-react - React-specific UI components and hooks for Auth0 integrations.

What it provides:

• ⚛️ React Components: Pre-built UI components for Auth0 features (MFA management, user profiles, ,org management etc.)
• 🎣 Custom Hooks: React hooks for component state management and API interactions
• 🎨 UI Elements: Beautiful, accessible components built with Radix UI and Tailwind CSS, following shadcn design patterns.
• 🔄 Providers: React context providers for managing authentication, theme, and internationalization.

🚀 Using the Library

For detailed instructions on how to install and use the components in your project, please refer to the README.md file within the specific framework package you are using.

• React Usage Guide

🛠️ Getting Started (for Contributors)

Prerequisites

• Node.js >= 18
• PNPM (recommended package manager)

Installation

1. Clone the repository:

   git clone https://github.com/auth0/auth0-ui-components
   cd auth0-ui-components

2. Install dependencies:

   pnpm install

3. Build all packages:

   pnpm run build

Development

Local Development Workflow

To make and test changes locally:

1. Make your desired changes in any of the packages (e.g., packages/core or packages/react).
2. Re-build all packages to apply your changes:

   pnpm run build

3. Navigate to a technology-specific example application in the examples/ directory (e.g., examples/react-spa-npm).
4. Configure the required environment variables in a .env file as per the example's README.
5. Start the development server to see your changes in action:

   pnpm run dev

Testing

Running tests:

pnpm run test
pnpm run test:react
pnpm run test:core

To run a specific test, go to the relevant package folder and run:

pnpm run test org-details-edit

Shadcn Local Development

1. Update registry.json with your changes.

2. Create a new build based on registry.json:

   pnpm build:shadcn

3. Open docs-site and serve the registry:

cd docs-site
pnpm install
pnpm run dev

4. Go to your app (e.g., react-spa-shadcn) and update the components:

   npx shadcn@latest add http://localhost:5173/r/my-account/user-mfa-management.json --overwrite
   npx shadcn@latest add http://localhost:5173/r/my-org/org-details-edit.json --overwrite
   # ... other components

   Note: The port may differ if other applications are running.

🤝 Contributing

Contributions are welcome! Please feel free to submit a pull request or open an issue for any bugs, feature requests, or improvements.

📜 License

Copyright 2025 Okta, Inc

This project is licensed under the MIT License. See the LICENSE file for details.

Authors
Okta Inc.