Feature - Adding step labeling (ptomasroos#213)

* * Adding so its possible to show steps
  - Show step labels
  - Show step marks on the track
  - Customizable step labels, prefix and suffix styling et.
  - Customizable styling for step container, step label and step markers
* Adding smooth-snapped

* Added docs

Author: gusolsso

MultiSlider.js

@@ -1,4 +1,5 @@
 import React from 'react';
+import { Text } from 'react-native';
 
 import {
   StyleSheet,
@@ -40,10 +41,15 @@ export default class MultiSlider extends React.Component {
     sliderLength: 280,
     onToggleOne: undefined,
     onToggleTwo: undefined,
+    stepsAs: [],
+    showSteps: false,
+    showStepMarkers: true,
+    showStepLabels: true,
     enabledOne: true,
     enabledTwo: true,
     allowOverlap: false,
     snapped: false,
+    smoothSnapped: false,
     vertical: false,
     minMarkerOverlapDistance: 0,
     minMarkerOverlapStepDistance: 0,
@@ -53,8 +59,13 @@ export default class MultiSlider extends React.Component {
   constructor(props) {
     super(props);
 
-    if(this.props.minMarkerOverlapDistance > 0 && this.props.minMarkerOverlapStepDistance > 0) {
-      console.error('You should provide either "minMarkerOverlapDistance" or "minMarkerOverlapStepDistance", not both. Expect unreliable results.');
+    if (
+      this.props.minMarkerOverlapDistance > 0 &&
+      this.props.minMarkerOverlapStepDistance > 0
+    ) {
+      console.error(
+        'You should provide either "minMarkerOverlapDistance" or "minMarkerOverlapStepDistance", not both. Expect unreliable results.',
+      );
     }
 
     this.optionsArray =
@@ -71,6 +82,31 @@ export default class MultiSlider extends React.Component {
       ),
     );
 
+    var tempStepsAs = {};
+    this.props.stepsAs.forEach(step => {
+      if (step?.index !== undefined) {
+        tempStepsAs[step?.index] = step;
+      }
+    });
+
+    this.stepsAs = {};
+    this.optionsArray.forEach((ops, index) => {
+      if (tempStepsAs[index]) {
+        var step = tempStepsAs[index];
+        this.stepsAs[index] = {
+          stepLabel: step?.stepLabel ? step.stepLabel : ops,
+          suffix: step?.suffix ? step.suffix : '',
+          prefix: step?.prefix ? step.prefix : '',
+        };
+      } else {
+        this.stepsAs[index] = {
+          stepLabel: ops,
+          suffix: '',
+          prefix: '',
+        };
+      }
+    });
+
     this.state = {
       pressedOne: true,
       valueOne: this.props.values[0],
@@ -293,9 +329,16 @@ export default class MultiSlider extends React.Component {
       return;
     }
 
+    var snapped = valueToPosition(
+      this.state.valueOne,
+      this.optionsArray,
+      this.props.sliderLength,
+    );
+
     this.setState(
       {
-        pastOne: this.state.positionOne,
+        pastOne: this.props.smoothSnapped ? snapped : this.state.positionOne,
+        ...(this.props.smoothSnapped ? { positionOne: snapped } : {}),
         onePressed: !this.state.onePressed,
       },
       () => {
@@ -314,10 +357,17 @@ export default class MultiSlider extends React.Component {
       return;
     }
 
+    var snapped = valueToPosition(
+      this.state.valueTwo,
+      this.optionsArray,
+      this.props.sliderLength,
+    );
+
     this.setState(
       {
         twoPressed: !this.state.twoPressed,
-        pastTwo: this.state.positionTwo,
+        pastTwo: this.props.smoothSnapped ? snapped : this.state.positionTwo,
+        ...(this.props.smoothSnapped ? { positionTwo: snapped } : {}),
       },
       () => {
         this.props.onValuesChangeFinish([
@@ -392,6 +442,50 @@ export default class MultiSlider extends React.Component {
     }
   }
 
+  getSteps() {
+    const stepLength = this.props.sliderLength / (this.optionsArray.length - 1);
+    const textStyles = [
+      styles.stepLabel,
+      this.props.stepLabelStyle,
+      ...(this.props.vertical ? [{ transform: [{ rotate: '90deg' }] }] : []),
+    ];
+    const markerHeight = this.props?.trackStyle?.height || styles.track.height;
+    const markerStyles = [
+      styles.stepMarker,
+      {
+        height: markerHeight,
+        width: markerHeight,
+        borderRadius: markerHeight / 2,
+      },
+      this.props.stepMarkerStyle,
+    ];
+
+    return this.optionsArray.map((number, index) => {
+      var step = this.stepsAs[index];
+      return (
+        <View
+          key={number}
+          style={[
+            styles.step,
+            this.props.stepStyle,
+            { left: stepLength * index },
+          ]}
+        >
+          {this.props.showStepMarkers &&
+            index !== 0 &&
+            index !== this.optionsArray.length - 1 && (
+              <View style={markerStyles} />
+            )}
+          {this.props.showStepLabels && (
+            <Text
+              style={textStyles}
+            >{`${step.prefix}${step.stepLabel}${step.suffix}`}</Text>
+          )}
+        </View>
+      );
+    });
+  }
+
   render() {
     const { positionOne, positionTwo } = this.state;
     const {
@@ -481,6 +575,7 @@ export default class MultiSlider extends React.Component {
               ]}
             />
           )}
+          {this.props.showSteps && this.getSteps()}
           <View
             style={[
               styles.markerContainer,
@@ -648,4 +743,21 @@ const styles = StyleSheet.create({
     justifyContent: 'center',
     alignItems: 'center',
   },
+  step: {
+    position: 'absolute',
+    marginLeft: -5,
+  },
+  stepMarker: {
+    position: 'absolute',
+    left: 2,
+    width: 6,
+    height: 6,
+    backgroundColor: '#0000008c',
+    borderRadius: 3,
+  },
+  stepLabel: {
+    position: 'absolute',
+    top: 15,
+    color: '#333',
+  },
 });

README.md

@@ -86,15 +86,20 @@ Feel free to contribute to this part of the documentation.
 | 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} Style |  | style object | Styles for the slider |
+| {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 |

index.d.ts

@@ -7,6 +7,13 @@ import * as React from "react";
 import { ViewStyle } from "react-native";
 
 
+export interface StepsAsProps {
+    index: number;
+    stepLabel: string;
+    prefix: string;
+    suffix: string;
+}
+
 export interface MarkerProps {
     pressed: boolean;
     pressedMarkerStyle: ViewStyle;
@@ -54,6 +61,8 @@ export interface MultiSliderProps {
     max?: number;
     step?: number;
 
+    stepsAs?: StepsAsProps[];
+
     optionsArray?: number[];
 
     containerStyle?: ViewStyle;
@@ -63,14 +72,21 @@ export interface MultiSliderProps {
     markerContainerStyle?: ViewStyle;
     markerStyle?: ViewStyle;
     pressedMarkerStyle?: ViewStyle;
+    stepStyle?: ViewStyle;
+    stepLabelStyle?: ViewStyle;
+    stepMarkerStyle?: ViewStyle;
     valuePrefix?: string;
     valueSuffix?: string;
+    showSteps?: boolean;
+    showStepMarkers?: boolean;
+    showStepLabels?: boolean;
     enabledOne?: boolean;
     enabledTwo?: boolean;
     onToggleOne?: () => void;
     onToggleTwo?: () => void;
     allowOverlap?: boolean;
     snapped?: boolean;
+    smoothSnapped?: boolean;
     markerOffsetX?: number;
     markerOffsetY?: number;
     minMarkerOverlapDistance?: number;