Gathering detailed insights and metrics for rc-slider
Installations
npm install rc-sliderDeveloper Guide
BETA
Typescript
Yes
Module System
CommonJS
Min. Node Version
>=8.x
Node Version
22.8.0
NPM Version
10.8.3
Score
92.9
Supply Chain
95.3
Quality
91.8
Maintenance
100
Vulnerability
100
License
Releases
57
Contributors
118
Languages
3
TypeScript
JavaScript
Less
TypeScript (63.29%)
JavaScript (31.61%)
Less (5.11%)
Developer
Download Statistics
Total Downloads
367,958,554
Last Day
355,219
Last Week
1,607,353
Last Month
7,497,246
Last Year
93,675,900
GitHub Statistics
3,064 Stars
738 Commits
777 Forks
48 Watching
12 Branches
118 Contributors
Bundle Size
24.76 kB
Minified
9.23 kB
Minified + Gzipped
Maintainers
9
Package Meta Information
Latest Version
11.1.8
Package Id
rc-slider@11.1.8
Unpacked Size
169.00 kB
Size
24.71 kB
File Count
68
NPM Version
10.8.3
Node Version
22.8.0
Publised On
31 Dec 2024
Total Downloads
Cumulative downloads
Total Downloads
367,958,554
Last day
-9.9%
355,219
Compared to previous day
Last week
-19.4%
1,607,353
Compared to previous week
Last month
-0.2%
7,497,246
Compared to previous month
Last year
17.1%
93,675,900
Compared to previous year
Daily Downloads
Weekly Downloads
Monthly Downloads
Yearly Downloads
Dependencies
3
Dev Dependencies
27
@rc-component/father-plugin@testing-library/jest-dom@testing-library/react@types/classnames@types/jest@types/node@types/react@types/react-dom@umijs/fabriccross-envdumieslinteslint-plugin-jesteslint-plugin-unicornfatherfather-buildgh-pagesgloblessnprc-testrc-tooltiprc-triggerreactreact-domregenerator-runtimetypescript
Versions
rc-slider
Slider UI component for React
Install
Example
npm start and then go to http://localhost:8000
Online examples: https://slider.react-component.now.sh/
Usage
Slider
1import Slider from 'rc-slider'; 2import 'rc-slider/assets/index.css'; 3 4export default () => ( 5 <> 6 <Slider /> 7 </> 8);
Range
Please refer to #825 for information regarding usage of Range.
An example:
1import Slider, { Range } from 'rc-slider'; 2import 'rc-slider/assets/index.css'; 3 4export default () => ( 5 <> 6 <Slider range /> 7 </> 8);
Compatibility
 IE / Edge |  Firefox |  Chrome |  Safari |  Electron |
|---|---|---|---|---|
| IE11, Edge | last 2 versions | last 2 versions | last 2 versions | last 2 versions |
API
createSliderWithTooltip(Slider | Range) => React.Component
An extension to make Slider or Range support Tooltip on handle.
1const Slider = require('rc-slider'); 2const createSliderWithTooltip = Slider.createSliderWithTooltip; 3const Range = createSliderWithTooltip(Slider.Range);
After Range or Slider was wrapped by createSliderWithTooltip, it will have the following props:
| Name | Type | Default | Description |
|---|---|---|---|
| tipFormatter | (value: number): React.ReactNode | value => value | A function to format tooltip's overlay |
| tipProps | Object | { placement: 'top', prefixCls: 'rc-slider-tooltip', overlay: tipFormatter(value) } | A function to format tooltip's overlay |
Common API
The following APIs are shared by Slider and Range.
| Name | Type | Default | Description |
|---|---|---|---|
| className | string | '' | Additional CSS class for the root DOM node |
| min | number | 0 | The minimum value of the slider |
| max | number | 100 | The maximum value of the slider |
| id | string | '' | Unique identifier for the component, used for accessibility |
| marks | {number: ReactNode} or{number: { style, label }} | {} | Marks on the slider. The key determines the position, and the value determines what will show. If you want to set the style of a specific mark point, the value should be an object which contains style and label properties. |
| step | number or null | 1 | Value to be added or subtracted on each step the slider makes. Must be greater than zero, and max - min should be evenly divisible by the step value. When marks is not an empty object, step can be set to null, to make marks as steps. |
| vertical | boolean | false | If vertical is true, the slider will be vertical. |
| handle | (props) => React.ReactNode | A handle generator which could be used to customized handle. | |
| included | boolean | true | If the value is true, it means a continuous value interval, otherwise, it is a independent value. |
| reverse | boolean | false | If the value is true, it means the component is rendered reverse. |
| disabled | boolean | false | If true, handles can't be moved. |
| keyboard | boolean | true | Support using keyboard to move handlers. |
| dots | boolean | false | When the step value is greater than 1, you can set the dots to true if you want to render the slider with dots. |
| onBeforeChange | Function | NOOP | onBeforeChange will be triggered when ontouchstart or onmousedown is triggered. |
| onChange | Function | NOOP | onChange will be triggered while the value of Slider changing. |
| onChangeComplete | Function | NOOP | onChangeComplete will be triggered when ontouchend or onmouseup is triggered. |
| minimumTrackStyle | Object | please use trackStyle instead. (only used for slider, just for compatibility , will be deprecate at rc-slider@9.x ) | |
| maximumTrackStyle | Object | please use railStyle instead (only used for slider, just for compatibility , will be deprecate at rc-slider@9.x) | |
| handleStyle | Array[Object] | Object | [{}] | The style used for handle. (both for slider(Object) and range(Array of Object), the array will be used for multi handle following element order) |
| trackStyle | Array[Object] | Object | [{}] | The style used for track. (both for slider(Object) and range(Array of Object), the array will be used for multi track following element order) |
| railStyle | Object | {} | The style used for the track base color. |
| dotStyle | Object | (dotValue) => Object | {} | The style used for the dots. |
| activeDotStyle | Object | (dotValue) => Object | {} | The style used for the active dots. |
Slider
| Name | Type | Default | Description |
|---|---|---|---|
| defaultValue | number | 0 | Set initial value of slider. |
| value | number | - | Set current value of slider. |
| startPoint | number | undefined | Track starts from this value. If undefined, min is used. |
| tabIndex | number | 0 | Set the tabIndex of the slider handle. |
| ariaLabelForHandle | string | - | Set the aria-label attribute on the slider handle. |
| ariaLabelledByForHandle | string | - | Set the aria-labelledby attribute on the slider handle. |
| ariaRequired | boolean | - | Set the aria-required attribute on the slider handle. |
| ariaValueTextFormatterForHandle | (value) => string | - | A function to set the aria-valuetext attribute on the slider handle. It receives the current value of the slider and returns a formatted string describing the value. See WAI-ARIA Authoring Practices 1.1 for more information. |
Range
| Name | Type | Default | Description |
|---|---|---|---|
| defaultValue | number[] | [0, 0] | Set initial positions of handles. |
| value | number[] | Set current positions of handles. | |
| tabIndex | number[] | [0, 0] | Set the tabIndex of each handle. |
| ariaLabelGroupForHandles | Array[string] | - | Set the aria-label attribute on each handle. |
| ariaLabelledByGroupForHandles | Array[string] | - | Set the aria-labelledby attribute on each handle. |
| ariaValueTextFormatterGroupForHandles | Array[(value) => string] | - | A function to set the aria-valuetext attribute on each handle. It receives the current value of the slider and returns a formatted string describing the value. See WAI-ARIA Authoring Practices 1.1 for more information. |
| count | number | 1 | Determine how many ranges to render, and multiple handles will be rendered (number + 1). |
| allowCross | boolean | true | allowCross could be set as true to allow those handles to cross. |
| pushable | boolean or number | false | pushable could be set as true to allow pushing of surrounding handles when moving a handle. When set to a number, the number will be the minimum ensured distance between handles. Example:  |
| draggableTrack | boolean | false | Open the track drag. open after click on the track will be invalid. |
SliderTooltip
The Tooltip Component that keep following with content.
Development
npm install
npm start
Test Case
npm run test
Coverage
npm run coverage
License
rc-slider is released under the MIT license.
No vulnerabilities found.
Reason
no dangerous workflow patterns detected
Reason
no binaries found in the repo
Reason
0 existing vulnerabilities detected
Reason
license file detected
Details
- Info: project has a license file: LICENSE:0
- Info: FSF or OSI recognized license: MIT License: LICENSE:0
Reason
SAST tool detected but not run on all commits
Details
- Info: SAST configuration detected: CodeQL
- Warn: 13 commits out of 14 are checked with a SAST tool
Reason
3 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 2
Reason
Found 5/28 approved changesets -- score normalized to 1
Reason
detected GitHub workflow tokens with excessive permissions
Details
- Info: jobLevel 'contents' permission set to 'read': .github/workflows/codeql.yml:17
- Info: jobLevel 'actions' permission set to 'read': .github/workflows/codeql.yml:16
- Warn: no topLevel permission defined: .github/workflows/codeql.yml:1
- Warn: no topLevel permission defined: .github/workflows/main.yml:1
- Info: no jobLevel write permissions found
Reason
dependency not pinned by hash detected -- score normalized to 0
Details
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql.yml:27: update your workflow using https://app.stepsecurity.io/secureworkflow/react-component/slider/codeql.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql.yml:30: update your workflow using https://app.stepsecurity.io/secureworkflow/react-component/slider/codeql.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql.yml:36: update your workflow using https://app.stepsecurity.io/secureworkflow/react-component/slider/codeql.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql.yml:39: update your workflow using https://app.stepsecurity.io/secureworkflow/react-component/slider/codeql.yml/master?enable=pin
- Info: 0 out of 4 GitHub-owned GitHubAction dependencies pinned
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
security policy file not detected
Details
- Warn: no security policy file detected
- Warn: no security file to analyze
- Warn: no security file to analyze
- Warn: no security file to analyze
Score
4.7
/10
Last Scanned on 2025-01-20
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn More