react-native-simple-radio-button

simple and useful radio button component for React Native

Demo

Installation

in Cli

1npm i react-native-simple-radio-button --save

Getting started

1import RadioForm, {RadioButton, RadioButtonInput, RadioButtonLabel} from 'react-native-simple-radio-button';
2
3
4var radio_props = [
5  {label: 'param1', value: 0 },
6  {label: 'param2', value: 1 }
7];
8
9var RadioButtonProject = React.createClass({
10  getInitialState: function() {
11    return {
12      value: 0,
13    }
14  },
15  render: function() {
16    return (
17      <View>
18        <RadioForm
19          radio_props={radio_props}
20          initial={0}
21          onPress={(value) => {this.setState({value:value})}}
22        />
23      </View>
24    );
25  }
26});

Basic

1<RadioForm
2  radio_props={radio_props}
3  initial={0}
4  onPress={(value) => {this.setState({value:value})}}
5/>

Advanced

1<RadioForm
2  radio_props={this.state.types}
3  initial={0}
4  formHorizontal={false}
5  labelHorizontal={true}
6  buttonColor={'#2196f3'}
7  animation={true}
8  onPress={(value) => {this.setState({value:value})}}
9/>

Pro

1<RadioForm
2  formHorizontal={true}
3  animation={true}
4>
5  {/* To create radio buttons, loop through your array of options */}
6  {
7    radio_props.map((obj, i) => (
8      <RadioButton labelHorizontal={true} key={i} >
9        {/*  You can set RadioButtonLabel before RadioButtonInput */}
10        <RadioButtonInput
11          obj={obj}
12          index={i}
13          isSelected={this.state.value3Index === i}
14          onPress={onPress}
15          borderWidth={1}
16          buttonInnerColor={'#e74c3c'}
17          buttonOuterColor={this.state.value3Index === i ? '#2196f3' : '#000'}
18          buttonSize={40}
19          buttonOuterSize={80}
20          buttonStyle={{}}
21          buttonWrapStyle={{marginLeft: 10}}
22        />
23        <RadioButtonLabel
24          obj={obj}
25          index={i}
26          labelHorizontal={true}
27          onPress={onPress}
28          labelStyle={{fontSize: 20, color: '#2ecc71'}}
29          labelWrapStyle={{}}
30        />
31      </RadioButton>
32    ))
33  }  
34</RadioForm>

Methods

updateIsActiveIndex

Updating active radio button forcibly

Props

RadioForm Component

radio_props (Default: []) *required

radio button value and label array

onPress *required

callback when radio button clicked.

initial (Default: 0)

The index of selected radio button. This is used when this component is activated. If you want to pass initial as asynchronous, you can use updateIsActiveIndex function.

If you want to make it empty initially, please pass -1

buttonColor(Default: '#2196f3')

change radio button color

1<RadioForm
2  radio_props={radio_props}
3  initial={0}
4  buttonColor={'#50C900'}
5/>

labelColor(Default: '#000')

change label color

1<RadioForm
2  radio_props={radio_props}
3  initial={0}
4  labelColor={'#50C900'}
5/>

formHorizontal(Default: false)

change form position

1<RadioForm
2  radio_props={radio_props}
3  initial={0}
4  formHorizontal={true}
5/>

labelHorizontal(Default: true)

change label position

1<RadioForm
2  radio_props={radio_props}
3  initial={0}
4  labelHorizontal={false}
5/>

animation (Default: true)

if you pass false, animation of radio button is disabled

accessible

indicates accessibility for the individual radio button input and radio button label components

accessibilityLabel

used to set accessibilityLabel for individual radio button input and radio button label components, radio button input will have accessibilityLabel = [accessibilityLabel]Input[index] radio button label will have accessibilityLabel = [accessibilityLabel]Label[index]

testID

used to set testID for individual radio button input and radio button label components, radio button input will have testID = [testID]Input[index] radio button label will have testID = [testID]Label[index]

RadioButton Component

isSelected

If you pass true to this param, that button change to selected status.

labelHorizontal

change label position to horizontal

buttonColor

The button color

selectedButtonColor

The selected button color

labelColor

The label color

style

The label style

wrapStyle

Styles that are applied to the wrapping the RadioButton component.

onPress *required

callback when radio button clicked.

idSeparator (Default: |)

separator used for extracting id from accessibilityLabel and testID

accessible

indicates accessibility for the wrapped radio button input and radio button label components

accessibilityLabel

used to set accessibilityLabel for the wrapped radio button input and radio button label components, needs to be of the format [accessibilityLabel][separator][id] radio button input will have accessibilityLabel = [accessibilityLabel]Input[index] radio button label will have accessibilityLabel = [accessibilityLabel]Label[index]

testID

used to set testID for individual radio button input and radio button label components, needs to be of the format [testID][separator][id] radio button input will have testID = [testID]Input[index] radio button label will have testID = [testID]Label[index]

1<RadioButton
2  accessible={true}
3  idSeparator=','
4  accessibilityLabel='noteType,1'
5  testID='noteType,1'
6/>

RadioButtonInput

isSelected

onPress

buttonInnerColor

The button inner color

buttonOuterColor

The button inner color

buttonSize

The button size. Width and height will be same length.

buttonOuterSize

The button size of outer. Width and height will be same length.

buttonStyle

Custom button style

buttonWrapStyle

Custom style for view of button's outside

accessible

indicates accessibility for the radio button input component

accessibilityLabel

used to set accessibilityLabel (content description / label for Android) for the radio button input component

testID

used to set testID (id / name for iOS) for the radio button input component

RadioButtonLabel

labelHorizontal

If you pass true, the button and label will be aligned horizontally.

labelStyle

If you pass style, you can change label text style as you want

labelWrapStyle

If you pass style, you can change label wrapper view style as you want

onPress *required

callback when radio button clicked.

accessible

indicates accessibility for the radio button label component

accessibilityLabel

used to set accessibilityLabel (content description / label for Android) for the radio button label component

testID

used to set testID (id / name for iOS) for the radio button label component

Contributing

Of course! Welcome :)

You can use following command in example dir:

npm run sync

During running this command, when you change source to implement/fix something, these changes will sync to example/node_modules/react-native-simple-radio-button/. You can check your change using example project easily.

License

MIT