@bolttech/atoms-range-slider
v0.17.0
Published
The **RangeSlider** component is a React component designed to provide a range slider input element with customizable options such as minimum, maximum, step, and value range. This component is a part of the project's UI module and is intended to offer a u
Downloads
190
Maintainers
Keywords
Readme
RangeSlider Component
The RangeSlider component is a React component designed to provide a range slider input element with customizable options such as minimum, maximum, step, and value range. This component is a part of the project's UI module and is intended to offer a user-friendly way to select a range of values within specified bounds.
Table of Contents
Installation
To use the RangeSlider component in your React application, you need to follow these steps:
Using npm
npm install @bolttech/frontend-foundations @bolttech/atoms-range-slider
Using Yarn
yarn add @bolttech/frontend-foundations @bolttech/atoms-range-slider
Once you have the required dependencies installed, you can start using the RangeSlider
component in your React application.
Usage
The RangeSlider component provides a range slider input element along with the ability to customize its appearance and behavior using various props.
To use the component, import it and include it in your JSX:
import React from 'react';
import {RangeSlider} from '@bolttech/atoms-range-slider';
import {bolttechTheme, BolttechThemeProvider} from "@bolttech/frontend-foundations";
function App() {
return (
<BolttechThemeProvider theme={bolttechTheme}>
<RangeSlider
id="range-slider-1"
dataTestId="range-slider-1"
min={0}
max={100}
values={[20, 80]}
step={5}
onChange={(values) => console.log('Selected values:', values)}
/>
</BolttechThemeProvider>
);
}
export default App;
Props
The RangeSlider component accepts the following props:
| Prop | Type | Description |
|------------------|---------------|-----------------------------------------------------------|
| id
| string | The ID attribute for the range slider container. |
| dataTestId
| string | The data-testid attribute for testing purposes. |
| min
| number | The minimum value of the range slider. |
| max
| number | The maximum value of the range slider. |
| values
| number[] | An array containing the current selected values. |
| step
| number | The step interval between selectable values. |
| disabled
| boolean | Whether the range slider is disabled. |
| onChange
| function | A callback function triggered when values change. |
| formatText
| function | A function to format the displayed value text. |
Example
Here's an example of using the RangeSlider component:
<RangeSlider
id="slider-1"
dataTestId="slider-1"
min={0}
max={100}
values={[25, 75]}
step={10}
onChange={(values) => console.log('Selected values:', values)}
formatText={(value) => `${value}%`}
/>
This will render a RangeSlider component with a range from 0 to 100, default values of 25 and 75, step intervals of 10, and a custom text formatting function to display percentage values.
Contributing
Contributions to the RangeSlider component are welcome. If you find any issues or have suggestions for improvements, please feel free to open an issue or submit a pull request on the project's GitHub repository.