ant-design/components/slider/index.md

32 lines
2.0 KiB
Markdown
Raw Normal View History

2015-06-25 15:25:59 +08:00
# Slider
2015-06-15 22:01:39 +08:00
- category: Components
2015-06-25 15:25:59 +08:00
- chinese: 滑动输入条
2015-08-22 20:16:24 +08:00
- type: 表单
2015-06-15 22:01:39 +08:00
---
2015-06-17 20:24:42 +08:00
2015-06-26 14:42:30 +08:00
滑动型输入器,展示当前值和可选范围。
2015-06-17 20:24:42 +08:00
2015-06-26 14:42:30 +08:00
## 何时使用
2015-06-17 20:24:42 +08:00
2015-11-18 17:50:22 +08:00
当用户需要在数值区间/自定义区间内进行选择时,可为连续或离散值。
2015-07-13 08:00:31 +08:00
## API
2015-07-16 16:48:06 +08:00
| 参数 | 类型 | 默认值 |说明 |
2015-07-13 08:00:31 +08:00
|------------|----------------|-------------|--------------|
2016-03-15 22:12:00 +08:00
| range | Boolean | false | 双滑块模式
2015-07-13 08:00:31 +08:00
| min | Number | 0 | 最小值
| max | Number | 100 | 最大值
2015-11-19 14:21:58 +08:00
| step | Number or null | 1 | 步长,取值必须大于 0并且可被 (max - min) 整除。当 `marks` 不为空对象时,可以设置 `step``null`,此时 Slider 的可选值仅有 marks 标出来的部分。
2016-03-22 17:50:21 +08:00
| marks | Object{Number: String|React.Component} or Object{Number: { style, label}} | {} | 刻度标记key 的类型必须为 `Number` 且取值在闭区间 [min, max] 内,每个标签可以单独设置样式
2016-03-15 22:12:00 +08:00
| dots | Boolean | false | 是否只能拖拽到刻度上
2015-11-18 16:56:22 +08:00
| value | Number or [Number, Number]| | 设置当前取值。当 `range``false` 时,使用 `Number`,否则用 `[Number, Number]`
| defaultValue | Number or [Number, Number]| 0 or [0, 0] | 设置初始取值。当 `range``false` 时,使用 `Number`,否则用 `[Number, Number]`
| included | Boolean | true | `marks` 不为空对象时有效,值为 true 时表示值为包含关系false 表示并列
| disabled | Boolean | false | 值为 `true` 时,滑块为禁用状态
| onChange | Function | NOOP | 当 Slider 的值发生改变时,会触发 onChange 事件,并把改变后的值作为参数传入。
2015-12-24 09:54:59 +08:00
| onAfterChange | Function | NOOP | 与 `onmouseup` 触发时机一致,把当前值作为参数传入。
| tipFormatter | Function or null | IDENTITY | Slider 会把当前值传给 `tipFormatter`,并在 Tooltip 中显示 `tipFormatter` 的返回值,若为 null则隐藏 Tooltip。