Back to Shadcn Ui

Radio Group

apps/v4/content/docs/components/base/radio-group.mdx

latest2.4 KB
Original Source
<ComponentPreview styleName="base-nova" name="radio-group-demo" />

Installation

<CodeTabs> <TabsList> <TabsTrigger value="cli">Command</TabsTrigger> <TabsTrigger value="manual">Manual</TabsTrigger> </TabsList> <TabsContent value="cli">
bash
npx shadcn@latest add radio-group
</TabsContent> <TabsContent value="manual"> <Steps className="mb-0 pt-2">

<Step>Install the following dependencies:</Step>

bash
npm install @base-ui/react

<Step>Copy and paste the following code into your project.</Step>

<ComponentSource name="radio-group" title="components/ui/radio-group.tsx" styleName="base-nova" />

<Step>Update the import paths to match your project setup.</Step>

</Steps> </TabsContent> </CodeTabs>

Usage

tsx
import { Label } from "@/components/ui/label"
import { RadioGroup, RadioGroupItem } from "@/components/ui/radio-group"
tsx
<RadioGroup defaultValue="option-one">
  <div className="flex items-center gap-3">
    <RadioGroupItem value="option-one" id="option-one" />
    <Label htmlFor="option-one">Option One</Label>
  </div>
  <div className="flex items-center gap-3">
    <RadioGroupItem value="option-two" id="option-two" />
    <Label htmlFor="option-two">Option Two</Label>
  </div>
</RadioGroup>

Examples

Description

Radio group items with a description using the Field component.

<ComponentPreview styleName="base-nova" name="radio-group-description" />

Choice Card

Use FieldLabel to wrap the entire Field for a clickable card-style selection.

<ComponentPreview styleName="base-nova" name="radio-group-choice-card" />

Fieldset

Use FieldSet and FieldLegend to group radio items with a label and description.

<ComponentPreview styleName="base-nova" name="radio-group-fieldset" />

Disabled

Use the disabled prop on RadioGroup to disable all items.

<ComponentPreview styleName="base-nova" name="radio-group-disabled" />

Invalid

Use aria-invalid on RadioGroupItem and data-invalid on Field to show validation errors.

<ComponentPreview styleName="base-nova" name="radio-group-invalid" />

RTL

To enable RTL support in shadcn/ui, see the RTL configuration guide.

<ComponentPreview styleName="base-nova" name="radio-group-rtl" direction="rtl" />

API Reference

See the Base UI Radio Group documentation.