Preview
Installation
Install the runtime packages:
pnpm add @oshon-ai/components @oshon-ai/tokens @oshon-ai/primitives
Or scaffold the component source directly into your codebase (shadcn-style):
pnpm dlx @oshon-ai/cli add selectioncontrols
Wire the tokens into your Tailwind v4 stylesheet:
/* app/globals.css */ @import 'tailwindcss'; @import '@oshon-ai/tokens/css'; @import '@oshon-ai/tokens/tailwind';
New here? Walk through the full setup — prereqs, theming, your first render.
Usage
Import the component and render it. Every component supports the standard tier, size, and disabled props where applicable.
'use client';
import { SelectionControls } from '@oshon-ai/components';
export default function Example() {
return <SelectionControls />;
}Default
<Checkbox size="m" label="Accept terms" />
Size matrix
<div style={{ display: 'flex', flexDirection: 'column', gap: '1rem', alignItems: 'flex-start' }}>
<div key="xs" data-story-size="xs">
<Checkbox size="xs" label="Accept terms" />
</div>
<div key="s" data-story-size="s">
<Checkbox size="s" label="Accept terms" />
</div>
<div key="m" data-story-size="m">
<Checkbox size="m" label="Accept terms" />
</div>
<div key="l" data-story-size="l">
<Checkbox size="l" label="Accept terms" />
</div>
<div key="mobile" data-story-size="mobile">
<Checkbox size="mobile" label="Accept terms" />
</div>
</div>API
Every prop is documented here directly from the component's TypeScript interface. Inherited DOM attributes (aria-*, onClick, style, etc.) work as usual but are omitted from this table.
| Prop | Type | Default | Description |
|---|---|---|---|
checked | boolean | — | Controlled checked state. |
className | string | — | Additional classes merged after the root defaults. |
defaultChecked | boolean | — | Uncontrolled initial checked state. |
description | ReactNode | — | Optional secondary description rendered under the label. |
disabled | boolean | — | Disabled state. |
indeterminate | boolean | — | Indeterminate visual + ARIA state. Independent of `checked` per the WAI-ARIA `aria-checked="mixed"` pattern. |
label | ReactNode | — | Optional visible label rendered to the right of the box. |
onCheckedChange | ((checked: boolean) => void) | — | Fires on every toggle with the new boolean. |
size | enum | m | Visual size. Default `'m'` (Figma 20×20). |
slotClassName | CheckboxSlotClassNames | — | Per-slot className overrides. |
Styling
Three layers of customization, in order of escape-hatch strength: className overrides → data-attribute targeting → CSS custom properties.
Passing Tailwind classes
Every Oshon component accepts a className prop merged AFTER the component's default classes. Use it to override spacing, color, or size without forking the component.
<SelectionControls className="ring-2 ring-offset-2 ring-blue-500" />
Data attributes
Oshon components expose their internal state as data-oshon-* attributes so you can target them from CSS without coupling to internal class names. The most common attributes are listed below — see the component's source for the full set.
| Attribute | Values | Description |
|---|---|---|
data-oshon-size | xs · s · m · l · mobile | Visual size axis. Mirrors the `size` prop. |
data-oshon-tier | primary · secondary · tertiary | Visual emphasis tier (Button family). Mirrors the `tier` prop. |
data-oshon-state | enabled · active · error · disabled | Component surface state. Set automatically based on props. |
data-disabled | true · (omitted) | Set when `disabled` is true. Pair with `:disabled` CSS for native input components. |
data-state | open · closed · checked · unchecked · … | Radix-derived state for overlay components (Dialog, Tabs, Toggle, etc.). |
/* Target the secondary tier specifically */
[data-oshon-tier="secondary"] {
--oshon-color-primary-700: var(--my-brand-color);
}Interactive states
Every interactive component supports the standard CSS pseudo- classes plus Tailwind's state variants. Focus rings always use :focus-visible so keyboard users see them but mouse users don't.
:hover/hover:*— pointer hover:focus-visible/focus-visible:*— keyboard focus:active/active:*— pressed:disabled/disabled:*— set via thedisabledprop