UNPKG

@kiwicom/orbit-components

Version:

Orbit-components is a React component library which provides developers with the easiest possible way of building Kiwi.com’s products.

51 lines (43 loc) 1.9 kB
# Radio To implement Radio component into your project you'll need to add the import: ```jsx import Radio from "@kiwicom/orbit-components/lib/Radio"; ``` After adding import into your project you can use it simply like: ```jsx <Radio label="Radio" /> ``` ## Props Table below contains all types of the props available in Radio component. | Name | Type | Default | Description | | :------- | :----------- | :------ | :------------------------------- | | checked | `boolean` | `false` | If `true`, the Radio will be checked. | dataTest | `string` | | Optional prop for testing purposes. | disabled | `boolean` | `false` | If `true`, the Radio will be set up as disabled. | hasError | `boolean` | `false` | If `true`, the border of the Radio will turn red. [See Functional specs](#functional-specs) | info | `React.Node` | | The additional info about the Radio. | label | `string` | | The label of the Radio. | name | `string` | | The name for the Radio. | onChange | `func` | | Function for handling onChange event. | ref | `func` | | Prop for forwarded ref of the Radio. [See Functional specs](#functional-specs) | value | `string` | | The value of the Radio. ## Functional specs * The`hasError` prop will be visible only when the Radio has `checked` or `disabled` prop set on false. * `ref` can be used for example auto-focus the elements immediately after render. ```jsx class Component extends React.PureComponent<Props> { constructor() { super() this.ref = React.createRef(); } componentDidMount() { this.ref.current && this.ref.current.focus(); } ref: { current: React$ElementRef<*> | null }; render() { return ( <Radio ref={this.ref} /> ) } } ```