1.0.0 • Published 3 years ago

react-native-slider-kf v1.0.0

Weekly downloads
-
License
MIT
Repository
github
Last release
3 years ago
iOSAndroidWindows
iOS ScreenshotAndroid ScreenshotWindows Screenshot

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 For web support please use @react-native-community/slider@next

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"
/>

Check out the example project for more examples.


Migrating from the core react-native module

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';

React Native Compatibility

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

@react-native-community/slider versionRequired React Native Version
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

PropertyDescriptionTypeRequiredPlatform
styleUsed to style and layout the Slider. See StyleSheet.js and ViewStylePropTypes.js for more info.View.styleNo
disabledIf true the user won't be able to move the slider.Default value is false.boolNo
maximumValueInitial maximum value of the slider.Default value is 1.numberNo
minimumTrackTintColorThe color used for the track to the left of the button.Overrides the default blue gradient image on iOS.colorNo
minimumValueInitial minimum value of the slider.Default value is 0.numberNo
onSlidingStartCallback that is called when the user picks up the slider.The initial value is passed as an argument to the callback handler.functionNo
onSlidingCompleteCallback 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.functionNo
onValueChangeCallback continuously called while the user is dragging the slider.functionNo
stepStep 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).numberNo
maximumTrackTintColorThe color used for the track to the right of the button.Overrides the default gray gradient image on iOS.colorNo
testIDUsed to locate this view in UI automation tests.stringNo
valueWrite-only property representing the value of the slider. Can be used to programmaticaly controll the position of the thumb. Entered once at the beginning still acts as an initial value. 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.numberNo
tapToSeekPermits tapping on the slider track to set the thumb position.Defaults to false on iOS. No effect on Android or Windows.boolNoiOS
invertedReverses the direction of the slider.Default value is false.boolNo
verticalChanges the orientation of the slider to vertical, if set to true.Default value is false.boolNoWindows
thumbTintColorColor of the foreground switch grip.colorNoAndroid
maximumTrackImageAssigns a maximum track image. Only static images are supported. The leftmost pixel of the image will be stretched to fill the track.Image.propTypes.sourceNoiOS
minimumTrackImageAssigns a minimum track image. Only static images are supported. The rightmost pixel of the image will be stretched to fill the track.Image.propTypes.sourceNoiOS
thumbImageSets 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.sourceNo
trackImageAssigns 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.sourceNoiOS
refReference object.MutableRefObjectNoweb
ViewInherited View props...

Contributing

This project uses yarn workspaces to handle its internal dependencies.

  • Make sure to use yarn to install dependencies when implementing changes to this library.
yarn install
  • Make sure your code passes Flow, ESLint and the tests. Run the following to verify:
yarn validate:flow
yarn validate:eslint --fix
yarn test:jest

or

yarn test

to run them all.

  • 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 yarn in the root directory to install dependencies, and again in src to create the dist build.
  • (on iOS) Run npx pod-install from the example directory
  • (on Windows) You need to manually link the Slider module to your project.

Start the app

  • Run yarn run:android to run on Android
  • Run yarn run:ios to run on iOS
  • Run yarn run:web to run on web
  • Run yarn run:windows to run on Windows.

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

abababsolute-pathacornabort-controlleracceptsanseracorn-globalsacorn-walkansi-escapesansi-fragmentsacorn-jsxajvansi-regexanymatchansi-stylesargparseapplicationinsightsargsarrayappdirsjsarr-diffarr-unionarr-flattenarray-find-indexarray-filterarray-equalarray-maparray-reducearray-uniqarray-uniqueasn1array-includesasapassert-plusarray-unionast-typesastral-regexassign-symbolsasyncasync-limiterasync-listenerasync-hook-jlasynckitaws4babel-eslintbabel-plugin-jest-hoistbabel-corebabel-plugin-dynamic-import-nodebabel-plugin-module-resolveratobaws-sign2babel-plugin-polyfill-corejs3babel-plugin-polyfill-regeneratorbabel-plugin-polyfill-corejs2babel-plugin-istanbulbabel-preset-fbjsbabel-preset-expobadginbabel-preset-jestbabel-plugin-syntax-trailing-function-commasbasebabel-jestbase64-jsbcrypt-pbkdfbabel-plugin-react-native-webbinary-extensionsbplist-parserbalanced-matchblueimp-md5bplist-creatorbrowser-process-hrtimebig-integerbserbrowser-resolvebrowserslistbrace-expansionbuffer-allocbracesbuffer-alloc-unsafebuffer-fillcache-basebytesbuffer-fromcall-bindcaller-callsitecallsitescamelcasecaller-pathcapture-exitcaniuse-litecaselesschokidarcharcodeschalkchardetcli-cursorci-infoclass-utilscli-spinnerscli-widthcliuiclonecollection-visitcolor-convertclone-deepcolorettecolor-namecolorscocommandercommondircombined-streamcls-hookedcommand-existscompare-versionscompare-urlscompressiblecompressioncomponent-emitterconcat-mapconnectconvert-source-mapcontinuation-local-storagecore-jscore-js-compatcopy-descriptorcore-util-iscosmiconfigcross-spawncreate-react-classcss-in-js-utilscssomcssstyledata-urlsdashdashdayjsdebugdebouncedeep-isdeep-assigndeepmergedefaultsdefine-propertydefine-propertiesdecamelizedetect-newlinedepddecode-uri-componentdenodeifydelayed-streamdiagnostic-channel-publishersdiff-sequencesdiagnostic-channeldir-globdoctrineecc-jsbndomexceptionelectron-to-chromiumdestroyee-firstemoji-regexemitter-listenerend-of-streamenvinfoencodingencodeurlerror-exerrorhandlererror-stack-parseres-to-primitivees-abstractescaladeescape-htmlescodegeneslint-plugin-eslint-commentseslintescape-string-regexpeslint-plugin-flowtypeeslint-plugin-jesteslint-plugin-reacteslint-scopeeslint-plugin-react-nativeeslint-plugin-react-hookseslint-utilseslint-plugin-react-native-globalseslint-visitor-keysespreeesqueryesrecurseesprimaeslint-plugin-prettierestraverseetagesutilsexec-shevent-target-shimexecaexpand-bracketsexpectexampleexitexpoexpo-constantsexpo-error-recoveryexpo-assetexpo-file-systemexpo-keep-awakeexpo-linear-gradientexpo-fontexpo-linkingexpo-permissionsexpo-locationexpo-sqliteextendexpo-web-browserextend-shallowextglobextsprintfexternal-editorfast-deep-equalfast-difffast-json-stable-stringifyfb-watchmanfbemitterfast-levenshteinfbjs-css-varsfbjsfiguresfill-rangefind-babel-configfile-entry-cachefind-upfinalhandlerflattedflow-binflat-cacheflow-parserfontfaceobserverfor-eachforever-agentfind-cache-dirfreshfor-infragment-cachefs-extrafs-readdir-recursiveform-datafunction-bindfs.realpathfunctional-red-black-treeget-caller-fileget-intrinsicget-monorepo-packagesget-valuegensyncglobget-symbol-descriptiongetpassgrowlyget-streamglob-parenthar-schemahar-validatorglobbyhasglobalshas-property-descriptorsgraceful-fshas-symbolshas-bigintshermes-enginehas-tostringtaghermes-parserhas-flaghas-valueshermes-profile-transformerhtml-encoding-snifferhas-valuehosted-git-infohttp-signaturehtml-escaperhttp-errorsiconv-litehyphenate-style-nameignoreimage-sizeimurmurhashimmediateimport-localimport-freshinheritsinline-style-prefixerinflightinquirerinternal-slotinterpretinvariantis-arrayishis-binary-pathipis-boolean-objectis-accessor-descriptoris-bigintis-bufferis-ciis-core-moduleis-data-descriptoris-descriptoris-callableis-directoryis-date-objectis-extendableis-globis-extglobis-fullwidth-code-pointis-generator-fnis-negative-zerois-number-objectis-numberis-shared-array-bufferis-objis-plain-objectis-plain-objis-stringis-symbolis-streamis-typedarrayis-regexis-windowsis-weakrefis-wslisobjectistanbul-lib-coverageisexeisomorphic-fetchisarrayistanbul-lib-instrumentisstreamistanbul-lib-source-mapsistanbul-lib-reportistanbul-reportsjestjest-changed-filesjest-configjest-clijest-diffjest-docblockjest-environment-nodejest-eachjest-environment-jsdomjest-haste-mapjest-get-typejest-jasmine2jest-leak-detectorjest-matcher-utilsjest-message-utiljest-pnp-resolverjest-mockjest-regex-utiljest-resolvejest-runnerjest-resolve-dependenciesjest-serializerjest-runtimejest-snapshotjest-utiljest-workerjetifierjest-validatejoijest-watcherjs-tokensjs-yamljsbnjsc-androidjscodeshiftjsdomjson-parse-better-errorsjsescjson-schemajson-schema-traversejson-stable-stringify-without-jsonifyjson-stringify-safejsonfilejson5jsprimjsonifyjsx-ast-utilsklawlevenkleurkind-ofleft-padlevnlodashlocate-pathlodash.sortbyload-json-filelodash.debouncelodash.throttlelodash.unescapeloose-envifylog-symbolslogkittymakeerrorlru-cachemake-dirmap-cachememmap-age-cleanermap-visitmd5-filemetro-babel-registermerge-streammetrometro-cache-keymetro-cachemetro-configmetro-babel-transformermetro-hermes-compilermetro-react-native-babel-presetmetro-coremetro-inspector-proxymetro-minify-uglifymetro-react-native-babel-transformermetro-resolvermetro-runtimemetro-source-mapmetro-symbolicatemetro-transform-workermetro-transform-pluginsmime-typesmimic-fnmimemime-dbminimatchmicromatchminimistmixin-deepmkdirpmute-streamnanomatchmsnatural-comparemustacheneo-asyncnegotiatornice-trynocachenode-fetchnode-dirnode-notifiernode-int64node-releasesnoop-fnnormalize-pathnormalize-css-colornode-stream-zipnormalize-package-datanpm-run-pathnullthrowsnormalize-urlobject-assignnwsapioauth-signobject-copyobject-keysob1object-visitobject-inspectobject.assignobject.fromentriesobject.pickon-headersobject.getownpropertydescriptorson-finishedoptionatoronceopenonetimeoptionsp-deferoraos-tmpdirp-finallyp-each-seriesp-limitp-locatep-reducep-is-promisep-tryparent-moduleparse-jsonpascalcasepath-existsparseurlparse5path-is-absolutepath-browserifypath-parsepath-keypath-typeperformance-nowpicocolorspifypiratespkg-dirpicomatchplistpnpkg-upposix-character-classesprelude-lspouchdb-collectionsprepend-httpprettierpretty-formatpromiseprocess-nextick-argsprogresspslpromptsprop-typespumppunycodeqsquery-stringreactquerystringifyreact-devtools-corereact-isrange-parserreact-native-codegenreact-nativereact-native-view-shotreact-native-webreact-native-windowsread-pkgreact-test-rendererreact-refreshread-pkg-upreadable-streamreact-timer-mixinrealpath-nativereadlinereaddirprecastrechoirregenerator-runtimeregenerateregenerate-unicode-propertiesregenerator-transformregex-notregjsgenregexppregjsparserregexpu-coreremove-trailing-separatorrepeat-stringrepeat-elementrequestrequest-promise-corerequire-main-filenamerequest-promise-nativerequire-directoryrequires-portreselectresolve-cwdresolveresolve-fromresolve-urlrestore-cursorrimrafretrsvprxjsrun-asyncsafer-buffersafe-regexsafe-buffersaxsaneschedulersemverserialize-errorsendset-blockingset-valueserve-staticsetprototypeofsetimmediateshebang-regexshallow-cloneshelljsshebang-commandshell-quoteshellwordsside-channelsimple-plistsisteransisignal-exitslashsnapdragon-nodesnapdragonslice-ansisort-keyssnapdragon-utilsource-map-urlsource-mapsource-map-supportspdx-correctsource-map-resolvespdx-exceptionsspdx-license-idssplit-stringspdx-expression-parsesshpkstack-utilssprintf-jsstackframestack-chainstacktrace-parserstream-buffersstatic-extendstatusesstealthy-requirestring-lengthstrict-uri-encodestring-widthstring_decoderstring.prototype.trimendstring.prototype.trimstartshimmerstrip-ansistrip-bomsudo-promptstrip-json-commentsstrip-eofsupports-colorsupports-preserve-symlinks-flagsymbol-treetemptabletext-tablethroatthrough2test-excludetmpthroughtmpltiny-queuetoidentifierto-object-pathto-fast-propertiesto-regexto-regex-rangetr46tslibtough-cookietsutilstweetnacltunnel-agenttype-festtypescripttype-checkultronua-parser-jsuglify-esunbox-primitiveunicode-canonical-property-names-ecmascriptunicode-property-aliases-ecmascriptunicode-match-property-ecmascriptunimodules-app-loaderunicode-match-property-value-ecmascriptunimodules-barcode-scanner-interfaceunimodules-constants-interfaceunimodules-camera-interfaceunimodules-face-detector-interfaceunimodules-font-interfaceunimodules-file-system-interfaceunimodules-image-loader-interfaceunion-valueunimodules-sensors-interfaceunimodules-permissions-interfaceunimodules-task-manager-interfaceunpipeuniversalifyurl-parseuri-jsunset-valueurixuseusernameuse-subscriptionuuidutil-deprecateutil.promisifyw3c-hr-timev8-compile-cachevaryutils-mergevalidate-npm-package-licensevlqverrorwcwidthwalkerwhatwg-fetchwebidl-conversionswhatwg-urlwhatwg-mimetypewhichwhatwg-encodingwhich-boxed-primitivewhich-moduleword-wrapwrap-ansiwrappywrite-file-atomicxml-formatterwritewsxml-name-validatorxml-parserxcodexml-parser-xoxmldocxmlbuilderxtendxpathy18nyallistyargsyargs-parser
1.0.0

3 years ago