Radio Group
The RadioGroup component is designed to manage a set of radio buttons that allows users to select a single option from multiple choices. It groups multiple Radio components together, ensuring that only one option can be selected at a time.
Installation
Install the package
npm i @start-base/react-form-elements
Add the styles
To use the React form elements styles in a Next.js project, import the styles in your layout.tsx
file.
app/layout.tsx
import "@start-base/react-form-elements/styles.css";
Import the component
import RadioGroup from '@start-base/react-form-elements/RadioGroup';
Usages
Radio Group Component Disabled
Radio Option 1
Radio Option 2
Radio Group Component Error
Radio Option 1
Radio Option 2
Error Message
API
A group of radio inputs managed together.
Name | Type | Default | Description |
---|---|---|---|
name | string | Name of the input | |
label | string | null | Label of the input |
value | string or number | Value of the input | |
onChange | function | Callback function that is fired when the value changes. | |
inputClassName | string | null | Classname for input element |
labelClassName | string | null | Classname for label element |
errorClassName | string | null | Classname for error element |
disabled | boolean | false | Disable the input |
error | string or boolean or object | null | Error message to display below the input. if value is a boolean input border will be change. Also you can pass schema validator error objects. |
options | array | [] | Array of options to display |
optionLabelClassName | string | null | Classname for option label |