rc-slider

What is rc-slider?

The rc-slider npm package is a React component that allows users to implement slider functionality in their web applications. It provides a range of sliders, including basic sliders, range sliders, and sliders with custom handles and tracks. It is customizable and supports various configurations such as vertical orientation, marks, step adjustments, and more.

What are rc-slider's main functionalities?

Basic Slider

This code sample demonstrates how to create a basic horizontal slider with a default value set to 30.

import React from 'react';
import Slider from 'rc-slider';
import 'rc-slider/assets/index.css';

const BasicSlider = () => (
  <Slider defaultValue={30} />
);

export default BasicSlider;

Range Slider

This code sample shows how to create a range slider that allows users to select a value range. The default selected range is from 20 to 50.

import React from 'react';
import { Range } from 'rc-slider';
import 'rc-slider/assets/index.css';

const RangeSlider = () => (
  <Range defaultValue={[20, 50]} />
);

export default RangeSlider;

Slider with Marks

This code sample illustrates a slider with marks at specified values. It also shows how to style individual marks and use React components as labels.

import React from 'react';
import Slider from 'rc-slider';
import 'rc-slider/assets/index.css';

const marks = {
  0: '0°C',
  26: '26°C',
  37: '37°C',
  100: {
    style: {
      color: 'red',
    },
    label: <strong>100°C</strong>,
  },
};

const MarkedSlider = () => (
  <Slider marks={marks} defaultValue={37} step={null} />
);

export default MarkedSlider;

Vertical Slider

This code sample demonstrates how to create a vertical slider by setting the 'vertical' prop. The slider is contained within a div that specifies its height.

import React from 'react';
import Slider from 'rc-slider';
import 'rc-slider/assets/index.css';

const VerticalSlider = () => (
  <div style={{ height: 200, marginLeft: 50 }}>
    <Slider vertical defaultValue={30} />
  </div>
);

export default VerticalSlider;

Other packages similar to rc-slider

react-slider

react-slider is another React component for creating sliders. It is similar to rc-slider but offers a different API and additional features like multiple thumbs on a single track, which can be useful for building more complex sliders.

react-rangeslider

react-rangeslider is a lightweight React component that provides a slider with a single handle. It is less feature-rich compared to rc-slider, focusing on simplicity and ease of use.

react-input-slider

react-input-slider is a React component that allows for slider input. It is similar to rc-slider but has a simpler API and fewer customization options, making it a good choice for straightforward slider implementations.

README

rc-slider

---

slider ui component for react

Screenshots

Feature

• support ie8,ie8+,chrome,firefox,safari

Keyboard

install

Usage

var React = require('react');
var ReactDOM = require('react-dom');
var Rcslider = require('rc-slider');
ReactDOM.render(<Rcslider />, container);

API

props

name	type	default	description
className	String	rc-slider	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
marks	object {number: string}	{}	Mark on the slider. The key determines the position, and the value determines what will show.
step	number or `null`	1	Value to be added or subtracted on each step the slider makes. Must be greater than zero. 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.
range	boolean	false	Determines the type of slider. If range is `true`, two handles will be rendered in order to select a range.
allowCross	boolean	true	When `range` is `true`, `allowCross` could be set as `true` to allow those two handles cross.
defaultValue	number or [number, number]	0 or [0, 0]	Set initial positions of handles. If range is `false`, the type of `defaultValue` should be `number`. Otherwise, `[number, number]`
value	number or [number, number]		Set current positions of handles. If range is `false`, the type of `defaultValue` should be `number`. Otherwise, `[number, number]`
included	boolean	true	If the value is `true`, it means a continuous value interval, otherwise, it is a independent value.
disabled	boolean	false	If `true`, handles can't be moved.
tipTransitionName	string	''	Set the animation for tooltip if it shows.
tipFormatter	function		Format the value of the tooltip if it shows.
dots	bool	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.
onChange	function	NOOP	`onChange` will be triggered while the value of Slider changing.
onAfterChange	function	NOOP	`onAfterChange` will be triggered when `ontouchend` or `onmouseup` is triggered.

Development

npm install
npm start

Example

http://localhost:8005/examples/

online example: http://react-component.github.io/slider/

Test Case

http://localhost:8005/tests/runner.html?coverage

Coverage

http://localhost:8005/node_modules/rc-server/node_modules/node-jscover/lib/front-end/jscoverage.html?w=http://localhost:8088/tests/runner.html?coverage

License

rc-slider is released under the MIT license.