rns
react-native-smooth-slider
npm i react-native-smooth-slider
rns

react-native-smooth-slider

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

by Li Zheng

1.3.4 (see all)License:MITTypeScript:Not Found
npm i react-native-smooth-slider
Readme

react-native-smooth-slider

npm version npm downloads npm licence Platform

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

It is a drop-in replacement for Slider.

Install

For RN >= 0.60

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

For RN < 0.60

npm i --save react-native-smooth-slider@1.2.x react-native-gesture-handler@1.2.2

And be aware of https://github.com/software-mansion/react-native-gesture-handler/issues/1164 if you use react-native-web and want to slide on web.

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}
          useNativeDriver={true}
          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

PropTypeOptionalDefaultDescription
valuenumberYes0Initial value of the slider
disabledboolYesfalseIf true the user won't be able to move the slider
minimumValuenumberYes0Initial minimum value of the slider
maximumValuenumberYes1Initial maximum value of the slider
stepnumberYes0Step value of the slider. The value should be between 0 and maximumValue - minimumValue)
minimumTrackTintColorstringYes'#3f3f3f'The color used for the track to the left of the button
maximumTrackTintColorstringYes'#b3b3b3'The color used for the track to the right of the button
thumbTintColorstringYes'#343434'The color used for the thumb
thumbTouchSizeobjectYes{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.
moveVelocityThresholdnumberYes2000Prevent onValueChange if velocityX or velocityY (vertical is true) of nativeEvent is over the moveVelocityThreshold
onValueChangefunctionYesCallback continuously called while the user is dragging the slider and the dragging movement speed is below the moveVelocityThreshold
onSlidingStartfunctionYesCallback called when the user starts changing the value (e.g. when the slider is pressed)
onSlidingCompletefunctionYesCallback called when the user finishes changing the value (e.g. when the slider is released)
stylestyleYesThe style applied to the slider container
trackStylestyleYesThe style applied to the track
trackImagesourceYesSets an image for the track.
thumbStylestyleYesThe style applied to the thumb
thumbImagesourceYesSets an image for the thumb.
verticalboolYesfalseSet this to true to be a vertical slider.
useNativeDriverboolYesfalseThe useNativeDriver parameter in Animated used by react-native-gesture-handler when the user change the value. Default value is false, because some Android phone PanGestureHandler causes Animated Value to jump when using native driver
animateTransitionsboolYesfalseSet to true to animate values with default 'timing' animation type when value in next props is different.
animationTypestringYes'timing'Custom Animation type when value in next props is different. 'spring' or 'timing'.
animationConfigobjectYesundefinedUsed to configure the animation parameters when value in next props is different. 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.

To support my work, please consider donate.

  • ETH: 0xd02fa2738dcbba988904b5a9ef123f7a957dbb3e


MIT Licensed

Downloads/wk

918

GitHub Stars

13

LAST COMMIT

1yr ago

MAINTAINERS

1

CONTRIBUTORS

14

OPEN ISSUES

3

OPEN PRs

0
VersionTagPublished
1.3.4
latest
1yr ago
No alternatives found
No tutorials found
Add a tutorial