|
| 1 | +--- |
| 2 | +title: Slider |
| 3 | +nextjs: |
| 4 | + metadata: |
| 5 | + title: Slider |
| 6 | + description: An input where the user selects a value from within a given range. |
| 7 | + twitter: |
| 8 | + title: Slider |
| 9 | + images: |
| 10 | + url: https://rafty.rhinobase.io/api/og?title=Slider |
| 11 | + openGraph: |
| 12 | + title: Slider |
| 13 | + images: |
| 14 | + url: https://rafty.rhinobase.io/api/og?title=Slider |
| 15 | +--- |
| 16 | + |
| 17 | +An input where the user selects a value from within a given range. |
| 18 | + |
| 19 | +This component is made on top of [Radix UIs Slider Component](https://www.radix-ui.com/primitives/docs/components/slider) with our styling conventions. This component has been shared with you, ensuring that all its native properties are accessible. |
| 20 | + |
| 21 | +## Anatomy |
| 22 | + |
| 23 | +Import the component. |
| 24 | + |
| 25 | +```jsx |
| 26 | +import { Slider, SliderRange, SliderThumb, SliderTrack } from "@rafty/ui"; |
| 27 | + |
| 28 | +<Slider> |
| 29 | + <SliderTrack> |
| 30 | + <SliderRange /> |
| 31 | + </SliderTrack> |
| 32 | + <SliderThumb /> |
| 33 | +</Slider>; |
| 34 | +``` |
| 35 | + |
| 36 | +## ColorScheme |
| 37 | + |
| 38 | +There are 5 `colorScheme` options in badge: `primary` (default), `secondary`, `error`, `info`, `success` & `warning`. |
| 39 | + |
| 40 | +{% example %} |
| 41 | + |
| 42 | +```jsx |
| 43 | +<Slider colorScheme="secondary" defaultValue={[20]}> |
| 44 | + <SliderTrack> |
| 45 | + <SliderRange /> |
| 46 | + </SliderTrack> |
| 47 | + <SliderThumb /> |
| 48 | +</Slider> |
| 49 | +``` |
| 50 | + |
| 51 | +{% /example %} |
| 52 | + |
| 53 | +## Size |
| 54 | + |
| 55 | +There are 3 `size` options available: `sm`, `md` (default) & `lg` |
| 56 | + |
| 57 | +{% example %} |
| 58 | + |
| 59 | +```jsx |
| 60 | +<Slider size="sm" defaultValue={[20]}> |
| 61 | + <SliderTrack> |
| 62 | + <SliderRange /> |
| 63 | + </SliderTrack> |
| 64 | + <SliderThumb /> |
| 65 | +</Slider> |
| 66 | +``` |
| 67 | + |
| 68 | +{% /example %} |
| 69 | + |
| 70 | +## Range Slider |
| 71 | + |
| 72 | +Slider accepts value in array and returns value in array in `onValueChange` function, so it can be used as `Range Slider`. You just need to pass more than one values in `value` and `defaultValue` props and put the same number of `<SliderThumb />`. |
| 73 | + |
| 74 | +{% example %} |
| 75 | + |
| 76 | +```jsx |
| 77 | +<Slider defaultValue={[20, 80]}> |
| 78 | + <SliderTrack> |
| 79 | + <SliderRange /> |
| 80 | + </SliderTrack> |
| 81 | + <SliderThumb /> |
| 82 | + <SliderThumb /> |
| 83 | +</Slider> |
| 84 | +``` |
| 85 | + |
| 86 | +{% /example %} |
| 87 | + |
| 88 | +## Props |
| 89 | + |
| 90 | +--- |
| 91 | + |
| 92 | +### Slider |
| 93 | + |
| 94 | +This component is built on top of [Radix Slider](https://www.radix-ui.com/primitives/docs/components/slider#root). |
| 95 | + |
| 96 | +| Property | Description | Type | Default | |
| 97 | +| ----------- | ------------------------------------- | ----------------------------------------------------------------------------------- | ----------- | |
| 98 | +| size | Size of the Slider component. | `"sm"` or `"md"` or `"lg"` | `"md"` | |
| 99 | +| colorScheme | Color Scheme of the Slider component. | `"primary"` or `"secondary"` or `"error"` or `"success"` or `"warning"` or `"info"` | `"primary"` | |
| 100 | +| isDisabled | To manage disabled state. | `boolean` | `false` | |
| 101 | +| isReadOnly | To manage readonly state. | `boolean` | `false` | |
| 102 | + |
| 103 | +### SliderTrack |
| 104 | + |
| 105 | +This component is built on top of [Radix Slider Track](https://www.radix-ui.com/primitives/docs/components/slider#track). |
| 106 | + |
| 107 | +### SliderRange |
| 108 | + |
| 109 | +This component is built on top of [Radix Slider Range](https://www.radix-ui.com/primitives/docs/components/slider#range). |
| 110 | + |
| 111 | +### SliderThumb |
| 112 | + |
| 113 | +This component is built on top of [Radix Slider Thumb](https://www.radix-ui.com/primitives/docs/components/slider#thumb). |
0 commit comments