Skip to content

Commit 8dec67c

Browse files
Include disabled prop description in README
1 parent 706d272 commit 8dec67c

1 file changed

Lines changed: 1 addition & 0 deletions

File tree

‎README.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,7 @@ If you have any questions, issues or any other topic that you need an advise in,
7373
| `upperLimit` | Limits the available range of the slider to the upper value. The user won't be able to slide above this limit.<br/>The track is still drawn up to `maximumValue`. | number | `maximumValue` |
7474
| `step` | Step defines the granularity of the slider. The value of the slider will always be a multiple of the step value.<br/>This works for both single and ranged sliders in the same manner.<br/>A `step` of `0` leaves the value continuous. | number | `0` |
7575
| `orientation` | The orientation of the Slider.<br/>Switches the way the Slider is displayed. A vertical Slider holds its lowest value at the bottom, and its highest at the top. | `"horizontal"` \| `"vertical"` | `"horizontal"` |
76+
| `disabled` | Switches the Slider off. It is drawn in the platform's own disabled look, and takes no taps, clicks, drags or keyboard input, so none of the callbacks are called.<br/>The values given through the props still apply, so a disabled Slider keeps showing wherever they put its thumbs. It stays readable for screen readers, but cannot be reached by them.<br/>A custom `track`, `thumb` or `stepMarkers` component is dimmed along with the rest of the Slider, and is passed `disabled` so that it can draw the state its own way instead. | bool | `false` |
7677
| `onValueChange` | Callback continuously called while the user is dragging the thumb of a single Slider. A ranged Slider reports its thumbs through `onLeftValueChange` and `onRightValueChange` instead. | (value: number) => void | |
7778
| `onLeftValueChange` | Callback continuously called while the user is dragging the lower thumb of a ranged Slider. | (value: number) => void | |
7879
| `onRightValueChange` | Callback continuously called while the user is dragging the upper thumb of a ranged Slider. | (value: number) => void | |

0 commit comments

Comments
 (0)