snapshot of https://github.com/shadcn-ui/ui.git (main, 2026-09-15; blobs > 131072B omitted)
This commit is contained in:
127
apps/v4/content/docs/components/radix/radio-group.mdx
Normal file
127
apps/v4/content/docs/components/radix/radio-group.mdx
Normal file
@@ -0,0 +1,127 @@
|
||||
---
|
||||
title: Radio Group
|
||||
description: A set of checkable buttons—known as radio buttons—where no more than one of the buttons can be checked at a time.
|
||||
base: radix
|
||||
component: true
|
||||
links:
|
||||
doc: https://www.radix-ui.com/docs/primitives/components/radio-group
|
||||
api: https://www.radix-ui.com/docs/primitives/components/radio-group#api-reference
|
||||
---
|
||||
|
||||
<ComponentPreview styleName="radix-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 radix-ui
|
||||
```
|
||||
|
||||
<Step>Copy and paste the following code into your project.</Step>
|
||||
|
||||
<ComponentSource
|
||||
name="radio-group"
|
||||
title="components/ui/radio-group.tsx"
|
||||
styleName="radix-nova"
|
||||
/>
|
||||
|
||||
<Step>Update the import paths to match your project setup.</Step>
|
||||
|
||||
</Steps>
|
||||
|
||||
</TabsContent>
|
||||
|
||||
</CodeTabs>
|
||||
|
||||
## Usage
|
||||
|
||||
```tsx showLineNumbers
|
||||
import { Label } from "@/components/ui/label"
|
||||
import { RadioGroup, RadioGroupItem } from "@/components/ui/radio-group"
|
||||
```
|
||||
|
||||
```tsx showLineNumbers
|
||||
<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>
|
||||
```
|
||||
|
||||
## Composition
|
||||
|
||||
Use the following composition to build a `RadioGroup`:
|
||||
|
||||
```text
|
||||
RadioGroup
|
||||
├── RadioGroupItem
|
||||
└── RadioGroupItem
|
||||
```
|
||||
|
||||
## Description
|
||||
|
||||
Radio group items with a description using the `Field` component.
|
||||
|
||||
<ComponentPreview styleName="radix-nova" name="radio-group-description" />
|
||||
|
||||
## Choice Card
|
||||
|
||||
Use `FieldLabel` to wrap the entire `Field` for a clickable card-style selection.
|
||||
|
||||
<ComponentPreview styleName="radix-nova" name="radio-group-choice-card" />
|
||||
|
||||
## Fieldset
|
||||
|
||||
Use `FieldSet` and `FieldLegend` to group radio items with a label and description.
|
||||
|
||||
<ComponentPreview styleName="radix-nova" name="radio-group-fieldset" />
|
||||
|
||||
## Disabled
|
||||
|
||||
Use the `disabled` prop on `RadioGroupItem` to disable individual items.
|
||||
|
||||
<ComponentPreview styleName="radix-nova" name="radio-group-disabled" />
|
||||
|
||||
## Invalid
|
||||
|
||||
Use `aria-invalid` on `RadioGroupItem` and `data-invalid` on `Field` to show validation errors.
|
||||
|
||||
<ComponentPreview styleName="radix-nova" name="radio-group-invalid" />
|
||||
|
||||
## RTL
|
||||
|
||||
To enable RTL support in shadcn/ui, see the [RTL configuration guide](/docs/rtl).
|
||||
|
||||
<ComponentPreview
|
||||
styleName="radix-nova"
|
||||
name="radio-group-rtl"
|
||||
direction="rtl"
|
||||
/>
|
||||
|
||||
## API Reference
|
||||
|
||||
See the [Radix UI Radio Group](https://www.radix-ui.com/docs/primitives/components/radio-group#api-reference) documentation.
|
||||
Reference in New Issue
Block a user