SegmentedButton 分段按钮

分段按钮组件封装了一组按钮，用于提供选项、切换视图或对元素进行排序等。

使用方法

按需导入组件：

import 'mdui/components/segmented-button-group.js';
import 'mdui/components/segmented-button.js';

按需导入组件的 TypeScript 类型：

import type { SegmentedButtonGroup } from 'mdui/components/segmented-button-group.js';
import type { SegmentedButton } from 'mdui/components/segmented-button.js';

使用示例：

Day

Week

Month

<mdui-segmented-button-group>
  <mdui-segmented-button>Day</mdui-segmented-button>
  <mdui-segmented-button>Week</mdui-segmented-button>
  <mdui-segmented-button>Month</mdui-segmented-button>
</mdui-segmented-button-group>

示例

全宽显示

在 <mdui-segmented-button-group> 元素上添加 full-width 属性，可使组件占据全部宽度。

Day

Week

Month

<mdui-segmented-button-group full-width>
  <mdui-segmented-button>Day</mdui-segmented-button>
  <mdui-segmented-button>Week</mdui-segmented-button>
  <mdui-segmented-button>Month</mdui-segmented-button>
</mdui-segmented-button-group>

源码

单选模式

在 <mdui-segmented-button-group> 元素上指定 selects 属性为 single，可以实现单选模式。此时 <mdui-segmented-button-group> 的 value 属性值即为当前选中的 <mdui-segmented-button> 的 value 属性的值。

Day

Week

Month

Day

Week

Month

<mdui-segmented-button-group selects="single">
  <mdui-segmented-button value="day">Day</mdui-segmented-button>
  <mdui-segmented-button value="week">Week</mdui-segmented-button>
  <mdui-segmented-button value="month">Month</mdui-segmented-button>
</mdui-segmented-button-group>

<mdui-segmented-button-group selects="single" value="week">
  <mdui-segmented-button value="day">Day</mdui-segmented-button>
  <mdui-segmented-button value="week">Week</mdui-segmented-button>
  <mdui-segmented-button value="month">Month</mdui-segmented-button>
</mdui-segmented-button-group>

源码

多选模式

在 <mdui-segmented-button-group> 元素上指定 selects 属性为 multiple，可以实现多选模式。此时 <mdui-segmented-button-group> 的 value 属性值为当前选中的 <mdui-segmented-button> 的 value 属性的值组成的数组。

注意：在多选模式下，<mdui-segmented-button-group> 的 value 属性值为数组，只能通过 JavaScript 属性来读取和设置该值。

Day

Week

Month

Day

Week

Month

<mdui-segmented-button-group selects="multiple">
  <mdui-segmented-button value="day">Day</mdui-segmented-button>
  <mdui-segmented-button value="week">Week</mdui-segmented-button>
  <mdui-segmented-button value="month">Month</mdui-segmented-button>
</mdui-segmented-button-group>

<mdui-segmented-button-group selects="multiple" class="demo-multiple">
  <mdui-segmented-button value="day">Day</mdui-segmented-button>
  <mdui-segmented-button value="week">Week</mdui-segmented-button>
  <mdui-segmented-button value="month">Month</mdui-segmented-button>
</mdui-segmented-button-group>

<script>
  // 设置默认选中 week 和 month
  const group = document.querySelector(".demo-multiple");
  group.value = ["week", "month"];
</script>

源码

图标

在 <mdui-segmented-button> 元素上，通过设置 icon 和 end-icon 属性，可以在按钮的左侧和右侧添加 Material Icons 图标。另外，也可以通过 icon 和 end-icon slot 在按钮的左侧和右侧添加元素。

Day

Week

Month

<mdui-segmented-button-group>
  <mdui-segmented-button icon="search">Day</mdui-segmented-button>
  <mdui-segmented-button end-icon="arrow_forward">Week</mdui-segmented-button>
  <mdui-segmented-button>
    Month
    <mdui-icon slot="icon" name="downloading"></mdui-icon>
    <mdui-icon slot="end-icon" name="attach_file"></mdui-icon>
  </mdui-segmented-button>
</mdui-segmented-button-group>

源码

在 <mdui-segmented-button> 元素上，通过添加 selected-icon 属性，可以设置选中状态的 Material Icons 图标。也可以通过 selected-icon slot 进行设置。

Day

Week

<mdui-segmented-button-group selects="multiple">
  <mdui-segmented-button value="day" selected-icon="cloud_done">Day</mdui-segmented-button>
  <mdui-segmented-button value="week">
    <mdui-icon slot="selected-icon" name="cloud_done"></mdui-icon>
    Week
  </mdui-segmented-button>
</mdui-segmented-button-group>

源码

链接

在 <mdui-segmented-button> 元素上，通过设置 href 属性，可以将按钮转换为链接。此时，还可以使用与链接相关的属性，如：download、target、rel。

Link

Week

Month

<mdui-segmented-button-group>
  <mdui-segmented-button href="https://www.mdui.org" target="_blank">Link</mdui-segmented-button>
  <mdui-segmented-button>Week</mdui-segmented-button>
  <mdui-segmented-button>Month</mdui-segmented-button>
</mdui-segmented-button-group>

源码

禁用及加载中状态

在 <mdui-segmented-button-group> 元素上，通过添加 disabled 属性，可以禁用整个分段按钮组。

Day

Week

Month

<mdui-segmented-button-group disabled>
  <mdui-segmented-button>Day</mdui-segmented-button>
  <mdui-segmented-button>Week</mdui-segmented-button>
  <mdui-segmented-button>Month</mdui-segmented-button>
</mdui-segmented-button-group>

源码

在 <mdui-segmented-button> 元素上，通过添加 disabled 属性，可以禁用特定按钮；通过添加 loading 属性，可以为特定按钮添加加载中状态。

Day

Week

Month

Year

<mdui-segmented-button-group>
  <mdui-segmented-button>Day</mdui-segmented-button>
  <mdui-segmented-button disabled>Week</mdui-segmented-button>
  <mdui-segmented-button loading>Month</mdui-segmented-button>
  <mdui-segmented-button disabled loading>Year</mdui-segmented-button>
</mdui-segmented-button-group>

源码

`mdui-segmented-button-group` API

属性

HTML 属性	JavaScript 属性	类型	默认值
`full-width`	`fullWidth`	`boolean`	`false`
是否填满父元素宽度
`selects`	`selects`	`'single' \| 'multiple'`	-
分段按钮的可选中状态，默认为不可选中。可选值包括： `single`：单选 `multiple`：多选
`disabled`	`disabled`	`boolean`	`false`
是否为禁用状态
`required`	`required`	`boolean`	`false`
提交表单时，是否必须选中
`form`	`form`	`string`	-
关联的 `<form>` 元素。此属性值应为同一页面中的一个 `<form>` 元素的 `id`。如果未指定此属性，则该元素必须是 `<form>` 元素的子元素。通过此属性，你可以将元素放置在页面的任何位置，而不仅仅是 `<form>` 元素的子元素。
`name`	`name`	`string`	`''`
提交表单时的名称，将与表单数据一起提交
`value`	`value`	`string \| string[]`	`''`
当前选中的 `<mdui-segmented-button>` 的值。 Note：该属性的 HTML 属性始终为字符串，且仅在 `selects="single"` 时可以通过 HTML 属性设置初始值。该属性的 JavaScript 属性值在 `selects="single"` 时为字符串，在 `selects="multiple"` 时为字符串数组。所以，在 `selects="multiple"` 时，如果要修改该值，只能通过修改 JavaScript 属性值实现。
	`defaultValue`	`string \| string[]`	`''`
默认选中的值。在重置表单时，将重置为该默认值。该属性只能通过 JavaScript 属性设置
	`validity`	`ValidityState`	-
表单验证状态对象，具体参见 `ValidityState`
	`validationMessage`	`string`	-
如果表单验证未通过，此属性将包含提示信息。如果验证通过，此属性将为空字符串

方法

名称	参数	返回值
`checkValidity`		`boolean`
检查表单字段是否通过验证。如果未通过，返回 `false` 并触发 `invalid` 事件；如果通过，返回 `true`
`reportValidity`		`boolean`
检查表单字段是否通过验证。如果未通过，返回 `false` 并触发 `invalid` 事件；如果通过，返回 `true`。如果验证未通过，还会在组件上显示验证失败的提示。
`setCustomValidity`	`message: string`	`void`
设置自定义的错误提示文本。只要这个文本不为空，就表示字段未通过验证

事件

名称
`change`
选中的值变更时触发
`invalid`
表单字段验证未通过时触发

Slots

名称
默认
`<mdui-segmented-button>` 组件

CSS 自定义属性

名称
`--shape-corner`
组件的圆角大小。可以指定一个具体的像素值；但更推荐引用设计令牌

`mdui-segmented-button` API

属性

HTML 属性	JavaScript 属性	类型	默认值
`icon`	`icon`	`string`	-
左侧的 Material Icons 图标名。也可以通过 `slot="icon"` 设置
`end-icon`	`endIcon`	`string`	-
右侧的 Material Icons 图标名。也可以通过 `slot="end-icon"` 设置
`selected-icon`	`selectedIcon`	`string`	-
选中状态的 Material Icons 图标名。也可以通过 `slot="selected-icon"` 设置
`href`	`href`	`string`	-
链接的目标 URL。如果设置了此属性，组件内部将渲染为 `<a>` 元素，并可以使用链接相关的属性。
`download`	`download`	`string`	-
下载链接的目标。 Note：仅在设置了 `href` 属性时，此属性才有效。
`target`	`target`	`'_blank' \| '_parent' \| '_self' \| '_top'`	-
链接的打开方式。可选值包括： `_blank`：在新窗口中打开链接 `_parent`：在父框架中打开链接 `_self`：默认。在当前框架中打开链接 `_top`：在整个窗口中打开链接 Note：仅在设置了 `href` 属性时，此属性才有效。
`rel`	`rel`	`'alternate' \| 'author' \| 'bookmark' \| 'external' \| 'help' \| 'license' \| 'me' \| 'next' \| 'nofollow' \| 'noreferrer' \| 'opener' \| 'prev' \| 'search' \| 'tag'`	-
当前文档与被链接文档之间的关系。可选值包括： `alternate`：当前文档的替代版本 `author`：当前文档或文章的作者 `bookmark`：永久链接到最近的祖先章节 `external`：引用的文档与当前文档不在同一站点 `help`：链接到相关的帮助文档 `license`：当前文档的主要内容由被引用文件的版权许可覆盖 `me`：当前文档代表链接内容的所有者 `next`：当前文档是系列中的一部分，被引用的文档是系列的下一个文档 `nofollow`：当前文档的作者或发布者不认可被引用的文件 `noreferrer`：不包含 `Referer` 头。类似于 `noopener` 的效果 `opener`：如果超链接会创建一个顶级浏览上下文（即 `target` 属性值为 `_blank`），则创建一个辅助浏览上下文 `prev`：当前文档是系列的一部分，被引用的文档是系列的上一个文档 `search`：提供一个资源链接，可用于搜索当前文件及其相关页面 `tag`：提供一个适用于当前文档的标签（由给定地址识别） Note：仅在指定了 `href` 属性时可用。
`autofocus`	`autofocus`	`boolean`	`false`
是否在页面加载完成后自动获取焦点
`tabindex`	`tabIndex`	`number`	-
元素在使用 Tab 键切换焦点时的顺序
`disabled`	`disabled`	`boolean`	`false`
是否禁用
`loading`	`loading`	`boolean`	`false`
是否处于加载中状态
`name`	`name`	`string`	`''`
按钮的名称，将与表单数据一起提交。 Note：仅在未设置 `href` 属性时，此属性才有效。
`value`	`value`	`string`	`''`
按钮的初始值，将与表单数据一起提交。 Note：仅在未设置 `href` 属性时，此属性才有效。
`type`	`type`	`'submit' \| 'reset' \| 'button'`	`'button'`
按钮的类型。默认类型为 `button`。可选类型包括： `submit`：点击按钮会提交表单数据到服务器 `reset`：点击按钮会将表单中的所有字段重置为初始值 `button`：此类型的按钮没有默认行为 Note：仅在未指定 `href` 属性时，此属性才有效。
`form`	`form`	`string`	-
关联的 `<form>` 元素。此属性值应为同一页面中的一个 `<form>` 元素的 `id`。如果未指定此属性，则该元素必须是 `<form>` 元素的子元素。通过此属性，你可以将元素放置在页面的任何位置，而不仅仅是 `<form>` 元素的子元素。 Note：仅在未指定 `href` 属性时，此属性才有效。
`formaction`	`formAction`	`string`	-
指定提交表单的 URL。如果指定了此属性，将覆盖 `<form>` 元素的 `action` 属性。 Note：仅在未指定 `href` 属性且 `type="submit"` 时，此属性才有效。
`formenctype`	`formEnctype`	`'application/x-www-form-urlencoded' \| 'multipart/form-data' \| 'text/plain'`	-
指定提交表单到服务器的内容类型。可选值包括： `application/x-www-form-urlencoded`：未指定该属性时的默认值 `multipart/form-data`：当表单包含 `<input type="file">` 元素时使用 `text/plain`：HTML5 新增，用于调试如果指定了此属性，将覆盖 `<form>` 元素的 `enctype` 属性。 Note：仅在未指定 `href` 属性且 `type="submit"` 时，此属性才有效。
`formmethod`	`formMethod`	`'post' \| 'get'`	-
指定提交表单时使用的 HTTP 方法。可选值包括： `post`：表单数据包含在表单内容中，发送到服务器 `get`：表单数据以 `?` 作为分隔符附加到表单的 URI 属性中，生成的 URI 发送到服务器。当表单没有副作用，并且仅包含 ASCII 字符时，使用此方法如果设置了此属性，将覆盖 `<form>` 元素的 `method` 属性。 Note：仅在未设置 `href` 属性且 `type="submit"` 时，此属性才有效。
`formnovalidate`	`formNoValidate`	`boolean`	`false`
如果设置了此属性，表单提交时将不执行表单验证。如果设置了此属性，将覆盖 `<form>` 元素的 `novalidate` 属性。 Note：仅在未设置 `href` 属性且 `type="submit"` 时，此属性才有效。
`formtarget`	`formTarget`	`'_self' \| '_blank' \| '_parent' \| '_top'`	-
提交表单后接收到的响应应显示在何处。可选值包括： `_self`：默认选项，在当前框架中打开 `_blank`：在新窗口中打开 `_parent`：在父框架中打开 `_top`：在整个窗口中打开如果设置了此属性，将覆盖 `<form>` 元素的 `target` 属性。 Note：仅在未设置 `href` 属性且 `type="submit"` 时，此属性才有效。
	`validity`	`ValidityState`	-
表单验证状态对象，具体参见 `ValidityState`
	`validationMessage`	`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`
失去焦点时触发
`invalid`
表单字段验证未通过时触发

Slots

名称
默认
分段按钮项的文本内容
`icon`
分段按钮项的左侧图标
`selected-icon`
选中状态的左侧图标
`end-icon`
分段按钮项的右侧图标

CSS Parts

名称
`button`
内部的 `<button>` 或 `<a>` 元素
`icon`
左侧的图标
`selected-icon`
选中状态的左侧图标
`end-icon`
右侧的图标
`label`
文本内容
`loading`
加载中状态的 `<mdui-circular-progress>` 元素

Fab 浮动操作按钮

Chip 纸片