目录

Slider

滑动条组件,通常用于快速调节设置值,如音量调节、亮度调节等应用场景。支持样式定制、方向配置、交互方式和无障碍功能,能解决UI一致性问题,提升开发效率,从而改善用户体验并降低开发成本。

  • 该组件从API version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。

  • 从API版本26.0.0开始,Slider组件传入材质参数时,使用组件内部预设的视觉参数,传入的材质参数仅作为开启系统材质的开关标记,不影响实际视觉效果。主要影响Slider的滑块大小、滑块样式、阴影等视觉属性。传入undefined时,系统材质不生效,表现为原先的Slider样式。

子组件

无

接口

Slider(options?: SliderOptions)

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

元服务API: 从API version 11开始,该接口支持在元服务中使用。

系统能力: SystemCapability.ArkUI.ArkUI.Full

参数:

参数名 类型 必填 说明
options SliderOptions 否 配置滑动条的参数。若不传入,则使用SliderOptions中各属性的默认值。

SliderOptions对象说明

滑动条的信息。

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

元服务API: 从API version 11开始,该接口支持在元服务中使用。

系统能力: SystemCapability.ArkUI.ArkUI.Full

名称 类型 只读 可选 说明
value number 否 是

当前进度值。

默认值:与属性min的取值一致。

从API version 10开始,该属性支持$$双向绑定变量。

该属性支持!!双向绑定变量。

取值范围: [min, max]

小于min时取min,大于max时取max。

$$运算符为系统组件提供TS变量的引用,使TS变量和Slider组件的value值保持同步。详细使用示例请参考示例7(设置滑动条的双向绑定)。

min number 否 是

设置最小值。

默认值:0

max number 否 是

设置最大值。

默认值:100

说明:

当min >= max时,min取默认值0,max取默认值100。

当value不在[min, max]范围内时,取min或者max,靠近min取min,靠近max取max。

step number 否 是

设置Slider滑动步长。

默认值:1

取值范围:[0.01, max - min]

说明:

若设置的step值小于0或大于max - min值,则按默认值显示。

style SliderStyle 否 是

设置Slider的滑块与滑轨显示样式。

默认值:SliderStyle.OutSet

direction8+ Axis 否 是

设置滑动条滑动方向为水平或竖直方向。

默认值:Axis.Horizontal

reverse8+ boolean 否 是

设置滑动条取值范围是否反向。

true:横向Slider从右往左滑动,竖向Slider从下往上滑动;false:横向Slider从左往右滑动,竖向Slider从上往下滑动。

默认值:false

SliderStyle枚举说明

滑动条滑块在滑轨上显示的样式,样式说明请参考Slider组件滑块与滑轨是如何对齐的。

系统能力: SystemCapability.ArkUI.ArkUI.Full

名称 值 说明
OutSet 0

滑块在滑轨上。

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

元服务API: 从API version 11开始,该接口支持在元服务中使用。

InSet 1

滑块在滑轨内。

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

元服务API: 从API version 11开始,该接口支持在元服务中使用。

NONE12+ 2

无滑块

卡片能力: 从API version 12开始,该接口支持在ArkTS卡片中使用。

元服务API: 从API version 12开始,该接口支持在元服务中使用。

模型约束: 此接口仅可在Stage模型下使用。

  • Slider无默认padding。
  • 水平滑动条时,默认高度为40vp,宽度为父容器的宽度,滑动条居中显示,style为SliderStyle.OutSet时,左右间距分别为9vp,即为blockSize宽度的一半,style为SliderStyle.InSet时,左右间距分别为6vp,若设置padding,padding不会覆盖左右间距。
  • 竖直滑动条时,默认宽度为40vp,高度为父容器的高度,滑动条居中显示,style为SliderStyle.OutSet时,上下间距分别为10vp,style为SliderStyle.InSet时,上下间距分别为6vp,若设置padding,padding不会覆盖上下间距。

属性

支持除触摸热区以外的通用属性。

[h2]blockColor

blockColor(value: ResourceColor)

设置滑块的颜色。

当滑块形状设置为SliderBlockType.DEFAULT时,blockColor可设置默认圆形滑块颜色。

当滑块形状设置为SliderBlockType.IMAGE时,滑块无填充,设置blockColor不生效。

当滑块形状设置为SliderBlockType.SHAPE时,blockColor可设置自定义形状的填充颜色。

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

元服务API: 从API version 11开始,该接口支持在元服务中使用。

系统能力: SystemCapability.ArkUI.ArkUI.Full

参数:

参数名 类型 必填 说明
value ResourceColor 是

滑块的颜色。

默认值:$r('sys.color.ohos_id_color_foreground_contrary')

[h2]blockColor21+

blockColor(value: ResourceColor | LinearGradient)

设置Slider滑块的颜色,支持渐变色。与blockColor相比,新增LinearGradient类型支持。

当滑块形状设置为SliderBlockType.DEFAULT时,blockColor可设置默认圆形滑块颜色。

当滑块形状设置为SliderBlockType.IMAGE时,滑块无填充,设置blockColor不生效。

当滑块形状设置为SliderBlockType.SHAPE时,blockColor可设置自定义形状的填充颜色。

卡片能力: 从API version 21开始,该接口支持在ArkTS卡片中使用。

元服务API: 从API version 21开始,该接口支持在元服务中使用。

模型约束: 此接口仅可在Stage模型下使用。

系统能力: SystemCapability.ArkUI.ArkUI.Full

参数:

参数名 类型 必填 说明
value ResourceColor | LinearGradient 是

滑块的颜色。

默认值:$r('sys.color.ohos_id_color_foreground_contrary')

说明:

当滑块形状设置为SliderBlockType.IMAGE时,滑块无填充,设置blockColor不生效。

[h2]trackColor

trackColor(value: ResourceColor | LinearGradient)

设置滑轨的背景颜色。

从API version 12开始,支持使用LinearGradient类型设置滑轨的渐变色。

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

元服务API: 从API version 11开始,该接口在元服务中仅支持ResourceColor类型。

系统能力: SystemCapability.ArkUI.ArkUI.Full

参数:

参数名 类型 必填 说明
value ResourceColor | LinearGradient 是

滑轨的背景颜色。

默认值:$r('sys.color.ohos_id_color_component_normal')

说明:

1. 设置渐变色时,如果颜色断点颜色值为非法值或渐变色断点为空,渐变色将不起效果。

2. 该接口中的LinearGradient类型不支持在元服务中使用。

[h2]trackColorMetrics23+

trackColorMetrics(color: ColorMetricsLinearGradient)

设置滑轨的线性渐变背景颜色。与trackColor相比,使用ColorMetricsLinearGradient类型支持指定色域的渐变。

元服务API: 从API version 23开始,该接口支持在元服务中使用。

与trackColor的关系: trackColorMetrics与trackColor功能类似,但使用ColorMetricsLinearGradient类型支持指定色域的渐变控制;trackColor中的LinearGradient类型不支持元服务,而trackColorMetrics支持。两者功能类似,不能同时生效,后调用的方法会覆盖先调用的设置。

系统能力: SystemCapability.ArkUI.ArkUI.Full

模型约束: 此接口仅可在Stage模型下使用。

参数:

参数名 类型 必填 说明
color ColorMetricsLinearGradient 是

滑轨的线性渐变背景颜色。

设置渐变色时,如果color的值为undefined,渐变色设置无效,滑轨背景颜色默认取值为:$r('sys.color.ohos_id_color_component_normal')。

[h2]selectedColor

selectedColor(value: ResourceColor)

设置滑轨的已滑动部分颜色。

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

元服务API: 从API version 11开始,该接口支持在元服务中使用。

系统能力: SystemCapability.ArkUI.ArkUI.Full

参数:

参数名 类型 必填 说明
value ResourceColor 是

滑轨的已滑动部分颜色。

默认值:$r('sys.color.ohos_id_color_emphasize')

[h2]selectedColor18+

selectedColor(selectedColor: ResourceColor | LinearGradient)

设置滑轨的已滑动部分颜色。与selectedColor相比,新增了LinearGradient类型的支持。

卡片能力: 从API version 18开始,该接口支持在ArkTS卡片中使用。

元服务API: 从API version 18开始,该接口支持在元服务中使用。

模型约束: 此接口仅可在Stage模型下使用。

系统能力: SystemCapability.ArkUI.ArkUI.Full

参数:

参数名 类型 必填 说明
selectedColor ResourceColor | LinearGradient 是

滑轨的已滑动部分颜色。

默认值:$r('sys.color.ohos_id_color_emphasize')

说明:

设置渐变色时,若颜色断点颜色值为非法值或者渐变色断点为空时,渐变色不起效果。

[h2]showSteps

showSteps(value: boolean)

设置是否显示步长刻度值。

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

元服务API: 从API version 11开始,该接口支持在元服务中使用。

系统能力: SystemCapability.ArkUI.ArkUI.Full

参数:

参数名 类型 必填 说明
value boolean 是

是否显示步长刻度值。

true:显示刻度值;false:不显示刻度值。

默认值:false

[h2]showTips

showTips(value: boolean, content?: ResourceStr)

设置滑动时是否显示气泡提示。

当direction的值为Axis.Horizontal时,气泡提示显示在滑块上方;若上方空间不足以显示完整气泡提示,则在下方显示。当值为Axis.Vertical时,气泡提示显示在滑块左边;若左边空间不足以显示完整气泡提示,则在右边显示。当未设置周边边距或边距小于气泡提示所需空间时,气泡提示会被截断。

气泡提示的绘制区域为Slider自身节点的overlay。

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

元服务API: 从API version 11开始,该接口支持在元服务中使用。

系统能力: SystemCapability.ArkUI.ArkUI.Full

参数:

参数名 类型 必填 说明
value boolean 是

滑动时是否显示气泡提示。

true:显示气泡;false:不显示气泡。

默认值:false

content10+ ResourceStr 否

气泡提示的文本内容。传入时显示自定义文本(当需要展示特定格式或额外信息时使用),不传入时默认显示当前百分比数值。

模型约束: 此接口仅可在Stage模型下使用。

[h2]trackThickness8+

trackThickness(value: Length)

设置滑轨的粗细。设置小于等于0的值时,取默认值。

为保证滑块和滑轨的SliderStyle样式,blockSize跟随trackThickness同比例增减。

当style为SliderStyle.OutSet时,trackThickness:blockSize=1:4,当style为SliderStyle.InSet时,trackThickness:blockSize=5:3。

trackThickness或blockSize的大小超过Slider组件的宽度或高度时,取默认值。

当SliderStyle设置为OutSet时,尽管trackThickness的大小没超过Slider组件的宽度或高度,但是blockSize超过了,取默认值。

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

元服务API: 从API version 11开始,该接口支持在元服务中使用。

系统能力: SystemCapability.ArkUI.ArkUI.Full

参数:

参数名 类型 必填 说明
value Length 是

滑轨的粗细。

默认值:style为SliderStyle.OutSet时为4.0vp,style为SliderStyle.InSet时为20.0vp。

[h2]blockBorderColor10+

blockBorderColor(value: ResourceColor)

设置滑块描边颜色。

当滑块形状设置为SliderBlockType.DEFAULT时,blockBorderColor可设置默认圆形滑块描边颜色。

当滑块形状设置为SliderBlockType.IMAGE时,滑块无描边,设置blockBorderColor不生效。

当滑块形状设置为SliderBlockType.SHAPE时,blockBorderColor可设置自定义形状中线的颜色。

元服务API: 从API version 11开始,该接口支持在元服务中使用。

模型约束: 此接口仅可在Stage模型下使用。

系统能力: SystemCapability.ArkUI.ArkUI.Full

参数:

参数名 类型 必填 说明
value ResourceColor 是

滑块描边颜色。

默认值:'#00000000'

[h2]blockBorderWidth10+

blockBorderWidth(value: Length)

设置滑块描边粗细。

当滑块形状设置为SliderBlockType.DEFAULT时,blockBorderWidth可设置默认圆形滑块描边粗细。

当滑块形状设置为SliderBlockType.IMAGE时,滑块无描边,设置blockBorderWidth不生效。

当滑块形状设置为SliderBlockType.SHAPE时,blockBorderWidth可设置自定义形状中线的粗细。

元服务API: 从API version 11开始,该接口支持在元服务中使用。

模型约束: 此接口仅可在Stage模型下使用。

系统能力: SystemCapability.ArkUI.ArkUI.Full

参数:

参数名 类型 必填 说明
value Length 是

滑块描边粗细。

说明:

value为string类型时,不支持百分比。

[h2]stepColor10+

stepColor(value: ResourceColor)

设置刻度颜色。

元服务API: 从API version 11开始,该接口支持在元服务中使用。

模型约束: 此接口仅可在Stage模型下使用。

系统能力: SystemCapability.ArkUI.ArkUI.Full

参数:

参数名 类型 必填 说明
value ResourceColor 是

刻度颜色。

默认值:

混入$r('sys.color.ohos_id_alpha_normal_bg')透明度的$r('sys.color.ohos_id_color_foreground')颜色。

[h2]trackBorderRadius10+

trackBorderRadius(value: Length)

设置滑轨圆角半径。

元服务API: 从API version 11开始,该接口支持在元服务中使用。

模型约束: 此接口仅可在Stage模型下使用。

系统能力: SystemCapability.ArkUI.ArkUI.Full

参数:

参数名 类型 必填 说明
value Length 是

滑轨圆角半径。

默认值:

style为SliderStyle.OutSet时默认值为2vp。

style为SliderStyle.InSet时默认值为10vp。

说明:

设定值小于0时取默认值。

[h2]selectedBorderRadius12+

selectedBorderRadius(value: Dimension)

设置已滑动部分(高亮)圆角半径。

元服务API: 从API version 12开始,该接口支持在元服务中使用。

模型约束: 此接口仅可在Stage模型下使用。

系统能力: SystemCapability.ArkUI.ArkUI.Full

参数:

参数名 类型 必填 说明
value Dimension 是

已滑动部分的圆角半径。

默认值:style为SliderStyle.InSet或SliderStyle.OutSet时,跟随滑轨圆角;style为SliderStyle.NONE时,为0。

说明:

不支持Percentage类型。设定值小于0时取默认值。

[h2]blockSize10+

blockSize(value: SizeOptions)

设置滑块大小。

当滑块形状设置为SliderBlockType.DEFAULT时,取宽高的最小值作为圆形半径。

当滑块形状设置为SliderBlockType.IMAGE时,用于设置图片的尺寸大小,图片采用ObjectFit.Cover策略进行缩放。

当滑块形状设置为SliderBlockType.SHAPE时,用于设置自定义形状的大小,自定义形状也会采用ObjectFit.Cover策略进行缩放。

元服务API: 从API version 11开始,该接口支持在元服务中使用。

模型约束: 此接口仅可在Stage模型下使用。

系统能力: SystemCapability.ArkUI.ArkUI.Full

参数:

参数名 类型 必填 说明
value SizeOptions 是

滑块大小。

默认值:当参数style的值设置为SliderStyle.OutSet时为{width: 18, height: 18},当参数style的值设置为SliderStyle.InSet时为{width: 12, height: 12},当参数style的值设置为SliderStyle.NONE时,此字段不生效。

当blockSize宽高不相等时,取较小值作为尺寸,当设置的宽高值中有一个或两个都小于等于0的时候,取默认值。

[h2]blockStyle10+

blockStyle(value: SliderBlockStyle)

设置滑块形状参数。

元服务API: 从API version 11开始,该接口支持在元服务中使用。

模型约束: 此接口仅可在Stage模型下使用。

系统能力: SystemCapability.ArkUI.ArkUI.Full

参数:

参数名 类型 必填 说明
value SliderBlockStyle 是

滑块形状参数。

默认值为SliderBlockType.DEFAULT,即圆形滑块。

[h2]stepSize10+

stepSize(value: Length)

设置刻度大小(直径)。当值为0时,刻度点不显示,当值小于0时,取默认值。

元服务API: 从API version 11开始,该接口支持在元服务中使用。

模型约束: 此接口仅可在Stage模型下使用。

系统能力: SystemCapability.ArkUI.ArkUI.Full

参数:

参数名 类型 必填 说明
value Length 是

刻度大小(直径)。

默认值:'4vp'

取值范围:[0, trackThickness),单位为vp

[h2]sliderInteractionMode12+

sliderInteractionMode(value: SliderInteraction)

设置用户与滑动条组件交互方式。

元服务API: 从API version 12开始,该接口支持在元服务中使用。

模型约束: 此接口仅可在Stage模型下使用。

系统能力: SystemCapability.ArkUI.ArkUI.Full

参数:

参数名 类型 必填 说明
value SliderInteraction 是

用户与滑动条组件交互方式。

默认值为SliderInteraction.SLIDE_AND_CLICK。

[h2]minResponsiveDistance12+

minResponsiveDistance(value: number)

设置滑块开始滑动的最小响应距离。

元服务API: 从API version 12开始,该接口支持在元服务中使用。

模型约束: 此接口仅可在Stage模型下使用。

系统能力: SystemCapability.ArkUI.ArkUI.Full

参数:

参数名 类型 必填 说明
value number 是

设置滑块开始滑动的最小响应距离。

默认值:0

说明:

单位与SliderOptions中的属性min以及属性max一致。

当value小于0、大于max-min、为NaN或非数字类型时,取默认值。

[h2]contentModifier12+

contentModifier(modifier: ContentModifier<SliderConfiguration>)

定制Slider内容区的方法。

元服务API: 从API version 12开始,该接口支持在元服务中使用。

模型约束: 此接口仅可在Stage模型下使用。

系统能力: SystemCapability.ArkUI.ArkUI.Full

参数:

参数名 类型 必填 说明
modifier ContentModifier<SliderConfiguration> 是

在Slider组件上,定制内容区的方法。

ContentModifier为内容修改器,需自定义class实现该接口。

  • 设置了contentModifier后,自定义区域内点击和手势滑动均不会触发原Slider组件的onChange事件。
  • 仅当调用triggerChange函数且传递正确的参数值时,才可以触发原Slider组件的onChange事件。

[h2]slideRange12+

slideRange(value: SlideRange)

设置有效滑动区间。设置后滑块滑动范围被限制在[from, to]区间内,区间外的点击和手势不会触发滑动;value初始值若超出区间会自动调整到区间边界。

元服务API: 从API version 12开始,该接口支持在元服务中使用。

模型约束: 此接口仅可在Stage模型下使用。

系统能力: SystemCapability.ArkUI.ArkUI.Full

参数:

参数名 类型 必填 说明
value SlideRange 是 有效滑动区间

[h2]enableHapticFeedback18+

enableHapticFeedback(enabled: boolean)

设置是否开启触控反馈。

开启触控反馈时,需要在工程的module.json5中配置requestPermissions字段开启振动权限,配置如下:

"requestPermissions": [
  {
    "name": "ohos.permission.VIBRATE"
  }
 ]

元服务API: 从API version 18开始,该接口支持在元服务中使用。

模型约束: 此接口仅可在Stage模型下使用。

系统能力: SystemCapability.ArkUI.ArkUI.Full

参数:

参数名 类型 必填 说明
enabled boolean 是

是否开启触控反馈。

true:开启触控反馈;false:不开启触控反馈。

默认值:true

[h2]digitalCrownSensitivity18+

digitalCrownSensitivity(sensitivity: Optional<CrownSensitivity>)

设置旋转表冠灵敏度。

该接口不支持在attributeModifier中调用。

元服务API: 从API version 18开始,该接口支持在元服务中使用。

模型约束: 此接口仅可在Stage模型下使用。

系统能力: SystemCapability.ArkUI.ArkUI.Full

参数:

参数名 类型 必填 说明
sensitivity Optional<CrownSensitivity> 是

旋转表冠灵敏度。

默认值:CrownSensitivity.MEDIUM

[h2]prefix20+

prefix(content: ComponentContent, options?: SliderPrefixOptions)

设置滑动条的前缀。

元服务API: 从API version 20开始,该接口支持在元服务中使用。

模型约束: 此接口仅可在Stage模型下使用。

系统能力: SystemCapability.ArkUI.ArkUI.Full

参数:

参数名 类型 必填 说明
content ComponentContent 是 滑动条前缀的可视化内容,显示在滑动条起始位置。
options SliderPrefixOptions 否

滑动条前缀的配置选项,用于设置与无障碍功能相关的属性。

默认值:null

[h2]suffix20+

suffix(content: ComponentContent, options?: SliderSuffixOptions)

设置滑动条的后缀。

元服务API: 从API version 20开始,该接口支持在元服务中使用。

模型约束: 此接口仅可在Stage模型下使用。

系统能力: SystemCapability.ArkUI.ArkUI.Full

参数:

参数名 类型 必填 说明
content ComponentContent 是 滑动条后缀的可视化内容,显示在滑动条结束位置。
options SliderSuffixOptions 否

滑动条后缀的配置选项,用于设置与无障碍功能相关的属性。

默认值:null

[h2]showSteps20+

showSteps(value: boolean, options?: SliderShowStepOptions)

设置当前是否显示步长刻度值。

支持设置每个刻度点的无障碍文本信息,不设置时默认使用当前刻度点的值作为无障碍文本信息。

当显示步长时,设置的刻度点无障碍文本信息生效。

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

元服务API: 从API version 20开始,该接口支持在元服务中使用。

模型约束: 此接口仅可在Stage模型下使用。

系统能力: SystemCapability.ArkUI.ArkUI.Full

参数:

参数名 类型 必填 说明
value boolean 是

是否显示步长刻度值。

true:显示刻度值;false:不显示刻度值。

默认值:false

options SliderShowStepOptions 否

刻度点无障碍文本的配置选项,用于设置与无障碍功能相关的属性。

默认值:null

[h2]minLabel(deprecated)

minLabel(value: string)

设置最小值标签的文本内容。

从API version 7开始支持,从API version 9开始废弃,建议使用SliderOptions的min属性替代。

系统能力: SystemCapability.ArkUI.ArkUI.Full

参数:

参数名 类型 必填 说明
value string 是 最小值标签文本。

[h2]maxLabel(deprecated)

maxLabel(value: string)

设置最大值标签的文本内容。

从API version 7开始支持,从API version 9开始废弃,建议使用SliderOptions的max属性替代。

系统能力: SystemCapability.ArkUI.ArkUI.Full

参数:

参数名 类型 必填 说明
value string 是 最大值标签文本。

ColorMetricsLinearGradient23+

滑轨的线性渐变背景颜色。

[h2]constructor23+

constructor(colorStops: ColorMetricsStop[])

ColorMetricsLinearGradient的构造函数。

元服务API: 从API version 23开始,该接口支持在元服务中使用。

系统能力: SystemCapability.ArkUI.ArkUI.Full

模型约束: 此接口仅可在Stage模型下使用。

参数:

参数名 类型 必填 说明
colorStops ColorMetricsStop[] 是 线性渐变颜色断点数组,每个元素描述一个颜色及其在渐变中的断点值。

ColorMetricsStop23+

线性渐变颜色断点类型,用于描述渐变色颜色断点。

元服务API: 从API version 23开始,该接口支持在元服务中使用。

系统能力: SystemCapability.ArkUI.ArkUI.Full

模型约束: 此接口仅可在Stage模型下使用。

名称 类型 只读 可选 说明
color ColorMetrics 否 否 线性渐变颜色断点的颜色值。
offset Length 否 否

线性渐变颜色断点的断点值,取值为0~1之间的比例值。小于0置为0,大于1置为1。

说明:

如果传入字符串类型且内容为数字,则转换为对应的数值。例如'10vp'转换为10,'10%'转换为0.1。

SliderCustomContentOptions20+

Slider前后缀组件无障碍信息参数。

元服务API: 从API version 20开始,该接口支持在元服务中使用。

模型约束: 此接口仅可在Stage模型下使用。

系统能力: SystemCapability.ArkUI.ArkUI.Full

名称 类型 只读 可选 说明
accessibilityText ResourceStr 否 是

无障碍文本,供屏幕阅读器等工具读取,增强无障碍功能。

默认值:""

accessibilityDescription ResourceStr 否 是

无障碍功能详细描述,描述滑块前缀或后缀的功能或用途,供屏幕阅读器等工具使用。

默认值为“单指双击即可执行”。

accessibilityLevel string 否 是

控制组件是否可被无障碍辅助服务识别。

支持的值为:

"auto":当前组件会转换为“yes”。

"yes":当前组件可被无障碍辅助服务所识别。

"no":当前组件不可被无障碍辅助服务所识别。

"no-hide-descendants":当前组件及其所有子组件不可被无障碍辅助服务所识别。

默认值:"auto"。

accessibilityGroup boolean 否 是

标识元素是否属于无障碍组,帮助屏幕阅读器等工具分组相关元素。

true:该组件及其所有子组件为一整个可以选中的组件,无障碍服务将不再关注其子组件内容;false:不启用无障碍分组。

默认值:false

SliderPrefixOptions20+

Slider前缀组件无障碍信息参数。

元服务API: 从API version 20开始,该接口支持在元服务中使用。

模型约束: 此接口仅可在Stage模型下使用。

系统能力: SystemCapability.ArkUI.ArkUI.Full

提供前缀组件的无障碍信息,继承自SliderCustomContentOptions。

SliderSuffixOptions20+

Slider后缀组件无障碍信息参数。

元服务API: 从API version 20开始,该接口支持在元服务中使用。

模型约束: 此接口仅可在Stage模型下使用。

系统能力: SystemCapability.ArkUI.ArkUI.Full

提供后缀组件的无障碍信息,继承自SliderCustomContentOptions。

SliderStepItemAccessibility20+

Slider刻度点的无障碍文本信息。

元服务API: 从API version 20开始,该接口支持在元服务中使用。

模型约束: 此接口仅可在Stage模型下使用。

系统能力: SystemCapability.ArkUI.ArkUI.Full

名称 类型 只读 可选 说明
text ResourceStr 否 是

无障碍文本,供屏幕阅读器等工具读取,增强无障碍功能。

默认值:""

SliderShowStepOptions20+

Slider刻度点的无障碍文本信息映射集。

元服务API: 从API version 20开始,该接口支持在元服务中使用。

模型约束: 此接口仅可在Stage模型下使用。

系统能力: SystemCapability.ArkUI.ArkUI.Full

名称 类型 只读 可选 说明
stepsAccessibility Map<number, SliderStepItemAccessibility> 否 是

刻度点无障碍文本映射集,供屏幕阅读器等工具读取,增强无障碍功能。

Key取值范围:[0, INT32_MAX],当Key设定为负数和小数时,设定项不生效。

默认值:{}

SliderBlockStyle10+对象说明

Slider组件滑块形状参数。

元服务API: 从API version 11开始,该接口支持在元服务中使用。

模型约束: 此接口仅可在Stage模型下使用。

系统能力: SystemCapability.ArkUI.ArkUI.Full

名称 类型 只读 可选 说明
type SliderBlockType 否 否

滑块形状。

默认值:SliderBlockType.DEFAULT,使用圆形滑块。

image ResourceStr 否 是

设置滑块图片资源。

图片显示区域大小由blockSize属性控制,请勿输入尺寸过大的图片。

说明: 仅当type为SliderBlockType.IMAGE时生效,与shape属性互斥,不能同时使用。

shape Circle | Ellipse | Path | Rect 否 是

设置滑块使用的自定义形状。

说明: 仅当type为SliderBlockType.SHAPE时生效,与image属性互斥,不能同时使用。

SliderBlockType10+枚举说明

Slider组件滑块形状枚举。

元服务API: 从API version 11开始,该接口支持在元服务中使用。

模型约束: 此接口仅可在Stage模型下使用。

系统能力: SystemCapability.ArkUI.ArkUI.Full

名称 值 说明
DEFAULT 0 使用默认滑块(圆形)。
IMAGE 1 使用图片资源作为滑块。
SHAPE 2 使用自定义形状作为滑块。

SliderInteraction12+枚举说明

用户与滑动条组件交互方式。

元服务API: 从API version 12开始,该接口支持在元服务中使用。

模型约束: 此接口仅可在Stage模型下使用。

系统能力: SystemCapability.ArkUI.ArkUI.Full

名称 值 说明
SLIDE_AND_CLICK 0 用户可拖拽滑块或者点击滑轨使滑块移动,鼠标或手指按下即发生移动。
SLIDE_ONLY 1 禁止用户通过点击滑轨使滑块移动。
SLIDE_AND_CLICK_UP 2 用户可拖拽滑块或者点击滑轨使滑块移动,当鼠标或手指抬起时,若与屏幕按压位置一致,则触发移动。

SlideRange12+对象说明

定义有效滑动区间。

元服务API: 从API version 12开始,该接口支持在元服务中使用。

模型约束: 此接口仅可在Stage模型下使用。

系统能力: SystemCapability.ArkUI.ArkUI.Full

名称 类型 只读 可选 说明
from number 否 是 设置有效滑动区间的开始。
to number 否 是 设置有效滑动区间的结束。
  • 仅当min<=from<=to<=max时生效(min和max取实际生效值)。
  • 可只设置from或者to,也可以同时设置from和to。
  • 当接口生效且设置的from处于紧邻的step整数倍的值之间,则from实际取左区间step整数倍的那个值或者min作为修正后的值。
  • 当接口生效且设置的to处于紧邻的step整数倍的值之间,则to实际取右区间step整数倍的那个值或者MAX作为修正后的值。
  • from和to取修正值后,value为undefined或null时与from一致;value为数值且<=from时取from;value>to时取to。

事件

除支持通用事件外,还支持以下事件:

[h2]onChange

onChange(callback: (value: number, mode: SliderChangeMode) => void)

Slider拖动或点击时触发事件回调。

Begin和End状态在点击时触发,Moving和Click状态在value值变化时触发。

连贯拖动动作不触发Click状态。

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

元服务API: 从API version 11开始,该接口支持在元服务中使用。

系统能力: SystemCapability.ArkUI.ArkUI.Full

参数:

参数名 类型 必填 说明
value number 是 当前滑动进度值,返回值精度由Slider的step参数决定。若返回值有小数,可使用number.toFixed()方法将数据处理为预期的精度。
mode SliderChangeMode 是 事件触发的相关状态值。可选值包括Begin、Moving、End和Click,详见SliderChangeMode枚举说明。

SliderChangeMode枚举说明

滑块状态值,包括按下、拖动、离开、点击滑动条使滑块移动时。

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

元服务API: 从API version 11开始,该接口支持在元服务中使用。

系统能力: SystemCapability.ArkUI.ArkUI.Full

名称 值 说明
Begin 0 手势或鼠标接触/按下滑块。
Moving 1 拖动滑块过程中。
End 2

手势或鼠标离开滑块。

说明:

手势或鼠标离开滑块时触发,包含正常拖动结束;异常值恢复成默认值时触发,即value设置小于min或大于max。

Click8+ 3 点击滑动条使滑块移动。

SliderConfiguration12+对象说明

开发者需要自定义class实现ContentModifier接口。继承自CommonConfiguration。

元服务API: 从API version 12开始,该接口支持在元服务中使用。

模型约束: 此接口仅可在Stage模型下使用。

系统能力: SystemCapability.ArkUI.ArkUI.Full

名称 类型 只读 可选 说明
value number 否 否 当前进度值。
min number 否 否 最小值。
max number 否 否 最大值。
step number 否 否 Slider滑动步长,表示滑动条每次滑动的数值增量。
triggerChange SliderTriggerChangeCallback 否 否 触发Slider变化。

SliderTriggerChangeCallback12+

type SliderTriggerChangeCallback = (value: number, mode: SliderChangeMode) => void

定义SliderConfiguration中使用的回调类型。

元服务API: 从API version 12开始,该接口支持在元服务中使用。

模型约束: 此接口仅可在Stage模型下使用。

系统能力: SystemCapability.ArkUI.ArkUI.Full

参数:

参数名 类型 必填 说明
value number 是

设置当前进度值。

取值范围:[min-max]

mode SliderChangeMode 是 设置事件触发的相关状态值。

示例

[h2]示例1(滑动条基础样式)

该示例通过配置style、showTips、showSteps控制气泡、刻度值、滑块和滑轨的显示。

// xxx.ets
@Entry
@Component
struct SliderExample {
  @State outSetValueOne: number = 40;
  @State inSetValueOne: number = 40;
  @State noneValueOne: 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;

  build() {
    Column({ space: 8 }) {
      Text('outset slider').fontSize(9).fontColor(0xCCCCCC).width('90%').margin(15)
      Row() {
        Slider({
          value: this.outSetValueOne,
          min: 0,
          max: 100,
          style: SliderStyle.OutSet
        })
          .showTips(true)
          .onChange((value: number, mode: SliderChangeMode) => {
            this.outSetValueOne = value;
            console.info('value:' + value + 'mode:' + mode.toString());
          })
        // toFixed(0)将滑动条返回值处理为整数精度
        Text(this.outSetValueOne.toFixed(0)).fontSize(12)
      }
      .width('80%')
      Row() {
        Slider({
          value: this.outSetValueTwo,
          step: 10,
          style: SliderStyle.OutSet
        })
          .showSteps(true)
          .onChange((value: number, mode: SliderChangeMode) => {
            this.outSetValueTwo = value;
            console.info('value:' + value + 'mode:' + mode.toString());
          })
        Text(this.outSetValueTwo.toFixed(0)).fontSize(12)
      }
      .width('80%')

      Text('inset slider').fontSize(9).fontColor(0xCCCCCC).width('90%').margin(15)
      Row() {
        Slider({
          value: this.inSetValueOne,
          min: 0,
          max: 100,
          style: SliderStyle.InSet
        })
          .blockColor('#191970')
          .trackColor('#ADD8E6')
          .selectedColor('#4169E1')
          .showTips(true)
          .onChange((value: number, mode: SliderChangeMode) => {
            this.inSetValueOne = value;
            console.info('value:' + value + 'mode:' + mode.toString());
          })
        Text(this.inSetValueOne.toFixed(0)).fontSize(12)
      }
      .width('80%')
      Row() {
        Slider({
          value: this.inSetValueTwo,
          step: 10,
          style: SliderStyle.InSet
        })
          .blockColor('#191970')
          .trackColor('#ADD8E6')
          .selectedColor('#4169E1')
          .showSteps(true)
          .onChange((value: number, mode: SliderChangeMode) => {
            this.inSetValueTwo = value;
            console.info('value:' + value + 'mode:' + mode.toString());
          })
        Text(this.inSetValueTwo.toFixed(0)).fontSize(12)
      }
      .width('80%')

      Text('none slider').fontSize(9).fontColor(0xCCCCCC).width('90%').margin(15)
      Row() {
        Slider({
          value: this.noneValueOne,
          min: 0,
          max: 100,
          style: SliderStyle.NONE
        })
          .blockColor('#191970')
          .trackColor('#ADD8E6')
          .selectedColor('#4169E1')
          .showTips(true)
          .onChange((value: number, mode: SliderChangeMode) => {
            this.noneValueOne = value;
            console.info('value:' + value + 'mode:' + mode.toString());
          })
        Text(this.noneValueOne.toFixed(0)).fontSize(12)
      }
      .width('80%')

      Row() {
        Column() {
          Text('vertical outset slider').fontSize(9).fontColor(0xCCCCCC).width('50%').margin(15)
          Row() {
            Text().width('10%')
            Slider({
              value: this.vOutSetValueOne,
              style: SliderStyle.OutSet,
              direction: Axis.Vertical
            })
              .blockColor('#191970')
              .trackColor('#ADD8E6')
              .selectedColor('#4169E1')
              .showTips(true)
              .onChange((value: number, mode: SliderChangeMode) => {
                this.vOutSetValueOne = value;
                console.info('value:' + value + 'mode:' + mode.toString());
              })
            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) => {
                this.vOutSetValueTwo = value;
                console.info('value:' + value + 'mode:' + mode.toString());
              })
          }
        }.width('50%').height(300)

        Column() {
          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) => {
                this.vInSetValueOne = value;
                console.info('value:' + value + 'mode:' + mode.toString());
              })
            Slider({
              value: this.vInSetValueTwo,
              step: 10,
              style: SliderStyle.InSet,
              direction: Axis.Vertical,
              reverse: true
            })
              .showSteps(true)
              .onChange((value: number, mode: SliderChangeMode) => {
                this.vInSetValueTwo = value;
                console.info('value:' + value + 'mode:' + mode.toString());
              })
          }
        }.width('50%').height(300)
      }
    }.width('100%')
  }
}

[h2]示例2(设置滑动条样式)

该示例通过blockBorderColor、blockSize、blockBorderWidth、blockStyle设置滑块的样式,通过stepSize、stepColor设置刻度值的样式,通过trackBorderRadius设置底板的圆角,通过selectedBorderRadius设置已滑动部分的圆角。

@Entry
@Component
struct SliderExample {
  @State tipsValue: number = 40;

  build() {
    Column({ space: 8 }) {
      Text('block').fontSize(9).fontColor(0xCCCCCC).margin(15).width('90%')
      Slider({ style: SliderStyle.OutSet, value: 40 })
        .blockSize({ width: 40, height: 40 })
        .blockBorderColor(Color.Red)
        .blockBorderWidth(5)
      Divider()
      Text('step').fontSize(9).fontColor(0xCCCCCC).margin(15).width('90%')
      Slider({ style: SliderStyle.InSet, value: 40, step: 10 })
        .showSteps(true)
        .stepSize(8)
        .stepColor(Color.Yellow)
      Divider()
      Text('track').fontSize(9).fontColor(0xCCCCCC).margin(15).width('90%')
      Slider({ style: SliderStyle.InSet, value: 40 })
        .trackBorderRadius(2)
      Divider()
      Text('selected').fontSize(9).fontColor(0xCCCCCC).margin(15).width('90%')
      Slider({ style: SliderStyle.InSet, value: 40 })
        .selectedBorderRadius(2)
      Divider()
      Text('blockStyle').fontSize(9).fontColor(0xCCCCCC).margin(15).width('90%')
      Slider({ style: SliderStyle.OutSet, value: 40 })
        .blockStyle({ type: SliderBlockType.DEFAULT })
      Slider({ style: SliderStyle.OutSet, value: 40 })
        .blockStyle({ type: SliderBlockType.IMAGE, image: $r('sys.media.ohos_app_icon') })
      Slider({ style: SliderStyle.OutSet, value: 40 })
        .blockSize({ width: '60px', height: '60px' })
        .blockColor(Color.Red)
        .blockStyle({ type: SliderBlockType.SHAPE, shape: new Path({ commands: 'M60 60 M30 30 L15 56 L45 56 Z' }) })
      Divider()
      Text('tips').fontSize(9).fontColor(0xCCCCCC).margin(15).width('90%')
      Slider({ style: SliderStyle.InSet, value: this.tipsValue })
        .showTips(true, this.tipsValue.toFixed())
        .onChange(value => {
          this.tipsValue = value;
        })
    }
  }
}

[h2]示例3(自定义滑动条)

通过样式Builder定制Slider组件内容区。点击增加按钮,进度条会按照原Slider设置的步长增加,反之点击减少按钮进度条会减少,并触发原组件的onChange事件。

// xxx.ets

@Builder
function buildSlider(config: SliderConfiguration) {
  Row() {
    Column({ space: 30 }) {
      Progress({ value: config.value, total: config.max, type: ProgressType.Ring })
        .margin({ top: 20 })

      Button('增加')
        .onClick(() => {
          config.value = config.value + config.step;
          config.triggerChange(config.value, SliderChangeMode.Click);
        })
        .width(100)
        .height(25)
        .fontSize(10)
        .enabled(config.value < config.max)

      Button('减少')
        .onClick(() => {
          config.value = config.value - config.step;
          config.triggerChange(config.value, SliderChangeMode.Click);
        })
        .width(100)
        .height(25)
        .fontSize(10)
        .enabled(config.value > config.min)

      Slider({
        value: config.value,
        min: config.min,
        max: config.max,
        step: config.step,
      })
        .width(100)
        .visibility((config.contentModifier as MySliderStyle).showSlider ? Visibility.Visible : Visibility.Hidden)
        .showSteps(true)
        .onChange((value: number, mode: SliderChangeMode) => {
          config.triggerChange(value, mode);
        })
      Text('当前状态:' + ((config.contentModifier as MySliderStyle).sliderChangeMode == 0 ? "Begin"
        : ((config.contentModifier as MySliderStyle).sliderChangeMode == 1 ? "Moving"
          : ((config.contentModifier as MySliderStyle).sliderChangeMode == 2 ? "End"
            : ((config.contentModifier as MySliderStyle).sliderChangeMode == 3 ? "Click" : "无")))))
        .fontSize(10)
      Text('进度值:' + config.value)
        .fontSize(10)
      Text('最小值:' + config.min)
        .fontSize(10)
      Text('最大值:' + config.max)
        .fontSize(10)
      Text('步长:' + config.step)
        .fontSize(10)
    }
    .width('80%')

  }
  .width('100%')
}

class MySliderStyle implements ContentModifier<SliderConfiguration> {
  showSlider: boolean = true;
  sliderChangeMode: number = 0;

  constructor(showSlider: boolean, sliderChangeMode: number) {
    this.showSlider = showSlider;
    this.sliderChangeMode = sliderChangeMode;
  }

  applyContent(): WrappedBuilder<[SliderConfiguration]> {
    return wrapBuilder(buildSlider);
  }
}


@Entry
@Component
struct SliderExample {
  @State showSlider: boolean = true;
  @State sliderValue: number = 0;
  @State sliderMin: number = 10;
  @State sliderMax: number = 100;
  @State sliderStep: number = 20;
  @State sliderChangeMode: number = 0;

  build() {
    Column({ space: 8 }) {

      Row() {
        Slider({
          value: this.sliderValue,
          min: this.sliderMin,
          max: this.sliderMax,
          step: this.sliderStep,
        })
          .showSteps(true)
          .onChange((value: number, mode: SliderChangeMode) => {
            this.sliderValue = value;
            this.sliderChangeMode = mode;
            console.info('SliderLog value:' + value + 'mode:' + mode.toString());
          })
          .contentModifier(new MySliderStyle(this.showSlider, this.sliderChangeMode))

      }
      .width('100%')

    }.width('100%')
  }
}

[h2]示例4(设置滑动条渐变色)

该示例通过selectedColor设置滑动条渐变色,通过focusable、defaultFocus和focusOnTouch设置滑动条支持表冠操作。

// xxx.ets
@Entry
@Component
struct SliderExample {
  @State inSetValueOne: number = 60
  @State colorGradient: LinearGradient = new LinearGradient([{ color: "#FF0000FF", offset: 0 }, { color: "#FFFF0000", offset: 1 }])
  @State sensitivity: CrownSensitivity | undefined | null = CrownSensitivity.MEDIUM
  scroller: Scroller = new Scroller()

  getIntegerDigits(num: number): string {
    let numRound = Math.round(num);
    return numRound.toString();
  }

  build() {
    Column() {
      Scroll(this.scroller){
        Column() {
          Row() {
            Stack({ alignContent: Alignment.Top }) {
              Slider({
                value: this.inSetValueOne,
                min: 0,
                max: 100,
                style: SliderStyle.NONE,
                direction: Axis.Vertical,
                reverse: true
              })
                .focusable(true)
                .defaultFocus(true)
                .focusOnTouch(true)
                .digitalCrownSensitivity(this.sensitivity)
                .trackColor("#26FFFFFF")
                .trackThickness(52)
                .selectedColor(this.colorGradient)
                .onChange((value: number, mode: SliderChangeMode) => {
                  this.inSetValueOne = value
                })
            }
            .height(233 - 66)
            .width(52)
            .margin({ top: 33, bottom: 33, left: 56 })
            Column() {
              Text('音量')
                .fontSize(19)
                .fontColor("#A9FFFFFF")
                .fontWeight(500)
                .textAlign(TextAlign.Start)
                .margin({ left: 20 })
              Row() {
                Text(this.getIntegerDigits(this.inSetValueOne))
                  .fontSize(52)
                  .fontColor("#FFFFFFFF")
                  .fontWeight(700)
                  .textAlign(TextAlign.Start)
                  .margin({ left: 20 })
                Text('%')
                  .fontSize(19)
                  .fontColor("#FFFFFFFF")
                  .fontWeight(500)
                  .textAlign(TextAlign.Start)
                  .margin({ left: 2 })
              }
            }.alignItems(HorizontalAlign.Start)
          }
          .width(233)
          .height(233)
          .borderRadius(116.5)
          .backgroundColor(Color.Black)
        }
      }
    }.width('100%')
  }
}

[h2]示例5(滑动条设置前后缀内容)

通过prefix、suffix属性设置滑动条的前后缀内容,定制其内容区以及无障碍属性。设置无障碍属性后,屏幕阅读器将以设置的无障碍内容进行朗读。

// xxx.ets
import { ComponentContent } from '@kit.ArkUI';

class NodeParams {
  param: ResourceStr = ""

  constructor(param: ResourceStr) {
    this.param = param;
  }
}

@Builder
function textBuilder(params: NodeParams) {
  Text(params.param)
    .fontSize($r('sys.float.Caption_L'))
    .clip(true)
    .textAlign(TextAlign.Center)
    .fontColor(Color.Black)
}

@Entry
@Component
struct SliderExample {
  private pre: string = '低';
  private suf: string = '高';
  private uiContext: UIContext = this.getUIContext();

  private preNode1: ComponentContent<NodeParams> = new ComponentContent(this.uiContext, wrapBuilder(textBuilder), new NodeParams(this.pre));
  private sufNode1: ComponentContent<NodeParams> = new ComponentContent(this.uiContext, wrapBuilder(textBuilder), new NodeParams(this.suf));
  private preNode2: ComponentContent<NodeParams> = new ComponentContent(this.uiContext, wrapBuilder(textBuilder), new NodeParams(this.pre));
  private sufNode2: ComponentContent<NodeParams> = new ComponentContent(this.uiContext, wrapBuilder(textBuilder), new NodeParams(this.suf));
  private preNode3: ComponentContent<NodeParams> = new ComponentContent(this.uiContext, wrapBuilder(textBuilder), new NodeParams(this.pre));
  private sufNode3: ComponentContent<NodeParams> = new ComponentContent(this.uiContext, wrapBuilder(textBuilder), new NodeParams(this.suf));
  private preNode4: ComponentContent<NodeParams> = new ComponentContent(this.uiContext, wrapBuilder(textBuilder), new NodeParams(this.pre));
  private sufNode4: ComponentContent<NodeParams> = new ComponentContent(this.uiContext, wrapBuilder(textBuilder), new NodeParams(this.suf));
  private preNode5: ComponentContent<NodeParams> = new ComponentContent(this.uiContext, wrapBuilder(textBuilder), new NodeParams(this.pre));
  private sufNode5: ComponentContent<NodeParams> = new ComponentContent(this.uiContext, wrapBuilder(textBuilder), new NodeParams(this.suf));
  private preNode6: ComponentContent<NodeParams> = new ComponentContent(this.uiContext, wrapBuilder(textBuilder), new NodeParams(this.pre));
  private sufNode6: ComponentContent<NodeParams> = new ComponentContent(this.uiContext, wrapBuilder(textBuilder), new NodeParams(this.suf));

  build() {
    Column({ space: 8 }) {
      Text('outset slider').fontSize(9).fontColor(0xCCCCCC).width('90%').margin(15)
      Row() {
        Slider({
          value: 50,
          min: 0,
          max: 100,
          style: SliderStyle.OutSet
        })
          .showTips(true)
          .prefix(this.preNode1)
          .suffix(this.sufNode1)
      }
      .width('80%')

      Row() {
        Slider({
          value: 50,
          min: 0,
          max: 100,
          style: SliderStyle.OutSet
        })
          .showTips(true)
          .prefix(this.preNode3)
      }
      .width('80%')

      Row() {
        Slider({
          value: 50,
          min: 0,
          max: 100,
          style: SliderStyle.OutSet
        })
          .showTips(true)
          .suffix(this.sufNode3)
      }
      .width('80%')

      Text('inset slider').fontSize(9).fontColor(0xCCCCCC).width('90%').margin(15)
      Row() {
        Slider({
          value: 50,
          min: 0,
          max: 100,
          style: SliderStyle.InSet
        })
          .blockColor('#191970')
          .trackColor('#ADD8E6')
          .selectedColor('#4169E1')
          .showTips(true)
          .trackThickness(36)
          .prefix(this.preNode2)
          .suffix(this.sufNode2)
      }
      .width('80%')

      Row() {
        Slider({
          value: 50,
          min: 0,
          max: 100,
          style: SliderStyle.InSet
        })
          .blockColor('#191970')
          .trackColor('#ADD8E6')
          .selectedColor('#4169E1')
          .showTips(true)
          .trackThickness(36)
          .prefix(this.preNode4)
      }
      .width('80%')

      Row() {
        Slider({
          value: 50,
          min: 0,
          max: 100,
          style: SliderStyle.InSet
        })
          .blockColor('#191970')
          .trackColor('#ADD8E6')
          .selectedColor('#4169E1')
          .showTips(true)
          .trackThickness(36)
          .suffix(this.sufNode4)
      }
      .width('80%')

      Text('slider Show Step').fontSize(9).fontColor(0xCCCCCC).width('90%').margin(15)
      Row() {
        Slider({
          value: 50,
          min: 0,
          max: 100,
          step:10,
          style: SliderStyle.InSet
        })
          .blockColor('#191970')
          .trackColor('#ADD8E6')
          .selectedColor('#4169E1')
          .showTips(true)
          .trackThickness(36)
          .showSteps(true)
          .prefix(this.preNode5, {
            accessibilityText: 'prefixText',
            accessibilityDescription: 'prefixDescription',
            accessibilityLevel: 'auto',
            accessibilityGroup: true
          })
          .suffix(this.sufNode5, {
            accessibilityText: 'suffixText',
            accessibilityDescription: 'suffixDescription',
            accessibilityLevel: 'auto',
            accessibilityGroup: true
          })
      }
      .width('80%')

      Row() {
        Slider({
          value: 50,
          min: 0,
          max: 100,
          step:10,
          style: SliderStyle.InSet
        })
          .blockColor('#191970')
          .trackColor('#ADD8E6')
          .selectedColor('#4169E1')
          .showTips(true)
          .trackThickness(36)
          .showSteps(true)
          .prefix(this.preNode6, {
            accessibilityText: 'prefixText',
            accessibilityDescription: 'prefixDescription',
            accessibilityLevel: 'auto',
            accessibilityGroup: true
          })
      }
      .width('80%')
      
      Row() {
        Slider({
          value: 50,
          min: 0,
          max: 100,
          step:10,
          style: SliderStyle.InSet
        })
          .blockColor('#191970')
          .trackColor('#ADD8E6')
          .selectedColor('#4169E1')
          .showTips(true)
          .trackThickness(36)
          .showSteps(true)
          .suffix(this.sufNode6, {
            accessibilityText: 'suffixText',
            accessibilityDescription: 'suffixDescription',
            accessibilityLevel: 'auto',
            accessibilityGroup: true
          })
      }
      .width('80%')
    }.width('100%')
  }
}

[h2]示例6(滑动条设置刻度点无障碍文本)

通过showSteps属性设置刻度点的无障碍文本信息。设置后,屏幕阅读器将以设置的无障碍内容进行朗读。从API version 20开始,showSteps方法新增可选参数options。

class SliderBlockBorderColorModifier1 implements AttributeModifier<SliderAttribute>{
  optionMaps:Map<number, SliderStepItemAccessibility> = new Map()
    .set(1, {text : '123123'})
    .set(2, {text : 'Slider无障碍文本'})
    .set(3, {text : $r('app.string.stepItemText')})
    .set(4, {text : '!@#$%^&*()'});
  applyNormalAttribute(instance: SliderAttribute): void {
    instance.showSteps(true, {stepsAccessibility: this.optionMaps})
  }
}
@Entry
@Component
struct SliderExample {
  @State show: boolean = true;
  @State optionMaps:Map<number, SliderStepItemAccessibility> = new Map();
  private  sliderModifier: SliderBlockBorderColorModifier1 =new SliderBlockBorderColorModifier1()
  aboutToAppear(){
    this.optionMaps.set(1, {text : '123123'})
    this.optionMaps.set(2, {text : 'Slider无障碍文本'})
    this.optionMaps.set(3, {text : $r('app.string.app_name')})
    this.optionMaps.set(4, {text : '!@#$%^&*()'})
    this.show = true;
  }
  build() {
    Column({ space: 8 }) {
      Text('This is an example for showSteps attribute').fontSize(15).fontColor(0x000000).margin(15).width('90%')
      Row() {
        Slider({
          style: SliderStyle.InSet,
          value: 20,
          step: 10,
          max: 50,
          min: 0,
          direction: Axis.Horizontal
        })
          .stepSize(8)
          .stepColor(Color.Yellow)
          .showSteps(true, {stepsAccessibility: this.optionMaps})
      }.width('80%').height(100)
      Divider()
      Text('This is an example for showSteps attribute with modifier').fontSize(15).fontColor(0x000000).margin(15)
        .width('90%')
      Row() {
        Slider({
          style: SliderStyle.InSet,
          value: 20,
          step: 10,
          max: 50,
          min: 0,
          direction: Axis.Horizontal
        })
          .stepSize(8)
          .stepColor(Color.Yellow)
          .attributeModifier(this.sliderModifier)
      }.width('80%').height(100)
      Divider()
    }
  }
}

[h2]示例7(设置滑动条的双向绑定)

从API version 11开始,将SliderOptions的value属性设置为$$绑定的变量,实现数据同步。

// xxx.ets
@Entry
@Component
struct SliderExample {
  @State valueWith$: number = 40
  @State valueWithout$: number = 40
  build() {
    Column({ space: 20 }) {
      Text("使用$$双向绑定: " + this.valueWith$)
      Slider({
        value: $$this.valueWith$,
        min: 0,
        max: 100,
      })

      Text("不使用$$双向绑定: " + this.valueWithout$)
      Slider({
        value: this.valueWithout$,
        min: 0,
        max: 100,
      })
    }
  }
}

[h2]示例8(滑块设置渐变色)

通过blockColor属性设置滑块渐变色。

@Entry
@Component
struct SliderExample {
  @State colorGradient: LinearGradient = new LinearGradient([{ color: "#FFFFFF", offset: 0 }, { color: "#007DFF", offset: 1 }])

  build() {
    Column({ space: 10 }) {
      Slider({
        style:SliderStyle.OutSet,
        min: 0,
        max: 100,
      })
        .blockColor(this.colorGradient)
        .blockSize({width:"50vp",height:"50vp"})
      Slider({
        style:SliderStyle.OutSet,
        min: 0,
        max: 100,
        reverse: true
      })
        .blockColor(this.colorGradient)
        .blockSize({width:"50vp",height:"50vp"})
      Slider({
        style:SliderStyle.InSet,
        min: 0,
        max: 100,
      })
        .blockColor(this.colorGradient)
        .blockSize({width:"50vp",height:"50vp"})
      Slider({
        style:SliderStyle.InSet,
        min: 0,
        max: 100,
        reverse: true
      })
        .blockColor(this.colorGradient)
        .blockSize({width:"50vp",height:"50vp"})
      Slider({
        style:SliderStyle.NONE,
        min: 0,
        max: 100,
      })
        .blockColor(this.colorGradient)
        .blockSize({width:"50vp",height:"50vp"})
      Slider({
        style:SliderStyle.NONE,
        min: 0,
        max: 100,
        reverse: true
      })
        .blockColor(this.colorGradient)
        .blockSize({width:"50vp",height:"50vp"})

      Row({ space: 20 }){
        Slider({
          style:SliderStyle.OutSet,
          min: 0,
          max: 100,
          direction:Axis.Vertical
        })
          .blockColor(this.colorGradient)
          .blockSize({width:"50vp",height:"50vp"})
        Slider({
          style:SliderStyle.OutSet,
          min: 0,
          max: 100,
          reverse: true,
          direction:Axis.Vertical
        })
          .blockColor(this.colorGradient)
          .blockSize({width:"50vp",height:"50vp"})
        Slider({
          style:SliderStyle.InSet,
          min: 0,
          max: 100,
          direction:Axis.Vertical
        })
          .blockColor(this.colorGradient)
          .blockSize({width:"50vp",height:"50vp"})
        Slider({
          style:SliderStyle.InSet,
          min: 0,
          max: 100,
          reverse: true,
          direction:Axis.Vertical
        })
          .blockColor(this.colorGradient)
          .blockSize({width:"50vp",height:"50vp"})
        Slider({
          style:SliderStyle.NONE,
          min: 0,
          max: 100,
          direction:Axis.Vertical
        })
          .blockColor(this.colorGradient)
          .blockSize({width:"50vp",height:"50vp"})
        Slider({
          style:SliderStyle.NONE,
          min: 0,
          max: 100,
          reverse: true,
          direction:Axis.Vertical
        })
          .blockColor(this.colorGradient)
          .blockSize({width:"50vp",height:"50vp"})
      }.height("50%")
    }.width("100%")

  }
}

[h2]示例9(设置滑轨的背景颜色)

通过trackColorMetrics设置指定色域的渐变断点值。示例中的colorSpace使用了ColorSpace.DISPLAY_P3类型,需要对应窗口调用setWindowColorSpace接口,将当前窗口设置为广色域模式,设置窗口色域模式为广色域参照方法setWindowColorSpace。

从API version 23开始,新增trackColorMetrics接口。

// xxx.ets
import { ColorMetrics } from '@kit.ArkUI';

@Entry
@Component
struct SliderExample {
  @State greenColor: ColorMetrics = ColorMetrics.colorWithSpace(ColorSpace.DISPLAY_P3, 0.0, 1.0, 0.0, 1);
  @State yellowColor: ColorMetrics = ColorMetrics.colorWithSpace(ColorSpace.DISPLAY_P3, 1.0, 1.0, 0.0, 1);
  @State inSetValueOne: number = 40;
  @State color: ColorMetricsLinearGradient =
    new ColorMetricsLinearGradient([{ color: this.greenColor, offset: 0 }, { color: this.yellowColor, offset: 1 }])

  build() {
    Column({ space: 8 }) {
      Slider({
        value: this.inSetValueOne,
        min: 0,
        max: 100,
        style: SliderStyle.InSet
      }).margin('10')
        .width('80%')
        .blockColor('#FF0000')
        .trackColorMetrics(this.color)
        .selectedColor('#4169E1')
        .showTips(true)
        .onChange((value: number, mode: SliderChangeMode) => {
          this.inSetValueOne = value;
          console.info('value:' + value + 'mode:' + mode.toString());
        })
    }.alignItems(HorizontalAlign.Center)
    .width('100%')
  }
}

[h2]示例10(设置滑动条的沉浸光感效果)

该示例通过通用属性systemMaterial设置滑动条的系统材质,实现沉浸光感效果。设置系统材质后,Slider滑动过程中会产生粒子动画效果。

该示例配图为高算力设备强档效果,组件沉浸光感效果会根据设备算力与用户在系统中设置的沉浸光感效果自适应调整,开发者无需额外适配。

从API版本26.0.0开始,新增systemMaterial接口。

// xxx.ets
import { uiMaterial } from '@kit.ArkUI';

@Entry
@Component
struct SliderSystemMaterial {
  build() {
    RelativeContainer() {
      Slider({
        style: SliderStyle.InSet
      })
        .alignRules({
          center: { anchor: '__container__', align: VerticalAlign.Center },
          middle: { anchor: '__container__', align: HorizontalAlign.Center },
        })
        .systemMaterial(new uiMaterial.ImmersiveMaterial({
          style: uiMaterial.ImmersiveStyle.ULTRA_THIN,
        }))
    }
    .height('100%')
    .width('100%')
    // 请开发者替换为实际资源文件
    .backgroundImage($r("app.media.img"))
  }
}

未设置系统材质时:

设置系统材质后: