From 5dbde43da841d45e8d73990ba58592ab91dbbfc7 Mon Sep 17 00:00:00 2001 From: Benjy Cui Date: Thu, 19 Nov 2015 11:43:07 +0800 Subject: [PATCH] docs: update README.md --- README.md | 34 +++++++++++----------------------- 1 file changed, 11 insertions(+), 23 deletions(-) diff --git a/README.md b/README.md index 67f6ca1..58023d1 100644 --- a/README.md +++ b/README.md @@ -88,11 +88,17 @@ ReactDOM.render(, container); 100 The maximum value of the slider + + marks + object {number: string} + {} + Mark on the slider. The key determines the position, and the value determines what will show. + step - number + number or `null` 1 - Value to be added or subtracted on each step the slider makes. Must be greater than zero. max - min should be evenly divisible by the step value. + Value to be added or subtracted on each step the slider makes. Must be greater than zero. max - min should be evenly divisible by the step value. When `marks` is not an empty object, `step` can be set to `null`, to make marks as steps. range @@ -112,35 +118,17 @@ ReactDOM.render(, container); Set current positions of handles. If range is `false`, the type of `defaultValue` should be `number`. Otherwise, `[number, number]` - - marks - array - [] - Mark every step for the slider, it will ignore the `step` parameter if it has been defined. Does not work with `range` - included boolean true If the value is `true`, it means a continuous value interval, otherwise, it is a independent value. - - defaultIndex - number - 0 - For step or marks slider, determines the initial position of the handle. Does not work with `range` - - - index - number - - For step or marks slider, determines current position of the handle. Does not work with `range` - disabled boolean false - If true the handles can't be moved. + If `true`, handles can't be moved. tipTransitionName @@ -150,7 +138,7 @@ ReactDOM.render(, container); tipFormatter - func + function Format the value of the tooltip if it shows. @@ -158,7 +146,7 @@ ReactDOM.render(, container); dots bool false - For linear slider, when the `step` value is greater than 1, you can set the `dots` to `true` if you want to render the slider bar with dots. + When the `step` value is greater than 1, you can set the `dots` to `true` if you want to render the slider with dots.