UNPKG

@primer/components

Version:
39 lines (38 loc) 1.34 kB
import React, { InputHTMLAttributes } from 'react'; import { SxProp } from './sx'; export declare type RadioProps = { /** * A unique value that is never shown to the user. * Used during form submission and to identify which radio button in a group is selected */ value: string; /** * Name attribute of the input element. Required for grouping radio inputs */ name: string; /** * Apply inactive visual appearance to the radio button */ disabled?: boolean; /** * Indicates whether the radio button is selected */ checked?: boolean; /** * Forward a ref to the underlying input element */ ref?: React.RefObject<HTMLInputElement>; /** * Indicates whether the radio button must be checked before the form can be submitted */ required?: boolean; /** * Indicates whether the radio button validation state is non-standard */ validationStatus?: 'error' | 'success'; } & InputHTMLAttributes<HTMLInputElement> & SxProp; /** * An accessible, native radio component for selecting one option from a list. */ declare const Radio: React.ForwardRefExoticComponent<Pick<RadioProps, "sx" | keyof React.InputHTMLAttributes<HTMLInputElement> | "validationStatus"> & React.RefAttributes<HTMLInputElement>>; export default Radio;