callstack/react-native-slider

Repository files navigation

CircleCI StatusSupports Android and iOSMIT License

React Native component used to select a single value from a range of values.

iOS ScreenshotAndroid Screenshot

yarn add @react-native-community/slider

or

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

react-native link @react-native-community/slider

Manually link the library on iOS

Drag RNCSlider.xcodeproj to your project on Xcode (usually under the Libraries group on Xcode):

xcode-add

Click on your main project file (the one that represents the .xcodeproj) select Build Phases and drag the static library from the Products folder inside the Library you are importing to Link Binary With Libraries (or use the + sign and choose library from the list):

xcode-link

Manually link the library on Android
include ':react-native-community-slider'
project(':react-native-community-slider').projectDir = new File(rootProject.projectDir, '../node_modules/@react-native-community/slider/android')
dependencies {
   ...
   implementation project(':react-native-community-slider')
}

On top, where imports are:

import com.reactnativecommunity.slider.ReactSliderPackage;

Add the ReactSliderPackage class to your list of exported packages.

@Override
protected List<ReactPackage> getPackages() {
    return Arrays.asList(
            new MainReactPackage(),
            new ReactSliderPackage()
    );
}

This module was created when the Slider was split out from the core of React Native. To migrate to this module you need to follow the installation instructions above and then change you imports from:

import { Slider } from 'react-native';

to:

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

Check out the example project for more examples.


Used to style and layout the Slider. See StyleSheet.js and ViewStylePropTypes.js for more info.

TypeRequired
View.styleNo

If true the user won't be able to move the slider. Default value is false.

TypeRequired
boolNo

Initial maximum value of the slider. Default value is 1.

TypeRequired
numberNo

The color used for the track to the left of the button. Overrides the default blue gradient image on iOS.

TypeRequired
colorNo

Initial minimum value of the slider. Default value is 0.

TypeRequired
numberNo

Callback that is called when the user picks up the slider. The initial value is passed as an argument to the callback handler.

TypeRequired
functionNo

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.

TypeRequired
functionNo

Callback continuously called while the user is dragging the slider.

TypeRequired
functionNo

Step value of the slider. The value should be between 0 and (maximumValue - minimumValue). Default value is 0.

TypeRequired
numberNo

The color used for the track to the right of the button. Overrides the default gray gradient image on iOS.

TypeRequired
colorNo

Used to locate this view in UI automation tests.

TypeRequired
stringNo

Initial value of the slider. 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.

TypeRequired
numberNo

Color of the foreground switch grip.

TypeRequiredPlatform
colorNoAndroid

Assigns a maximum track image. Only static images are supported. The leftmost pixel of the image will be stretched to fill the track.

TypeRequiredPlatform
Image.propTypes.sourceNoiOS

Assigns a minimum track image. Only static images are supported. The rightmost pixel of the image will be stretched to fill the track.

TypeRequiredPlatform
Image.propTypes.sourceNoiOS

Sets an image for the thumb. Only static images are supported.

TypeRequiredPlatform
Image.propTypes.sourceNoiOS

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.

TypeRequiredPlatform
Image.propTypes.sourceNoiOS

This module was extracted from react-native core. Please reffer to https://.com/react-native-community/react-native-slider/graphs/contributors for the complete list of contributors.

The library is released under the MIT licence. For more information see LICENSE.