1.0.2 • Published 4 years ago

react-circular-slider-hme v1.0.2

Weekly downloads
2
License
MIT
Repository
github
Last release
4 years ago

react-circular-slider

npm.io npm.io

A highly customizable circular slider with no dependencies. See some live demos here!

install

npm install @fseehawer/react-circular-slider

example

import React from 'react';
import CircularSlider from '@fseehawer/react-circular-slider';

const App = () => {
    return (
        <CircularSlider
            onChange={ value => { console.log(value); } }
        />
    )
};

export default App;

Use min and max props to define the range of numbers. Use prependToValue/appendToValue if you want to prepend/append e.g. "$" or "°" to the value. Or simply use the data prop and pass any number or string sequence as an array to be spread in 360°. See some live demos here!

import React from 'react';
import CircularSlider from '@fseehawer/react-circular-slider';

const App = () => {
    return (
        <CircularSlider
            label="savings"
            labelColor="#005a58"
            knobColor="#005a58"
            progressColorFrom="#00bfbd"
            progressColorTo="#009c9a"
            progressSize={24}
            trackColor="#eeeeee"
            trackSize={24}
            data={["1€","2€"]} //...
            dataIndex={10}
            onChange={ value => { console.log(value); } }
        />
    )
};

export default App;

Props

proptypedefaultAffects
widthnumber280width of the slider
directionnumber1clockwise (1) or anticlockwise (-1)
minnumber0smallest value
maxnumber360largest value
dataarray[]array of data to be spread in 360°
dataIndexnumber0initially place knob at a certain value in the array
knobColorstring#4e63eaknob color
knobSizenumber32knob size
hideKnobbooleanfalsehide knob
knobDraggablebooleantrueknob not draggable
knobPositionstringtopknob's 0 position to be top, right, bottom or left
labelstringANGLElabel
labelColorstring#272b77label and value color
labelBottombooleanfalselabel position at bottom
labelFontSizestring1remlabel font-size
valueFontSizestring4remlabel value font-size
appendToValuestring''append character to value
prependToValuestring''prepend character to value
renderLabelValuejsxnulladd custom jsx code for the labels and styles
verticalOffsetstring2remvertical offset of the label and value
hideLabelValuebooleanfalsehide label and value
progressColorFromstring#80C3F3progress track gradient start color
progressColorTostring#4990E2progress track gradient end color
progressSizenumber8progress track size
progressLineCapstringroundprogress track cap to be round or flat
trackColorstring#DDDEFBbackground track color
trackSizenumber8background track size
onChangefuncvalue => {}returns label value

license

MIT License