@commercetools-uikit/radio-field

# RadioField ## Description A controlled radio input component with validation states and a label. ## Installation ``` yarn add @commercetools-uikit/radio-field ``` ``` npm --save install @commercetools-uikit/radio-field ``` Additionally install the peer dependencies (if not present) ``` yarn add react ``` ``` npm --save install react ``` ## Usage ```jsx import RadioField from '@commercetools-uikit/radio-field'; import RadioInput from '@commercetools-uikit/radio-input'; const Example = () => ( <RadioField title="Fruits" name="fruits" value="apple" onChange={(event) => alert(event.target.value)} > <RadioInput.Option value="apple">{'Apple'}</RadioInput.Option> <RadioInput.Option value="banana">{'Banana'}</RadioInput.Option> </RadioField> ); export default Example; ``` ## Properties | Props | Type | Required | Default | Description | | ---------------------- | ----------------------------------------------------------------------------------------- | :------: | --------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | `string` | | | Used as HTML id property. An id is auto-generated when it is not specified. | | `horizontalConstraint` | `union` Possible values: `, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 'scale', 'auto'` | | `'scale'` | Horizontal size limit of the input fields. | | `errors` | `Record` | | | A map of errors. Error messages for known errors are rendered automatically. Unknown errors will be forwarded to `renderError`. | | `warnings` | `Record` | | | A map of warnings. Warning messages for known warnings are rendered automatically.
 
Unknown warnings will be forwarded to renderWarning. | | `renderError` | `Function` [See signature.](#signature-rendererror) | | | Called with custom errors.
 
This function can return a message which will be wrapped in an ErrorMessage. It can also return null to show no error. | | `renderWarning` | `Function` [See signature.](#signature-renderwarning) | | | Called with custom warnings, as renderWarning(key, warning). This function can return a message which will be wrapped in a WarningMessage.
 
It can also return null to show no warning. | | `isRequired` | `boolean` | | | Indicates if the value is required. Shows an the "required asterisk" if so. | | `touched` | `boolean` | | | Indicates whether the field was touched. Errors will only be shown when the field was touched. | | `name` | `string` | | | Used as HTML name of the input component. | | `value` | `union` Possible values: `string , boolean` | ✅ | | Value of the input component. | | `onChange` | `ChangeEventHandler` | | | Called with an event containing the new value. Required when input is not read only. Parent should pass it back as value. | | `onBlur` | `FocusEventHandler` | | | Called when input is blurred | | `onFocus` | `FocusEventHandler` | | | Called when input is focused | | `isDisabled` | `boolean` | | | Indicates that the input cannot be modified (e.g not authorized, or changes currently saving). | | `isReadOnly` | `boolean` | | | Indicates that the field is displaying read-only content | | `direction` | `union` Possible values: `'stack' , 'inline'` | | | Rendering direction of the radio `RadioInput.Option`s | | `directionProps` | `Partial` | | | Passes props of the `Spacings.Stack` or `Spacings.Inline`, depending on the chosen direction | | `children` | `ReactNode` | ✅ | | At least one `RadioInput.Option` component or another node (mixed children are allowed) | | `title` | `union` Possible values: `string , ReactNode` | ✅ | | Title of the label | | `hint` | `union` Possible values: `string , ReactNode` | | | Hint for the label. Provides a supplementary but important information regarding the behaviour of the input (e.g warn about uniqueness of a field, when it can only be set once), whereas description can describe it in more depth.
 
Can also receive a `hintIcon`. | | `description` | `union` Possible values: `string , ReactNode` | | | Provides a description for the title. | | `onInfoButtonClick` | `Function` [See signature.](#signature-oninfobuttonclick) | | | Function called when info button is pressed.
 
Info button will only be visible when this prop is passed. | | `hintIcon` | `ReactElement` | | | Icon to be displayed beside the hint text.
 
Will only get rendered when `hint` is passed as well. | | `badge` | `ReactNode` | | | Badge to be displayed beside the label.
 
Might be used to display additional information about the content of the field (E.g verified email) | ## Signatures ### Signature `renderError` ```ts (key: string, error?: boolean) => ReactNode; ``` ### Signature `renderWarning` ```ts (key: string, warning?: boolean) => ReactNode; ``` ### Signature `onInfoButtonClick` ```ts ( event: MouseEvent<HTMLButtonElement> | KeyboardEvent<HTMLButtonElement> ) => void ``` ## `data-*` props The component further forwards all `data-` attributes to the underlying `RadioInput` component. ### RadioInput.Option See `RadioInput` README for the list of props. ## `errors` This object is a key-value map. The `renderError` prop will be called for each entry with the key and the value. The return value will be rendered inside an `ErrorMessage` component underneath the input. The `RadioField` supports some errors out of the box. Return `undefined` from `renderError` for these and the default errors will be shown instead. This prevents consumers from having to reimplement the same error messages for known errors while still keeping the flexibility of showing custom error messages for them. When the `key` is known, and when the value is truthy, and when `renderError` returned `undefined` for that error entry, then the `RadioField` will render an appropriate error automatically. Known error keys are: - `missing`: tells the user that this field is required ## Main Functions and use cases are: - Single option selection field in login forms ## Static methods ### `RadioField.toFieldErrors` Use this function to convert the Formik `errors` object type to our custom field errors type. This is primarily useful when using TypeScript. ```ts type FormValues = { myField: string; }; <RadioField // ... name="my-field" errors={RadioField.toFieldErrors<FormValues>(formik.errors).myField} />; ```