ts-basic-components-slider.md 8.5 KB
Newer Older
Z
zengyawen 已提交
1 2
# Slider

3
滑动条组件,通常用于快速调节设置值,如音量调节、亮度调节等应用场景。
Z
zengyawen 已提交
4

G
gmy 已提交
5 6 7
>  **说明:**
>
>  该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
Z
zengyawen 已提交
8

Z
zengyawen 已提交
9 10

## 子组件
Z
zengyawen 已提交
11 12 13



Z
zengyawen 已提交
14 15 16

## 接口

G
gmy 已提交
17
Slider(options?: {value?: number, min?: number, max?: number, step?: number, style?: SliderStyle, direction?: Axis, reverse?: boolean})
Z
zengyawen 已提交
18

19 20
从API version 9开始,该接口支持在ArkTS卡片中使用。

G
gmy 已提交
21
**参数:**
Z
zengyawen 已提交
22

G
gmy 已提交
23 24 25 26 27
| 参数名 | 参数类型 | 必填 | 参数描述 |
| -------- | -------- | -------- | -------- |
| value | number | 否 | 当前进度值。<br/>默认值:0 |
| min | number | 否 | 设置最小值。<br/>默认值:0 |
| max | number | 否 | 设置最大值。<br/>默认值:100 |
28
| step | number | 否 | 设置Slider滑动步长。<br/>默认值:1<br/>取值范围:[0.01, max] |
29
| style | SliderStyle | 否 | 设置Slider的滑块与滑轨显示样式。<br/>默认值:SliderStyle.OutSet |
G
gmy 已提交
30
| direction<sup>8+</sup> | [Axis](ts-appendix-enums.md#axis) | 否 | 设置滑动条滑动方向为水平或竖直方向。<br/>默认值:Axis.Horizontal |
31
| reverse<sup>8+</sup> | boolean | 否 | 设置滑动条取值范围是否反向,横向Slider默认为从左往右滑动,竖向Slider默认为从上往下滑动。<br/>默认值:false |
G
gmy 已提交
32 33 34

## SliderStyle枚举说明

35 36
从API version 9开始,该接口支持在ArkTS卡片中使用。

G
gmy 已提交
37 38 39 40
| 名称 | 描述 |
| -------- | -------- |
| OutSet | 滑块在滑轨上。 |
| InSet | 滑块在滑轨内。 |
Z
zengyawen 已提交
41 42 43


## 属性
Z
zengyawen 已提交
44

45
支持除触摸热区以外的通用属性设置。
Z
zengyawen 已提交
46

G
gmy 已提交
47 48
| 名称 | 参数类型 | 描述 |
| -------- | -------- | -------- |
49 50 51 52 53 54
| blockColor | [ResourceColor](ts-types.md#resourcecolor) | 设置滑块的颜色。 <br/>从API version 9开始,该接口支持在ArkTS卡片中使用。|
| trackColor | [ResourceColor](ts-types.md#resourcecolor) | 设置滑轨的背景颜色。 <br/>从API version 9开始,该接口支持在ArkTS卡片中使用。|
| selectedColor | [ResourceColor](ts-types.md#resourcecolor) | 设置滑轨的已滑动部分颜色。<br/>从API version 9开始,该接口支持在ArkTS卡片中使用。 |
| showSteps | boolean | 设置当前是否显示步长刻度值。<br/>默认值:false <br/>从API version 9开始,该接口支持在ArkTS卡片中使用。|
| showTips | boolean | 设置滑动时是否显示百分比气泡提示。<br/>默认值:false <br/>从API version 9开始,该接口支持在ArkTS卡片中使用。|
| trackThickness      | [Length](ts-types.md#length) | 设置滑轨的粗细。<br/>从API version 9开始,该接口支持在ArkTS卡片中使用。 |
Z
zengyawen 已提交
55 56 57


## 事件
Z
zengyawen 已提交
58

59
通用事件仅支持挂载卸载事件:OnAppear,OnDisAppear。
Z
zengyawen 已提交
60

G
gmy 已提交
61
| 名称 | 功能描述 |
62
| -------- | -------- |
63
| onChange(callback:&nbsp;(value:&nbsp;number,&nbsp;mode:&nbsp;SliderChangeMode)&nbsp;=&gt;&nbsp;void) | Slider滑动时触发事件回调。<br/>value:当前滑动进度值。若返回值有小数,可使用Math.toFixed()方法将数据处理为预期的精度。<br/>mode:拖动状态。<br/>从API version 9开始,该接口支持在ArkTS卡片中使用。|
Z
zengyawen 已提交
64

G
gmy 已提交
65 66
## SliderChangeMode枚举说明

67 68
从API version 9开始,该接口支持在ArkTS卡片中使用。

G
gmy 已提交
69 70
| 名称 | 值 | 描述 |
| -------- | -------- | -------- |
71 72 73 74
| Begin | 0 | 开始拖动滑块。 |
| Moving | 1 | 正在拖动滑块过程中。 |
| End | 2 | 结束拖动滑块。 |
| Click    | 3    | 点击滑动条使滑块位置移动。 |
Z
zengyawen 已提交
75 76 77


## 示例
Z
zengyawen 已提交
78

H
geshi  
HelloCrease 已提交
79 80
```ts
// xxx.ets
Z
zengyawen 已提交
81 82 83
@Entry
@Component
struct SliderExample {
Y
yamila 已提交
84 85 86 87 88 89 90 91
  @State outSetValueOne: number = 40
  @State inSetValueOne: number = 40
  @State outSetValueTwo: number = 40
  @State inSetValueTwo: number = 40
  @State vOutSetValueOne: number = 40
  @State vInSetValueOne: number = 40
  @State vOutSetValueTwo: number = 40
  @State vInSetValueTwo: number = 40
Z
zengyawen 已提交
92 93

  build() {
94 95
    Column({ space: 8 }) {
      Text('outset slider').fontSize(9).fontColor(0xCCCCCC).width('90%').margin(15)
Z
zengyawen 已提交
96 97
      Row() {
        Slider({
98
          value: this.outSetValueOne,
Z
zengyawen 已提交
99 100 101 102
          min: 0,
          max: 100,
          style: SliderStyle.OutSet
        })
103 104
          .showTips(true)
          .onChange((value: number, mode: SliderChangeMode) => {
Y
yamila 已提交
105 106
            this.outSetValueOne = value
            console.info('value:' + value + 'mode:' + mode.toString())
107 108 109 110 111 112 113 114 115 116
          })
        // toFixed(0)将滑动条返回值处理为整数精度
        Text(this.outSetValueOne.toFixed(0)).fontSize(12)
      }
      .width('80%')
      Row() {
        Slider({
          value: this.outSetValueTwo,
          step: 10,
          style: SliderStyle.OutSet
Z
zengyawen 已提交
117
        })
118 119
          .showSteps(true)
          .onChange((value: number, mode: SliderChangeMode) => {
Y
yamila 已提交
120 121
            this.outSetValueTwo = value
            console.info('value:' + value + 'mode:' + mode.toString())
122 123
          })
        Text(this.outSetValueTwo.toFixed(0)).fontSize(12)
Z
zengyawen 已提交
124 125 126
      }
      .width('80%')

127
      Text('inset slider').fontSize(9).fontColor(0xCCCCCC).width('90%').margin(15)
Z
zengyawen 已提交
128 129
      Row() {
        Slider({
130
          value: this.inSetValueOne,
Z
zengyawen 已提交
131 132 133 134
          min: 0,
          max: 100,
          style: SliderStyle.InSet
        })
135 136 137 138 139
          .blockColor('#191970')
          .trackColor('#ADD8E6')
          .selectedColor('#4169E1')
          .showTips(true)
          .onChange((value: number, mode: SliderChangeMode) => {
Y
yamila 已提交
140 141
            this.inSetValueOne = value
            console.info('value:' + value + 'mode:' + mode.toString())
142 143
          })
        Text(this.inSetValueOne.toFixed(0)).fontSize(12)
Z
zengyawen 已提交
144 145
      }
      .width('80%')
Z
zengyawen 已提交
146
      Row() {
147 148 149 150 151 152 153 154
        Slider({
          value: this.inSetValueTwo,
          step: 10,
          style: SliderStyle.InSet
        })
          .blockColor('#191970')
          .trackColor('#ADD8E6')
          .selectedColor('#4169E1')
Z
zengyawen 已提交
155 156
          .showSteps(true)
          .onChange((value: number, mode: SliderChangeMode) => {
Y
yamila 已提交
157 158
            this.inSetValueTwo = value
            console.info('value:' + value + 'mode:' + mode.toString())
Z
zengyawen 已提交
159
          })
160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177
        Text(this.inSetValueTwo.toFixed(0)).fontSize(12)
      }
      .width('80%')

      Row() {
        Column() {
          Text('vertical outset slider').fontSize(9).fontColor(0xCCCCCC).width('50%').margin(15)
          Row() {
            Slider({
              value: this.vOutSetValueOne,
              style: SliderStyle.OutSet,
              direction: Axis.Vertical
            })
              .blockColor('#191970')
              .trackColor('#ADD8E6')
              .selectedColor('#4169E1')
              .showTips(true)
              .onChange((value: number, mode: SliderChangeMode) => {
Y
yamila 已提交
178 179
                this.vOutSetValueOne = value
                console.info('value:' + value + 'mode:' + mode.toString())
180 181 182 183 184 185 186 187 188 189 190 191
              })
            Slider({
              value: this.vOutSetValueTwo,
              step: 10,
              style: SliderStyle.OutSet,
              direction: Axis.Vertical
            })
              .blockColor('#191970')
              .trackColor('#ADD8E6')
              .selectedColor('#4169E1')
              .showSteps(true)
              .onChange((value: number, mode: SliderChangeMode) => {
Y
yamila 已提交
192 193
                this.vOutSetValueTwo = value
                console.info('value:' + value + 'mode:' + mode.toString())
194 195
              })
          }
Z
zengyawen 已提交
196 197 198
        }.width('50%').height(300)

        Column() {
199 200 201 202 203 204 205 206 207 208
          Text('vertical inset slider').fontSize(9).fontColor(0xCCCCCC).width('50%').margin(15)
          Row() {
            Slider({
              value: this.vInSetValueOne,
              style: SliderStyle.InSet,
              direction: Axis.Vertical,
              reverse: true // 竖向的Slider默认是上端是min值,下端是max值,因此想要从下往上滑动,需要设置reverse为true
            })
              .showTips(true)
              .onChange((value: number, mode: SliderChangeMode) => {
Y
yamila 已提交
209 210
                this.vInSetValueOne = value
                console.info('value:' + value + 'mode:' + mode.toString())
211 212 213 214 215 216 217 218 219 220
              })
            Slider({
              value: this.vInSetValueTwo,
              step: 10,
              style: SliderStyle.InSet,
              direction: Axis.Vertical,
              reverse: true
            })
              .showSteps(true)
              .onChange((value: number, mode: SliderChangeMode) => {
Y
yamila 已提交
221 222
                this.vInSetValueTwo = value
                console.info('value:' + value + 'mode:' + mode.toString())
223 224
              })
          }
Z
zengyawen 已提交
225 226
        }.width('50%').height(300)
      }
227
    }.width('100%')
Z
zengyawen 已提交
228 229 230 231
  }
}
```

Z
zengyawen 已提交
232
![zh-cn_image_0000001179613854](figures/zh-cn_image_0000001179613854.gif)