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

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

Z
zengyawen 已提交
6 7 8

滑动条组件,用来快速调节设置值,如音量、亮度等。

Z
zengyawen 已提交
9 10

## 权限列表
Z
zengyawen 已提交
11 12 13



Z
zengyawen 已提交
14 15

## 子组件
Z
zengyawen 已提交
16 17 18



Z
zengyawen 已提交
19 20 21

## 接口

K
kangchongtao 已提交
22
Slider(options:{value?: number, min?: number, max?: number, step?: number, style?: SliderStyle, direction?: Axis, reverse?: boolean})
Z
zengyawen 已提交
23 24 25 26 27 28 29 30 31

- 参数
  | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
  | -------- | -------- | -------- | -------- | -------- |
  | value | number | 否 | 0 | 当前进度值。 |
  | min | number | 否 | 0 | 设置最小值。 |
  | max | number | 否 | 100 | 设置最大值。 |
  | step | number | 否 | 1 | 设置Slider滑动跳动值,当设置相应的step时,Slider为间歇滑动。 |
  | style | SliderStyle | 否 | SliderStyle.OutSet | 设置Slider的滑块样式。 |
K
kangchongtao 已提交
32
  | direction<sup>8+</sup> | [Axis](ts-appendix-enums.md#axis) | 否 | Axis.Horizontal | 设置滑动条滑动方向为水平或竖直方向。 |
Z
zengyawen 已提交
33 34 35
  | reverse<sup>8+</sup> | boolean | 否 | false | 设置滑动条取值范围是否反向。 |

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


## 属性
Z
zengyawen 已提交
43

Z
zengyawen 已提交
44 45
不支持触摸热区设置。

G
gmy 已提交
46
| 名称 | 参数类型 | 默认值 | 描述 |
Z
zengyawen 已提交
47
| -------- | -------- | -------- | -------- |
K
kangchongtao 已提交
48 49 50
| blockColor | [ResourceColor](../../ui/ts-types.md#resourcecolor8) | - | 设置滑块的颜色。 |
| trackColor | [ResourceColor](../../ui/ts-types.md#resourcecolor8) | - | 设置滑轨的背景颜色。 |
| selectedColor | [ResourceColor](../../ui/ts-types.md#resourcecolor8) | - | 设置滑轨的已滑动颜色。 |
G
gmy 已提交
51 52
| showSteps | boolean | false | 设置当前是否显示步长刻度值。 |
| showTips | boolean | false | 设置滑动时是否显示气泡提示百分比。 |
K
kangchongtao 已提交
53
| trackThickness      | [Length](../../ui/ts-types.md#length) | - | 设置滑轨的粗细。 |
Z
zengyawen 已提交
54 55 56


## 事件
Z
zengyawen 已提交
57 58 59

通用事件仅支持:OnAppear,OnDisAppear。

G
gmy 已提交
60
| 名称 | 功能描述 |
61
| -------- | -------- |
K
kangchongtao 已提交
62
| onChange(callback:&nbsp;(value:&nbsp;number,&nbsp;mode:&nbsp;SliderChangeMode)&nbsp;=&gt;&nbsp;void) | Slider滑动时触发事件回调。<br/>value:当前进度值。<br/>mode:拖动状态。 |
Z
zengyawen 已提交
63 64

- SliderChangeMode枚举说明
G
gmy 已提交
65 66 67 68 69
  | 名称 | 值 | 描述 |
  | -------- | -------- | -------- |
  | Begin | 0 | 用户开始拖动滑块。 |
  | Moving | 1 | 用户拖动滑块中。 |
  | End | 2 | 用户结束拖动滑块。 |
K
kangchongtao 已提交
70
  | Click    | 3    | 用户点击滑动条使滑块位置移动。 |
Z
zengyawen 已提交
71 72 73


## 示例
Z
zengyawen 已提交
74

H
geshi  
HelloCrease 已提交
75 76
```ts
// xxx.ets
Z
zengyawen 已提交
77 78 79 80 81
@Entry
@Component
struct SliderExample {
  @State outSetValue: number = 40
  @State inSetValue: number = 40
Z
zengyawen 已提交
82 83
  @State outVerticalSetValue: number = 40
  @State inVerticalSetValue: number = 40
Z
zengyawen 已提交
84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130

  build() {
    Column({ space: 5 }) {
      Text('slider out set').fontSize(9).fontColor(0xCCCCCC).width('90%')
      Row() {
        Slider({
          value: this.outSetValue,
          min: 0,
          max: 100,
          step: 1,
          style: SliderStyle.OutSet
        })
        .blockColor(Color.Blue)
        .trackColor(Color.Gray)
        .selectedColor(Color.Blue)
        .showSteps(true)
        .showTips(true)
        .onChange((value: number, mode: SliderChangeMode) => {
          this.outSetValue = value
          console.info('value:' + value + 'mode:' + mode.toString())
        })
        Text(this.outSetValue.toFixed(0)).fontSize(16)
      }
      .padding({ top: 50 })
      .width('80%')

      Text('slider in set').fontSize(9).fontColor(0xCCCCCC).width('90%')
      Row() {
        Slider({
          value: this.inSetValue,
          min: 0,
          max: 100,
          step: 1,
          style: SliderStyle.InSet
        })
        .blockColor(0xCCCCCC)
        .trackColor(Color.Black)
        .selectedColor(0xCCCCCC)
        .showSteps(false)
        .showTips(false)
        .onChange((value: number, mode: SliderChangeMode) => {
          this.inSetValue = value
          console.info('value:' + value + 'mode:' + mode.toString())
        })
        Text(this.inSetValue.toFixed(0)).fontSize(16)
      }
      .width('80%')
Z
zengyawen 已提交
131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177

      Row() {
        Column() {
          Text('slider out direction set').fontSize(9).fontColor(0xCCCCCC).width('50%')
          Slider({
            value: this.outVerticalSetValue,
            min: 0,
            max: 100,
            step: 1,
            style: SliderStyle.OutSet,
            direction: Axis.Vertical
          })
          .blockColor(Color.Blue)
          .trackColor(Color.Gray)
          .selectedColor(Color.Blue)
          .showSteps(true)
          .showTips(true)
          .onChange((value: number, mode: SliderChangeMode) => {
            this.outVerticalSetValue = value
            console.info('value:' + value + 'mode:' + mode.toString())
          })
          Text(this.outVerticalSetValue.toFixed(0)).fontSize(16)
        }.width('50%').height(300)

        Column() {
          Text('slider in direction set').fontSize(9).fontColor(0xCCCCCC).width('50%')
          Slider({
            value: this.inVerticalSetValue,
            min: 0,
            max: 100,
            step: 1,
            style: SliderStyle.InSet,
            direction: Axis.Vertical
          })
          .blockColor(0xCCCCCC)
          .trackColor(Color.Black)
          .selectedColor(0xCCCCCC)
          .showSteps(false)
          .showTips(false)
          .onChange((value: number, mode: SliderChangeMode) => {
            this.inVerticalSetValue = value
            console.info('value:' + value + 'mode:' + mode.toString())
          })
          Text(this.inVerticalSetValue.toFixed(0)).fontSize(16)
        }.width('50%').height(300)
      }

Z
zengyawen 已提交
178 179 180 181 182
    }.width('100%').margin({ top: 5 })
  }
}
```

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