Slider 滑块

滑块组件允许用户在一系列值中进行选择。

使用方法

按需导入组件：

import 'mdui/components/slider.js';

按需导入组件的 TypeScript 类型：

import type { Slider } from 'mdui/components/slider.js';

使用示例：

<mdui-slider></mdui-slider>

示例

默认值

通过 value 属性，可以读取或设置滑块的当前值。

<mdui-slider value="50"></mdui-slider>

源码

禁用状态

添加 disabled 属性可以禁用滑块。

<mdui-slider disabled></mdui-slider>

源码

范围

使用 min 和 max 属性来设置滑块的最小值和最大值。

<mdui-slider min="10" max="20"></mdui-slider>

源码

步进间隔

通过 step 属性，你可以设置滑块的步进间隔。

<mdui-slider step="10"></mdui-slider>

源码

刻度标记

添加 tickmarks 属性，可以在滑块上显示刻度标记。

<mdui-slider tickmarks step="10"></mdui-slider>

源码

隐藏文本提示

如果你想隐藏滑块上的文本提示，可以添加 nolabel 属性。

<mdui-slider nolabel></mdui-slider>

源码

修改文本提示

可以通过 labelFormatter JavaScript 属性来修改文本提示的显示格式。这个属性的值应该是一个函数，该函数接收当前滑块的值作为参数，返回你希望显示的文本。

<mdui-slider class="example-label-formatter"></mdui-slider>

<script>
  const slider = document.querySelector(".example-label-formatter");
  slider.labelFormatter = (value) => `${value} 小时`;
</script>

源码

API

属性

HTML 属性	JavaScript 属性	类型	默认值
`value`	`value`	`number`	`0`
滑块的值，将于表单数据一起提交
	`defaultValue`	`number`	`0`
默认值。在重置表单时，将重置为该默认值。该属性只能通过 JavaScript 属性设置
`autofocus`	`autofocus`	`boolean`	`false`
是否在页面加载完成后自动获取焦点
`tabindex`	`tabIndex`	`number`	-
元素在使用 Tab 键切换焦点时的顺序
`min`	`min`	`number`	`0`
滑块的最小值，默认为 `0`
`max`	`max`	`number`	`100`
滑块的最大值，默认为 `100`
`step`	`step`	`number`	`1`
步进间隔，默认为 `1`
`tickmarks`	`tickmarks`	`boolean`	`false`
是否添加刻度标记
`nolabel`	`nolabel`	`boolean`	`false`
是否隐藏文本提示
`disabled`	`disabled`	`boolean`	`false`
是否被禁用
`form`	`form`	`string`	-
关联的 `<form>` 元素。此属性值应为同一页面中的一个 `<form>` 元素的 `id`。如果未指定此属性，则该元素必须是 `<form>` 元素的子元素。通过此属性，你可以将元素放置在页面的任何位置，而不仅仅是 `<form>` 元素的子元素。
`name`	`name`	`string`	`''`
滑块的名称，该名称将与表单数据一起提交
	`validity`	`ValidityState`	-
表单验证状态对象，具体参见 `ValidityState`
	`validationMessage`	`string`	-
如果表单验证未通过，此属性将包含提示信息。如果验证通过，此属性将为空字符串
	`labelFormatter`	`(value: number) => string`	-
用于自定义标签的显示格式的函数。函数参数为滑块的当前值，返回值为期望显示的文本。

方法

名称	参数	返回值
`click`		`void`
模拟鼠标点击元素
`focus`	`options: FocusOptions` (可选)	`void`
将焦点设置到当前元素。可以传入一个对象作为参数，该对象的属性包括： `preventScroll`：默认情况下，元素获取焦点后，页面会滚动以将该元素滚动到视图中。如果不希望页面滚动，可以将此属性设置为 `true`。
`blur`		`void`
移除当前元素的焦点
`checkValidity`		`boolean`
检查表单字段是否通过验证。如果未通过，返回 `false` 并触发 `invalid` 事件；如果通过，返回 `true`
`reportValidity`		`boolean`
检查表单字段是否通过验证。如果未通过，返回 `false` 并触发 `invalid` 事件；如果通过，返回 `true`。如果验证未通过，还会在组件上显示验证失败的提示。
`setCustomValidity`	`message: string`	`void`
设置自定义的错误提示文本。只要这个文本不为空，就表示字段未通过验证

事件

名称
`focus`
获得焦点时触发
`blur`
失去焦点时触发
`change`
在值发生变更，且失去焦点时，将触发该事件
`input`
值变更时触发
`invalid`
表单字段验证未通过时触发

CSS Parts

名称
`track-inactive`
未激活状态的轨道
`track-active`
已激活状态的轨道
`handle`
操作杆
`label`
提示文本
`tickmark`
刻度标记

Switch 开关切换

RangeSlider 范围滑块