1# Slider 2 3滑动条组件，通常用于快速调节设置值，如音量调节、亮度调节等应用场景。 4 5> **说明：** 6> 7> 该组件从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 8 9 10## 子组件 11 12无 13 14 15## 接口 16 17Slider(options?: SliderOptions) 18 19**卡片能力：** 从API version 9开始，该接口支持在ArkTS卡片中使用。 20 21**系统能力：** SystemCapability.ArkUI.ArkUI.Full 22 23**参数：** 24 25| 参数名 | 类型 | 必填 | 描述 | 26| ------- | --------------------------------------- | ---- | ------------------ | 27| options | [SliderOptions](#slideroptions对象说明) | 否 | 配置滑动条的参数。 | 28 29## SliderOptions对象说明 30 31| 名称 | 类型 | 必填 | 说明 | 32| -------- | -------- | -------- | -------- | 33| value | number | 否 | 当前进度值。<br/>默认值：与参数min的取值一致。<br />从API version 10开始，该参数支持[$$](../../quick-start/arkts-two-way-sync.md)双向绑定变量。 | 34| min | number | 否 | 设置最小值。<br/>默认值：0 | 35| max | number | 否 | 设置最大值。<br/>默认值：100<br/>**说明：** <br/>min >= max异常情况，min取默认值0，max取默认值100。<br/>value不在[min, max]范围之内，取min或者max，靠近min取min，靠近max取max。 | 36| step | number | 否 | 设置Slider滑动步长。<br/>默认值：1<br/>取值范围：[0.01, max]<br/>**说明：** <br/>设置小于0的值时，按默认值显示。 | 37| style | [SliderStyle](#sliderstyle枚举说明) | 否 | 设置Slider的滑块与滑轨显示样式。<br/>默认值：SliderStyle.OutSet | 38| direction<sup>8+</sup> | [Axis](ts-appendix-enums.md#axis) | 否 | 设置滑动条滑动方向为水平或竖直方向。<br/>默认值：Axis.Horizontal | 39| reverse<sup>8+</sup> | boolean | 否 | 设置滑动条取值范围是否反向，横向Slider默认为从左往右滑动，竖向Slider默认为从上往下滑动。<br/>默认值：false | 40 41## SliderStyle枚举说明 42 43从API version 9开始，该接口支持在ArkTS卡片中使用。 44 45| 名称 | 描述 | 46| -------- | -------- | 47| OutSet | 滑块在滑轨上。 | 48| InSet | 滑块在滑轨内。 | 49 50## 属性 51 52支持除触摸热区以外的[通用属性](ts-universal-attributes-size.md)。 53 54| 名称 | 参数类型 | 描述 | 55| -------- | -------- | -------- | 56| blockColor | [ResourceColor](ts-types.md#resourcecolor) | 设置滑块的颜色。 <br/>从API version 9开始，该接口支持在ArkTS卡片中使用。<br/>**说明：** <br/>默认值：'#ffffff'。<br/>当滑块形状设置为`SliderBlockType.DEFAULT`时，`blockColor`可设置默认圆形滑块颜色；<br/>当滑块形状设置为`SliderBlockType.IMAGE`时，滑块无填充，设置`blockColor`不生效；<br/>当滑块形状设置为`SliderBlockType.SHAPE`时，`blockColor`可设置自定义形状的填充颜色。 | 57| trackColor | [ResourceColor](ts-types.md#resourcecolor) | 设置滑轨的背景颜色。 <br/>从API version 9开始，该接口支持在ArkTS卡片中使用。<br/>**说明：** <br/>默认值：'#19182431'。| 58| selectedColor | [ResourceColor](ts-types.md#resourcecolor) | 设置滑轨的已滑动部分颜色。<br/>从API version 9开始，该接口支持在ArkTS卡片中使用。<br/>**说明：** <br/>默认值：'#007dff'。 | 59| showSteps | boolean | 设置当前是否显示步长刻度值。<br/>默认值：false <br/>从API version 9开始，该接口支持在ArkTS卡片中使用。| 60| showTips | value: boolean,<br/>content<sup>10+</sup>?: [ResourceStr](ts-types.md#resourcestr) | value：设置滑动时是否显示气泡提示。<br/>默认值：false <br/>content：设置气泡提示的文本内容，默认显示当前百分比。<br/>从API version 9开始，该接口支持在ArkTS卡片中使用。<br/>**说明：** <br/>当direction的值为Axis.Horizontal时，tip显示在滑块正上方。值为Axis.Vertical时，tip显示在滑块正左边。<br/>tip的绘制区域为Slider自身节点的overlay。<br/>Slider不设置边距或者边距比较小时，tip会被截断。| 61| trackThickness<sup>8+</sup> | [Length](ts-types.md#length) | 设置滑轨的粗细。<br/>默认值：当参数style的值设置[SliderStyle](#sliderstyle枚举说明).OutSet 时为 4.0vp，[SliderStyle](#sliderstyle枚举说明).InSet时为20.0vp<br/>从APIversion9开始，该接口支持在ArkTS卡片中使用。<br/>**说明：** <br/>设置为小于等于0的值时，取默认值。 | 62| blockBorderColor<sup>10+</sup> | [ResourceColor](ts-types.md#resourcecolor) | 设置滑块描边颜色。<br/>**说明：** <br/>默认值：'#ffffff'。<br/>当滑块形状设置为`SliderBlockType.DEFAULT`时，`blockBorderColor`可设置默认圆形滑块描边颜色；<br/>当滑块形状设置为`SliderBlockType.IMAGE`时，滑块无描边，设置`blockBorderColor`不生效；<br/>当滑块形状设置为`SliderBlockType.SHAPE`时，`blockBorderColor`可设置自定义形状中线的颜色。 | 63| blockBorderWidth<sup>10+</sup> | [Length](ts-types.md#length) | 设置滑块描边粗细。<br/>**说明：** <br/>当滑块形状设置为`SliderBlockType.DEFAULT`时，`blockBorderWidth`可设置默认圆形滑块描边粗细；<br/>当滑块形状设置为`SliderBlockType.IMAGE`时，滑块无描边，设置`blockBorderWidth`不生效；<br/>当滑块形状设置为`SliderBlockType.SHAPE`时，`blockBorderWidth`可设置自定义形状中线的粗细。 | 64| stepColor<sup>10+</sup> | [ResourceColor](ts-types.md#resourcecolor) | 设置刻度颜色。<br/>**说明：** <br/>默认值：'#19182431'。 | 65| trackBorderRadius<sup>10+</sup> | [Length](ts-types.md#length) | 设置底板圆角半径。<br/>**说明：** <br/>默认值：'2vp'。 | 66| blockSize<sup>10+</sup> | [SizeOptions](ts-types.md#sizeoptions) | 设置滑块大小。 <br/>**说明：** <br/>默认值：当参数style的值设置为[SliderStyle](#sliderstyle枚举说明).OutSet 时为：{width: 16, height: 16}，当参数style的值设置为[SliderStyle](#sliderstyle枚举说明).InSet时为：{width: 12, height: 12}。<br/>当设置的bolckSize的宽高值不相等时，取较小值的尺寸，当设置的宽高值中有一个或两个都小于等于0的时候，取默认值。| 67| blockStyle<sup>10+</sup> | [SliderBlockStyle](#sliderblockstyle10对象说明) | 设置滑块形状参数。<br/>**说明：** <br/>默认值：SliderBlockType.DEFAULT，使用圆形滑块。 | 68| stepSize<sup>10+</sup> | [Length](ts-types.md#length) | 设置刻度大小（直径）。 <br/>**说明：** <br/>默认值：'4vp'。<br/>当值为0时，刻度点不显示，当值小于0时，取默认值。| 69| minLabel<sup>deprecated</sup> | string | 设置最小值。<br/>从APIversion9开始废弃，使用min替代。 | 70| maxLabel<sup>deprecated</sup> | string | 设置最大值。<br/>从APIversion9开始废弃，使用max替代。 | 71 72> **说明：** 73> - Slider无默认padding。 74> - 当Slider为水平滑动条时，Slider默认高度为40vp，宽度为父容器的宽度，滑动条居中显示，左右间距为分别为10vp，若设置padding，padding不会覆盖左右间距。 75> - 当Slider为竖直滑动条时，Slider默认宽度为40vp，高度为父容器的高度，滑动条居中显示，上下间距为分别为6vp，若设置padding，padding不会覆盖上下间距。 76 77## SliderBlockStyle<sup>10+</sup>对象说明 78 79Slider组件滑块形状参数。 80 81| 名称 | 类型 | 必填 | 说明 | 82| ----- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | 83| type | [SliderBlockType](#sliderblocktype10枚举说明) | 是 | 设置滑块形状。<br/>默认值：SliderBlockType.DEFAULT，使用圆形滑块。 | 84| image | [ResourceStr](ts-types.md#resourcestr) | 否 | 设置滑块图片资源。<br />图片显示区域大小由blockSize属性控制，请勿输入尺寸过大的图片。 | 85| shape | [Circle](ts-drawing-components-circle.md) \| [Ellipse](ts-drawing-components-ellipse.md) \| [Path](ts-drawing-components-path.md) \| [Rect](ts-drawing-components-rect.md) | 否 | 设置滑块使用的自定义形状。 | 86 87## SliderBlockType<sup>10+</sup>枚举说明 88 89Slider组件滑块形状枚举。 90 91| 名称 | 描述 | 92| ------- | ---------------------- | 93| DEFAULT | 使用默认滑块（圆形）。 | 94| IMAGE | 使用图片资源作为滑块。 | 95| SHAPE | 使用自定义形状作为滑块。 | 96 97## 事件 98 99支持[通用事件](ts-universal-events-click.md)外，还支持以下事件： 100 101| 名称 | 功能描述 | 102| -------- | -------- | 103| onChange(callback: (value: number, mode: SliderChangeMode) => void) | Slider拖动或点击时触发事件回调。<br/>value：当前滑动进度值。若返回值有小数，可使用number.toFixed()方法将数据处理为预期的精度。<br/>mode：事件触发的相关状态值。<br/>从API version 9开始，该接口支持在ArkTS卡片中使用。<br/>**说明：** <br/>Begin和End状态当手势点击时都会触发，Moving和Click状态当value值发生变化时触发。<br/>当连贯动作为拖动动作时，不触发Click状态。<br/>value值的变化范围为对应步长steps数组。 | 104 105## SliderChangeMode枚举说明 106 107从API version 9开始，该接口支持在ArkTS卡片中使用。 108 109| 名称 | 值 | 描述 | 110| -------- | -------- | -------- | 111| Begin | 0 | 手势/鼠标接触或者按下滑块。 | 112| Moving | 1 | 正在拖动滑块过程中。 | 113| End | 2 | 手势/鼠标离开滑块。 | 114| Click | 3 | 点击滑动条使滑块位置移动。 | 115 116## 示例 117 118### 示例1 119 120```ts 121// xxx.ets 122@Entry 123@Component 124struct SliderExample { 125 @State outSetValueOne: number = 40 126 @State inSetValueOne: number = 40 127 @State outSetValueTwo: number = 40 128 @State inSetValueTwo: number = 40 129 @State vOutSetValueOne: number = 40 130 @State vInSetValueOne: number = 40 131 @State vOutSetValueTwo: number = 40 132 @State vInSetValueTwo: number = 40 133 134 build() { 135 Column({ space: 8 }) { 136 Text('outset slider').fontSize(9).fontColor(0xCCCCCC).width('90%').margin(15) 137 Row() { 138 Slider({ 139 value: this.outSetValueOne, 140 min: 0, 141 max: 100, 142 style: SliderStyle.OutSet 143 }) 144 .showTips(true) 145 .onChange((value: number, mode: SliderChangeMode) => { 146 this.outSetValueOne = value 147 console.info('value:' + value + 'mode:' + mode.toString()) 148 }) 149 // toFixed(0)将滑动条返回值处理为整数精度 150 Text(this.outSetValueOne.toFixed(0)).fontSize(12) 151 } 152 .width('80%') 153 Row() { 154 Slider({ 155 value: this.outSetValueTwo, 156 step: 10, 157 style: SliderStyle.OutSet 158 }) 159 .showSteps(true) 160 .onChange((value: number, mode: SliderChangeMode) => { 161 this.outSetValueTwo = value 162 console.info('value:' + value + 'mode:' + mode.toString()) 163 }) 164 Text(this.outSetValueTwo.toFixed(0)).fontSize(12) 165 } 166 .width('80%') 167 168 Text('inset slider').fontSize(9).fontColor(0xCCCCCC).width('90%').margin(15) 169 Row() { 170 Slider({ 171 value: this.inSetValueOne, 172 min: 0, 173 max: 100, 174 style: SliderStyle.InSet 175 }) 176 .blockColor('#191970') 177 .trackColor('#ADD8E6') 178 .selectedColor('#4169E1') 179 .showTips(true) 180 .onChange((value: number, mode: SliderChangeMode) => { 181 this.inSetValueOne = value 182 console.info('value:' + value + 'mode:' + mode.toString()) 183 }) 184 Text(this.inSetValueOne.toFixed(0)).fontSize(12) 185 } 186 .width('80%') 187 Row() { 188 Slider({ 189 value: this.inSetValueTwo, 190 step: 10, 191 style: SliderStyle.InSet 192 }) 193 .blockColor('#191970') 194 .trackColor('#ADD8E6') 195 .selectedColor('#4169E1') 196 .showSteps(true) 197 .onChange((value: number, mode: SliderChangeMode) => { 198 this.inSetValueTwo = value 199 console.info('value:' + value + 'mode:' + mode.toString()) 200 }) 201 Text(this.inSetValueTwo.toFixed(0)).fontSize(12) 202 } 203 .width('80%') 204 205 Row() { 206 Column() { 207 Text('vertical outset slider').fontSize(9).fontColor(0xCCCCCC).width('50%').margin(15) 208 Row() { 209 Slider({ 210 value: this.vOutSetValueOne, 211 style: SliderStyle.OutSet, 212 direction: Axis.Vertical 213 }) 214 .blockColor('#191970') 215 .trackColor('#ADD8E6') 216 .selectedColor('#4169E1') 217 .showTips(true) 218 .onChange((value: number, mode: SliderChangeMode) => { 219 this.vOutSetValueOne = value 220 console.info('value:' + value + 'mode:' + mode.toString()) 221 }) 222 Slider({ 223 value: this.vOutSetValueTwo, 224 step: 10, 225 style: SliderStyle.OutSet, 226 direction: Axis.Vertical 227 }) 228 .blockColor('#191970') 229 .trackColor('#ADD8E6') 230 .selectedColor('#4169E1') 231 .showSteps(true) 232 .onChange((value: number, mode: SliderChangeMode) => { 233 this.vOutSetValueTwo = value 234 console.info('value:' + value + 'mode:' + mode.toString()) 235 }) 236 } 237 }.width('50%').height(300) 238 239 Column() { 240 Text('vertical inset slider').fontSize(9).fontColor(0xCCCCCC).width('50%').margin(15) 241 Row() { 242 Slider({ 243 value: this.vInSetValueOne, 244 style: SliderStyle.InSet, 245 direction: Axis.Vertical, 246 reverse: true // 竖向的Slider默认是上端是min值，下端是max值，因此想要从下往上滑动，需要设置reverse为true 247 }) 248 .showTips(true) 249 .onChange((value: number, mode: SliderChangeMode) => { 250 this.vInSetValueOne = value 251 console.info('value:' + value + 'mode:' + mode.toString()) 252 }) 253 Slider({ 254 value: this.vInSetValueTwo, 255 step: 10, 256 style: SliderStyle.InSet, 257 direction: Axis.Vertical, 258 reverse: true 259 }) 260 .showSteps(true) 261 .onChange((value: number, mode: SliderChangeMode) => { 262 this.vInSetValueTwo = value 263 console.info('value:' + value + 'mode:' + mode.toString()) 264 }) 265 } 266 }.width('50%').height(300) 267 } 268 }.width('100%') 269 } 270} 271``` 272 273 274 275### 示例2 276 277```ts 278@Entry 279@Component 280struct SliderExample { 281 @State tipsValue: number = 40 282 283 build() { 284 Column({ space: 8 }) { 285 Text('block').fontSize(9).fontColor(0xCCCCCC).margin(15).width('90%') 286 Slider({ style: SliderStyle.OutSet, value: 40 }) 287 .blockSize({ width: 40, height: 40 }) 288 .blockBorderColor(Color.Red) 289 .blockBorderWidth(5) 290 Divider() 291 Text('step').fontSize(9).fontColor(0xCCCCCC).margin(15).width('90%') 292 Slider({ style: SliderStyle.InSet, value: 40, step: 10 }) 293 .showSteps(true) 294 .stepSize(8) 295 .stepColor(Color.Yellow) 296 Divider() 297 Text('track').fontSize(9).fontColor(0xCCCCCC).margin(15).width('90%') 298 Slider({ style: SliderStyle.InSet, value: 40 }) 299 .trackBorderRadius(2) 300 Divider() 301 Text('blockStyle').fontSize(9).fontColor(0xCCCCCC).margin(15).width('90%') 302 Slider({ style: SliderStyle.OutSet, value: 40 }) 303 .blockStyle({ type: SliderBlockType.DEFAULT }) 304 Slider({ style: SliderStyle.OutSet, value: 40 }) 305 .blockStyle({ type: SliderBlockType.IMAGE, image: $r('sys.media.ohos_app_icon') }) 306 Slider({ style: SliderStyle.OutSet, value: 40 }) 307 .blockSize({ width: '60px', height: '60px' }) 308 .blockColor(Color.Red) 309 .blockStyle({ type: SliderBlockType.SHAPE, shape: new Path({ commands: 'M60 60 M30 30 L15 56 L45 56 Z' }) }) 310 Divider() 311 Text('tips').fontSize(9).fontColor(0xCCCCCC).margin(15).width('90%') 312 Slider({ style: SliderStyle.InSet, value: this.tipsValue }) 313 .showTips(true, 'value:' + this.tipsValue.toFixed()) 314 .onChange(value => { 315 this.tipsValue = value 316 }) 317 } 318 } 319} 320``` 321 322
