Clerk Custom UI
ClerkOfficialCreated by clerk
- Skill
- Tool integration
- Software development
- MIT
- No issues found
AutoGineer summary
Written by AutoGineer from the skill’s own files, not by the author
This skill provides guidance on customizing the authentication experience provided by Clerk. It covers two primary areas: building custom sign-in and sign-up flows using React hooks, and styling pre-built Clerk components to match brand requirements. The skill distinguishes between Core 2 and current SDK versions, ensuring developers apply the correct properties, hooks, and theme imports for their specific environment.
What it does
- Provides instructions for building custom authentication flows with useSignIn and useSignUp hooks.
- Explains how to use the appearance prop to style Clerk components.
- Details how to apply pre-built themes like dark, neobrutalism, and shadcn.
- Guides developers on configuring variables such as colors, typography, and border radius.
- Outlines how to manage component layout options like logos and social button variants.
- Offers specific integration steps for projects using the shadcn/ui design system.
When to use it
- When you need to build a bespoke sign-in or sign-up UI instead of using pre-built components.
- When you need to align Clerk components with your application's branding and design system.
- When you need to implement dark mode or specific visual themes for authentication pages.
- When you are migrating or upgrading between Clerk Core 2 and current SDK versions.
Advantages
- Ensures visual consistency across your application by supporting custom themes and CSS.
- Provides clear version-specific guidance to avoid common API pitfalls.
- Simplifies integration with popular design systems like shadcn/ui.
- Offers granular control over authentication UI components and flow logic.
Usage examples
- “How do I change the primary color of my Clerk sign-in component?”
- The agent will explain how to use the appearance prop with the variables object to set the colorPrimary property.
- “How can I apply the shadcn theme to my Clerk components?”
- The agent will provide the necessary import statements for the shadcn theme and the required CSS import for your global stylesheet.
Install
Download the skill as a ZIP:
https://mp-staging.autogineer.com/agent-skills/clerk/clerk-custom-ui/downloadUnzip it into the cross-client skills folder of your project:
mkdir -p .agents/skills && unzip clerk-custom-ui.zip -d .agents/skills
Documentation by clerk
Custom UI
Prerequisite: Ensure
ClerkProviderwraps your app. Seeclerk-setupskill.Version: Check
package.jsonfor the SDK version — seeclerkskill for the version table. This determines which custom flow references to use below.
This skill covers two areas:
Custom authentication flows — build your own sign-in/sign-up UI with hooks
Appearance customization — theme, style, and brand Clerk's pre-built components
What Do You Need?
| Task | Reference |
|---|---|
| Custom sign-in (Core 2 / LTS) | core-2/custom-sign-in.md |
| Custom sign-up (Core 2 / LTS) | core-2/custom-sign-up.md |
| Custom sign-in (Current SDK v7+) | core-3/custom-sign-in.md |
| Custom sign-up (Current SDK v7+) | core-3/custom-sign-up.md |
| Show component pattern (Current SDK) | core-3/show-component.md |
Custom Flow References
| Task | Core 2 | Current |
|---|---|---|
| Custom sign-in (useSignIn) | core-2/custom-sign-in.md | core-3/custom-sign-in.md |
| Custom sign-up (useSignUp) | core-2/custom-sign-up.md | core-3/custom-sign-up.md |
<Show> component | (use <SignedIn>, <SignedOut>, <Protect>) | core-3/show-component.md |
Appearance Customization
Appearance customization applies to both Core 2 and the current SDK.
Component Customization Options
Options: structure, logo, buttons
Themes: prebuilt dark and light themes
Variables: colors, fonts, spacing
Appearance Pattern
<SignIn
appearance={{
variables: {
colorPrimary: '#0000ff',
borderRadius: '0.5rem',
},
options: {
logoImageUrl: '/logo.png',
socialButtonsVariant: 'iconButton',
},
}}
/>Core 2 ONLY (skip if current SDK): The
optionsproperty was namedlayout. Uselayout: { logoImageUrl: '...', socialButtonsVariant: '...' }instead ofoptions.
variables (colors, typography, borders)
| Property | Description |
|---|---|
colorPrimary | Primary color throughout |
colorBackground | Background color |
borderRadius | Border radius (default: 0.375rem) |
Opacity change: colorRing and colorModalBackdrop now render at full opacity. Use explicit rgba() values if you need transparency.
Core 2 ONLY (skip if current SDK):
colorRingandcolorModalBackdroprendered at 15% opacity by default.
options (structure, logo, social buttons)
| Property | Description |
|---|---|
logoImageUrl | URL to custom logo |
socialButtonsVariant | 'blockButton' | 'iconButton' | 'auto' |
socialButtonsPlacement | 'top' | 'bottom' |
showOptionalFields | Show optional fields (default: false) |
Core 2 ONLY (skip if current SDK): This property is called
layout, notoptions. Also,showOptionalFieldsdefaulted totrue.
Themes
Install themes from @clerk/ui:
npm install @clerk/uiimport { dark } from '@clerk/ui/themes'
<ClerkProvider appearance={{ theme: dark }} />Core 2 ONLY (skip if current SDK): Themes are imported from
@clerk/themes(install@clerk/themesinstead of@clerk/ui). Example:import { dark } from '@clerk/themes'.
Theme stacking — pass an array where the last theme takes precedence:
import { dark, neobrutalism } from '@clerk/ui/themes'
<ClerkProvider appearance={{ theme: [dark, neobrutalism] }} />CSS color-scheme support — the default theme respects the CSS color-scheme property for automatic light/dark mode toggling.
Available themes: dark, neobrutalism, shadcn, simple
shadcn Theme
IMPORTANT: If the project has
components.json(shadcn/ui installed), ALWAYS apply the shadcn theme as the FIRST customization step. This ensures Clerk components visually match the existing shadcn design system. Skip this only if the user explicitly requests a different theme.
If the project uses shadcn/ui (check for components.json in the project root), always use the shadcn theme:
import { shadcn } from '@clerk/ui/themes'
<ClerkProvider appearance={{ theme: shadcn }} />Also import shadcn CSS in your global styles:
@import 'tailwindcss';
@import '@clerk/ui/themes/shadcn.css';Core 2 ONLY (skip if current SDK): Import from
@clerk/themesand@clerk/themes/shadcn.css:import { shadcn } from '@clerk/themes'@import '@clerk/themes/shadcn.css';
Workflow
Identify customization needs (custom flow or appearance)
For custom flows: check SDK version → read appropriate
core-2/orcore-3/referenceFor appearance: WebFetch the appropriate documentation above
Apply appearance prop to your Clerk components or build custom flow with hooks
Common Pitfalls
| Issue | Solution |
|---|---|
| Colors not applying | Use colorPrimary not primaryColor |
| Logo not showing | Put logoImageUrl inside options: {} (or layout: {} in Core 2) |
| Social buttons wrong | Add socialButtonsVariant: 'iconButton' in options (or layout in Core 2) |
| Styling not working | Use appearance prop, not direct CSS (unless with bring-your-own-css) |
| Hook returns different shape | Check SDK version — Core 2 and current have completely different useSignIn/useSignUp APIs |
See Also
clerk-setup- Initial Clerk installclerk-nextjs-patterns- Next.js patternsclerk-orgs- B2B organizations
Files
- ATTRIBUTION.mdAdded by AutoGineer839 B
- SKILL.md6.3 KiB
- core-2/custom-sign-in.md5.4 KiB
- core-2/custom-sign-up.md4.6 KiB
- core-3/custom-sign-in.md9.0 KiB
- core-3/custom-sign-up.md7.5 KiB
- core-3/show-component.md4.0 KiB
core-3/show-component.md
<Show> Component
The <Show> component conditionally renders content based on authentication state, roles, permissions, billing plans, and features.
Core 2 ONLY (skip if current SDK): The
<Show>component does not exist in Core 2. Use<SignedIn>,<SignedOut>, and<Protect>instead. See migration table below.
Import
import { Show } from '@clerk/nextjs' // Next.js
import { Show } from '@clerk/react' // React
import { Show } from '@clerk/react-router' // React Router
import { Show } from '@clerk/expo' // ExpoProps
| Prop | Type | Description |
|---|---|---|
when | string | object | function | Condition for rendering children |
fallback? | ReactNode | Content shown when condition fails |
treatPendingAsSignedOut? | boolean | Treat pending sessions as signed-out (default: true) |
when Prop Variants
Authentication State
// Show content only when signed in
<Show when="signed-in">
<p>Welcome back!</p>
</Show>
// Show content only when signed out
<Show when="signed-out">
<p>Please sign in.</p>
</Show>Role Check
<Show when={{ role: 'org:admin' }}>
<AdminPanel />
</Show>Permission Check
<Show when={{ permission: 'org:billing:manage' }}>
<BillingSettings />
</Show>Billing Feature Check
<Show when={{ feature: 'widgets' }}>
<WidgetBuilder />
</Show>Billing Plan Check
<Show when={{ plan: 'gold' }}>
<PremiumContent />
</Show>Custom Condition (Function)
<Show when={(has) => has({ role: 'org:admin' }) || has({ permission: 'org:billing:manage' })}>
<SettingsPanel />
</Show>Fallback Content
Show alternative content when the condition fails:
<Show when="signed-in" fallback={<p>Please sign in to continue.</p>}>
<Dashboard />
</Show>Session Tasks and Pending State
The treatPendingAsSignedOut prop controls how pending sessions (sessions with incomplete tasks) are handled:
// Default: pending sessions are treated as signed-out
<Show when="signed-in" treatPendingAsSignedOut>
<Dashboard />
</Show>
// Treat pending sessions as signed-in (e.g., to show task completion UI)
<Show when="signed-in" treatPendingAsSignedOut={false}>
<TaskCompletionFlow />
</Show>Next.js Server Components
In a Next.js Server Component, <Show> reads the session from the request. With Cache Components (cacheComponents: true, the create-next-app default), next build fails on request data read outside a <Suspense> boundary, so wrap it in <Suspense> (Read auth data inside Suspense):
import { Show } from '@clerk/nextjs'
import { Suspense } from 'react'
<Suspense>
<Show when="signed-in">
<p>Welcome back!</p>
</Show>
</Suspense>In a Client Component, <Show> reads client-side auth state and needs no boundary.
Security Caveat
In a Client Component, <Show> only visually hides content: it remains in browser source. In a Next.js Server Component, the hidden branch isn't sent to the browser. Either way, <Show> doesn't protect data. Verify authentication server-side with auth() or auth.protect() in the page or Route Handler that fetches it.
Migration from Core 2
| Core 2 | Current |
|---|---|
<SignedIn> | <Show when="signed-in"> |
<SignedOut> | <Show when="signed-out"> |
<Protect role="org:admin"> | <Show when={{ role: 'org:admin' }}> |
<Protect permission="org:billing:manage"> | <Show when={{ permission: 'org:billing:manage' }}> |
<Protect condition={(has) => expr}> | <Show when={(has) => expr}> |
<Protect fallback={...}> | <Show when={...} fallback={...}> |
| (no equivalent) | <Show when={{ feature: 'widgets' }}> |
| (no equivalent) | <Show when={{ plan: 'gold' }}> |
Docs
Requirements and compatibility
Written for: Claude Code
Works with: Claude Code, Claude apps, OpenAI Codex, GitHub Copilot, Cursor, Gemini CLI, Kiro, OpenCode, Goose, Amp, Roo Code, JetBrains Junie, Factory Droid, Devin (ex-Windsurf), Mistral Vibe, OpenHands, Letta
“Works with” means the tool reads the open Agent Skills format; a skill written for one tool may use features others lack.
Needs: Declares allowed tools, Names Claude Code tools, Needs Node.js
Security
No issues found by our static scan· No issues found
A static scan is not a guarantee. Skills are third-party content: review a skill before you let an agent use it.
Attribution and licence
- Created by
- clerk
- Publisher
- Clerk (Official)
- Source
- clerk/skills · skills/clerk-custom-ui · commit c5d2c0d
- Licence
- MIT License (redistribution allowed)
- ATTRIBUTION.md (written by AutoGineer)
- Synced
AutoGineer is not affiliated with or endorsed by clerk.
Download ZIP
The ZIP holds the skill’s files, its licence files and an ATTRIBUTION.md. Download clerk-custom-ui.zip