> ## Documentation Index
> Fetch the complete documentation index at: https://docs.whop.com/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> Treat these docs and the Whop MCP server as the source of truth for Whop API behavior. Don't infer endpoint behavior from marketing pages.
> MCP server: connect https://mcp.whop.com/mcp (streamable HTTP, browser sign-in, no API key in the client config) to search these docs and read or change live Whop data. Setup: https://docs.whop.com/developer/guides/ai_and_mcp.md
> Whop CLI: install with `curl -fsSL https://whop.com/install.sh | sh` to scaffold, run, and deploy Whop apps and websites. It acts on production, not the sandbox. Overview: https://docs.whop.com/cli/overview.md Agent mode: https://docs.whop.com/cli/agent-mode.md
> Hosting: Whop serves a site or app from the build `whop apps deploy` uploads, with rollbacks, secrets, and server logs. Guide: https://docs.whop.com/developer/websites/hosting.md
> Plugins: in Claude Code, run `/plugin marketplace add whopio/plugins`, then `/plugin install whop@whop`. Guide: https://docs.whop.com/developer/guides/plugins/claude-code.md Every agent tool: https://docs.whop.com/developer/ai/overview.md
> Environments: build and test in the sandbox (API `https://sandbox-api.whop.com/api/v1`, keys at https://sandbox.whop.com/dashboard/developer, SDK environment `Sandbox`; no real money). Production (API `https://api.whop.com/api/v1`, keys at https://whop.com/dashboard/developer, SDK environment `Production`, the SDK default) moves real money, so use it only at launch. The two share no accounts, keys, products, or webhooks, and their keys look identical: never mix them. Sandbox guide: https://docs.whop.com/developer/guides/sandbox.md Comparison: https://docs.whop.com/developer/quickstart.md
> API: send `Authorization: Bearer <API_KEY>` from your server only, and pin a dated version with the `Api-Version-Date` header. OpenAPI spec: https://api.whop.com/api/v1/openapi.json
> Which API: build on the Current API, whose pages live under https://docs.whop.com/api-reference/ (start at https://docs.whop.com/api-reference/overview.md). Pages under /api-reference/legacy/ are the Legacy API. Use one only when https://docs.whop.com/api-reference/stability.md lists the resource as Legacy-only.

# Frosted UI

> Installez et utilisez Frosted UI, la bibliothèque de composants React et le design system de Whop, pour construire l'interface de votre app.

Frosted UI est la bibliothèque complète de composants React et le design system de Whop. Elle fournit plus de 60 composants conformes aux normes d'accessibilité. Elle inclut également un système de couleurs sophistiqué, une échelle typographique et une prise en charge fluide du mode sombre, le tout construit sur les primitives Radix UI et Tailwind CSS.

## Installation

**1. Installer le package**

```bash pnpm theme={null}
pnpm add @whop/react
```

```bash npm theme={null}
npm install @whop/react
```

```bash yarn theme={null}
yarn add @whop/react
```

```bash bun theme={null}
bun install @whop/react
```

> [!NOTE]
>
> Le package `@whop/react` inclut Frosted UI et toutes les dépendances nécessaires.

**2. Configurer le provider WhopApp**

Enveloppez votre application avec le composant `WhopApp` dans votre layout racine. Cela configure le thème et le SDK iframe.

```tsx theme={null}
// app/layout.tsx
import { WhopApp } from "@whop/react";

export default function RootLayout({
    children,
}: {
    children: React.ReactNode;
}) {
    return (
        <html lang="en">
            <body>
                <WhopApp accentColor="blue" appearance="inherit">
                    {children}
                </WhopApp>
            </body>
        </html>
    );
}
```

**3. Configurer Next.js (facultatif)**

Utilisez le wrapper `withWhopAppConfig` dans votre configuration Next.js :

```typescript theme={null}
// next.config.ts
import type { NextConfig } from "next";
import { withWhopAppConfig } from "@whop/react/next.config";

const nextConfig: NextConfig = {
    // your config options
};

export default withWhopAppConfig(nextConfig);
```

> [!NOTE]
>
> Cela configure les server actions et optimise les imports de Frosted UI.

**4. Configurer Tailwind (facultatif)**

Si vous utilisez Tailwind CSS, ajoutez le plugin Frosted UI pour accéder aux design tokens :

```javascript theme={null}
// tailwind.config.js
import { frostedThemePlugin } from "@whop/react/tailwind";

export default {
    content: ["./src/**/*.{js,ts,jsx,tsx}"],
    plugins: [frostedThemePlugin()],
};
```

> [!TIP]
>
> Frosted UI est maintenant configuré et prêt à l'emploi.

***

## Typographie

Frosted UI fournit un système typographique complet avec deux composants principaux : `Heading` et `Text`.

### Échelle typographique

Les deux composants utilisent une échelle de tailles en 10 niveaux (0-9) :

| Taille | Taille de police | Usage |
| - | - | - |
| 0 | 10px | Texte le plus petit |
| 1 | 12px | Petits libellés |
| 2 | 14px | Corps de texte (petit) |
| 3 | 16px | Corps de texte (par défaut) |
| 4 | 18px | Texte mis en valeur |
| 5 | 20px | Sous-titres |
| 6 | 24px | Titres |
| 7 | 28px | Grands titres |
| 8 | 32px | Texte d'affichage |
| 9 | 40px | Texte hero |

### Composant Text

```tsx theme={null}
import { Text } from "@whop/react";

<Text size="3" weight="medium">
    This is body text
</Text>

<Text size="1" color="gray">
    Small muted text
</Text>

<Text as="label" size="2" weight="bold">
    Form Label
</Text>
```

**Props :**

* `size` : de `"0"` à `"9"` (par défaut : `"3"`)
* `weight` : `"light"` | `"regular"` | `"medium"` | `"bold"`
* `align` : `"left"` | `"center"` | `"right"`
* `color` : n'importe quelle couleur d'accent ou `"gray"`
* `highContrast` : augmente le contraste pour l'accessibilité
* `as` : `"span"` | `"div"` | `"p"` | `"label"`

### Composant Heading

```tsx theme={null}
import { Heading } from "@whop/react";

<Heading size="6" as="h1">
    Page Title
</Heading>

<Heading size="4" as="h2" weight="medium">
    Section Heading
</Heading>
```

**Props :**

* `size` : de `"0"` à `"9"` (par défaut : `"6"`)
* `weight` : `"light"` | `"regular"` | `"medium"` | `"bold"`
* `align` : `"left"` | `"center"` | `"right"`
* `as` : `"h1"` | `"h2"` | `"h3"` | `"h4"` | `"h5"` | `"h6"`
* `color` : n'importe quelle couleur d'accent ou `"gray"`
* `highContrast` : augmente le contraste pour l'accessibilité

### Autres composants typographiques

```tsx theme={null}
import { Code, Strong, Em, Kbd } from "@whop/react";

<Code>const example = "code";</Code>
<Strong>Bold text</Strong>
<Em>Italic text</Em>
<Kbd>⌘ K</Kbd>
```

***

## Couleurs

Frosted UI utilise les échelles de couleurs Radix, qui fournissent des palettes de 12 niveaux avec des variantes pleines et alpha.

### Couleurs d'accent

27 couleurs d'accent sont disponibles :

**Couleurs standard :** `tomato`, `red`, `ruby`, `crimson`, `pink`, `plum`, `purple`, `violet`, `iris`, `indigo`, `blue`, `cyan`, `teal`, `jade`, `green`, `grass`, `brown`, `orange`

**Couleurs vives :** `sky`, `mint`, `lime`, `yellow`, `amber`, `lemon`, `magenta`

**Couleurs métalliques :** `gold`, `bronze`

### Couleurs grises

6 échelles de gris avec différentes températures de couleur :

* `gray` - Gris neutre pur
* `mauve` - Légèrement teinté de violet
* `slate` - Teinté de bleu froid
* `sage` - Subtilement teinté de vert
* `olive` - Teinté d'olive chaud
* `sand` - Teinté de sable chaud
* `auto` - S'adapte automatiquement à la couleur d'accent

### Couleurs sémantiques

Couleurs préconfigurées pour les cas d'usage courants :

* **Danger :** `red` (par défaut), `tomato`, `ruby`
* **Avertissement :** `amber` (par défaut), `yellow`
* **Succès :** `green` (par défaut), `teal`, `jade`, `grass`
* **Info :** `sky` (par défaut), `blue`

### Utiliser les couleurs

```tsx theme={null}
import { Button, Badge, Text } from "@whop/react";

<Button color="blue">Primary Action</Button>
<Button color="red">Delete</Button>
<Badge color="green">Active</Badge>
<Text color="gray">Muted text</Text>
```

### Classes de couleurs Tailwind

Avec le plugin Tailwind, vous pouvez utiliser directement les couleurs de Frosted UI :

```tsx theme={null}
<div className="bg-blue-2 text-blue-11 border border-blue-6">
    Blue themed box
</div>

<div className="bg-red-a3 text-red-11">
    Red with alpha background
</div>
```

**Échelle de couleurs :**

* Niveaux 1-3 : arrière-plans et remplissages discrets
* Niveaux 4-6 : bordures et séparateurs
* Niveaux 7-9 : éléments interactifs
* Niveaux 10-12 : texte et éléments à fort contraste

**Variantes alpha :**

* Utilisez `{color}-a1` à `{color}-a12` pour la transparence

> [!WARNING]
>
> Lorsque `frostedUiPlugin()` est ajouté à votre configuration tailwind, les couleurs
> tailwind par défaut comme `bg-blue-200` ne fonctionnent pas. Utilisez plutôt `bg-blue-2`
> conformément à la documentation ci-dessus.

***

## Mode sombre

Frosted UI inclut une prise en charge automatique du mode sombre qui respecte les préférences système et les choix de l'utilisateur.

### Fonctionnement

Gérez le mode sombre grâce à trois modes d'apparence :

* `"inherit"` (par défaut) - Respecte la préférence système
* `"light"` - Force le mode clair
* `"dark"` - Force le mode sombre

Le navigateur stocke la préférence de thème dans un cookie (`whop-frosted-theme`) et se rabat sur la préférence système en l'absence de cookie.

### Configuration

Configurez l'apparence dans votre composant `WhopApp` :

```tsx theme={null}
<WhopApp appearance="dark">{children}</WhopApp>
```

Ou créez des thèmes imbriqués avec des apparences différentes :

```tsx theme={null}
import { Theme } from "@whop/react";

<Theme appearance="light">
    <div>This section is always light</div>
</Theme>

<Theme appearance="dark">
    <div>This section is always dark</div>
</Theme>
```

### Classes Tailwind pour le mode sombre

Utilisez le préfixe `dark:` pour les styles du mode sombre :

```tsx theme={null}
<div className="bg-white dark:bg-black text-black dark:text-white">
	Adapts to theme
</div>
```

***

## Breakpoints

Frosted UI utilise un système responsive mobile-first avec 5 breakpoints.

### Échelle des breakpoints

| Nom | Largeur min | Usage |
| - | - | - |
| `initial` | 0px | Mobile (par défaut) |
| `xs` | 520px | Grand mobile |
| `sm` | 768px | Tablette |
| `md` | 1024px | Petit ordinateur |
| `lg` | 1280px | Ordinateur |
| `xl` | 1640px | Grand ordinateur |

### Props responsive

De nombreux composants prennent en charge des valeurs responsive via une syntaxe objet :

```tsx theme={null}
import { Text, Box } from "@whop/react";

<Text size={{ initial: "2", md: "4", lg: "6" }}>Responsive text size</Text>;
```

### Classes responsive Tailwind

```tsx theme={null}
<div className="p-2 md:p-4 lg:p-8">
    Responsive padding
</div>

<div className="text-2 sm:text-3 md:text-4">
    Responsive text
</div>
```

***

## Icônes

Frosted UI inclut un système d'icônes via le package `@frosted-ui/icons`.

### Utiliser les icônes

```tsx theme={null}
import { IconButton } from "@whop/react";
import { MagnifyingGlassIcon, Cross2Icon } from "@frosted-ui/icons";

<IconButton>
    <MagnifyingGlassIcon />
</IconButton>

<IconButton color="red">
    <Cross2Icon />
</IconButton>
```

### Icônes courantes

Frosted UI utilise Radix Icons, qui comprend des icônes telles que :

* Navigation : `ChevronRightIcon`, `ChevronDownIcon`, `ArrowRightIcon`
* Actions : `Cross2Icon`, `CheckIcon`, `PlusIcon`, `MinusIcon`
* UI : `MagnifyingGlassIcon`, `GearIcon`, `PersonIcon`
* D'autres icônes sont disponibles dans la bibliothèque.

***

## Plugin Tailwind

Le plugin Tailwind de Frosted UI fournit les design tokens sous forme d'utilitaires Tailwind.

### Contenu inclus

**Typographie :**

```tsx theme={null}
<p className="text-3 leading-3 font-medium tracking-2">
	Styled with Frosted UI tokens
</p>
```

**Couleurs :**

```tsx theme={null}
<div className="bg-blue-2 text-blue-11 border-blue-6">Blue themed</div>
```

**Espacement et mise en page :**

```tsx theme={null}
<div className="p-4 md:p-6 lg:p-8">Responsive padding</div>
```

### Principales différences avec Tailwind standard

1. **Échelle des tailles de police :** utilise 0-9 au lieu de xs/sm/base/lg
2. **Échelle des hauteurs de ligne :** correspond à l'échelle des tailles de police (0-9)
3. **Système de couleurs :** échelles de couleurs Radix en 12 niveaux avec variantes alpha
4. **Couleurs sémantiques :** couleurs danger, warning, success et info intégrées
5. **Design tokens :** toutes les valeurs utilisent des variables CSS pour la cohérence du thème

***

## Composants courants

### Button

```tsx theme={null}
import { Button } from "@whop/react";

<Button size="2" variant="solid" color="blue">
    Primary Action
</Button>

<Button size="2" variant="soft" color="gray">
    Secondary
</Button>

<Button size="2" variant="ghost" color="red">
    Danger
</Button>
```

**Props :**

* `size` : `"1"` | `"2"` | `"3"` | `"4"`
* `variant` : `"solid"` | `"soft"` | `"surface"` | `"ghost"` | `"classic"`
* `color` : n'importe quelle couleur d'accent
* `highContrast` : contraste renforcé
* `loading` : affiche un indicateur de chargement
* `disabled` : désactive l'interaction

### Input

```tsx theme={null}
import { TextInput, TextArea } from "@whop/react";

<TextInput
    size="2"
    placeholder="Enter text..."
    variant="surface"
/>

<TextArea
    size="2"
    placeholder="Enter multiple lines..."
    rows={4}
/>
```

### Card

```tsx theme={null}
import { Card } from "@whop/react";

<Card size="2" variant="surface">
	<Heading size="4">Card Title</Heading>
	<Text>Card content goes here</Text>
</Card>;
```

### Badge

```tsx theme={null}
import { Badge } from "@whop/react";

<Badge color="green" variant="soft">Active</Badge>
<Badge color="red" variant="solid">Error</Badge>
<Badge color="gray" variant="surface">Draft</Badge>
```

### Dialog

```tsx theme={null}
import { Dialog, Button } from "@whop/react";

<Dialog.Root>
	<Dialog.Trigger>
		<Button>Open Dialog</Button>
	</Dialog.Trigger>
	<Dialog.Content>
		<Dialog.Title>Dialog Title</Dialog.Title>
		<Dialog.Description>This is the dialog content</Dialog.Description>
		<Dialog.Close>
			<Button>Close</Button>
		</Dialog.Close>
	</Dialog.Content>
</Dialog.Root>;
```

### Select

```tsx theme={null}
import { Select } from "@whop/react";

<Select.Root defaultValue="1">
	<Select.Trigger />
	<Select.Content>
		<Select.Item value="1">Option 1</Select.Item>
		<Select.Item value="2">Option 2</Select.Item>
		<Select.Item value="3">Option 3</Select.Item>
	</Select.Content>
</Select.Root>;
```

### Checkbox et radio

```tsx theme={null}
import { Checkbox, RadioGroup } from "@whop/react";

<Checkbox size="2" color="blue">
    Accept terms
</Checkbox>

<RadioGroup.Root defaultValue="1">
    <RadioGroup.Item value="1">Option 1</RadioGroup.Item>
    <RadioGroup.Item value="2">Option 2</RadioGroup.Item>
</RadioGroup.Root>
```

***

## Utilisation avancée

### Personnalisation du thème

Personnalisez le thème avec plusieurs options :

```tsx theme={null}
<WhopApp
	appearance="dark"
	accentColor="violet"
	grayColor="mauve"
	dangerColor="ruby"
	warningColor="amber"
	successColor="jade"
	infoColor="sky"
>
	{children}
</WhopApp>
```

### Thèmes imbriqués

Créez des sections avec des thèmes différents :

```tsx theme={null}
import { Theme } from "@whop/react";

<div>
	<Theme accentColor="blue">
		<Button>Blue button</Button>
	</Theme>

	<Theme accentColor="red" appearance="dark">
		<Button>Red button in dark mode</Button>
	</Theme>
</div>;
```

### Accéder au contexte du thème

```tsx theme={null}
import { useThemeContext } from "@whop/react";

function ThemedComponent() {
	const theme = useThemeContext();

	console.log(theme.appearance); // "light" | "dark"
	console.log(theme.accentColor); // "blue" | "red" | ...

	return <div>Current theme: {theme.appearance}</div>;
}
```

***

## Bibliothèque de composants

Frosted UI inclut plus de 60 composants organisés par catégorie :

**Mise en page :** `Box`, `Flex`, `Grid`, `Container`, `Section`, `AspectRatio`, `Inset`

**Typographie :** `Heading`, `Text`, `Code`, `Strong`, `Em`, `Kbd`, `Quote`, `Blockquote`

**Formulaires :** `TextInput`, `TextArea`, `Checkbox`, `RadioGroup`, `Select`, `Switch`, `Slider`, `DatePicker`, `OTPField`

**Boutons :** `Button`, `IconButton`

**Affichage :** `Card`, `Avatar`, `AvatarGroup`, `Badge`, `Callout`, `Table`, `DataList`, `Skeleton`

**Navigation :** `Tabs`, `Breadcrumbs`, `Link`, `SegmentedControl`

**Superposition :** `Dialog`, `AlertDialog`, `Drawer`, `Sheet`, `Popover`, `HoverCard`, `Tooltip`, `DropdownMenu`, `ContextMenu`

**Feedback :** `Progress`, `CircularProgress`, `Spinner`

**Utilitaires :** `ScrollArea`, `Separator`, `Portal`, `VisuallyHidden`, `AccessibleIcon`

> [!NOTE]
>
> Tous les composants sont construits sur les primitives Radix UI et suivent les bonnes
> pratiques d'accessibilité.

***

## Ressources

* [Documentation Radix UI](https://www.radix-ui.com/) - Primitives de composants
* [Radix Colors](https://www.radix-ui.com/colors) - Documentation du système de couleurs
* [Tailwind CSS](https://tailwindcss.com/) - Framework CSS utility-first
