1.0.0 • Published 3 years ago

rn-tri-toggle-switch-custom v1.0.0

Weekly downloads
-
License
MIT
Repository
github
Last release
3 years ago

React Native Tri State Toggle Switch Component for iOS and Android.

Content

Installation

  • 1.Run npm i rn-tri-toggle-switch --save
  • 2.import TriStateToggleSwitch from 'rn-tri-toggle-switch'

Demo

Screenshots

Getting started

To Get Started, Import rn-tri-toggle-switch to your js file.

import TriStateToggleSwitch from 'rn-tri-toggle-switch'

Inside render or any other function returning component you can use tristate toggle switch like:

let choicesProp = [
  {
    choiceCode: 'Yes',
    choiceText: 'Yes'
  },
  {
    choiceCode: 'No',
    choiceText: 'No'
  }
]
<TriStateToggleSwitch 
    width={400} 
    height={80} 
    selectedNoneBgColor={'#999999'}
    selectedLeftBgColor={'#75CF41'}
    selectedRightBgColor={'#D72E30'}
    fontColor={'#fff'}
    fontSize={30}
    circleBgColor={'white'}
    choices={choicesProp}
    onChange={(value)=>alert(JSON.stringify(value))}
/>

Customize

PropsTypeOptionalDefaultDescription
widthnumbertrue120You can specify width based on your requirements
heightnumbertrue24You can specify height based on your requirements
selectedNoneBgColorStringtrue'#41B6E6'Background Color if Circle Button is in the middle, or no option is selected
selectedLeftBgColorStringtrue#3171BFBackground Color if Left option is selected
selectedRightBgColorStringtrue#3171BFBackground Color if Right option is selected
circleBgColorStringtrue#fffColor of Circle Button
fontColorStringtrue#fffColor of toggle label text
fontSizenumbertrue12Size of toggle label textcomponent
choicesJSONtrue{choiceCode: 'Yes',choiceText: 'Yes'}, {choiceCode: 'No',choiceText: 'No'}Only the choiceCode and choiceText is mandatory, you can add any property to your JSON, it will return on function callback.
onChangefunction callbacktrueNo event callbackIt will call the function callback on user selection change, it will return JSON option based on selected choice property
initialValueStringtruenullSet initial value by choiceCode

Contribution

If you encounter any issue, bugs or see any area for improvement feel free to create an issue, pull request and discuss it. Please add screenshot of the bug or a code snippet.

Thanks!

MIT Licensed