1.0.2 • Published 4 years ago

react-native-custom-slider v1.0.2

Weekly downloads
11
License
MIT
Repository
github
Last release
4 years ago

react-native-custom-slider

Getting started

$ npm install react-native-custom-slider --save

Mostly automatic installation

$ react-native link react-native-custom-slider

Usage

import React, { useState } from "react"
import { View } from "react-native"
import Slider from 'react-native-custom-slider';

const SliderApp = props => {

    const [value, setValue] = useState(15);

    return (
        <Slider
            value={value}
            minimumValue={0}
            maximumValue={50}
            onValueChange={(value) => setValue(value)}
            thumbStyle={{ justifyContent: 'center', alignItems: 'center', width: 25 }}
            customThumb={
                <View
                    style={{
                        width: 35,
                        height: 20,
                        overflow: 'hidden',
                        borderTopLeftRadius: 10,
                        borderTopRightRadius: 10,
                        borderBottomLeftRadius: 10,
                        borderBottomRightRadius: 10,
                        backgroundColor: 'gold' 
                    }}
                />
            }
        />
    )
}

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
customMinimumTracknumberYes1Initial 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
customMinimumTrackcomponentYesSets an custom component used for the track to the left of the button.
maximumTrackTintColorstringYes'#b3b3b3'The color used for the track to the right of the button
customMaximumTrackcomponentYesSets an custom component 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.
onValueChangefunctionYesCallback continuously called while the user is dragging the slider
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
thumbStylestyleYesThe style applied to the thumb
customThumbcomponentYesSets an custom component for the thumb.
debugTouchAreaboolYesfalseSet this to true to visually see the thumb touch rect in green.
animateTransitionsboolYesfalseSet to true if you want to use the default 'spring' animation
animationTypestringYes'timing'Set to 'spring' or 'timing' to use one of those two types of animations with the default animation properties.
animationConfigobjectYesundefinedUsed to configure the animation parameters. These are the same parameters in the Animated library.

MIT Licensed