Skip to content

Commit 465c6a9

Browse files
committed
Add more README
1 parent e65a704 commit 465c6a9

File tree

2 files changed

+48
-0
lines changed

2 files changed

+48
-0
lines changed

README.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,11 @@
66
[![jsdelivr](https://data.jsdelivr.com/v1/package/gh/erimicel/stimulus-range-slider/badge)](https://www.jsdelivr.com/package/gh/erimicel/stimulus-range-slider)
77
[![License](https://img.shields.io/github/license/erimicel/stimulus-range-slider?style=flat-square)](LICENSE)
88

9+
This component currently supports Numbers, Strings and only USD Currency number format.
10+
Also it comes with 2 value set options;
11+
`[1,2,3,4,5]` < as Array
12+
`1..5` < as Range
13+
914
## Live demo
1015

1116
https://erimicel.github.io/stimulus-range-slider/
@@ -44,6 +49,40 @@ To use `default` theme we also need to add css;
4449
import 'stimulus-range-slider/dist/stimulus-range-slider.css';
4550
```
4651

52+
Now we can add `range-slider` component to our view;
53+
```html
54+
<!-- Multi Range Slider with Tooltips -->
55+
<div data-controller="range-slider"
56+
data-range-slider-values-value="1..10"
57+
data-range-slider-labels-value="true"
58+
data-range-slider-tooltip-value="true">
59+
<label class="block mb-8 text-sm font-medium text-gray-700 dark:text-white">Example of multi point range slider with tooltips</label>
60+
61+
<input type="text" data-range-slider-target="inputMin" value="2">
62+
<input type="text" data-range-slider-target="inputMax" value="5">
63+
64+
<!-- To show value on different element => <span data-range-slider-target="value"></span> -->
65+
</div>
66+
67+
<!-- Single Range Slider -->
68+
<div data-controller="range-slider"
69+
data-range-slider-values-value="[1,5,10,15,20,25]">
70+
<label class="block mb-2 text-sm font-medium text-gray-700 dark:text-white">Example of single range slider</label>
71+
72+
<input type="text" data-range-slider-target="inputMin" value="5">
73+
</div>
74+
```
75+
76+
Other data options;
77+
```
78+
data-range-slider-values-value="[1,2,3,4,5]"
79+
data-range-slider-values-value='["red", "blue", "green"]'
80+
data-range-slider-step-value=5
81+
data-range-slider-width-value="50%"
82+
data-range-slider-selected-colour-value="#ff0000"
83+
data-range-slider-currency-value="USD"
84+
```
85+
4786
## Development
4887

4988
To view examples locally, run `npm install && npm run build && npx serve` and then open `localhost:3000` in your browser.

index.html

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,15 @@ <h2 class="mb-6 text-2xl font-semibold text-gray-800 dark:text-white">
8484
<input type="text" data-range-slider-target="inputMin" value="5">
8585
</div>
8686

87+
<!-- Single Range Slider with Labels and Step -->
88+
<div data-controller="range-slider" data-range-slider-values-value="0..150" data-range-slider-labels-value="true"
89+
data-range-slider-step-value="10">
90+
<label class="block mb-2 text-sm font-medium text-gray-700 dark:text-white">Example of single range slider with
91+
labels and step of 10</label>
92+
93+
<input type="text" data-range-slider-target="inputMin" value="20">
94+
</div>
95+
8796
<!-- Single Range Slider with Tooltip -->
8897
<div data-controller="range-slider"
8998
data-range-slider-values-value="1..10"

0 commit comments

Comments
 (0)