react-radio
A carefully crafted radio-group for React
See demo at zippyui.github.io/react-radio
Install
$ npm install react-radio --save
Usage
var RadioGroup = var colors = value: 'red' label: 'Red color' style: color: 'red' 'blue' 'orange' { console} //uncontrolled<RadioGroup ="colors" = = =/> var COLOR = 'red'//controlled<RadioGroup ="colors" = = = /> <RadioGroup ="colors" = => <input ="radio" ="blue" />blue <input ="radio" ="red" />red</RadioGroup>
Props
-
name: String - the name to be set to all radios in the group
-
value/defaultValue - the value that should be checked in the group (controlled/uncontrolled)
-
labelStyle - a style for the radio label
-
disabledStyle|disabledLabelStyle - a style for the radio label, when disabled
-
inputStyle - a style for the radio input
-
checkedLabelStyle - a style for the checked radio label
-
checkedInputStyle - a style for the checked radio input
-
disabledInputStyle - a style for the disabled radio input
-
onChange: Function(value, event) - the function to be calle when the radio group value changes. NOTE: first param sent to this function is the new value, not the event object, as usual
-
renderRadio: Function(props, index, arr) - you can customize how each radio item is rendered in the group using this function. NOTE: it is called with 3 params, so not intended to be directly used with a React factory.
Example:
//NOT LIKE THIS <RadioGroup = /> //BUT like this { return <label /> } <RadioGroup = /> //or { if index < arrlength - 1 propsstyleborderBottom = '1px solid blue' propsstyledisplay = 'block' //we can skip returning something //if we only want to modify props/styles }
If the renderRadio
function returns undefined, we assume you just wanted to modify the props before rendering, which is ok, so we fallback to the default implementation:
<label {...props}/>
-
items: Array
The items prop can be an array of strings/objects or mixed. If an array of strings, the strings will be used as both value and label. If objects,
item.value
will be used as a value, anditem.label
as a radio label:Example:
var items =label: 'Green' value: 'green'label: <b>Blueish</b> value: 'blue'value: 'red' //'red' will be used as both value and label//orvar items = 'green' 'blue' 'red'If an array item is an object, besides
value
andlabel
, it can also have astyle
property, acheckedStyle
property, and adisabled
property.var items ='red'label: 'Blue'value: 'blue'disabled: truedisabledStyle: color: 'gray'style: color: 'blue'checkedStyle: color: 'blue' background: 'red' -
children - if the
RadioGroup
component specifies children, the radio group children will not be generated fromitems
, but will be what you specify in thechildren
prop
If you have a ref to the react-radio
component, you can also call group.getValue()
to get the current value of the radio group.
Changelog
See changelog
Contributing
Use Github issues for feature requests and bug reports.
We actively welcome pull requests.
For setting up the project locally, use:
$ git clone https://github.com/zippyui/react-radio$ cd react-radio$ npm install$ npm run dev
Now navigate to localhost:9191
Before building a new version, make sure you run
$ npm run build
which compiles the src
folder (which contains jsx syntax) into the lib
folder (only valid EcmaScript 5 files).