Some checks failed
App Prod-Parity E2E Dispatch / dispatch (push) Failing after 10s
CD Storybook UI / build (push) Failing after 3m25s
CD Storybook UI / dispatch (push) Has been skipped
CD deploy main / website-changed-files (push) Successful in 18m8s
CI Agent Skills / changed-files-check (push) Successful in 18m9s
CI Create App E2E minimal / changed-files-check (push) Successful in 24s
CI Create App / changed-files-check (push) Successful in 26s
CI Docs / changed-files-check (push) Successful in 26s
CI Emails / changed-files-check (push) Successful in 28s
CI Example App Hello World / changed-files-check (push) Successful in 23s
CI Front / changed-files-check (push) Has been skipped
CI Example App Postcard / changed-files-check (push) Successful in 27s
CI UI / changed-files-check (push) Has been skipped
CI Utils Test / changed-files-check (push) Successful in 45s
CI Twenty Apps / discover (push) Successful in 1m3s
CD deploy main / deploy-main (push) Failing after 3s
CI Agent Skills / agent-skills-validate (push) Has been skipped
CI Create App / create-app-test (lint) (push) Has been skipped
CI Emails / emails-test (push) Has been skipped
CI Front / front-task (lingui:compile) (push) Has been skipped
CI Front / front-task (lint) (push) Has been skipped
CI Example App Postcard / example-app-postcard (push) Has been skipped
CI UI / ui-task (lint) (push) Has been skipped
CI UI / ui-task (pack-size) (push) Has been skipped
CI UI / ui-task (size) (push) Has been skipped
CI UI / ui-task (test) (push) Has been skipped
CI UI / ui-task (typecheck) (push) Has been skipped
CI Utils Test / utils-test (push) Has been skipped
CI Twenty Apps / ${{ matrix.app.name }} (push) Has been skipped
CI Emails / ci-emails-status-check (push) Successful in 2s
CI Example App Hello World / ci-example-app-hello-world-status-check (push) Successful in 2s
CI Example App Postcard / ci-example-app-postcard-status-check (push) Successful in 3s
CI UI / ui-sb-test (push) Has been skipped
CI Utils Test / ci-utils-test-status-check (push) Successful in 2s
CI Twenty Apps / ci-twenty-apps-status-check (push) Successful in 2s
CI UI / ci-ui-status-check (push) Successful in 2s
CI Desktop / desktop (push) Failing after 1m8s
Push docs to Crowdin / Push documentation to Crowdin (push) Failing after 55s
Push translations to Crowdin / Extract and upload translations (push) Failing after 5s
Push website translations to Crowdin / Extract and upload website translations (push) Failing after 5s
CI Create App / create-app-test (test) (push) Has been skipped
CI Create App / create-app-test (typecheck) (push) Has been skipped
CI Docs / docs-lint (push) Has been skipped
CI Example App Hello World / example-app-hello-world (push) Has been skipped
CI Front / front-task (lingui:extract) (push) Has been skipped
CI Front / front-task (test) (push) Has been skipped
CI Front / front-task (typecheck) (push) Has been skipped
CI UI / ui-sb-build (push) Failing after 1m32s
CI Twenty Apps / ${{ matrix.app.name }} (${{ matrix.server-source }}) (push) Has been skipped
CI Agent Skills / agent-skills-publish (push) Has been skipped
CI Create App / ci-create-app-status-check (push) Successful in 2s
CI Agent Skills / agent-skills-remote-source (push) Has been skipped
CI Create App E2E minimal / create-app-e2e-minimal (push) Has been cancelled
CI E2E Main / e2e-test (push) Has been cancelled
CI Front / front-sb-build (push) Has been cancelled
CI Front / front-build (push) Has been cancelled
CI Create App E2E minimal / ci-create-app-e2e-minimal-status-check (push) Has been cancelled
CI E2E Main / ci-e2e-main-status-check (push) Has been cancelled
CI E2E Main / notify-main-ci-failure (push) Has been cancelled
CI E2E Main / qa-scout-comment (push) Has been cancelled
CI Front / front-sb-test (push) Has been cancelled
CI Front / front-sb-screenshots (push) Has been cancelled
CI Front / ci-front-status-check (push) Has been cancelled
DPA Sub-Processor Sync / sync-subprocessors (push) Failing after 3s
AI Catalog Sync / sync-catalog (push) Failing after 2s
118 lines
3.9 KiB
Plaintext
118 lines
3.9 KiB
Plaintext
---
|
|
title: RadioGroup
|
|
description: Manage a single selection across a set of radio options.
|
|
---
|
|
|
|
import { StoryEmbed } from '/snippets/ui/StoryEmbed.mdx';
|
|
|
|
import RadioGroupReference from '/snippets/ui/generated/input/radio-group.mdx';
|
|
|
|
`RadioGroup` coordinates the value, keyboard navigation, and form submission of its [Radio](/ui/primitives/input/radio) children.
|
|
|
|
<StoryEmbed
|
|
storyId="ui-input-radiogroup--default"
|
|
title="RadioGroup example"
|
|
height={240}
|
|
/>
|
|
|
|
## Anatomy
|
|
|
|
Put each `Radio` inside the group and associate it with a label. `RadioGroup` and `Radio` are separate exports.
|
|
|
|
```text
|
|
fieldset
|
|
├── legend
|
|
└── RadioGroup
|
|
├── label
|
|
│ └── Radio
|
|
└── label
|
|
└── Radio
|
|
```
|
|
|
|
| Part | Requirement | Purpose |
|
|
| -------------------- | --------------------------- | ---------------------------------------------------------- |
|
|
| `RadioGroup` | Required | Owns selection, keyboard navigation, and form integration. |
|
|
| `Radio` | One per option | Supplies an option with a distinct `value`. |
|
|
| `label` | Recommended for each option | Provides a visible, clickable name for its radio. |
|
|
| `fieldset`, `legend` | Optional grouping | Groups related controls under a visible heading. |
|
|
|
|
Give the group its own accessible name using `aria-label` or `aria-labelledby`. In the examples below, `aria-labelledby` connects the group to the legend. Each radio also needs its own name. Put selection props on `RadioGroup` and option values on `Radio`.
|
|
|
|
## Uncontrolled state
|
|
|
|
Use `defaultValue` to set the initial billing frequency. The group owns subsequent changes.
|
|
|
|
```tsx
|
|
import { useId } from 'react';
|
|
import { Radio, RadioGroup } from 'twenty-ui/primitives/input';
|
|
|
|
export const BillingFrequency = () => {
|
|
const labelId = useId();
|
|
|
|
return (
|
|
<fieldset>
|
|
<legend id={labelId}>Billing frequency</legend>
|
|
<RadioGroup
|
|
name="billingFrequency"
|
|
defaultValue="monthly"
|
|
aria-labelledby={labelId}
|
|
>
|
|
<label>
|
|
<Radio value="monthly" />
|
|
Monthly
|
|
</label>
|
|
<label>
|
|
<Radio value="yearly" />
|
|
Yearly
|
|
</label>
|
|
</RadioGroup>
|
|
</fieldset>
|
|
);
|
|
};
|
|
```
|
|
|
|
The group's `name` identifies the selected value in form submission. Give the group an accessible name as well as labeling each radio.
|
|
|
|
## Controlled state
|
|
|
|
Pass `value` and update it with `onValueChange` to own the same billing frequency in React state. Selection belongs to the group, not to individual radio controls.
|
|
|
|
```tsx
|
|
import { useId, useState } from 'react';
|
|
import { Radio, RadioGroup } from 'twenty-ui/primitives/input';
|
|
|
|
export const BillingFrequency = () => {
|
|
const labelId = useId();
|
|
const [billingFrequency, setBillingFrequency] = useState('monthly');
|
|
|
|
return (
|
|
<fieldset>
|
|
<legend id={labelId}>Billing frequency</legend>
|
|
<RadioGroup
|
|
name="billingFrequency"
|
|
value={billingFrequency}
|
|
onValueChange={setBillingFrequency}
|
|
aria-labelledby={labelId}
|
|
>
|
|
<label>
|
|
<Radio value="monthly" />
|
|
Monthly
|
|
</label>
|
|
<label>
|
|
<Radio value="yearly" />
|
|
Yearly
|
|
</label>
|
|
</RadioGroup>
|
|
</fieldset>
|
|
);
|
|
};
|
|
```
|
|
|
|
`onValueChange` receives the next value and event details. The generic value type is inferred from the props. Use `disabled` on the group to disable every option, or on an individual radio to disable one choice. Arrow keys navigate the enabled options; Tab moves out of the group.
|
|
|
|
## Props
|
|
|
|
The reference is generated from the public component types. Native attributes, including accessible names and event handlers, are also accepted on parts that render elements.
|
|
|
|
<RadioGroupReference />
|