1.6.3 â€ĸ Published 5 years ago

react-circle-slider-hooked v1.6.3

Weekly downloads
133
License
MIT
Repository
github
Last release
5 years ago

🕹ī¸ react-circle-slider

Circle Slider Component for React.js

Imgur

⚡ Functionality

  • Simple to use
  • No extra dependencies
  • Highly customizable
  • Defining min and max values
  • Defining step size
  • Touch support
  • Tooltip support
  • Style based: no images / SVGs

Examples

🚀 Getting started

Install react-circle-slider using npm.

npm install --save react-circle-slider

You can also test the components locally by cloning this repo and doing the following steps:

🔲 NPM-scripts

Install dependencies from package.json:

npm install

Runs the app in the development mode. Open http://localhost:1234 to view it in the browser.

npm run dev

Run linter

npm run lint

Start tests followed by jest

npm test

Usage

import React from "react";
import ReactDOM from "react-dom";
import { CircleSlider } from "react-circle-slider";

export class App extends React.Component {
    constructor(props) {
        super(props);
        this.state = { value: 0 };
    }

    handleChange = value => {
        console.log(`Changed value ${value}`);
        this.setState({ value });
    };

    handleChangeRange = event => {
        this.setState({
            value: event.target.valueAsNumber,
        });
    };

    render() {
        const { value } = this.state;
        return <CircleSlider value={value} onChange={this.handleChange} />;
    }
}

ReactDOM.render(<App />, document.getElementById("root"));

📃 Props

PropsTypeDefaultDescription
sizeNumber180size of the slider in px
stepSizeNumber1value to be added or subtracted on each step the slider makes.
knobRadiusNumber10knob radius in px
circleWidthNumber5width of circle in px
progressWidthNumber10progress curve width in px
minNumber0the minimum value of the slider
maxNumber100the maximum value of the slider
valueNumber0value
circleColorString#e9eaeecolor of slider
progressColorString#007affcolor of progress curve
knobColorString#e9eaeecolor of knob
disabledBooleanfalsedisabled status
shadowBooleantrueshadow on knob
showTooltipBooleanfalsetooltip
valuePrefixStringNOOPprefix of value within tooltip
valueSuffixStringNOOPsuffix of value within tooltip
tooltipSizeNumber32size of tooltip
tooltipColorString#333color of tooltip
onChangeFunctionNOOPwhen slider is moved, onChange is triggered.

💡 Todo

  • Keyboard support
  • Mouse scroll support
  • Accessibility

đŸ’ģ Contributing

  • For bugs and feature requests, please create an issue
  • Lint and test your code
  • Pull requests and ⭐ stars are always welcome

License

MIT