Skip to content

Commit

Permalink
README updates
Browse files Browse the repository at this point in the history
  • Loading branch information
Andrei Paramoshkin committed Jan 25, 2018
1 parent 9965445 commit 8900640
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 2 deletions.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,13 @@ Circle-style checkbox component for React Native.
## Usage

```js
import CircleCheckBox, {LABEL_POSITION} from 'react-native-circle-checkbox';

<CircleCheckBox
checked={true}
onToggle={(checked) => console.log('My state is: ', checked)}
labelPosition={LABEL_POSITION.RIGHT}
label="Checkbox example"
/>
```

Expand All @@ -33,6 +37,6 @@ Circle-style checkbox component for React Native.
- `filterColor` : Color of underlayer circle. Default: `#FFF`
- `innerColor` : Color of flag. Default: `#FC9527`
- `label` : Checkbox label. Default: empty
- `labelPosition` : Label rendering position. Default: `right`, may be 'right' or 'left'
- `labelPosition` : Label rendering position. Default: `right`, may be 'right' or 'left'. For your convenience this package exports `LABEL_POSITION` object with two keys - `RIGHT` and `LEFT`. You can use it for `labelPosition` definition.
- `styleCheckboxContainer`: Styles for checkbox container.
- `styleLabel`: Styles for label.
2 changes: 1 addition & 1 deletion index.js
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ export default class CircleCheckBox extends React.Component {
filterColor: '#FFF',
innerColor: '#FC9527',
label: '',
labelPosition: 'right',
labelPosition: LABEL_POSITION.RIGHT,
styleLabel: {}
};

Expand Down

0 comments on commit 8900640

Please sign in to comment.