-
Notifications
You must be signed in to change notification settings - Fork 64
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Watcharachai Kanjaikaew
authored and
Watcharachai Kanjaikaew
committed
Sep 12, 2016
1 parent
b35a1c6
commit 6397955
Showing
1 changed file
with
126 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,126 @@ | ||
# React Native Flexi Radio Button | ||
Simple and flexible Radio button for React Native App | ||
|
||
## Installation | ||
``` | ||
npm i react-native-flexi-radio-button --save | ||
``` | ||
|
||
## Usage | ||
|
||
###Basic Example | ||
[see full basic example](https://github.com/thegamenicorus/react-native-flexi-radio-button/blob/master/examples/BasicExample/app.js) | ||
```jsx | ||
|
||
import {RadioGroup, RadioButton} from 'react-native-flexi-radio-button' | ||
|
||
onSelect(index, value){ | ||
this.setState({ | ||
text: `Selected index: ${index} , value: ${value}` | ||
}) | ||
} | ||
|
||
render(){ | ||
return( | ||
<View style={styles.container}> | ||
|
||
<RadioGroup | ||
onSelect = {(index, value) => this.onSelect(index, value)} | ||
> | ||
<RadioButton value={'item1'} > | ||
<Text>This is item #1</Text> | ||
</RadioButton> | ||
|
||
<RadioButton value={'item2'}> | ||
<Text>This is item #2</Text> | ||
</RadioButton> | ||
|
||
<RadioButton value={'item3'}> | ||
<Text>This is item #3</Text> | ||
</RadioButton> | ||
</RadioGroup> | ||
|
||
<Text style={styles.text}>{this.state.text}</Text> | ||
|
||
</View> | ||
) | ||
} | ||
``` | ||
|
||
|Initialize|After Select| | ||
|---------------|----------| | ||
|![simulator screen shot sep 12 2559 be 11 12 55 pm](https://cloud.githubusercontent.com/assets/21040043/18443314/91b2d0be-793e-11e6-986d-fad44fcf9b0f.png)|![simulator screen shot sep 12 2559 be 11 14 51 pm](https://cloud.githubusercontent.com/assets/21040043/18443346/bbeb0e14-793e-11e6-8a13-305bdb8e469c.png)| | ||
|
||
###Custom Example | ||
[see full custom example](https://github.com/thegamenicorus/react-native-flexi-radio-button/blob/master/examples/CustomExample/app.js) | ||
|
||
modify in render() | ||
```jsx | ||
<RadioGroup | ||
size={24} | ||
thickness={2} | ||
color='#9575b2' | ||
highlightColor='#ccc8b9' | ||
selectedIndex={1} | ||
onSelect = {(index, value) => this.onSelect(index, value)} | ||
> | ||
<RadioButton | ||
style={{alignItems:'center'}} | ||
value='Yo!! I am a cat.' | ||
> | ||
<Image | ||
style={{width:100, height: 100}} | ||
source={{uri:'https://cloud.githubusercontent.com/assets/21040043/18446298/fa576974-794b-11e6-8430-b31b30846084.jpg'}} | ||
/> | ||
</RadioButton> | ||
|
||
<RadioButton | ||
value='index1' | ||
> | ||
<Text>Start from item index #1</Text> | ||
</RadioButton> | ||
|
||
<RadioButton | ||
value='red color' | ||
color='red' | ||
> | ||
<Text>Red Dot</Text> | ||
</RadioButton> | ||
|
||
<RadioButton | ||
value='green color' | ||
color='green' | ||
> | ||
<Text>Green Dot</Text> | ||
</RadioButton> | ||
|
||
<RadioButton | ||
value='blue color' | ||
color='blue' | ||
> | ||
<Text>Blue Dot</Text> | ||
</RadioButton> | ||
</RadioGroup> | ||
``` | ||
|Initialize|After Select| | ||
|---------------|----------| | ||
|![simulator screen shot sep 13 2559 be 1 07 34 am](https://cloud.githubusercontent.com/assets/21040043/18446961/bd7bb14c-794e-11e6-8276-46d3804a5ee6.png)|![simulator screen shot sep 13 2559 be 1 07 55 am](https://cloud.githubusercontent.com/assets/21040043/18446965/c086492e-794e-11e6-95f0-1b0d072a20ee.png)| | ||
### Configuration | ||
##### Radio Group: | ||
| Property | Type | Default | Description | | ||
|---------------|----------|-------------|----------------------------------------------------------------| | ||
| size | number | 20 | Size of the radio button | | ||
| thickness | number | 1 | width of radio button border | | ||
| color | string | '#007AFF' | color of radio button | | ||
| highlightColor | string | null | background of radio button after selected | | ||
| selectedIndex | number | null | initialize selected index of radio group | | ||
| style | object | null | Custom styles to be applied if supplied | | ||
| onSelect | function(index, value) | null | function to be invoked when radio button is selected | | ||
|
||
##### Radio Button: | ||
|
||
| Property | Type | Default | Description | | ||
|-----------|--------|---------|--------------------------------------------| | ||
| value | any | null | value will be passed on callback `onSelect` as second argument | | ||
| style | object | null | Styles to be applied on 'RadioButton' component | | ||
| color | string | same as 'RadioGroup' component | color of radio dot | |