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

# Clementine DS Component Library Overview

> Ten React components in Clementine DS — each with a closed token contract, required ARIA attributes, and interaction state specs for AI-safe usage.

Clementine DS ships 10 React components backed by Mantine. Each component has a spec in `specs/<component>/` containing a closed token contract, required ARIA attributes, and interaction state definitions. Components earn an **AI-Ready** status only after all five spec gates pass — until then they carry **Draft** status and should be treated as unverified.

## Component Status

| Component | Status | Purpose |
| - | - | - |
| Button | ✅ AI-Ready | Primary action trigger |
| Badge | 🔶 Draft | Status and risk level indicator |
| TextInput | 🔶 Draft | Single-line text entry |
| Textarea | 🔶 Draft | Multi-line text entry |
| Select | 🔶 Draft | Dropdown selection |
| Checkbox | 🔶 Draft | Binary toggle |
| Radio | 🔶 Draft | Single selection from group |
| Switch | 🔶 Draft | On/off toggle |
| Tabs | 🔶 Draft | Tabbed content navigation |
| Modal | 🔶 Draft | Overlay dialog |

### AI-Ready vs Draft

**AI-Ready** means all five spec gates pass:

* `aria_correct` — required ARIA attributes are documented and implemented correctly
* `structure_correct` — semantic HTML structure matches the spec
* `states_complete` — every interaction state is defined with tokens
* `tokens_valid` — every token reference resolves through the 3-tier cascade without a gap
* `no_invented_styles` — no hardcoded hex values or out-of-contract color bindings

**Draft** means the component exists and ships, but at least one gate has not been verified. You can use Draft components in production, but their token bindings and variant definitions should not be modified until spec verification is complete.

## Installation

Install the package and import components directly from `@clementine-ds/ui`:

```bash theme={null}
npm install @clementine-ds/ui @mantine/core @mantine/hooks
```

```tsx theme={null}
import { Button, Badge, TextInput } from '@clementine-ds/ui';
```

Wrap your application in `ClementineDSProvider` to apply the Clementine theme:

```tsx theme={null}
import { ClementineDSProvider } from '@clementine-ds/ui';

function App() {
  return (
    <ClementineDSProvider>
      {/* your app */}
    </ClementineDSProvider>
  );
}
```

## Components

> [card] [Button](https://clementineds.mintlify.site/components/button.md)
>
> Primary action trigger. AI-Ready with 4 variants, 3 sizes, and 15 component tokens.

> [card] [Badge](https://clementineds.mintlify.site/components/badge.md)
>
> Inline status and risk level labels with 8 intent variants including 4 risk tiers.

> [card] [TextInput](https://clementineds.mintlify.site/components/text-input.md)
>
> Single-line text entry backed by Mantine TextInput with Clementine token bindings.

> [card] [Textarea](https://clementineds.mintlify.site/components/textarea.md)
>
> Multi-line text entry for longer free-form content.

> [card] [Select](https://clementineds.mintlify.site/components/select.md)
>
> Accessible dropdown selection for choosing one option from a list.

> [card] [Checkbox](https://clementineds.mintlify.site/components/checkbox.md)
>
> Binary toggle for boolean choices in forms and settings.

> [card] [Radio](https://clementineds.mintlify.site/components/radio.md)
>
> Single selection from a mutually exclusive group of options.

> [card] [Switch](https://clementineds.mintlify.site/components/switch.md)
>
> On/off toggle for immediately applied settings. Prefer over Checkbox for live changes.

> [card] [Tabs](https://clementineds.mintlify.site/components/tabs.md)
>
> Tabbed content navigation for switching between related views or sections.

> [card] [Modal](https://clementineds.mintlify.site/components/modal.md)
>
> Overlay dialog for confirmations, forms, and focused sub-tasks.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.