Skip to content

Commit 2235092

Browse files
cwjTerraceranrui.cwj
and
ranrui.cwj
authored
fix(Range): onProcess&onChange props type error fix alibaba-fusion#2769 (alibaba-fusion#3816)
* fix(Range): onProcess&onChange props type error Co-authored-by: ranrui.cwj <ranrui.cwj@alibaba-inc.com>
1 parent 6ddace0 commit 2235092

File tree

3 files changed

+13
-13
lines changed

3 files changed

+13
-13
lines changed

docs/range/index.en-us.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -29,15 +29,15 @@ Range Component is used to select a value in a range by dragging slider. Normall
2929
| min | minimal value | Number | 0 |
3030
| max | maximal value | Number | 100 |
3131
| step | step of the range, which is positive integer and (max - min) can be divided by it | Number | 1 |
32-
| value | current value. It's in the form of `Number` when `slider` is `single` otherwise `[Number, Number]` | Number/Array&lt;Number> | - |
33-
| defaultValue | default value. It's in the form of `Number` when `slider` is `single` otherwise `[Number, Number]` | Number/Array&lt;Number> | - |
32+
| value | current value. It's in the form of `Number` when `slider` is `single` otherwise `[Number, Number]` | Number/[Number, Number] | - |
33+
| defaultValue | default value. It's in the form of `Number` when `slider` is `single` otherwise `[Number, Number]` | Number/[Number, Number] | - |
3434
| marks | way to show the scale. (`false` means nothing, `array` means enum, `number` means equal division, and `object` means `key` as the mark with `value` as the value) | Boolean/Number/Array&lt;Number>/Object | false |
3535
| marksPosition | position for the scale<br><br>**option**:<br>'above', 'below' | Enum | 'above' |
3636
| disabled | disabled | Boolean | false |
37-
| onChange | callback triggered when value changes<br><br>**signature**:<br>Function(value: String/number) => void<br>**parameter**:<br>_value_: {String/number} null | Function | func.noop |
38-
| onProcess | callback triggered when slider being dragged, and used only for special need<br><br>**signature**:<br>Function(value: String/number) => void<br>**parameter**:<br>_value_: {String/number} null | Function | func.noop |
37+
| onChange | callback triggered when value changes | Function(value: Number/[Number, Number]) => void | func.noop |
38+
| onProcess | callback triggered when slider being dragged, and used only for special need | Function(value: Number/[Number, Number]) => void | func.noop |
3939
| hasTip | whether to show tip | Boolean | true |
40-
| tipRender | custom tip content<br><br>**signature**:<br>Function(value: Number/String) => ReactNode<br>**signature**:<br>_value_: {Number/String} value<br>**returns**:<br>{ReactNode} content<br> | Function | value => value |
40+
| tipRender | custom tip content<br><br>**signature**:<br>Function(value?: Number/String) => ReactNode<br>**signature**:<br>_value_: {Number/String} value<br>**returns**:<br>{ReactNode} content<br> | Function | value => value |
4141
| reverse | reverse the selected part | Boolean | false |
4242
| pure | pure render or not | Boolean | false |
4343
| fixedWidth | drag a line with fixed width. It considers `slider` as `double`, and `defaultValue` must be a interval. | Boolean | false |

docs/range/index.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -28,13 +28,13 @@
2828
| min | 最小值 | Number | 0 |
2929
| max | 最大值 | Number | 100 |
3030
| step | 步长,取值必须大于 0,并且可被 (max - min) 整除。 | Number | 1 |
31-
| value | 设置当前取值。当 `slider``single` 时,使用 `Number`,否则用 `[Number, Number]` | Number/Array&lt;Number> | - |
32-
| defaultValue | 设置初始取值。当 `slider``single` 时,使用 `Number`,否则用 `[Number, Number]` | Number/Array&lt;Number> | - |
31+
| value | 设置当前取值。当 `slider``single` 时,使用 `Number`,否则用 `[Number, Number]` | Number/[Number, Number] | - |
32+
| defaultValue | 设置初始取值。当 `slider``single` 时,使用 `Number`,否则用 `[Number, Number]` | Number/[Number, Number] | - |
3333
| marks | 刻度数值显示逻辑(false 代表不显示,array 枚举显示的值,number 代表按 number 平分,object 表示按 key 划分,value 值显示) | Boolean/Number/Array&lt;Number>/Object | false |
3434
| marksPosition | marks显示在上方('above')or下方('below')<br/><br/>**可选值**:<br/>'above', 'below' | Enum | 'above' |
3535
| disabled | 值为 `true` 时,滑块为禁用状态 | Boolean | false |
36-
| onChange | 当 Range 的值发生改变后,会触发 onChange 事件,并把改变后的值作为参数传入, 如果设置了value, 要配合此函数做受控使用<br/><br/>**签名**:<br/>Function(value: String/number) => void<br/>**参数**:<br/>_value_: {String/number} null | Function | func.noop |
37-
| onProcess | 滑块拖动的时候触发的事件,不建议在这里setState, 一般情况下不需要用, 滑动时有特殊需求时使用<br/><br/>**签名**:<br/>Function(value: String/number) => void<br/>**参数**:<br/>_value_: {String/number} null | Function | func.noop |
36+
| onChange | 当 Range 的值发生改变后,会触发 onChange 事件,并把改变后的值作为参数传入, 如果设置了value, 要配合此函数做受控使用 | Function(value: Number/[Number, Number]) => void | func.noop |
37+
| onProcess | 滑块拖动的时候触发的事件,不建议在这里setState, 一般情况下不需要用, 滑动时有特殊需求时使用 | Function(value: Number/[Number, Number]) => void | func.noop |
3838
| hasTip | 是否显示 tip | Boolean | true |
3939
| tipRender | 自定义 tip 显示内容<br/><br/>**签名**:<br/>Function(value: Number/String) => ReactNode<br/>**参数**:<br/>_value_: {Number/String} 值<br/>**返回值**:<br/>{ReactNode} 显示内容<br/> | Function | value => value |
4040
| reverse | 选中态反转 | Boolean | false |

types/range/index.d.ts

+4-4
Original file line numberDiff line numberDiff line change
@@ -47,12 +47,12 @@ export interface RangeProps extends HTMLAttributesWeak, CommonProps {
4747
/**
4848
* 设置当前取值。当 `slider` 为 `single` 时,使用 `Number`,否则用 `[Number, Number]`
4949
*/
50-
value?: number | Array<number>;
50+
value?: number | [number, number];
5151

5252
/**
5353
* 设置初始取值。当 `slider` 为 `single` 时,使用 `Number`,否则用 `[Number, Number]`
5454
*/
55-
defaultValue?: number | Array<number>;
55+
defaultValue?: number | [number, number];
5656

5757
/**
5858
* 刻度数值显示逻辑(false 代表不显示,array 枚举显示的值,number 代表按 number 平分,object 表示按 key 划分,value 值显示)
@@ -72,12 +72,12 @@ export interface RangeProps extends HTMLAttributesWeak, CommonProps {
7272
/**
7373
* 当 Range 的值发生改变后,会触发 onChange 事件,并把改变后的值作为参数传入, 如果设置了value, 要配合此函数做受控使用
7474
*/
75-
onChange?: (value: number) => void;
75+
onChange?: (value: number | [number, number]) => void;
7676

7777
/**
7878
* 滑块拖动的时候触发的事件,不建议在这里setState, 一般情况下不需要用, 滑动时有特殊需求时使用
7979
*/
80-
onProcess?: (value: number) => void;
80+
onProcess?: (value: number | [number, number]) => void;
8181

8282
/**
8383
* 是否显示 tip

0 commit comments

Comments
 (0)