/react-native-multi-slider

Android and iOS Pure JS react native multi slider

Primary LanguageJavaScriptMIT LicenseMIT

react-native-multi-slider

Pure JS react native slider component with one or two markers. Options to customize track, touch area and provide customer markers and callbacks for touch events and value changes.

Examples

cd example/Basic
npm install
react-native run-ios
react-native run-android

Example

Getting Started

Installation

$ npm install --save @ptomasroos/react-native-multi-slider

Usage in a ScrollView

import MultiSlider from '@ptomasroos/react-native-multi-slider';

...

 enableScroll = () => this.setState({ scrollEnabled: true });
 disableScroll = () => this.setState({ scrollEnabled: false });

 render() {
   return (
     <ScrollView scrollEnabled={this.state.scrollEnabled}>
      <MultiSlider
        ...
        onValuesChangeStart={this.disableScroll}
        onValuesChangeFinish={this.enableScroll}
      />
    </ScrollView>
    );

shape up CustomMarker as left and right

In order to make different styles on markers you can set isMarkersSeparated to true, define customMarkerLeft and customMarkerRight in MultiSlider. for example:

<MultiSlider
    ...
    isMarkersSeparated={true}

    customMarkerLeft={(e) => {
         return (<CustomSliderMarkerLeft
          currentValue={e.currentValue}/>)
    }}

    customMarkerRight={(e) => {
         return (<CustomSliderMarkerRight
         currentValue={e.currentValue}/>)
    }}
/>

Partial report of the props

Feel free to contribute to this part of the documentation.

Prop name Default value Type Purpouse
values [0] array of numbers Prefixed values of the slider.
onValuesChangeStart () => {} function Callback when the value starts changing
onValuesChange () => {} function Callback when the value changes
onValuesChangeFinish (values) => {} function Callback when the value stops changing
sliderLength 280 number Length of the slider (?)
touchDimensions {height: 50,width: 50,borderRadius: 15,slipDisplacement: 200} object (?)
enableLabel function Enable the label rendering
customLabel function Component used for rendering a label above the cursors.
customMarker function Component used for the cursor.
customMarkerLeft function Component used for the left cursor.
customMarkerRight function Component used for the right cursor.
isMarkersSeparated boolean See explaination above in the README.md
min 0 number Minimum value available in the slider.
max 10 number Maximum value available in the slider.
step 1 number Step value of the slider.
optionsArray array of numbers Possible values of the slider. Ignores min and max.
{container/track/selected/unselected/ markerContainer/marker/pressedMarker/step/stepLabel/StepMarker} Style style object Styles for the slider
valuePrefix string Prefix added to the value.
valueSuffix string Suffix added to the value.
enabledOne true boolean Enables the first cursor
enabledTwo true boolean Enables the second cursor
stepsAs [] array of objects Use stepsAs when you want to customize the steps-labels. stepsAs expects an array of objects [{index: number, stepLabel: string, prefix: string, suffix: string}]. Where index is for which step you want to customize, and all the other steps will show its index as its stepLabel. Both showSteps and showStepsLabels has to be enabled for stepsAs to be used.
showSteps false boolean Show steps
showStepMarkers true boolean Show steps-markers on the track, showSteps has to be enabled as well
showStepLabels true boolean Show steps-labels underneath the track, showSteps has to be enabled as well
onToggleOne undefined function callback Listener when first cursor toggles.
onToggleTwo undefined function callback Listener when second cursor toggles.
allowOverlap false boolean Allow the overlap within the cursors.
snapped false boolean Use this when you want a fixed position for your markers, this will split the slider in N specific positions
smoothSnapped false boolean Same as snapped but you can move the slider as usual. When released it will go to the nearest marker
vertical false boolean Use vertical orientation instead of horizontal.
markerOffsetX 0 number Offset the cursor(s) on the X axis
markerOffsetY 0 number Offset the cursor(s) on the Y axis
markerSize 0 number It determines the marker margin from the edges of the track, useful to avoid the markers to overflow out of the track.
minMarkerOverlapDistance 0 number if this is > 0 and allowOverlap is false, this value will determine the closest two markers can come to each other (in pixels, not steps). This can be used for cases where you have two markers large cursors and you don't want them to overlap. Note that markers will still overlap at the start if starting values are too near. CANNOT be combined with minMarkerOverlapStepDistance
minMarkerOverlapStepDistance 0 number if this is > 0 and allowOverlap is false, this value will determine the closest two markers can come to each other (in steps, not pixels). This can be used for cases where you have two markers large cursors and you don't want them to overlap. Note that markers will still overlap at the start if starting values are too near. CANNOT be combined with minMarkerOverlapDistance
imageBackgroundSource undefined string Specifies the source as required by ImageBackground
testID string Used to locate this view in end-to-end tests.

Recommendations

For very large min = 0 & max = 99999999 and very small step = 1, the step generation loop generates very large array which can causes a crash. Its better to dynamically generate a step size in those cases.

step = Math.round(Math.abs(max - min) / 100)

Credit ptomasroos#281 (comment)