/react-native-smooth-slider

A react-native-gesture-handler smoothed <Slider /> , also support trackImage and vertical

Primary LanguageJavaScriptMIT LicenseMIT

react-native-smooth-slider

npm version npm downloads npm licence Platform

A react-native-gesture-handler smoothed <Slider /> , also support trackImage and vertical.

Custom Slider View Code

It is a drop-in replacement for Slider.

Install

npm i --save react-native-smooth-slider

And need install react-native-gesture-handler (1.1.0+ e.g. 1.2.2 for RN 0.57.2+ , or latest for RN 0.60.0+) by yourself.

Usage

import React from "react";
import Slider from "react-native-smooth-slider";
import { AppRegistry, StyleSheet, View, Text } from "react-native";

class SliderExample extends React.Component {
  state = {
    value: 0.2
  };

  render() {
    return (
      <View style={styles.container}>
        <Slider
          value={this.state.value}
          onValueChange={value => this.setState({ value })}
        />
        <Text>
          Value: {this.state.value}
        </Text>
      </View>
    );
  }
}

const styles = StyleSheet.create({
  container: {
    flex: 1,
    marginLeft: 10,
    marginRight: 10,
    alignItems: "stretch",
    justifyContent: "center"
  }
});

AppRegistry.registerComponent("SliderExample", () => SliderExample);

Props

Prop Type Optional Default Description
value number Yes 0 Initial value of the slider
disabled bool Yes false If true the user won't be able to move the slider
minimumValue number Yes 0 Initial minimum value of the slider
maximumValue number Yes 1 Initial maximum value of the slider
step number Yes 0 Step value of the slider. The value should be between 0 and maximumValue - minimumValue)
minimumTrackTintColor string Yes '#3f3f3f' The color used for the track to the left of the button
maximumTrackTintColor string Yes '#b3b3b3' The color used for the track to the right of the button
thumbTintColor string Yes '#343434' The color used for the thumb
thumbTouchSize object Yes {width: 40, height: 40} The size of the touch area that allows moving the thumb. The touch area has the same center as the visible thumb. This allows to have a visually small thumb while still allowing the user to move it easily.
moveVelocityThreshold number Yes 2000 Prevent onValueChange if velocityX or velocityY (vertical is true) of nativeEvent is over the moveVelocityThreshold
onValueChange function Yes Callback continuously called while the user is dragging the slider and the dragging movement speed is below the moveVelocityThreshold
onSlidingStart function Yes Callback called when the user starts changing the value (e.g. when the slider is pressed)
onSlidingComplete function Yes Callback called when the user finishes changing the value (e.g. when the slider is released)
style style Yes The style applied to the slider container
trackStyle style Yes The style applied to the track
trackImage source Yes Sets an image for the track.
thumbStyle style Yes The style applied to the thumb
thumbImage source Yes Sets an image for the thumb.
vertical bool Yes false Set this to true to be a vertical slider.
debugTouchArea bool Yes false Set this to true to visually see the thumb touch rect in green.
animateTransitions bool Yes false Set to true if you want to use the default 'spring' animation
animationType string Yes 'timing' Set to 'spring' or 'timing' to use one of those two types of animations with the default animation properties.
animationConfig object Yes undefined Used to configure the animation parameters. These are the same parameters in the Animated library.

Methods

setValue(value)

In some use case e.g. "tension rod", it's more convenient to use method instead of prop to restore original positon of the tension rod. Below is a vertical tension rod example screenshot.


MIT Licensed