mdui
Version:
实现 material you 设计规范的 Web Components 组件库
1,160 lines • 671 kB
JSON
{
"$schema": "http://json.schemastore.org/web-types",
"name": "mdui",
"version": "2.1.4",
"js-types-syntax": "typescript",
"description-markup": "markdown",
"framework-config": {
"enable-when": {
"node-packages": [
"mdui"
]
}
},
"contributions": {
"html": {
"elements": [
{
"name": "mdui-avatar",
"description": "头像组件\n\n```html\n<mdui-avatar src=\"https://avatars githubusercontent com/u/3030330?s=40&v=4\"></mdui-avatar>\n```",
"attributes": [
{
"name": "src",
"description": "头像图片的 URL 地址",
"value": {
"type": "string"
},
"doc-url": "https://www.mdui.org/zh-cn/docs/2/components/avatar#attributes-src"
},
{
"name": "fit",
"description": "图片如何适应容器框,与原生的 [`object-fit`](https://developer.mozilla.org/en-US/docs/Web/CSS/object-fit) 属性相同。可选值包括:\n\n* `contain`:保持图片原有尺寸比例,内容会被等比例缩放\n* `cover`:保持图片原有尺寸比例,但部分内容可能被剪切\n* `fill`:默认值,不保持图片原有尺寸比例,内容会被拉伸以填充整个容器\n* `none`:保留图片原有尺寸,内容不会被缩放或拉伸\n* `scale-down`:保持图片原有尺寸比例,内容尺寸与 `none` 或 `contain` 中较小的一个相同",
"value": {
"type": [
"'contain'",
"'cover'",
"'fill'",
"'none'",
"'scale-down'"
]
},
"doc-url": "https://www.mdui.org/zh-cn/docs/2/components/avatar#attributes-fit"
},
{
"name": "icon",
"description": "头像的 Material Icons 图标名",
"value": {
"type": "string"
},
"doc-url": "https://www.mdui.org/zh-cn/docs/2/components/avatar#attributes-icon"
},
{
"name": "label",
"description": "头像的替代文本描述",
"value": {
"type": "string"
},
"doc-url": "https://www.mdui.org/zh-cn/docs/2/components/avatar#attributes-label"
}
],
"priority": "highest",
"doc-url": "https://www.mdui.org/zh-cn/docs/2/components/avatar",
"slots": [
{
"name": "",
"description": "自定义头像内容,可以为字母、汉字、`<img>` 元素、图标等",
"doc-url": "https://www.mdui.org/zh-cn/docs/2/components/avatar#slots-default"
}
],
"js": {
"properties": [
{
"name": "src",
"description": "头像图片的 URL 地址",
"value": {
"type": "string"
},
"doc-url": "https://www.mdui.org/zh-cn/docs/2/components/avatar#attributes-src"
},
{
"name": "fit",
"description": "图片如何适应容器框,与原生的 [`object-fit`](https://developer.mozilla.org/en-US/docs/Web/CSS/object-fit) 属性相同。可选值包括:\n\n* `contain`:保持图片原有尺寸比例,内容会被等比例缩放\n* `cover`:保持图片原有尺寸比例,但部分内容可能被剪切\n* `fill`:默认值,不保持图片原有尺寸比例,内容会被拉伸以填充整个容器\n* `none`:保留图片原有尺寸,内容不会被缩放或拉伸\n* `scale-down`:保持图片原有尺寸比例,内容尺寸与 `none` 或 `contain` 中较小的一个相同",
"value": {
"type": [
"'contain'",
"'cover'",
"'fill'",
"'none'",
"'scale-down'"
]
},
"doc-url": "https://www.mdui.org/zh-cn/docs/2/components/avatar#attributes-fit"
},
{
"name": "icon",
"description": "头像的 Material Icons 图标名",
"value": {
"type": "string"
},
"doc-url": "https://www.mdui.org/zh-cn/docs/2/components/avatar#attributes-icon"
},
{
"name": "label",
"description": "头像的替代文本描述",
"value": {
"type": "string"
},
"doc-url": "https://www.mdui.org/zh-cn/docs/2/components/avatar#attributes-label"
}
]
},
"css": {
"properties": [
{
"name": "--shape-corner",
"description": "组件的圆角大小。可以指定一个具体的像素值;但更推荐引用[设计令牌](https://www.mdui.org/zh-cn/docs/2/styles/design-tokens#shape-corner)",
"doc-url": "https://www.mdui.org/zh-cn/docs/2/components/avatar#cssProperties-shape-corner"
}
],
"parts": [
{
"name": "image",
"description": "使用图片作为头像时,组件内部的 `<img>` 元素",
"doc-url": "https://www.mdui.org/zh-cn/docs/2/components/avatar#cssParts-image"
},
{
"name": "icon",
"description": "使用图标作为头像时,组件内部的 `<mdui-icon>` 元素",
"doc-url": "https://www.mdui.org/zh-cn/docs/2/components/avatar#cssParts-icon"
}
]
}
},
{
"name": "mdui-badge",
"description": "徽标组件\n\n```html\n<mdui-badge>12</mdui-badge>\n```",
"attributes": [
{
"name": "variant",
"description": "徽标的形状。可选值包括:\n\n* `small`:小型徽标,不显示文本\n* `large`:大型徽标,会显示文本",
"value": {
"type": [
"'small'",
"'large'"
]
},
"doc-url": "https://www.mdui.org/zh-cn/docs/2/components/badge#attributes-variant"
}
],
"priority": "highest",
"doc-url": "https://www.mdui.org/zh-cn/docs/2/components/badge",
"slots": [
{
"name": "",
"description": "徽标中显示的文本",
"doc-url": "https://www.mdui.org/zh-cn/docs/2/components/badge#slots-default"
}
],
"js": {
"properties": [
{
"name": "variant",
"description": "徽标的形状。可选值包括:\n\n* `small`:小型徽标,不显示文本\n* `large`:大型徽标,会显示文本",
"value": {
"type": [
"'small'",
"'large'"
]
},
"doc-url": "https://www.mdui.org/zh-cn/docs/2/components/badge#attributes-variant"
}
]
},
"css": {
"properties": [
{
"name": "--shape-corner",
"description": "组件的圆角大小。可以指定一个具体的像素值;但更推荐引用[设计令牌](https://www.mdui.org/zh-cn/docs/2/styles/design-tokens#shape-corner)",
"doc-url": "https://www.mdui.org/zh-cn/docs/2/components/badge#cssProperties-shape-corner"
}
]
}
},
{
"name": "mdui-bottom-app-bar",
"description": "底部应用栏组件\n\n```html\n<mdui-bottom-app-bar>\n <mdui-button-icon icon=\"check_box--outlined\"></mdui-button-icon>\n <mdui-button-icon icon=\"edit--outlined\"></mdui-button-icon>\n <mdui-button-icon icon=\"mic_none--outlined\"></mdui-button-icon>\n <mdui-button-icon icon=\"image--outlined\"></mdui-button-icon>\n <div style=\"flex-grow: 1\"></div>\n <mdui-fab icon=\"add\"></mdui-fab>\n</mdui-bottom-app-bar>\n```",
"attributes": [
{
"name": "hide",
"description": "是否隐藏",
"value": {
"type": "boolean"
},
"doc-url": "https://www.mdui.org/zh-cn/docs/2/components/bottom-app-bar#attributes-hide"
},
{
"name": "fab-detach",
"description": "是否让底部应用栏中的 [`<mdui-fab>`](https://www.mdui.org/zh-cn/docs/2/components/fab) 组件脱离应用栏。如果为 `true`,则当应用栏隐藏后,[`<mdui-fab>`](https://www.mdui.org/zh-cn/docs/2/components/fab) 仍会停留在页面上",
"value": {
"type": "boolean"
},
"doc-url": "https://www.mdui.org/zh-cn/docs/2/components/bottom-app-bar#attributes-fab-detach"
},
{
"name": "scroll-behavior",
"description": "滚动行为。可选值为:\n\n* `hide`:滚动时隐藏",
"value": {
"type": [
"'hide'",
"'shrink'",
"'elevate'"
]
},
"doc-url": "https://www.mdui.org/zh-cn/docs/2/components/bottom-app-bar#attributes-scroll-behavior"
},
{
"name": "scroll-target",
"description": "需要监听其滚动事件的元素。值可以是 CSS 选择器、DOM 元素、或 [JQ 对象](https://www.mdui.org/zh-cn/docs/2/functions/jq)。默认监听 `window` 的滚动事件",
"value": {
"type": [
"string",
"HTMLElement",
"JQ<HTMLElement>"
]
},
"doc-url": "https://www.mdui.org/zh-cn/docs/2/components/bottom-app-bar#attributes-scroll-target"
},
{
"name": "scroll-threshold",
"description": "在滚动多少距离之后触发滚动行为,单位为 `px`",
"value": {
"type": "number"
},
"doc-url": "https://www.mdui.org/zh-cn/docs/2/components/bottom-app-bar#attributes-scroll-threshold"
},
{
"name": "order",
"description": "该组件在 [`<mdui-layout>`](https://www.mdui.org/zh-cn/docs/2/components/layout) 中的布局顺序,按从小到大排序。默认为 `0`",
"value": {
"type": "number"
},
"doc-url": "https://www.mdui.org/zh-cn/docs/2/components/bottom-app-bar#attributes-order"
}
],
"priority": "highest",
"doc-url": "https://www.mdui.org/zh-cn/docs/2/components/bottom-app-bar",
"slots": [
{
"name": "",
"description": "底部应用栏内部的元素",
"doc-url": "https://www.mdui.org/zh-cn/docs/2/components/bottom-app-bar#slots-default"
}
],
"js": {
"properties": [
{
"name": "hide",
"description": "是否隐藏",
"value": {
"type": "boolean"
},
"doc-url": "https://www.mdui.org/zh-cn/docs/2/components/bottom-app-bar#attributes-hide"
},
{
"name": "fabDetach",
"description": "是否让底部应用栏中的 [`<mdui-fab>`](https://www.mdui.org/zh-cn/docs/2/components/fab) 组件脱离应用栏。如果为 `true`,则当应用栏隐藏后,[`<mdui-fab>`](https://www.mdui.org/zh-cn/docs/2/components/fab) 仍会停留在页面上",
"value": {
"type": "boolean"
},
"doc-url": "https://www.mdui.org/zh-cn/docs/2/components/bottom-app-bar#attributes-fabDetach"
},
{
"name": "scrollBehavior",
"description": "滚动行为。可选值为:\n\n* `hide`:滚动时隐藏",
"value": {
"type": [
"'hide'",
"'shrink'",
"'elevate'"
]
},
"doc-url": "https://www.mdui.org/zh-cn/docs/2/components/bottom-app-bar#attributes-scrollBehavior"
},
{
"name": "scrollTarget",
"description": "需要监听其滚动事件的元素。值可以是 CSS 选择器、DOM 元素、或 [JQ 对象](https://www.mdui.org/zh-cn/docs/2/functions/jq)。默认监听 `window` 的滚动事件",
"value": {
"type": [
"string",
"HTMLElement",
"JQ<HTMLElement>"
]
},
"doc-url": "https://www.mdui.org/zh-cn/docs/2/components/bottom-app-bar#attributes-scrollTarget"
},
{
"name": "scrollThreshold",
"description": "在滚动多少距离之后触发滚动行为,单位为 `px`",
"value": {
"type": "number"
},
"doc-url": "https://www.mdui.org/zh-cn/docs/2/components/bottom-app-bar#attributes-scrollThreshold"
},
{
"name": "order",
"description": "该组件在 [`<mdui-layout>`](https://www.mdui.org/zh-cn/docs/2/components/layout) 中的布局顺序,按从小到大排序。默认为 `0`",
"value": {
"type": "number"
},
"doc-url": "https://www.mdui.org/zh-cn/docs/2/components/bottom-app-bar#attributes-order"
}
],
"events": [
{
"name": "show",
"description": "开始显示时,事件被触发。可以通过调用 `event.preventDefault()` 阻止显示",
"doc-url": "https://www.mdui.org/zh-cn/docs/2/components/bottom-app-bar#events-show"
},
{
"name": "shown",
"description": "显示动画完成时,事件被触发",
"doc-url": "https://www.mdui.org/zh-cn/docs/2/components/bottom-app-bar#events-shown"
},
{
"name": "hide",
"description": "开始隐藏时,事件被触发。可以通过调用 `event.preventDefault()` 阻止隐藏",
"doc-url": "https://www.mdui.org/zh-cn/docs/2/components/bottom-app-bar#events-hide"
},
{
"name": "hidden",
"description": "隐藏动画完成时,事件被触发",
"doc-url": "https://www.mdui.org/zh-cn/docs/2/components/bottom-app-bar#events-hidden"
}
]
},
"css": {
"properties": [
{
"name": "--shape-corner",
"description": "组件的圆角大小。可以指定一个具体的像素值;但更推荐引用[设计令牌](https://www.mdui.org/zh-cn/docs/2/styles/design-tokens#shape-corner)",
"doc-url": "https://www.mdui.org/zh-cn/docs/2/components/bottom-app-bar#cssProperties-shape-corner"
},
{
"name": "--z-index",
"description": "组件的 CSS `z-index` 值",
"doc-url": "https://www.mdui.org/zh-cn/docs/2/components/bottom-app-bar#cssProperties-z-index"
}
]
}
},
{
"name": "mdui-button-icon",
"description": "图标按钮组件\n\n```html\n<mdui-button-icon icon=\"search\"></mdui-button-icon>\n```",
"attributes": [
{
"name": "variant",
"description": "图标按钮的形状。可选值包括:\n\n* `standard`:适用于最低优先级的操作\n* `filled`:视觉效果强烈,适用于高优先级的操作\n* `tonal`:视觉效果介于 `filled` 和 `outlined` 之间,适用于中高优先级的操作\n* `outlined`:适用于中等优先级的操作",
"value": {
"type": [
"'standard'",
"'filled'",
"'tonal'",
"'outlined'"
]
},
"doc-url": "https://www.mdui.org/zh-cn/docs/2/components/button-icon#attributes-variant"
},
{
"name": "icon",
"description": "Material Icons 图标名。也可以通过 default slot 设置",
"value": {
"type": "string"
},
"doc-url": "https://www.mdui.org/zh-cn/docs/2/components/button-icon#attributes-icon"
},
{
"name": "selected-icon",
"description": "选中状态的 Material Icons 图标名。也可以通过 `slot=\"selected-icon\"` 设置",
"value": {
"type": "string"
},
"doc-url": "https://www.mdui.org/zh-cn/docs/2/components/button-icon#attributes-selected-icon"
},
{
"name": "selectable",
"description": "是否可选中",
"value": {
"type": "boolean"
},
"doc-url": "https://www.mdui.org/zh-cn/docs/2/components/button-icon#attributes-selectable"
},
{
"name": "selected",
"description": "是否已被选中",
"value": {
"type": "boolean"
},
"doc-url": "https://www.mdui.org/zh-cn/docs/2/components/button-icon#attributes-selected"
},
{
"name": "href",
"description": "链接的目标 URL。\n\n如果设置了此属性,组件内部将渲染为 `<a>` 元素,并可以使用链接相关的属性。",
"value": {
"type": "string"
},
"doc-url": "https://www.mdui.org/zh-cn/docs/2/components/button-icon#attributes-href"
},
{
"name": "download",
"description": "下载链接的目标。\n\n**Note**:仅在设置了 `href` 属性时,此属性才有效。",
"value": {
"type": "string"
},
"doc-url": "https://www.mdui.org/zh-cn/docs/2/components/button-icon#attributes-download"
},
{
"name": "target",
"description": "链接的打开方式。可选值包括:\n\n* `_blank`:在新窗口中打开链接\n* `_parent`:在父框架中打开链接\n* `_self`:默认。在当前框架中打开链接\n* `_top`:在整个窗口中打开链接\n\n**Note**:仅在设置了 `href` 属性时,此属性才有效。",
"value": {
"type": [
"'_blank'",
"'_parent'",
"'_self'",
"'_top'"
]
},
"doc-url": "https://www.mdui.org/zh-cn/docs/2/components/button-icon#attributes-target"
},
{
"name": "rel",
"description": "当前文档与被链接文档之间的关系。可选值包括:\n\n* `alternate`:当前文档的替代版本\n* `author`:当前文档或文章的作者\n* `bookmark`:永久链接到最近的祖先章节\n* `external`:引用的文档与当前文档不在同一站点\n* `help`:链接到相关的帮助文档\n* `license`:当前文档的主要内容由被引用文件的版权许可覆盖\n* `me`:当前文档代表链接内容的所有者\n* `next`:当前文档是系列中的一部分,被引用的文档是系列的下一个文档\n* `nofollow`:当前文档的作者或发布者不认可被引用的文件\n* `noreferrer`:不包含 `Referer` 头。类似于 `noopener` 的效果\n* `opener`:如果超链接会创建一个顶级浏览上下文(即 `target` 属性值为 `_blank`),则创建一个辅助浏览上下文\n* `prev`:当前文档是系列的一部分,被引用的文档是系列的上一个文档\n* `search`:提供一个资源链接,可用于搜索当前文件及其相关页面\n* `tag`:提供一个适用于当前文档的标签(由给定地址识别)\n\n**Note**:仅在指定了 `href` 属性时可用。",
"value": {
"type": [
"'alternate'",
"'author'",
"'bookmark'",
"'external'",
"'help'",
"'license'",
"'me'",
"'next'",
"'nofollow'",
"'noreferrer'",
"'opener'",
"'prev'",
"'search'",
"'tag'"
]
},
"doc-url": "https://www.mdui.org/zh-cn/docs/2/components/button-icon#attributes-rel"
},
{
"name": "autofocus",
"description": "是否在页面加载完成后自动获取焦点",
"value": {
"type": "boolean"
},
"doc-url": "https://www.mdui.org/zh-cn/docs/2/components/button-icon#attributes-autofocus"
},
{
"name": "tabindex",
"description": "元素在使用 Tab 键切换焦点时的顺序",
"value": {
"type": "number"
},
"doc-url": "https://www.mdui.org/zh-cn/docs/2/components/button-icon#attributes-tabindex"
},
{
"name": "disabled",
"description": "是否禁用",
"value": {
"type": "boolean"
},
"doc-url": "https://www.mdui.org/zh-cn/docs/2/components/button-icon#attributes-disabled"
},
{
"name": "loading",
"description": "是否处于加载中状态",
"value": {
"type": "boolean"
},
"doc-url": "https://www.mdui.org/zh-cn/docs/2/components/button-icon#attributes-loading"
},
{
"name": "name",
"description": "按钮的名称,将与表单数据一起提交。\n\n**Note**:仅在未设置 `href` 属性时,此属性才有效。",
"value": {
"type": "string"
},
"doc-url": "https://www.mdui.org/zh-cn/docs/2/components/button-icon#attributes-name"
},
{
"name": "value",
"description": "按钮的初始值,将与表单数据一起提交。\n\n**Note**:仅在未设置 `href` 属性时,此属性才有效。",
"value": {
"type": "string"
},
"doc-url": "https://www.mdui.org/zh-cn/docs/2/components/button-icon#attributes-value"
},
{
"name": "type",
"description": "按钮的类型。默认类型为 `button`。可选类型包括:\n\n* `submit`:点击按钮会提交表单数据到服务器\n* `reset`:点击按钮会将表单中的所有字段重置为初始值\n* `button`:此类型的按钮没有默认行为\n\n**Note**:仅在未指定 `href` 属性时,此属性才有效。",
"value": {
"type": [
"'submit'",
"'reset'",
"'button'"
]
},
"doc-url": "https://www.mdui.org/zh-cn/docs/2/components/button-icon#attributes-type"
},
{
"name": "form",
"description": "关联的 `<form>` 元素。此属性值应为同一页面中的一个 `<form>` 元素的 `id`。\n\n如果未指定此属性,则该元素必须是 `<form>` 元素的子元素。通过此属性,你可以将元素放置在页面的任何位置,而不仅仅是 `<form>` 元素的子元素。\n\n**Note**:仅在未指定 `href` 属性时,此属性才有效。",
"value": {
"type": "string"
},
"doc-url": "https://www.mdui.org/zh-cn/docs/2/components/button-icon#attributes-form"
},
{
"name": "formaction",
"description": "指定提交表单的 URL。\n\n如果指定了此属性,将覆盖 `<form>` 元素的 `action` 属性。\n\n**Note**:仅在未指定 `href` 属性且 `type=\"submit\"` 时,此属性才有效。",
"value": {
"type": "string"
},
"doc-url": "https://www.mdui.org/zh-cn/docs/2/components/button-icon#attributes-formaction"
},
{
"name": "formenctype",
"description": "指定提交表单到服务器的内容类型。可选值包括:\n\n* `application/x-www-form-urlencoded`:未指定该属性时的默认值\n* `multipart/form-data`:当表单包含 `<input type=\"file\">` 元素时使用\n* `text/plain`:HTML5 新增,用于调试\n\n如果指定了此属性,将覆盖 `<form>` 元素的 `enctype` 属性。\n\n**Note**:仅在未指定 `href` 属性且 `type=\"submit\"` 时,此属性才有效。",
"value": {
"type": [
"'application/x-www-form-urlencoded'",
"'multipart/form-data'",
"'text/plain'"
]
},
"doc-url": "https://www.mdui.org/zh-cn/docs/2/components/button-icon#attributes-formenctype"
},
{
"name": "formmethod",
"description": "指定提交表单时使用的 HTTP 方法。可选值包括:\n\n* `post`:表单数据包含在表单内容中,发送到服务器\n* `get`:表单数据以 `?` 作为分隔符附加到表单的 URI 属性中,生成的 URI 发送到服务器。当表单没有副作用,并且仅包含 ASCII 字符时,使用此方法\n\n如果设置了此属性,将覆盖 `<form>` 元素的 `method` 属性。\n\n**Note**:仅在未设置 `href` 属性且 `type=\"submit\"` 时,此属性才有效。",
"value": {
"type": [
"'post'",
"'get'"
]
},
"doc-url": "https://www.mdui.org/zh-cn/docs/2/components/button-icon#attributes-formmethod"
},
{
"name": "formnovalidate",
"description": "如果设置了此属性,表单提交时将不执行表单验证。\n\n如果设置了此属性,将覆盖 `<form>` 元素的 `novalidate` 属性。\n\n**Note**:仅在未设置 `href` 属性且 `type=\"submit\"` 时,此属性才有效。",
"value": {
"type": "boolean"
},
"doc-url": "https://www.mdui.org/zh-cn/docs/2/components/button-icon#attributes-formnovalidate"
},
{
"name": "formtarget",
"description": "提交表单后接收到的响应应显示在何处。可选值包括:\n\n* `_self`:默认选项,在当前框架中打开\n* `_blank`:在新窗口中打开\n* `_parent`:在父框架中打开\n* `_top`:在整个窗口中打开\n\n如果设置了此属性,将覆盖 `<form>` 元素的 `target` 属性。\n\n**Note**:仅在未设置 `href` 属性且 `type=\"submit\"` 时,此属性才有效。",
"value": {
"type": [
"'_self'",
"'_blank'",
"'_parent'",
"'_top'"
]
},
"doc-url": "https://www.mdui.org/zh-cn/docs/2/components/button-icon#attributes-formtarget"
}
],
"priority": "highest",
"doc-url": "https://www.mdui.org/zh-cn/docs/2/components/button-icon",
"slots": [
{
"name": "",
"description": "图标组件",
"doc-url": "https://www.mdui.org/zh-cn/docs/2/components/button-icon#slots-default"
},
{
"name": "selected-icon",
"description": "选中状态显示的图标元素",
"doc-url": "https://www.mdui.org/zh-cn/docs/2/components/button-icon#slots-selected-icon"
}
],
"js": {
"properties": [
{
"name": "variant",
"description": "图标按钮的形状。可选值包括:\n\n* `standard`:适用于最低优先级的操作\n* `filled`:视觉效果强烈,适用于高优先级的操作\n* `tonal`:视觉效果介于 `filled` 和 `outlined` 之间,适用于中高优先级的操作\n* `outlined`:适用于中等优先级的操作",
"value": {
"type": [
"'standard'",
"'filled'",
"'tonal'",
"'outlined'"
]
},
"doc-url": "https://www.mdui.org/zh-cn/docs/2/components/button-icon#attributes-variant"
},
{
"name": "icon",
"description": "Material Icons 图标名。也可以通过 default slot 设置",
"value": {
"type": "string"
},
"doc-url": "https://www.mdui.org/zh-cn/docs/2/components/button-icon#attributes-icon"
},
{
"name": "selectedIcon",
"description": "选中状态的 Material Icons 图标名。也可以通过 `slot=\"selected-icon\"` 设置",
"value": {
"type": "string"
},
"doc-url": "https://www.mdui.org/zh-cn/docs/2/components/button-icon#attributes-selectedIcon"
},
{
"name": "selectable",
"description": "是否可选中",
"value": {
"type": "boolean"
},
"doc-url": "https://www.mdui.org/zh-cn/docs/2/components/button-icon#attributes-selectable"
},
{
"name": "selected",
"description": "是否已被选中",
"value": {
"type": "boolean"
},
"doc-url": "https://www.mdui.org/zh-cn/docs/2/components/button-icon#attributes-selected"
},
{
"name": "href",
"description": "链接的目标 URL。\n\n如果设置了此属性,组件内部将渲染为 `<a>` 元素,并可以使用链接相关的属性。",
"value": {
"type": "string"
},
"doc-url": "https://www.mdui.org/zh-cn/docs/2/components/button-icon#attributes-href"
},
{
"name": "download",
"description": "下载链接的目标。\n\n**Note**:仅在设置了 `href` 属性时,此属性才有效。",
"value": {
"type": "string"
},
"doc-url": "https://www.mdui.org/zh-cn/docs/2/components/button-icon#attributes-download"
},
{
"name": "target",
"description": "链接的打开方式。可选值包括:\n\n* `_blank`:在新窗口中打开链接\n* `_parent`:在父框架中打开链接\n* `_self`:默认。在当前框架中打开链接\n* `_top`:在整个窗口中打开链接\n\n**Note**:仅在设置了 `href` 属性时,此属性才有效。",
"value": {
"type": [
"'_blank'",
"'_parent'",
"'_self'",
"'_top'"
]
},
"doc-url": "https://www.mdui.org/zh-cn/docs/2/components/button-icon#attributes-target"
},
{
"name": "rel",
"description": "当前文档与被链接文档之间的关系。可选值包括:\n\n* `alternate`:当前文档的替代版本\n* `author`:当前文档或文章的作者\n* `bookmark`:永久链接到最近的祖先章节\n* `external`:引用的文档与当前文档不在同一站点\n* `help`:链接到相关的帮助文档\n* `license`:当前文档的主要内容由被引用文件的版权许可覆盖\n* `me`:当前文档代表链接内容的所有者\n* `next`:当前文档是系列中的一部分,被引用的文档是系列的下一个文档\n* `nofollow`:当前文档的作者或发布者不认可被引用的文件\n* `noreferrer`:不包含 `Referer` 头。类似于 `noopener` 的效果\n* `opener`:如果超链接会创建一个顶级浏览上下文(即 `target` 属性值为 `_blank`),则创建一个辅助浏览上下文\n* `prev`:当前文档是系列的一部分,被引用的文档是系列的上一个文档\n* `search`:提供一个资源链接,可用于搜索当前文件及其相关页面\n* `tag`:提供一个适用于当前文档的标签(由给定地址识别)\n\n**Note**:仅在指定了 `href` 属性时可用。",
"value": {
"type": [
"'alternate'",
"'author'",
"'bookmark'",
"'external'",
"'help'",
"'license'",
"'me'",
"'next'",
"'nofollow'",
"'noreferrer'",
"'opener'",
"'prev'",
"'search'",
"'tag'"
]
},
"doc-url": "https://www.mdui.org/zh-cn/docs/2/components/button-icon#attributes-rel"
},
{
"name": "autofocus",
"description": "是否在页面加载完成后自动获取焦点",
"value": {
"type": "boolean"
},
"doc-url": "https://www.mdui.org/zh-cn/docs/2/components/button-icon#attributes-autofocus"
},
{
"name": "tabIndex",
"description": "元素在使用 Tab 键切换焦点时的顺序",
"value": {
"type": "number"
},
"doc-url": "https://www.mdui.org/zh-cn/docs/2/components/button-icon#attributes-tabIndex"
},
{
"name": "disabled",
"description": "是否禁用",
"value": {
"type": "boolean"
},
"doc-url": "https://www.mdui.org/zh-cn/docs/2/components/button-icon#attributes-disabled"
},
{
"name": "loading",
"description": "是否处于加载中状态",
"value": {
"type": "boolean"
},
"doc-url": "https://www.mdui.org/zh-cn/docs/2/components/button-icon#attributes-loading"
},
{
"name": "name",
"description": "按钮的名称,将与表单数据一起提交。\n\n**Note**:仅在未设置 `href` 属性时,此属性才有效。",
"value": {
"type": "string"
},
"doc-url": "https://www.mdui.org/zh-cn/docs/2/components/button-icon#attributes-name"
},
{
"name": "value",
"description": "按钮的初始值,将与表单数据一起提交。\n\n**Note**:仅在未设置 `href` 属性时,此属性才有效。",
"value": {
"type": "string"
},
"doc-url": "https://www.mdui.org/zh-cn/docs/2/components/button-icon#attributes-value"
},
{
"name": "type",
"description": "按钮的类型。默认类型为 `button`。可选类型包括:\n\n* `submit`:点击按钮会提交表单数据到服务器\n* `reset`:点击按钮会将表单中的所有字段重置为初始值\n* `button`:此类型的按钮没有默认行为\n\n**Note**:仅在未指定 `href` 属性时,此属性才有效。",
"value": {
"type": [
"'submit'",
"'reset'",
"'button'"
]
},
"doc-url": "https://www.mdui.org/zh-cn/docs/2/components/button-icon#attributes-type"
},
{
"name": "form",
"description": "关联的 `<form>` 元素。此属性值应为同一页面中的一个 `<form>` 元素的 `id`。\n\n如果未指定此属性,则该元素必须是 `<form>` 元素的子元素。通过此属性,你可以将元素放置在页面的任何位置,而不仅仅是 `<form>` 元素的子元素。\n\n**Note**:仅在未指定 `href` 属性时,此属性才有效。",
"value": {
"type": "string"
},
"doc-url": "https://www.mdui.org/zh-cn/docs/2/components/button-icon#attributes-form"
},
{
"name": "formAction",
"description": "指定提交表单的 URL。\n\n如果指定了此属性,将覆盖 `<form>` 元素的 `action` 属性。\n\n**Note**:仅在未指定 `href` 属性且 `type=\"submit\"` 时,此属性才有效。",
"value": {
"type": "string"
},
"doc-url": "https://www.mdui.org/zh-cn/docs/2/components/button-icon#attributes-formAction"
},
{
"name": "formEnctype",
"description": "指定提交表单到服务器的内容类型。可选值包括:\n\n* `application/x-www-form-urlencoded`:未指定该属性时的默认值\n* `multipart/form-data`:当表单包含 `<input type=\"file\">` 元素时使用\n* `text/plain`:HTML5 新增,用于调试\n\n如果指定了此属性,将覆盖 `<form>` 元素的 `enctype` 属性。\n\n**Note**:仅在未指定 `href` 属性且 `type=\"submit\"` 时,此属性才有效。",
"value": {
"type": [
"'application/x-www-form-urlencoded'",
"'multipart/form-data'",
"'text/plain'"
]
},
"doc-url": "https://www.mdui.org/zh-cn/docs/2/components/button-icon#attributes-formEnctype"
},
{
"name": "formMethod",
"description": "指定提交表单时使用的 HTTP 方法。可选值包括:\n\n* `post`:表单数据包含在表单内容中,发送到服务器\n* `get`:表单数据以 `?` 作为分隔符附加到表单的 URI 属性中,生成的 URI 发送到服务器。当表单没有副作用,并且仅包含 ASCII 字符时,使用此方法\n\n如果设置了此属性,将覆盖 `<form>` 元素的 `method` 属性。\n\n**Note**:仅在未设置 `href` 属性且 `type=\"submit\"` 时,此属性才有效。",
"value": {
"type": [
"'post'",
"'get'"
]
},
"doc-url": "https://www.mdui.org/zh-cn/docs/2/components/button-icon#attributes-formMethod"
},
{
"name": "formNoValidate",
"description": "如果设置了此属性,表单提交时将不执行表单验证。\n\n如果设置了此属性,将覆盖 `<form>` 元素的 `novalidate` 属性。\n\n**Note**:仅在未设置 `href` 属性且 `type=\"submit\"` 时,此属性才有效。",
"value": {
"type": "boolean"
},
"doc-url": "https://www.mdui.org/zh-cn/docs/2/components/button-icon#attributes-formNoValidate"
},
{
"name": "formTarget",
"description": "提交表单后接收到的响应应显示在何处。可选值包括:\n\n* `_self`:默认选项,在当前框架中打开\n* `_blank`:在新窗口中打开\n* `_parent`:在父框架中打开\n* `_top`:在整个窗口中打开\n\n如果设置了此属性,将覆盖 `<form>` 元素的 `target` 属性。\n\n**Note**:仅在未设置 `href` 属性且 `type=\"submit\"` 时,此属性才有效。",
"value": {
"type": [
"'_self'",
"'_blank'",
"'_parent'",
"'_top'"
]
},
"doc-url": "https://www.mdui.org/zh-cn/docs/2/components/button-icon#attributes-formTarget"
},
{
"name": "validity",
"description": "表单验证状态对象,具体参见 [`ValidityState`](https://developer.mozilla.org/zh-CN/docs/Web/API/ValidityState)",
"value": {
"type": "ValidityState"
},
"doc-url": "https://www.mdui.org/zh-cn/docs/2/components/button-icon#attributes-validity"
},
{
"name": "validationMessage",
"description": "如果表单验证未通过,此属性将包含提示信息。如果验证通过,此属性将为空字符串",
"value": {
"type": "string"
},
"doc-url": "https://www.mdui.org/zh-cn/docs/2/components/button-icon#attributes-validationMessage"
}
],
"events": [
{
"name": "focus",
"description": "获得焦点时触发",
"doc-url": "https://www.mdui.org/zh-cn/docs/2/components/button-icon#events-focus"
},
{
"name": "blur",
"description": "失去焦点时触发",
"doc-url": "https://www.mdui.org/zh-cn/docs/2/components/button-icon#events-blur"
},
{
"name": "change",
"description": "选中状态变更时触发",
"doc-url": "https://www.mdui.org/zh-cn/docs/2/components/button-icon#events-change"
},
{
"name": "invalid",
"description": "表单字段验证未通过时触发",
"doc-url": "https://www.mdui.org/zh-cn/docs/2/components/button-icon#events-invalid"
}
]
},
"css": {
"properties": [
{
"name": "--shape-corner",
"description": "组件的圆角大小。可以指定一个具体的像素值;但更推荐引用[设计令牌](https://www.mdui.org/zh-cn/docs/2/styles/design-tokens#shape-corner)",
"doc-url": "https://www.mdui.org/zh-cn/docs/2/components/button-icon#cssProperties-shape-corner"
}
],
"parts": [
{
"name": "button",
"description": "内部的 `<button>` 或 `<a>` 元素",
"doc-url": "https://www.mdui.org/zh-cn/docs/2/components/button-icon#cssParts-button"
},
{
"name": "icon",
"description": "未选中状态的图标",
"doc-url": "https://www.mdui.org/zh-cn/docs/2/components/button-icon#cssParts-icon"
},
{
"name": "selected-icon",
"description": "选中状态的图标",
"doc-url": "https://www.mdui.org/zh-cn/docs/2/components/button-icon#cssParts-selected-icon"
},
{
"name": "loading",
"description": "加载中状态的 `<mdui-circular-progress>` 元素",
"doc-url": "https://www.mdui.org/zh-cn/docs/2/components/button-icon#cssParts-loading"
}
]
}
},
{
"name": "mdui-button",
"description": "按钮组件\n\n```html\n<mdui-button>Button</mdui-button>\n```",
"attributes": [
{
"name": "variant",
"description": "按钮的形状。可选值包括:\n\n* `elevated`:带阴影的按钮,适用于需要将按钮与背景视觉分离的场景\n* `filled`:视觉效果强烈,适用于重要流程的最终操作,如“保存”、“确认”等\n* `tonal`:视觉效果介于 `filled` 和 `outlined` 之间,适用于中高优先级的操作,如流程中的“下一步”\n* `outlined`:带边框的按钮,适用于中等优先级,且次要的操作,如“返回”\n* `text`:文本按钮,适用于最低优先级的操作",
"value": {
"type": [
"'elevated'",
"'filled'",
"'tonal'",
"'outlined'",
"'text'"
]
},
"doc-url": "https://www.mdui.org/zh-cn/docs/2/components/button#attributes-variant"
},
{
"name": "full-width",
"description": "是否填满父元素宽度",
"value": {
"type": "boolean"
},
"doc-url": "https://www.mdui.org/zh-cn/docs/2/components/button#attributes-full-width"
},
{
"name": "icon",
"description": "左侧的 Material Icons 图标名。也可以通过 `slot=\"icon\"` 设置",
"value": {
"type": "string"
},
"doc-url": "https://www.mdui.org/zh-cn/docs/2/components/button#attributes-icon"
},
{
"name": "end-icon",
"description": "右侧的 Material Icons 图标名。也可以通过 `slot=\"end-icon\"` 设置",
"value": {
"type": "string"
},
"doc-url": "https://www.mdui.org/zh-cn/docs/2/components/button#attributes-end-icon"
},
{
"name": "href",
"description": "链接的目标 URL。\n\n如果设置了此属性,组件内部将渲染为 `<a>` 元素,并可以使用链接相关的属性。",
"value": {
"type": "string"
},
"doc-url": "https://www.mdui.org/zh-cn/docs/2/components/button#attributes-href"
},
{
"name": "download",
"description": "下载链接的目标。\n\n**Note**:仅在设置了 `href` 属性时,此属性才有效。",
"value": {
"type": "string"
},
"doc-url": "https://www.mdui.org/zh-cn/docs/2/components/button#attributes-download"
},
{
"name": "target",
"description": "链接的打开方式。可选值包括:\n\n* `_blank`:在新窗口中打开链接\n* `_parent`:在父框架中打开链接\n* `_self`:默认。在当前框架中打开链接\n* `_top`:在整个窗口中打开链接\n\n**Note**:仅在设置了 `href` 属性时,此属性才有效。",
"value": {
"type": [
"'_blank'",
"'_parent'",
"'_self'",
"'_top'"
]
},
"doc-url": "https://www.mdui.org/zh-cn/docs/2/components/button#attributes-target"
},
{
"name": "rel",
"description": "当前文档与被链接文档之间的关系。可选值包括:\n\n* `alternate`:当前文档的替代版本\n* `author`:当前文档或文章的作者\n* `bookmark`:永久链接到最近的祖先章节\n* `external`:引用的文档与当前文档不在同一站点\n* `help`:链接到相关的帮助文档\n* `license`:当前文档的主要内容由被引用文件的版权许可覆盖\n* `me`:当前文档代表链接内容的所有者\n* `next`:当前文档是系列中的一部分,被引用的文档是系列的下一个文档\n* `nofollow`:当前文档的作者或发布者不认可被引用的文件\n* `noreferrer`:不包含 `Referer` 头。类似于 `noopener` 的效果\n* `opener`:如果超链接会创建一个顶级浏览上下文(即 `target` 属性值为 `_blank`),则创建一个辅助浏览上下文\n* `prev`:当前文档是系列的一部分,被引用的文档是系列的上一个文档\n* `search`:提供一个资源链接,可用于搜索当前文件及其相关页面\n* `tag`:提供一个适用于当前文档的标签(由给定地址识别)\n\n**Note**:仅在指定了 `href` 属性时可用。",
"value": {
"type": [
"'alternate'",
"'author'",
"'bookmark'",
"'external'",
"'help'",
"'license'",
"'me'",
"'next'",
"'nofollow'",
"'noreferrer'",
"'opener'",
"'prev'",
"'search'",
"'tag'"
]
},
"doc-url": "https://www.mdui.org/zh-cn/docs/2/components/button#attributes-rel"
},
{
"name": "autofocus",
"description": "是否在页面加载完成后自动获取焦点",
"value": {
"type": "boolean"
},
"doc-url": "https://www.mdui.org/zh-cn/docs/2/components/button#attributes-autofocus"
},
{
"name": "tabindex",
"description": "元素在使用 Tab 键切换焦点时的顺序",
"value": {
"type": "number"
},
"doc-url": "https://www.mdui.org/zh-cn/docs/2/components/button#attributes-tabindex"
},
{
"name": "disabled",
"description": "是否禁用",
"value": {
"type": "boolean"
},
"doc-url": "https://www.mdui.org/zh-cn/docs/2/components/button#attributes-disabled"
},
{
"name": "loading",
"description": "是否处于加载中状态",
"value": {
"type": "boolean"
},
"doc-url": "https://www.mdui.org/zh-cn/docs/2/components/button#attributes-loading"
},
{
"name": "name",
"description": "按钮的名称,将与表单数据一起提交。\n\n**Note**:仅在未设置 `href` 属性时,此属性才有效。",
"value": {
"type": "string"
},
"doc-url": "https://www.mdui.org/zh-cn/docs/2/components/button#attributes-name"
},
{
"name": "value",
"description": "按钮的初始值,将与表单数据一起提交。\n\n**Note**:仅在未设置 `href` 属性时,此属性才有效。",
"value": {
"type": "string"
},
"doc-url": "https://www.mdui.org/zh-cn/docs/2/components/button#attributes-value"
},
{
"name": "type",
"description": "按钮的类型。默认类型为 `button`。可选类型包括:\n\n* `submit`:点击按钮会提交表单数据到服务器\n* `reset`:点击按钮会将表单中的所有字段重置为初始值\n* `button`:此类型的按钮没有默认行为\n\n**Note**:仅在未指定 `href` 属性时,此属性才有效。",
"value": {
"type": [
"'submit'",
"'reset'",
"'button'"
]
},
"doc-url": "https://www.mdui.org/zh-cn/docs/2/components/button#attributes-type"
},
{
"name": "form",
"description": "关联的 `<form>` 元素。此属性值应为同一页面中的一个 `<form>` 元素的 `id`。\n\n如果未指定此属性,则该元素必须是 `<form>` 元素的子元素。通过此属性,你可以将元素放置在页面的任何位置,而不仅仅是 `<form>` 元素的子元素。\n\n**Note**:仅在未指定 `href` 属性时,此属性才有效。",
"value": {
"type": "string"
},
"doc-url": "https://www.mdui.org/zh-cn/docs/2/components/button#attributes-form"
},
{
"name": "formaction",
"description": "指定提交表单的 URL。\n\n如果指定了此属性,将覆盖 `<form>` 元素的 `action` 属性。\n\n**Note**:仅在未指定 `href` 属性且 `type=\"submit\"` 时,此属性才有效。",
"value": {
"type": "string"
},
"doc-url": "https://www.mdui.org/zh-cn/docs/2/components/button#attributes-formaction"
},
{
"name": "formenctype",
"description": "指定提交表单到服务器的内容类型。可选值包括:\n\n* `application/x-www-form-urlencoded`:未指定该属性时的默认值\n* `multipart/form-data`:当表单包含 `<input type=\"file\">` 元素时使用\n* `text/plain`:HTML5 新增,用于调试\n\n如果指定了此属性,将覆盖 `<form>` 元素的 `enctype` 属性。\n\n**Note**:仅在未指定 `href` 属性且 `type=\"submit\"` 时,此属性才有效。",
"value": {
"type": [
"'application/x-www-form-urlencoded'",
"'multipart/form-data'",
"'text/plain'"
]
},
"doc-url": "https://www.mdui.org/zh-cn/docs/2/components/button#attributes-formenctype"
},
{
"name": "formmethod",
"description": "指定提交表单时使用的 HTTP 方法。可选值包括:\n\n* `post`:表单数据包含在表单内容中,发送到服务器\n* `get`:表单数据以 `?` 作为分隔符附加到表单的 URI 属性中,生成的 URI 发送到服务器。当表单没有副作用,并且仅包含 ASCII 字符时,使用此方法\n\n如果设置了此属性,将覆盖 `<form>` 元素的 `method` 属性。\n\n**Note**:仅在未设置 `href` 属性且 `type=\"submit\"` 时,此属性才有效。",
"value": {
"type": [
"'post'",
"'get'"
]
},
"doc-url": "https://www.mdui.org/zh-cn/docs/2/components/button#attributes-formmethod"
},
{
"name": "formnovalidate",
"description": "如果设置了此属性,表单提交时将不执行表单验证。\n\n如果设置了此属性,将覆盖 `<form>` 元素的 `novalidate` 属性。\n\n**Note**:仅在未设置 `href` 属性且 `type=\"submit\"` 时,此属性才有效。",
"value": {
"type": "boolean"
},
"doc-url": "https://www.mdui.org/zh-cn/docs/2/components/button#attributes-formnovalidate"
},
{
"name": "formtarget",
"description": "提交表单后接收到的响应应显示在何处。可选值包括:\n\n* `_self`:默认选项,在当前框架中打开\n* `_blank`:在新窗口中打开\n* `_parent`:在父框架中打开\n* `_top`:在整个窗口中打开\n\n如果设置了此属性,将覆盖 `<form>` 元素的 `target` 属性。\n\n**Note**:仅在未设置 `href` 属性且 `type=\"submit\"` 时,此属性才有效。",
"value": {
"type": [
"'_self'",
"'_blank'",
"'_parent'",
"'_top'"
]
},
"doc-url": "https://www.mdui.org/zh-cn/docs/2/components/button#attributes-formtarget"
}
],
"priority": "highest",
"doc-url": "https://www.mdui.org/zh-cn/docs/2/components/button",
"slots": [
{
"name": "",
"description": "按钮的文本",
"doc-url": "https://www.mdui.org/zh-cn/docs/2/components/button#slots-default"
},
{
"name": "icon",
"description": "按钮左侧的元素",
"doc-url": "https://www.mdui.org/zh-cn/docs/2/components/button#slots-icon"
},
{
"name": "end-icon",
"description": "按钮右侧的元素",
"doc-url": "https://www.mdui.org/zh-cn/docs/2/components/button#slots-end-icon"
}
],
"js": {
"properties": [
{
"name": "variant",
"description": "按钮的形状。可选值包括:\n\n* `elevated`:带阴影的按钮,适用于需要将按钮与背景视觉分离的场景\n* `filled`:视觉效果强烈,适用于重要流程的最终操作,如“保存”、“确认”等\n* `tonal`:视觉效果介于 `filled` 和 `outlined` 之间,适用于中高优先级的操作,如流程中的“下一步”\n* `outlined`:带边框的按钮,适用于中等优先级,且次要的操作,如“返回”\n* `text`:文本按钮,适用于最低优先级的操作",
"value": {
"type": [
"'elevated'",
"'filled'",
"'tonal'",
"'outlined'",
"'text'"
]
},
"doc-url": "https://www.mdui.org/zh-cn/docs/2/components/button#attributes-variant"
},
{
"name": "fullWidth",
"description": "是否填满父元素宽度",
"value": {
"type": "boolean"
},
"doc-url": "https://www.mdui.org/zh-cn/docs/2/components/button#attributes-fullWidth"
},
{
"name": "icon",
"description": "左侧的 Material Icons 图标名。也可以通过 `slot=\"icon\"` 设置",
"value": {
"type": "string"
},
"doc-url": "https://www.mdui.org/zh-cn/docs/2/components/button#attributes-icon"
},
{
"name": "endIcon",
"description": "右侧的 Material Icons 图标名。也可以通过 `slot=\"end-icon\"` 设置",
"value": {
"type": "string"
},
"doc-url": "https://www.mdui.org/zh-cn/docs/2/components/button#attributes-endIcon"
},
{
"name": "href",
"description": "链接的目标 URL。\n\n如果设置了此属性,组件内部将渲染为 `<a>` 元素,并可以使用链接相关的属性。",
"value": {
"type": "string"
},
"doc-url": "https://www.mdui.org/zh-cn/docs/2/components/button#attributes-href"
},
{
"name": "d