1.0.1 • Published 2 years ago

rn-toggle-slider v1.0.1

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

react-native-toggle-slider

A toggle switch and slider with a label inside, on top of that it animates smoothly. Click and drag or just click it toggles and slider either way.

Motivation

Slider and toggle switches are quite common in almost every application, and we have so many UX variations of it. Based on different variations.

You can also use this slider-toggle vertically.

Our UX demanded a Toggle and slider with a label, which has both click and slide behavior. None of the existing libraries offered this complete solution. Some had the toggle behavior but the sliding behavior was missing, some had the swipe behavior but did not offer to have a label in it. This library has been created to fill that gap.

Working demo

Install

npm install --save rn-toggle-slider

Usages

import ToggleSlider from 'rn-toggle-slider'

class Demo extends ... {
  ...
  render() {
    return (
      ...
      <ToggleSlider
        text={{ on: "ON", off: "OFF", activeTextColor: "white", inactiveTextColor: "#B7B8BA" }}
        textStyle={{ fontWeight: "bold" }}
        color={{ indicator: "white", active: "#51747C", inactive: "#D5E0E3", activeBorder: "#466972", inactiveBorder: "#95A8AE" }}
        active={true}
        disabled={false}
        vertical={false}
        width={80}
        radius={25}
        borderWidth={4}
        universalPadding={4}
        onValueChange={(val) => {
           /* handler function... */
        }}
     />
      ...
    );
  }
}

Properties

AttributeDescription
text.onText to be displayed when Switch is in Active state
text.offText to be displayed when Switch in in inactive state
text.activeTextColorActive text color
text.inactiveTextColorInactive text color
textStyleAny valid text style supported by RN
color.indicatorThe color of the Slider / Indicator
color.activeBackground color of the Switch when it is in active state
color.inactiveBackground color of the Switch when it is in inactive state
color.activeBorderThe border color when Switch is in active state
color.inactiveBorderThe border color when Switch is in inactive state
activeInitial state of the Switch
disabledtrue if the control is disabled
verticaltrue if the control is vertically show
widthWidth of the control
radiusRadius of the Slider / Indicator
borderWidthborderWidth of the control
borderWidthborderWidth of the control
onValueChangeThe function to be called when Switch changes its states