0.0.5 • Published 1 year ago

simple-range-slider-nextjs v0.0.5

Weekly downloads
-
License
-
Repository
-
Last release
1 year ago

simple-range-slider-nextjs

a react component compatible with Next.js that can easy to use and interact with parent component with props and events.


Image examples.

No Dependency only single component file and css file

SimpleRangeSlider.jsx , SimpleRangeSlider.css

You can customize css to change UI/UX.

Download CSS file and modify it and reference it with baseClassName attribute

simplerangeslider.css

simplerangesliderblack.css

Following is the list of props that control the component

propstypedefaultdescription
minNumber0Slider Minimum Value that user can set
maxNumber100Slider Maximum Value that user can Set
minValueNumber25Slider range selected minimum value that will show default selected
maxValueNumber75Slider range selected maximum value that will show default selected
stepNumber5Slider change value that will change when bar clicked or keyboard arrow key pressed
stepOnlyBooleanfalsespecify user to select only values in round of step only
preventWheelBooleanfalsetrue then it not accept mouse wheel to change its value. false then (shift + wheel) change minValue (ctrl+wheel) change maxValue, (ctrl+shift+wheel) change both values
rulerBooleantrueis ruler visible or not
labelBooleantrueis label visible or not
labelsString Arrayspecify steps label string value
minCaptionStringcaption on min thumb when sliding - can set on onChange/onInput event
maxCaptionStringcaption on max thumb when sliding - can set on onChange/onInput event
subStepsBooleanfalseis small steps line visible or not
baseClassNameStringsimple-range-sliderChange CSS style of your own
classNameString''Add additional class with baseClassName to div.simple-range-slider
styleReact.CSSPropertiesspecify/override additional style on div.simple-range-slider
barLeftColorString-Colorspecify slider left part background color
barRightColorString-Colorspecify slider right part background color
barInnerColorString-Colorspecify slider inner part background color
thumbLeftColorString-Colorspecify slider left thumb background color
thumbRightColorString-Colorspecify slider right thumb background color
refReact.useRefreference to div.simple-range-slider

Event List

EventDescription
onChangetrigger when thumb mouse up OR slider value change done
onInputtrigger on thumb mouse move OR slider value changing

typescript props definition

Props = {
	min?: number | string;
	max?: number | string;
	step?: number | string;
	minValue?: number | string;
	maxValue?: number | string;
	baseClassName?: string;
	className?: string;
	style?: React.CSSProperties;
	ruler?: boolean | string;
	label?: boolean | string;
	subSteps?: boolean | string;
	stepOnly?: boolean | string;
	preventWheel?: boolean | string;
	labels?: string[];
	minCaption?: string;
	maxCaption?: string;
	barLeftColor?: string;
	barRightColor?: string;
	barInnerColor?: string;
	thumbLeftColor?: string;
	thumbRightColor?: string;
	onInput?: (e: ChangeResult) => void;
	onChange?: (e: ChangeResult) => void;
};

onInput/onChange event parameter type - typescript

type ChangeResult = {
	min: number;
	max: number;
	minValue: number;
	maxValue: number;
};

How to Install

copy following code and run on CLI

npm install simple-range-slider-nextjs

How to use

Example Code

App.jsx

import React, { useState } from "react";
import SimpleRangeSlider from "simple-range-slider-nextjs";
function App() {
const [minValue, set_minValue] = useState(25);
const [maxValue, set_maxValue] = useState(75);
const handleInput = (e) => {
	set_minValue(e.minValue);
	set_maxValue(e.maxValue);
};

return (
	<div className="App">
		<SimpleRangeSlider
			min={0}
			max={100}
			step={5}
			minValue={minValue}
			maxValue={maxValue}
			onInput={(e) => {
				handleInput(e);
			}}
		/>
	</div>
	);
}

export default App;

App.tsx

import React, { useState } from "react";
import SimpleRangeSlider, { ChangeResult } from "simple-range-slider-nextjs";

const App = () => {
	const [minValue, setMinValue] = useState(25);
	const [maxValue, setMaxValue] = useState(75);

	return (
		<div className='App'>
			<div className='simple-range-slider-container'>
				<b>Simple range slider with default values</b>
				<hr />
				<SimpleRangeSlider
					min={0}
					max={100}
					step={5}
					minValue={minValue}
					maxValue={maxValue}
					onInput={(e: ChangeResult) => {
						setMinValue(e.minValue);
						setMaxValue(e.maxValue);
					}}
				></SimpleRangeSlider>
				<div style={{ display: 'flex', justifyContent: 'center' }}>
					<div style={{ margin: '10px' }}>onInput:</div>
					<div style={{ margin: '10px' }}>{minValue}</div>
					<div style={{ margin: '10px' }}>{maxValue}</div>
				</div>
			</div>
		</div>
	)

}
export default App;