callstack/react-native-slider

README

React Native component used to select a single value from a range of values.
Currently supported on following platforms:

iOS	Android	Windows	Web

Installation & Usage

To install this module cd to your project directory and enter the following command:

yarn add @react-native-community/slider

npm install @react-native-community/slider --save

If using iOS please remember to install cocoapods by running: npx pod-install

The following code presents the basic usage scenario of this library:

import Slider from '@react-native-community/slider';

<Slider
  style={{width: 200, height: 40}}
  minimumValue={0}
  maximumValue={1}
  minimumTrackTintColor="#FFFFFF"
  maximumTrackTintColor="#000000"
  thumbSize={32}
/>

Check out the example project for more examples.

Reach out on Discord

If you have any questions, issues or any other topic that you need an advise in, reach out to us on our channel on Discord under this 👉 link.
See you there!

React Native Compatibility

To use this library you need to ensure you are using the correct version of React Native.

`@react-native-community/slider` version	Required React Native Version
`5.0.0`	`>=0.76`
`4.5.1`	`>=0.69`
`4.3.0`	`>=0.64`
`4.x.x`	`>=0.60`; `>=0.62` (on Windows);
`3.1.x`	`>=0.60`
`2.x.x`	`>= 0.60`
`1.x.x`	`<= 0.59`

Properties

Property	Description	Type	Platform
`style`	Used to style and layout the `Slider`. See `StyleSheet.js` and `ViewStylePropTypes.js` for more info.	View.style
`disabled`	If true the user won't be able to move the slider. Default value is false.	bool
`maximumValue`	Initial maximum value of the slider. Default value is 1.	number
`minimumTrackTintColor`	The color used for the track to the left of the button. Overrides the default blue gradient image on iOS.	color
`minimumValue`	Initial minimum value of the slider. Default value is 0.	number
`lowerLimit`	Slide lower limit. The user won't be able to slide below this limit.	number	Android, iOS, Web
`upperLimit`	Slide upper limit. The user won't be able to slide above this limit.	number	Android, iOS, Web
`onSlidingStart`	Callback that is called when the user picks up the slider. The initial value is passed as an argument to the callback handler.	function
`onSlidingComplete`	Callback that is called when the user releases the slider, regardless if the value has changed. The current value is passed as an argument to the callback handler.	function
`onValueChange`	Callback continuously called while the user is dragging the slider.	function
`step`	Step value of the slider. The value should be between 0 and (maximumValue - minimumValue). Default value is 0. On Windows OS the default value is 1% of slider's range (from `minimumValue` to `maximumValue`).	number
`maximumTrackTintColor`	The color used for the track to the right of the button. Overrides the default gray gradient image on iOS.	color
`testID`	Used to locate this view in UI automation tests.	string
`value`	Write-only property representing the value of the slider. Can be used to programmatically control the position of the thumb. Entered once at the beginning still acts as an initial value. Changing the value programmatically does not trigger any event. The value should be between minimumValue and maximumValue, which default to 0 and 1 respectively. Default value is 0. This is not a controlled component, you don't need to update the value during dragging.	number
`tapToSeek`	Permits tapping on the slider track to set the thumb position. Defaults to false on iOS. No effect on Android or Windows.	bool	iOS
`inverted`	Reverses the direction of the slider. Default value is false.	bool
`vertical`	Changes the orientation of the slider to vertical, if set to `true`. Default value is false.	bool	Windows
`thumbTintColor`	Color of the foreground switch grip. NOTE: This prop will override the `thumbImage` prop set, meaning that if both `thumbImage` and `thumbTintColor` will be set, image used for the thumb may not be displayed correctly!	color	Android
`thumbSize`	Sets the size (width and height) of the thumb. If `thumbImage` is provided, it will be scaled to this size. Units: points on iOS, dp on Android.	number	Android, iOS, Web
`maximumTrackImage`	Assigns a maximum track image. Only static images are supported. The leftmost pixel of the image will be stretched to fill the track.	Image .propTypes .source	iOS
`minimumTrackImage`	Assigns a minimum track image. Only static images are supported. The rightmost pixel of the image will be stretched to fill the track.	Image .propTypes .source	iOS
`thumbImage`	Sets an image for the thumb. Only static images are supported. Needs to be a URI of a local or network image; base64-encoded SVG is not supported.	Image .propTypes .source
`trackImage`	Assigns a single image for the track. Only static images are supported. The center pixel of the image will be stretched to fill the track.	Image .propTypes .source	iOS
`StepMarker`	Component to be rendered for each step on the track, with the possibility to change the styling, when thumb is at that given step	`FC<MarkerProps>`	iOS, Android, Windows
`renderStepNumber`	Turns on the displaying of numbers of steps. Numbers of steps are displayed under the track	bool	iOS, Android, Windows
`ref`	Reference object.	MutableRefObject	web
`View`	Inherited `View` props...

Custom step marker and step numbers

It is possible to render default step numbers under your slider and to render custom step component and step marker.
This can be achieved by using:

`renderStepNumber`

Turns on the displaying of numbers of steps.
Numbers of steps are displayed under the track.
Two font sizes are available and they will be selected automatically depending on the overall number of steps.

`StepMarker`

Your custom component rendered for every step on the Slider, both the thumb and the rest of steps along the Slider's whole length.
This StepMarker prop accepts your custom component and provides it with the following parameters:

stepMarked: boolean;	Indicates whether that custom step is the one that the thum is currently on. If user drags or clicks on that step, thumb will be moved there and the `stepMarked` parameter will be set to `true`. Use it, to differentiate between rendering your custom thumb component, or your custom step marker.
currentValue: number;	Contains the `number` type saying at which value of the Slider the thumb currently is. Use it, for example, to render the Slider value on every step marker, or to render different step marker's variant depending on the Thumb position.
index: number;	Contains the index at which this exact instantiation of your custom step marker was rendered at. Use it if you would like to render step number within the step marker, or, for example, if you want to render many variants of step marker depending on their positions along the Slider's width.
min: number;	Minimum value of the Slider. It is equal to `minimumValue` and has the same default if not set.
max: number;	Maximum value of the Slider. It is equal to `maximumValue` and has the same default if not set.

Roadmap and Progress

There's a Project board available here which contains all reported issues organized into columns regarding their status.

If you are interested in knowing whether the issue you reported is handled or just to check the status of a feature you would like to have in Slider, please check the board.

Contributing

The main package implementation is done in the package/ directory. So when implementing changes there, make sure your code passes ESLint and the tests. Run the following to verify:

cd package/
npm run lint
npm run test

Remember to cover your changes with tests if possible.

When creating an issue please remember to specify the platform which the issue occurs on.

Running the example app

While developing, you can run the example app to test your changes.

Setup

Clone the repository
Run npm install in the root directory to install dependencies.
Run npm run example-<platform>, where platform can be: ios, android, windows

You can also do this manually by:

Installing node modules for example app
Installing pods for iOS app
Running example app like always: npx react-native run-<platform>

Maintainers

Contributors

This module was extracted from react-native core. Please, refer to contributors graph for the complete list of contributors.

Made with ❤️ at Callstack

@callstack/react-native-slider is an open source project and will always remain free to use. If you think it's cool, please star it 🌟. Callstack is a group of React and React Native geeks, contact us at hello@callstack.com if you need any help with these or just want to say hi!

Like the project? ⚛️ Join the team who does amazing stuff for clients and drives React Native Open Source! 🔥