Skip to content

shadcn.io is an independent project built on shadcn/ui

Free

With Description Checkbox for Svelte

A Marketing emails checkbox with a muted line under the label about new products, features and updates.

UI library: Ark UI

One checkbox labeled Marketing emails. Under it, muted text says people will receive emails about new products, features and updates.

Add that line when the consequence is easy to miss, such as an email opt-in. A Switch fits a setting that applies the moment it changes. Ark UI in Svelte does not write the helper sentence.

Preview

Preview width

Installation

MCP · Pro
Make your AI a shadcn expert
Your agent installs components, builds pages and restyles your app from one prompt, in Claude Code, Cursor or VS Code.
Part of Pro

Anatomy

Checkbox anatomy: root, control, indicator, label

Usage

<Field class="max-w-sm" orientation="horizontal"><Checkbox name="marketing-emails" /><FieldContent><FieldLabel>Marketing emails</FieldLabel><FieldDescription>Receive emails about new products, features, and updates.</FieldDescription></FieldContent></Field>

FAQ

When should I add description text to checkboxes?

When the label alone doesn't say what checking it means: what an email list will send, what data is shared, what a permission allows. If people would ask "what does this do?", add a description. Skip it for self-explanatory options like "Enable dark mode".

How long should description text be?

One or two short sentences. The description explains the consequence; it isn't a policy. Link to full terms when there is more to say, and keep each line quick to scan.

Why is the description muted?

FieldDescription uses text-muted-foreground at a smaller size, so the label reads first and the description second. The two levels let people decide from the label and read on only when they need the detail.

How does description text wrap on narrow screens?

It wraps like any paragraph, and the field caps the block at max-w-sm here. Because the field holds a FieldContent, it aligns its items to the start, so the checkbox stays level with the label instead of drifting to the middle of a tall block.

Can description text contain links or formatting?

Yes. It is ordinary text, so a link to the terms or privacy policy, or a strong for emphasis, works. Keep it static: people expect a description to explain the option, not to hold more controls.

Do screen readers announce description text?

The label is the checkbox's name; the description is ordinary text next to it, read when a screen reader moves through the page. To have it announced with the checkbox on focus, give the description an id and point the checkbox's aria-describedby at it.

API Reference

Field

Sets orientation="horizontal". The rest is on the Field page.

Checkbox

Sets name="marketing-emails". The rest is on the Checkbox page.