mirror of
https://github.com/shadcn-ui/ui.git
synced 2026-06-29 23:55:02 +00:00
38de7fddc2
* feat: rtl * feat * fix * fix * fix * fix * fix * fix * fix * fix * fix * fix * fix * feat: add sidebar * fix * fix * fix * fix * fix * fix * fix * fix * fix * fix * fix * fix * fix * chore: changeset * fix * fix * fix * fix * fix * fix * fix * fix * fix * fix * fix * fix * fix * fix * fix * fix * fix * fix
120 lines
2.7 KiB
Plaintext
120 lines
2.7 KiB
Plaintext
---
|
|
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: base
|
|
component: true
|
|
links:
|
|
doc: https://base-ui.com/react/components/radio-group
|
|
api: https://base-ui.com/react/components/radio-group#api-reference
|
|
---
|
|
|
|
<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 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>
|
|
```
|
|
|
|
## 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](/docs/rtl).
|
|
|
|
<ComponentPreview
|
|
styleName="base-nova"
|
|
name="radio-group-rtl"
|
|
direction="rtl"
|
|
/>
|
|
|
|
## API Reference
|
|
|
|
See the [Base UI Radio Group](https://base-ui.com/react/components/radio-group#api-reference) documentation.
|