Skip to content

Latest commit

 

History

History
64 lines (44 loc) · 2.07 KB

README.md

File metadata and controls

64 lines (44 loc) · 2.07 KB
Raw

Toggle Switch Component for react native, it works on iOS and Android.

Content

Installation

  • 1.Run npm i toggle-switch-react-native --save
  • 2.import ToggleSwitch from 'toggle-switch-react-native'

Demo

Screenshots

Getting started

To Get Started, Import toggle-switch-react-native to your js file.

import ToggleSwitch from 'toggle-switch-react-native'

Inside your component's render method, or any other method returning views, use ToggleSwitch:

<ToggleSwitch
    isOn={false}
    onColor='green'
    offColor='red'
    label='Example label'
    labelStyle={{color: 'black', fontWeight: '900'}}
    size='large'
    onToggle={ (isOn) => console.log('changed to : ', isOn) }
/>;

API

Props Type Optional Default Description
isOn Boolean true 'false' Default state, true for On, false for off
onColor String true '#634fc9' On Color
offColor String true '#ecf0f1' Off Color
label String true Custom Label Text on the Left of the toggle Button
labelStyle Object true {marginHorizontal: 10} Custom Styling for the Label Text View
size String true 'medium' Size of the toggle switch button ( 'large', 'medium', 'small')
onToggle Function Callback false none Callback when the toggle switch component changes the state, params: isOn

Contribution

If you encountered an Issue, please add a screenshot of the bug or a code snippet.

Quickest way to solve issue is to reproduce it on the example project

Pull requests are welcome. If you want to change the API or imporove something, feel free to create an issue and discuss it first.

MIT Licensed