@react-native-community/slider

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

or

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:

1import Slider from '@react-native-community/slider';
2
3<Slider
4  style={{width: 200, height: 40}}
5  minimumValue={0}
6  maximumValue={1}
7  minimumTrackTintColor="#FFFFFF"
8  maximumTrackTintColor="#000000"
9/>

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.

Properties

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:

1  stepMarked: boolean;

1  currentValue: number;

1  index: number;

1  min: number;

1  max: number;

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:

1cd package/
2npm run lint
3npm 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>

New architecture setup (Fabric)

In order to use the new architecture some extra steps are needed.

iOS

• Install pods with new arch flag inside example/ios folder: RCT_NEW_ARCH_ENABLED=1 pod install
• Run npm run example-ios

Android

• Set newArchEnabled to true inside example/android/gradle.properties
• Run npm run example-android

1+ include $(NODE_MODULES_DIR)/@react-native-community/slider/android/build/generated/source/codegen/jni/Android.mk
2include $(CLEAR_VARS)

1    libreact_codegen_rncore \
2+   libreact_codegen_ReactSlider \
3    libreact_debug \

1#include <react/renderer/components/rncore/ComponentDescriptors.h>
2+ #include <react/renderer/components/ReactSlider/ComponentDescriptors.h>
3
4...
5
6MainComponentsRegistry::sharedProviderRegistry() {
7  auto providerRegistry = CoreComponentsRegistry::sharedProviderRegistry();
8
9  // Custom Fabric Components go here. You can register custom
10  // components coming from your App or from 3rd party libraries here.
11  //
12  // providerRegistry->add(concreteComponentDescriptorProvider<
13  //        AocViewerComponentDescriptor>());
14+ providerRegistry->add(concreteComponentDescriptorProvider<RNCSliderComponentDescriptor>());
15
16  return providerRegistry;
17}

Maintainers

• Bartosz Klonowski - Callstack
• Maciej Łodygowski - Callstack

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! 🔥