Skip to main content
Product
Solutions
Docs
Pricing
Company
Sign in
Start building
Start building
Start building
Start building
Sign out
Dashboard
Dashboard
Dashboard
Dashboard
Docs
Search documentation
Ask AI
Dashboard
Dashboard
Sign Up
Sign Up
Select your SDK
Next.js
React
Expo
JavaScript
Express
React Router
Astro
iOS
Nuxt
Vue
Chrome Extension
Fastify
Remix
TanStack React Start
Beta
JS Backend SDK
C#
Go
Java
Python
Ruby / Rails / Sinatra
SDK Development
Angular
Community
Elysia
Community
Hono
Community
Koa
Community
SolidJS
Community
Svelte
Community
Redwood
Community
Rust
Community
Next.js
React
Expo
JavaScript
Express
React Router
Astro
iOS
Nuxt
Vue
Chrome Extension
Fastify
Remix
TanStack React Start
JS Backend SDK
C#
Go
Java
Python
Ruby / Rails / Sinatra
SDK Development
Angular
Elysia
Hono
Koa
SolidJS
Svelte
Redwood
Rust
Getting started
Set up your Clerk account
Quickstart (App Router)
Quickstart (Pages Router)
Next.js Guides
Read session and user data
Add a custom sign-in-or-up page
Add a custom sign-up page
Add custom onboarding
Set up a waitlist
Role Based Access Control
Rendering modes
Geo blocking
Migrate from Auth.js
tRPC
Verifying OAuth access tokens
Build an MCP server
Connect an MCP client
Getting started
Set up your Clerk account
Quickstart
Getting started
Set up your Clerk account
Quickstart
Getting started
Set up your Clerk account
Quickstart
Astro + React
Astro Guides
Endpoints
Read session and user data
Hybrid rendering
Migrating from community SDK
Getting started
Set up your Clerk account
Quickstart
Chrome Extension Guides
Add React Router
Sync auth status between your Chrome Extension and web app
createClerkClient()
Configure a consistent CRX ID
Getting started
Set up your Clerk account
Quickstart
Expo Guides
Read session and user data
Use biometrics with local credentials
Configure passkeys
Offline support
Access the
Clerk
object outside of components
Getting started
Set up your Clerk account
Quickstart
Getting started
Set up your Clerk account
Quickstart
Getting started
Set up your Clerk account
Quickstart
Go Guides
Verifying sessions
Use Clerk Go for Backend API Operations
Getting started
Set up your Clerk account
Quickstart
iOS Guides
Sign in with Apple
Getting started
Set up your Clerk account
Quickstart
Getting started
Set up your Clerk account
Quickstart
Nuxt Guides
Read session and user data
Protect pages
Getting started
Set up your Clerk account
Quickstart
React Router Guides
Read session and user data
Add custom sign-in-or-up page
Add custom sign-up page
Library mode
Verifying OAuth access tokens
Getting started
Set up your Clerk account
Quickstart
Remix Guides
SPA Mode
Add custom sign-in-or-up page
Add custom sign-up page
Read session and user data
Getting started
Set up your Clerk account
Quickstart
Ruby Guides
Upgrade to v4
Rails integration
Sinatra integration
Rack integration
Getting started
Set up your Clerk account
Quickstart
TanStack React Start Guides
Add custom sign-in-or-up-page
Add custom sign-up-page
Read session and user data
Verifying OAuth access tokens
Getting started
Set up your Clerk account
Quickstart
Vue Guides
Migrating from community SDK
Overview
Terminology
Philosophy
Conventions
SDK Types
Guides
Frontend-only
Backend-only
Fullstack
Clerk UI
Clerk Components
Clerk Hooks
Account Portal
Configuration
Sign-up & Sign-in
Users
Organizations, Roles, and Permissions
Billing
Beta
Backend Requests
Webhooks
Customization
Appearance Prop
Custom Pages
Custom Menu Items
Localization
Elements
Beta
Development
Authorize users
Deployments & Migrations
Errors
Image Optimization
Multi-tenant Architecture
Override Clerk Interfaces
Reverification
Redirect URLs
Routing
OAuth
Testing
Troubleshooting
Upgrade Guides
SDK Reference
Overview
clerkMiddleware()
App Router References
Pages Router References
Demo Repositories
Overview
Demo Repository
Overview
Clerk
Client
Session
User
SignIn
SignUp
Organization
Types
Overview
clerkMiddleware()
updateClerkOptions()
Integration
Locals
Client-side helpers
Overview
Overview
useLocalCredentials()
useOAuth()
(deprecated)
useSSO()
Web support
Overview
Overview
Go SDK repository
Overview
getToken()
User
Organization
Allowlist Identifiers
Domains
Sessions
Client
Invitations
Redirect Urls
Email addresses
Phone numbers
SAML connections
Sign-in tokens
Testing Tokens
authenticateRequest()
verifyToken()
verifyWebhook()
Types
Overview
clerkMiddleware()
Overview
rootAuthLoader()
getAuth()
Overview
ClerkApp
rootAuthLoader()
Overview
Overview
getAuth()
createClerkHandler()
Overview
clerkPlugin
updateClerkOptions()
Client-side helpers
useUser()
useClerk()
useAuth()
useSignIn()
useSignUp
useSession()
useSessionList()
useOrganization()
Advanced
How Clerk Works
Integrations
Advanced Usage
Security & Privacy
Custom Flows
AI Prompts
API Reference
Backend API
Frontend API
Versioning
Overview
Available versions
Archived Versions
Core 1 Documentation
<UserButton /> component
Clerk's <UserButton /> component is used to render the familiar user button UI popularized by Google.
This page is available for the following SDKs. Select the SDK you would like to use:
Astro
Chrome Extension
Expo
Next.js
Nuxt
React
React Router
Remix
TanStack React Start
Beta
Vue
JavaScript
Feedback
What did you think of this content?
It was helpful
It was not helpful
I have feedback
Edit this page on GitHub
Support
