Files
LingChair/.vscode/mdui/html-data.zh-cn.json
CrescentLeaf 55c98027f7 chore: MDUI 语法提示
虽然对于 JSX 没什么用
2025-04-18 23:00:25 +08:00

6554 lines
258 KiB
JSON
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

{
"version": 1.1,
"tags": [
{
"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 地址",
"references": [
{
"name": "开发文档",
"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` 中较小的一个相同",
"values": [
{
"name": "contain",
"description": "保持图片原有尺寸比例,内容会被等比例缩放"
},
{
"name": "cover",
"description": "保持图片原有尺寸比例,但部分内容可能被剪切"
},
{
"name": "fill",
"description": "默认值,不保持图片原有尺寸比例,内容会被拉伸以填充整个容器"
},
{
"name": "none",
"description": "保留图片原有尺寸,内容不会被缩放或拉伸"
},
{
"name": "scale-down",
"description": "保持图片原有尺寸比例,内容尺寸与 `none` 或 `contain` 中较小的一个相同"
}
],
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/avatar#attributes-fit"
}
]
},
{
"name": "icon",
"description": "头像的 Material Icons 图标名",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/avatar#attributes-icon"
}
]
},
{
"name": "label",
"description": "头像的替代文本描述",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/avatar#attributes-label"
}
]
}
],
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/avatar"
},
{
"name": "Github",
"url": "https://github.com/zdhxiong/mdui/blob/v2/packages/mdui/src/components/avatar/index.ts"
}
]
},
{
"name": "mdui-badge",
"description": "徽标组件\n\n```html\n<mdui-badge>12</mdui-badge>\n```",
"attributes": [
{
"name": "variant",
"description": "徽标的形状。可选值包括:\n\n* `small`:小型徽标,不显示文本\n* `large`:大型徽标,会显示文本",
"values": [
{
"name": "small",
"description": "小型徽标,不显示文本"
},
{
"name": "large",
"description": "大型徽标,会显示文本"
}
],
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/badge#attributes-variant"
}
]
}
],
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/badge"
},
{
"name": "Github",
"url": "https://github.com/zdhxiong/mdui/blob/v2/packages/mdui/src/components/badge/index.ts"
}
]
},
{
"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": "是否隐藏",
"references": [
{
"name": "开发文档",
"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) 仍会停留在页面上",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/bottom-app-bar#attributes-fab-detach"
}
]
},
{
"name": "scroll-behavior",
"description": "滚动行为。可选值为:\n\n* `hide`:滚动时隐藏",
"values": [
{
"name": "hide"
},
{
"name": "shrink"
},
{
"name": "elevate"
}
],
"references": [
{
"name": "开发文档",
"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` 的滚动事件",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/bottom-app-bar#attributes-scroll-target"
}
]
},
{
"name": "scroll-threshold",
"description": "在滚动多少距离之后触发滚动行为,单位为 `px`",
"references": [
{
"name": "开发文档",
"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`",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/bottom-app-bar#attributes-order"
}
]
}
],
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/bottom-app-bar"
},
{
"name": "Github",
"url": "https://github.com/zdhxiong/mdui/blob/v2/packages/mdui/src/components/bottom-app-bar/index.ts"
}
]
},
{
"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`:适用于中等优先级的操作",
"values": [
{
"name": "standard",
"description": "适用于最低优先级的操作"
},
{
"name": "filled",
"description": "视觉效果强烈,适用于高优先级的操作"
},
{
"name": "tonal",
"description": "视觉效果介于 `filled` 和 `outlined` 之间,适用于中高优先级的操作"
},
{
"name": "outlined",
"description": "适用于中等优先级的操作"
}
],
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/button-icon#attributes-variant"
}
]
},
{
"name": "icon",
"description": "Material Icons 图标名。也可以通过 default slot 设置",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/button-icon#attributes-icon"
}
]
},
{
"name": "selected-icon",
"description": "选中状态的 Material Icons 图标名。也可以通过 `slot=\"selected-icon\"` 设置",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/button-icon#attributes-selected-icon"
}
]
},
{
"name": "selectable",
"description": "是否可选中",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/button-icon#attributes-selectable"
}
]
},
{
"name": "selected",
"description": "是否已被选中",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/button-icon#attributes-selected"
}
]
},
{
"name": "href",
"description": "链接的目标 URL。\n\n如果设置了此属性组件内部将渲染为 `<a>` 元素,并可以使用链接相关的属性。",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/button-icon#attributes-href"
}
]
},
{
"name": "download",
"description": "下载链接的目标。\n\n**Note**:仅在设置了 `href` 属性时,此属性才有效。",
"references": [
{
"name": "开发文档",
"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` 属性时,此属性才有效。",
"values": [
{
"name": "_blank",
"description": "在新窗口中打开链接"
},
{
"name": "_parent",
"description": "在父框架中打开链接"
},
{
"name": "_self",
"description": "默认。在当前框架中打开链接"
},
{
"name": "_top",
"description": "在整个窗口中打开链接"
}
],
"references": [
{
"name": "开发文档",
"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` 属性时可用。",
"values": [
{
"name": "alternate",
"description": "当前文档的替代版本"
},
{
"name": "author",
"description": "当前文档或文章的作者"
},
{
"name": "bookmark",
"description": "永久链接到最近的祖先章节"
},
{
"name": "external",
"description": "引用的文档与当前文档不在同一站点"
},
{
"name": "help",
"description": "链接到相关的帮助文档"
},
{
"name": "license",
"description": "当前文档的主要内容由被引用文件的版权许可覆盖"
},
{
"name": "me",
"description": "当前文档代表链接内容的所有者"
},
{
"name": "next",
"description": "当前文档是系列中的一部分,被引用的文档是系列的下一个文档"
},
{
"name": "nofollow",
"description": "当前文档的作者或发布者不认可被引用的文件"
},
{
"name": "noreferrer",
"description": "不包含 `Referer` 头。类似于 `noopener` 的效果"
},
{
"name": "opener",
"description": "如果超链接会创建一个顶级浏览上下文(即 `target` 属性值为 `_blank`),则创建一个辅助浏览上下文"
},
{
"name": "prev",
"description": "当前文档是系列的一部分,被引用的文档是系列的上一个文档"
},
{
"name": "search",
"description": "提供一个资源链接,可用于搜索当前文件及其相关页面"
},
{
"name": "tag",
"description": "提供一个适用于当前文档的标签(由给定地址识别)"
}
],
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/button-icon#attributes-rel"
}
]
},
{
"name": "autofocus",
"description": "是否在页面加载完成后自动获取焦点",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/button-icon#attributes-autofocus"
}
]
},
{
"name": "tabindex",
"description": "元素在使用 Tab 键切换焦点时的顺序",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/button-icon#attributes-tabindex"
}
]
},
{
"name": "disabled",
"description": "是否禁用",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/button-icon#attributes-disabled"
}
]
},
{
"name": "loading",
"description": "是否处于加载中状态",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/button-icon#attributes-loading"
}
]
},
{
"name": "name",
"description": "按钮的名称,将与表单数据一起提交。\n\n**Note**:仅在未设置 `href` 属性时,此属性才有效。",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/button-icon#attributes-name"
}
]
},
{
"name": "value",
"description": "按钮的初始值,将与表单数据一起提交。\n\n**Note**:仅在未设置 `href` 属性时,此属性才有效。",
"references": [
{
"name": "开发文档",
"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` 属性时,此属性才有效。",
"values": [
{
"name": "submit",
"description": "此按钮将表单数据提交给服务器"
},
{
"name": "reset",
"description": "此按钮重置所有组件为初始值"
},
{
"name": "button",
"description": "此按钮没有默认行为"
}
],
"references": [
{
"name": "开发文档",
"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` 属性时,此属性才有效。",
"references": [
{
"name": "开发文档",
"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\"` 时,此属性才有效。",
"references": [
{
"name": "开发文档",
"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\"` 时,此属性才有效。",
"values": [
{
"name": "application/x-www-form-urlencoded",
"description": "未指定该属性时的默认值"
},
{
"name": "multipart/form-data",
"description": "当表单包含 `<input type=\"file\">` 元素时使用"
},
{
"name": "text/plain",
"description": "HTML5 新增,用于调试"
}
],
"references": [
{
"name": "开发文档",
"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\"` 时,此属性才有效。",
"values": [
{
"name": "post",
"description": "表单数据包含在表单内容中,发送到服务器"
},
{
"name": "get",
"description": "表单数据以 `?` 作为分隔符附加到表单的 URI 属性中,生成的 URI 发送到服务器。当表单没有副作用,并且仅包含 ASCII 字符时,使用此方法"
}
],
"references": [
{
"name": "开发文档",
"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\"` 时,此属性才有效。",
"references": [
{
"name": "开发文档",
"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\"` 时,此属性才有效。",
"values": [
{
"name": "_self",
"description": "默认选项,在当前框架中打开"
},
{
"name": "_blank",
"description": "在新窗口中打开"
},
{
"name": "_parent",
"description": "在父框架中打开"
},
{
"name": "_top",
"description": "在整个窗口中打开"
}
],
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/button-icon#attributes-formtarget"
}
]
}
],
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/button-icon"
},
{
"name": "Github",
"url": "https://github.com/zdhxiong/mdui/blob/v2/packages/mdui/src/components/button-icon/index.ts"
}
]
},
{
"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`:文本按钮,适用于最低优先级的操作",
"values": [
{
"name": "elevated",
"description": "带阴影的按钮,适用于需要将按钮与背景视觉分离的场景"
},
{
"name": "filled",
"description": "视觉效果强烈,适用于重要流程的最终操作,如“保存”、“确认”等"
},
{
"name": "tonal",
"description": "视觉效果介于 `filled` 和 `outlined` 之间,适用于中高优先级的操作,如流程中的“下一步”"
},
{
"name": "outlined",
"description": "带边框的按钮,适用于中等优先级,且次要的操作,如“返回”"
},
{
"name": "text",
"description": "文本按钮,适用于最低优先级的操作"
}
],
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/button#attributes-variant"
}
]
},
{
"name": "full-width",
"description": "是否填满父元素宽度",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/button#attributes-full-width"
}
]
},
{
"name": "icon",
"description": "左侧的 Material Icons 图标名。也可以通过 `slot=\"icon\"` 设置",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/button#attributes-icon"
}
]
},
{
"name": "end-icon",
"description": "右侧的 Material Icons 图标名。也可以通过 `slot=\"end-icon\"` 设置",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/button#attributes-end-icon"
}
]
},
{
"name": "href",
"description": "链接的目标 URL。\n\n如果设置了此属性组件内部将渲染为 `<a>` 元素,并可以使用链接相关的属性。",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/button#attributes-href"
}
]
},
{
"name": "download",
"description": "下载链接的目标。\n\n**Note**:仅在设置了 `href` 属性时,此属性才有效。",
"references": [
{
"name": "开发文档",
"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` 属性时,此属性才有效。",
"values": [
{
"name": "_blank",
"description": "在新窗口中打开链接"
},
{
"name": "_parent",
"description": "在父框架中打开链接"
},
{
"name": "_self",
"description": "默认。在当前框架中打开链接"
},
{
"name": "_top",
"description": "在整个窗口中打开链接"
}
],
"references": [
{
"name": "开发文档",
"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` 属性时可用。",
"values": [
{
"name": "alternate",
"description": "当前文档的替代版本"
},
{
"name": "author",
"description": "当前文档或文章的作者"
},
{
"name": "bookmark",
"description": "永久链接到最近的祖先章节"
},
{
"name": "external",
"description": "引用的文档与当前文档不在同一站点"
},
{
"name": "help",
"description": "链接到相关的帮助文档"
},
{
"name": "license",
"description": "当前文档的主要内容由被引用文件的版权许可覆盖"
},
{
"name": "me",
"description": "当前文档代表链接内容的所有者"
},
{
"name": "next",
"description": "当前文档是系列中的一部分,被引用的文档是系列的下一个文档"
},
{
"name": "nofollow",
"description": "当前文档的作者或发布者不认可被引用的文件"
},
{
"name": "noreferrer",
"description": "不包含 `Referer` 头。类似于 `noopener` 的效果"
},
{
"name": "opener",
"description": "如果超链接会创建一个顶级浏览上下文(即 `target` 属性值为 `_blank`),则创建一个辅助浏览上下文"
},
{
"name": "prev",
"description": "当前文档是系列的一部分,被引用的文档是系列的上一个文档"
},
{
"name": "search",
"description": "提供一个资源链接,可用于搜索当前文件及其相关页面"
},
{
"name": "tag",
"description": "提供一个适用于当前文档的标签(由给定地址识别)"
}
],
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/button#attributes-rel"
}
]
},
{
"name": "autofocus",
"description": "是否在页面加载完成后自动获取焦点",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/button#attributes-autofocus"
}
]
},
{
"name": "tabindex",
"description": "元素在使用 Tab 键切换焦点时的顺序",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/button#attributes-tabindex"
}
]
},
{
"name": "disabled",
"description": "是否禁用",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/button#attributes-disabled"
}
]
},
{
"name": "loading",
"description": "是否处于加载中状态",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/button#attributes-loading"
}
]
},
{
"name": "name",
"description": "按钮的名称,将与表单数据一起提交。\n\n**Note**:仅在未设置 `href` 属性时,此属性才有效。",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/button#attributes-name"
}
]
},
{
"name": "value",
"description": "按钮的初始值,将与表单数据一起提交。\n\n**Note**:仅在未设置 `href` 属性时,此属性才有效。",
"references": [
{
"name": "开发文档",
"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` 属性时,此属性才有效。",
"values": [
{
"name": "submit",
"description": "此按钮将表单数据提交给服务器"
},
{
"name": "reset",
"description": "此按钮重置所有组件为初始值"
},
{
"name": "button",
"description": "此按钮没有默认行为"
}
],
"references": [
{
"name": "开发文档",
"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` 属性时,此属性才有效。",
"references": [
{
"name": "开发文档",
"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\"` 时,此属性才有效。",
"references": [
{
"name": "开发文档",
"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\"` 时,此属性才有效。",
"values": [
{
"name": "application/x-www-form-urlencoded",
"description": "未指定该属性时的默认值"
},
{
"name": "multipart/form-data",
"description": "当表单包含 `<input type=\"file\">` 元素时使用"
},
{
"name": "text/plain",
"description": "HTML5 新增,用于调试"
}
],
"references": [
{
"name": "开发文档",
"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\"` 时,此属性才有效。",
"values": [
{
"name": "post",
"description": "表单数据包含在表单内容中,发送到服务器"
},
{
"name": "get",
"description": "表单数据以 `?` 作为分隔符附加到表单的 URI 属性中,生成的 URI 发送到服务器。当表单没有副作用,并且仅包含 ASCII 字符时,使用此方法"
}
],
"references": [
{
"name": "开发文档",
"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\"` 时,此属性才有效。",
"references": [
{
"name": "开发文档",
"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\"` 时,此属性才有效。",
"values": [
{
"name": "_self",
"description": "默认选项,在当前框架中打开"
},
{
"name": "_blank",
"description": "在新窗口中打开"
},
{
"name": "_parent",
"description": "在父框架中打开"
},
{
"name": "_top",
"description": "在整个窗口中打开"
}
],
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/button#attributes-formtarget"
}
]
}
],
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/button"
},
{
"name": "Github",
"url": "https://github.com/zdhxiong/mdui/blob/v2/packages/mdui/src/components/button/index.ts"
}
]
},
{
"name": "mdui-card",
"description": "卡片组件\n\n```html\n<mdui-card>card content</mdui-card>\n```",
"attributes": [
{
"name": "variant",
"description": "卡片的形状。可选值包括:\n\n* `elevated`:带阴影的卡片,与背景的视觉分离度较高\n* `filled`:带填充色的卡片,与背景的视觉分离度较低\n* `outlined`:带边框的卡片,与背景的视觉分离度最高",
"values": [
{
"name": "elevated",
"description": "带阴影的卡片,与背景的视觉分离度较高"
},
{
"name": "filled",
"description": "带填充色的卡片,与背景的视觉分离度较低"
},
{
"name": "outlined",
"description": "带边框的卡片,与背景的视觉分离度最高"
}
],
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/card#attributes-variant"
}
]
},
{
"name": "clickable",
"description": "是否可点击。为 `true` 时,卡片将具有鼠标悬浮效果和点击涟漪效果",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/card#attributes-clickable"
}
]
},
{
"name": "disabled",
"description": "是否禁用",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/card#attributes-disabled"
}
]
},
{
"name": "href",
"description": "链接的目标 URL。\n\n如果设置了此属性组件内部将渲染为 `<a>` 元素,并可以使用链接相关的属性。",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/card#attributes-href"
}
]
},
{
"name": "download",
"description": "下载链接的目标。\n\n**Note**:仅在设置了 `href` 属性时,此属性才有效。",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/card#attributes-download"
}
]
},
{
"name": "target",
"description": "链接的打开方式。可选值包括:\n\n* `_blank`:在新窗口中打开链接\n* `_parent`:在父框架中打开链接\n* `_self`:默认。在当前框架中打开链接\n* `_top`:在整个窗口中打开链接\n\n**Note**:仅在设置了 `href` 属性时,此属性才有效。",
"values": [
{
"name": "_blank",
"description": "在新窗口中打开链接"
},
{
"name": "_parent",
"description": "在父框架中打开链接"
},
{
"name": "_self",
"description": "默认。在当前框架中打开链接"
},
{
"name": "_top",
"description": "在整个窗口中打开链接"
}
],
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/card#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` 属性时可用。",
"values": [
{
"name": "alternate",
"description": "当前文档的替代版本"
},
{
"name": "author",
"description": "当前文档或文章的作者"
},
{
"name": "bookmark",
"description": "永久链接到最近的祖先章节"
},
{
"name": "external",
"description": "引用的文档与当前文档不在同一站点"
},
{
"name": "help",
"description": "链接到相关的帮助文档"
},
{
"name": "license",
"description": "当前文档的主要内容由被引用文件的版权许可覆盖"
},
{
"name": "me",
"description": "当前文档代表链接内容的所有者"
},
{
"name": "next",
"description": "当前文档是系列中的一部分,被引用的文档是系列的下一个文档"
},
{
"name": "nofollow",
"description": "当前文档的作者或发布者不认可被引用的文件"
},
{
"name": "noreferrer",
"description": "不包含 `Referer` 头。类似于 `noopener` 的效果"
},
{
"name": "opener",
"description": "如果超链接会创建一个顶级浏览上下文(即 `target` 属性值为 `_blank`),则创建一个辅助浏览上下文"
},
{
"name": "prev",
"description": "当前文档是系列的一部分,被引用的文档是系列的上一个文档"
},
{
"name": "search",
"description": "提供一个资源链接,可用于搜索当前文件及其相关页面"
},
{
"name": "tag",
"description": "提供一个适用于当前文档的标签(由给定地址识别)"
}
],
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/card#attributes-rel"
}
]
},
{
"name": "autofocus",
"description": "是否在页面加载完成后自动获取焦点",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/card#attributes-autofocus"
}
]
},
{
"name": "tabindex",
"description": "元素在使用 Tab 键切换焦点时的顺序",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/card#attributes-tabindex"
}
]
}
],
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/card"
},
{
"name": "Github",
"url": "https://github.com/zdhxiong/mdui/blob/v2/packages/mdui/src/components/card/index.ts"
}
]
},
{
"name": "mdui-checkbox",
"description": "复选框组件\n\n```html\n<mdui-checkbox>Checkbox</mdui-checkbox>\n```",
"attributes": [
{
"name": "disabled",
"description": "是否为禁用状态",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/checkbox#attributes-disabled"
}
]
},
{
"name": "checked",
"description": "是否为选中状态",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/checkbox#attributes-checked"
}
]
},
{
"name": "indeterminate",
"description": "是否处于不确定状态",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/checkbox#attributes-indeterminate"
}
]
},
{
"name": "required",
"description": "提交表单时,是否必须选中此复选框",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/checkbox#attributes-required"
}
]
},
{
"name": "form",
"description": "关联的 `<form>` 元素。此属性值应为同一页面中的一个 `<form>` 元素的 `id`。\n\n如果未指定此属性则该元素必须是 `<form>` 元素的子元素。通过此属性,你可以将元素放置在页面的任何位置,而不仅仅是 `<form>` 元素的子元素。",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/checkbox#attributes-form"
}
]
},
{
"name": "name",
"description": "复选框名称,将与表单数据一起提交",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/checkbox#attributes-name"
}
]
},
{
"name": "value",
"description": "复选框的值,将于表单数据一起提交",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/checkbox#attributes-value"
}
]
},
{
"name": "unchecked-icon",
"description": "未选中状态的 Material Icons 图标名。也可以通过 `slot=\"unchecked-icon\"` 设置",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/checkbox#attributes-unchecked-icon"
}
]
},
{
"name": "checked-icon",
"description": "选中状态的 Material Icons 图标名。也可以通过 `slot=\"checked-icon\"` 设置",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/checkbox#attributes-checked-icon"
}
]
},
{
"name": "indeterminate-icon",
"description": "不确定状态的 Material Icons 图标名。也可以通过 `slot=\"indeterminate-icon\"` 设置",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/checkbox#attributes-indeterminate-icon"
}
]
},
{
"name": "autofocus",
"description": "是否在页面加载完成后自动获取焦点",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/checkbox#attributes-autofocus"
}
]
},
{
"name": "tabindex",
"description": "元素在使用 Tab 键切换焦点时的顺序",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/checkbox#attributes-tabindex"
}
]
}
],
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/checkbox"
},
{
"name": "Github",
"url": "https://github.com/zdhxiong/mdui/blob/v2/packages/mdui/src/components/checkbox/index.ts"
}
]
},
{
"name": "mdui-chip",
"description": "纸片组件\n\n```html\n<mdui-chip>Chip</mdui-chip>\n```",
"attributes": [
{
"name": "variant",
"description": "纸片的形状。可选值包括:\n\n* `assist`:用于显示与当前上下文相关的辅助操作,如在点餐页面提供分享、收藏等功能\n* `filter`:用于对内容进行筛选,如在搜索结果页过滤搜索结果\n* `input`:用于表示用户输入的信息片段,如在 Gmail 的“收件人”字段中的联系人\n* `suggestion`:用于提供动态生成的推荐信息,以简化用户操作,如在聊天应用中预测用户可能想发送的信息",
"values": [
{
"name": "assist",
"description": "用于显示与当前上下文相关的辅助操作,如在点餐页面提供分享、收藏等功能"
},
{
"name": "filter",
"description": "用于对内容进行筛选,如在搜索结果页过滤搜索结果"
},
{
"name": "input",
"description": "用于表示用户输入的信息片段,如在 Gmail 的“收件人”字段中的联系人"
},
{
"name": "suggestion",
"description": "用于提供动态生成的推荐信息,以简化用户操作,如在聊天应用中预测用户可能想发送的信息"
}
],
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/chip#attributes-variant"
}
]
},
{
"name": "elevated",
"description": "是否显示阴影",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/chip#attributes-elevated"
}
]
},
{
"name": "selectable",
"description": "是否可选中",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/chip#attributes-selectable"
}
]
},
{
"name": "selected",
"description": "是否已选中",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/chip#attributes-selected"
}
]
},
{
"name": "deletable",
"description": "是否可删除。为 `true` 时,纸片右侧会显示删除图标",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/chip#attributes-deletable"
}
]
},
{
"name": "icon",
"description": "左侧的 Material Icons 图标名。也可以通过 `slot=\"icon\"` 设置",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/chip#attributes-icon"
}
]
},
{
"name": "selected-icon",
"description": "选中状态下左侧的 Material Icons 图标名。也可以通过 `slot=\"selected-icon\"` 设置",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/chip#attributes-selected-icon"
}
]
},
{
"name": "end-icon",
"description": "右侧的 Material Icons 图标名。也可以通过 `slot=\"end-icon\"` 设置",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/chip#attributes-end-icon"
}
]
},
{
"name": "delete-icon",
"description": "可删除时,右侧删除图标的 Material Icons 图标名。也可以通过 `slot=\"delete-icon\"` 设置",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/chip#attributes-delete-icon"
}
]
},
{
"name": "href",
"description": "链接的目标 URL。\n\n如果设置了此属性组件内部将渲染为 `<a>` 元素,并可以使用链接相关的属性。",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/chip#attributes-href"
}
]
},
{
"name": "download",
"description": "下载链接的目标。\n\n**Note**:仅在设置了 `href` 属性时,此属性才有效。",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/chip#attributes-download"
}
]
},
{
"name": "target",
"description": "链接的打开方式。可选值包括:\n\n* `_blank`:在新窗口中打开链接\n* `_parent`:在父框架中打开链接\n* `_self`:默认。在当前框架中打开链接\n* `_top`:在整个窗口中打开链接\n\n**Note**:仅在设置了 `href` 属性时,此属性才有效。",
"values": [
{
"name": "_blank",
"description": "在新窗口中打开链接"
},
{
"name": "_parent",
"description": "在父框架中打开链接"
},
{
"name": "_self",
"description": "默认。在当前框架中打开链接"
},
{
"name": "_top",
"description": "在整个窗口中打开链接"
}
],
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/chip#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` 属性时可用。",
"values": [
{
"name": "alternate",
"description": "当前文档的替代版本"
},
{
"name": "author",
"description": "当前文档或文章的作者"
},
{
"name": "bookmark",
"description": "永久链接到最近的祖先章节"
},
{
"name": "external",
"description": "引用的文档与当前文档不在同一站点"
},
{
"name": "help",
"description": "链接到相关的帮助文档"
},
{
"name": "license",
"description": "当前文档的主要内容由被引用文件的版权许可覆盖"
},
{
"name": "me",
"description": "当前文档代表链接内容的所有者"
},
{
"name": "next",
"description": "当前文档是系列中的一部分,被引用的文档是系列的下一个文档"
},
{
"name": "nofollow",
"description": "当前文档的作者或发布者不认可被引用的文件"
},
{
"name": "noreferrer",
"description": "不包含 `Referer` 头。类似于 `noopener` 的效果"
},
{
"name": "opener",
"description": "如果超链接会创建一个顶级浏览上下文(即 `target` 属性值为 `_blank`),则创建一个辅助浏览上下文"
},
{
"name": "prev",
"description": "当前文档是系列的一部分,被引用的文档是系列的上一个文档"
},
{
"name": "search",
"description": "提供一个资源链接,可用于搜索当前文件及其相关页面"
},
{
"name": "tag",
"description": "提供一个适用于当前文档的标签(由给定地址识别)"
}
],
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/chip#attributes-rel"
}
]
},
{
"name": "autofocus",
"description": "是否在页面加载完成后自动获取焦点",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/chip#attributes-autofocus"
}
]
},
{
"name": "tabindex",
"description": "元素在使用 Tab 键切换焦点时的顺序",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/chip#attributes-tabindex"
}
]
},
{
"name": "disabled",
"description": "是否禁用",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/chip#attributes-disabled"
}
]
},
{
"name": "loading",
"description": "是否处于加载中状态",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/chip#attributes-loading"
}
]
},
{
"name": "name",
"description": "按钮的名称,将与表单数据一起提交。\n\n**Note**:仅在未设置 `href` 属性时,此属性才有效。",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/chip#attributes-name"
}
]
},
{
"name": "value",
"description": "按钮的初始值,将与表单数据一起提交。\n\n**Note**:仅在未设置 `href` 属性时,此属性才有效。",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/chip#attributes-value"
}
]
},
{
"name": "type",
"description": "按钮的类型。默认类型为 `button`。可选类型包括:\n\n* `submit`:点击按钮会提交表单数据到服务器\n* `reset`:点击按钮会将表单中的所有字段重置为初始值\n* `button`:此类型的按钮没有默认行为\n\n**Note**:仅在未指定 `href` 属性时,此属性才有效。",
"values": [
{
"name": "submit",
"description": "此按钮将表单数据提交给服务器"
},
{
"name": "reset",
"description": "此按钮重置所有组件为初始值"
},
{
"name": "button",
"description": "此按钮没有默认行为"
}
],
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/chip#attributes-type"
}
]
},
{
"name": "form",
"description": "关联的 `<form>` 元素。此属性值应为同一页面中的一个 `<form>` 元素的 `id`。\n\n如果未指定此属性则该元素必须是 `<form>` 元素的子元素。通过此属性,你可以将元素放置在页面的任何位置,而不仅仅是 `<form>` 元素的子元素。\n\n**Note**:仅在未指定 `href` 属性时,此属性才有效。",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/chip#attributes-form"
}
]
},
{
"name": "formaction",
"description": "指定提交表单的 URL。\n\n如果指定了此属性将覆盖 `<form>` 元素的 `action` 属性。\n\n**Note**:仅在未指定 `href` 属性且 `type=\"submit\"` 时,此属性才有效。",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/chip#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\"` 时,此属性才有效。",
"values": [
{
"name": "application/x-www-form-urlencoded",
"description": "未指定该属性时的默认值"
},
{
"name": "multipart/form-data",
"description": "当表单包含 `<input type=\"file\">` 元素时使用"
},
{
"name": "text/plain",
"description": "HTML5 新增,用于调试"
}
],
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/chip#attributes-formenctype"
}
]
},
{
"name": "formmethod",
"description": "指定提交表单时使用的 HTTP 方法。可选值包括:\n\n* `post`:表单数据包含在表单内容中,发送到服务器\n* `get`:表单数据以 `?` 作为分隔符附加到表单的 URI 属性中,生成的 URI 发送到服务器。当表单没有副作用,并且仅包含 ASCII 字符时,使用此方法\n\n如果设置了此属性将覆盖 `<form>` 元素的 `method` 属性。\n\n**Note**:仅在未设置 `href` 属性且 `type=\"submit\"` 时,此属性才有效。",
"values": [
{
"name": "post",
"description": "表单数据包含在表单内容中,发送到服务器"
},
{
"name": "get",
"description": "表单数据以 `?` 作为分隔符附加到表单的 URI 属性中,生成的 URI 发送到服务器。当表单没有副作用,并且仅包含 ASCII 字符时,使用此方法"
}
],
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/chip#attributes-formmethod"
}
]
},
{
"name": "formnovalidate",
"description": "如果设置了此属性,表单提交时将不执行表单验证。\n\n如果设置了此属性将覆盖 `<form>` 元素的 `novalidate` 属性。\n\n**Note**:仅在未设置 `href` 属性且 `type=\"submit\"` 时,此属性才有效。",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/chip#attributes-formnovalidate"
}
]
},
{
"name": "formtarget",
"description": "提交表单后接收到的响应应显示在何处。可选值包括:\n\n* `_self`:默认选项,在当前框架中打开\n* `_blank`:在新窗口中打开\n* `_parent`:在父框架中打开\n* `_top`:在整个窗口中打开\n\n如果设置了此属性将覆盖 `<form>` 元素的 `target` 属性。\n\n**Note**:仅在未设置 `href` 属性且 `type=\"submit\"` 时,此属性才有效。",
"values": [
{
"name": "_self",
"description": "默认选项,在当前框架中打开"
},
{
"name": "_blank",
"description": "在新窗口中打开"
},
{
"name": "_parent",
"description": "在父框架中打开"
},
{
"name": "_top",
"description": "在整个窗口中打开"
}
],
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/chip#attributes-formtarget"
}
]
}
],
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/chip"
},
{
"name": "Github",
"url": "https://github.com/zdhxiong/mdui/blob/v2/packages/mdui/src/components/chip/index.ts"
}
]
},
{
"name": "mdui-circular-progress",
"description": "圆形进度指示器组件\n\n```html\n<mdui-circular-progress></mdui-circular-progress>\n```",
"attributes": [
{
"name": "max",
"description": "进度指示器的最大值。默认为 `1`",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/circular-progress#attributes-max"
}
]
},
{
"name": "value",
"description": "进度指示器的当前值。如果未指定该值,则显示为不确定状态",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/circular-progress#attributes-value"
}
]
}
],
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/circular-progress"
},
{
"name": "Github",
"url": "https://github.com/zdhxiong/mdui/blob/v2/packages/mdui/src/components/circular-progress/index.ts"
}
]
},
{
"name": "mdui-collapse-item",
"description": "折叠面板项组件,需配合 `<mdui-collapse>` 组件使用\n\n```html\n<mdui-collapse>\n <mdui-collapse-item header=\"header-1\">content-1</mdui-collapse-item>\n <mdui-collapse-item header=\"header-2\">content-2</mdui-collapse-item>\n</mdui-collapse>\n```",
"attributes": [
{
"name": "value",
"description": "此折叠面板项的值",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/collapse#collapse-item-attributes-value"
}
]
},
{
"name": "header",
"description": "此折叠面板项的头部文本",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/collapse#collapse-item-attributes-header"
}
]
},
{
"name": "disabled",
"description": "是否禁用此折叠面板项",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/collapse#collapse-item-attributes-disabled"
}
]
},
{
"name": "trigger",
"description": "点击该元素时触发折叠,值可以是 CSS 选择器、DOM 元素、或 [JQ 对象](https://www.mdui.org/zh-cn/docs/2/functions/jq)。默认为点击整个 header 区域触发",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/collapse#collapse-item-attributes-trigger"
}
]
}
],
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/collapse"
},
{
"name": "Github",
"url": "https://github.com/zdhxiong/mdui/blob/v2/packages/mdui/src/components/collapse/collapse-item.ts"
}
]
},
{
"name": "mdui-collapse",
"description": "折叠面板组件,需配合 `<mdui-collapse-item>` 组件使用\n\n```html\n<mdui-collapse>\n <mdui-collapse-item header=\"header-1\">content-1</mdui-collapse-item>\n <mdui-collapse-item header=\"header-2\">content-2</mdui-collapse-item>\n</mdui-collapse>\n```",
"attributes": [
{
"name": "accordion",
"description": "是否启用手风琴模式",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/collapse#collapse-attributes-accordion"
}
]
},
{
"name": "value",
"description": "当前展开的 `<mdui-collapse-item>` 的值\n\n**Note**:该属性的 HTML 属性始终为字符串,只有在 `accordion` 为 `true` 时,才能设置初始值;该属性的 JavaScript 属性值在 `accordion` 为 `true` 时为字符串,在 `accordion` 为 `false` 时为字符串数组。因此,当 `accordion` 为 `false` 时,只能通过修改 JavaScript 属性值来改变此值。",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/collapse#collapse-attributes-value"
}
]
},
{
"name": "disabled",
"description": "是否禁用此折叠面板",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/collapse#collapse-attributes-disabled"
}
]
}
],
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/collapse"
},
{
"name": "Github",
"url": "https://github.com/zdhxiong/mdui/blob/v2/packages/mdui/src/components/collapse/collapse.ts"
}
]
},
{
"name": "mdui-dialog",
"description": "对话框组件\n\n```html\n<mdui-dialog>content</mdui-dialog>\n```",
"attributes": [
{
"name": "icon",
"description": "顶部的 Material Icons 图标名。也可以通过 `slot=\"icon\"` 设置",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/dialog#attributes-icon"
}
]
},
{
"name": "headline",
"description": "标题。也可以通过 `slot=\"headline\"` 设置",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/dialog#attributes-headline"
}
]
},
{
"name": "description",
"description": "标题下方的文本。也可以通过 `slot=\"description\"` 设置",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/dialog#attributes-description"
}
]
},
{
"name": "open",
"description": "是否打开对话框",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/dialog#attributes-open"
}
]
},
{
"name": "fullscreen",
"description": "是否全屏显示对话框",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/dialog#attributes-fullscreen"
}
]
},
{
"name": "close-on-esc",
"description": "是否允许按下 ESC 键关闭对话框",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/dialog#attributes-close-on-esc"
}
]
},
{
"name": "close-on-overlay-click",
"description": "是否允许点击遮罩层关闭对话框",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/dialog#attributes-close-on-overlay-click"
}
]
},
{
"name": "stacked-actions",
"description": "是否垂直排列底部操作按钮",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/dialog#attributes-stacked-actions"
}
]
}
],
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/dialog"
},
{
"name": "Github",
"url": "https://github.com/zdhxiong/mdui/blob/v2/packages/mdui/src/components/dialog/index.ts"
}
]
},
{
"name": "mdui-divider",
"description": "分割线组件\n\n```html\n<mdui-divider></mdui-divider>\n```",
"attributes": [
{
"name": "vertical",
"description": "是否为垂直分割线",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/divider#attributes-vertical"
}
]
},
{
"name": "inset",
"description": "是否进行左侧缩进",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/divider#attributes-inset"
}
]
},
{
"name": "middle",
"description": "是否进行左右两侧缩进",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/divider#attributes-middle"
}
]
}
],
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/divider"
},
{
"name": "Github",
"url": "https://github.com/zdhxiong/mdui/blob/v2/packages/mdui/src/components/divider/index.ts"
}
]
},
{
"name": "mdui-dropdown",
"description": "下拉组件\n\n```html\n<mdui-dropdown>\n <mdui-button slot=\"trigger\">open dropdown</mdui-button>\n <mdui-menu>\n <mdui-menu-item>Item 1</mdui-menu-item>\n <mdui-menu-item>Item 2</mdui-menu-item>\n </mdui-menu>\n</mdui-dropdown>\n```",
"attributes": [
{
"name": "open",
"description": "是否打开下拉组件",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/dropdown#attributes-open"
}
]
},
{
"name": "disabled",
"description": "是否禁用下拉组件",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/dropdown#attributes-disabled"
}
]
},
{
"name": "trigger",
"description": "下拉组件的触发方式,支持多个值,用空格分隔。可选值包括:\n\n* `click`:点击触发\n* `hover`:鼠标悬浮触发\n* `focus`:聚焦触发\n* `contextmenu`:鼠标右键点击、或触摸长按触发\n* `manual`:仅能通过编程方式打开和关闭下拉组件,不能再指定其他触发方式",
"values": [
{
"name": "click",
"description": "点击触发"
},
{
"name": "hover",
"description": "鼠标悬浮触发"
},
{
"name": "focus",
"description": "聚焦触发"
},
{
"name": "contextmenu",
"description": "鼠标右键点击、或触摸长按触发"
},
{
"name": "manual",
"description": "仅能通过编程方式打开和关闭下拉组件,不能再指定其他触发方式"
}
],
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/dropdown#attributes-trigger"
}
]
},
{
"name": "placement",
"description": "下拉组件内容的位置。可选值包括:\n\n* `auto`:自动判断位置\n* `top-start`:上方左对齐\n* `top`:上方居中\n* `top-end`:上方右对齐\n* `bottom-start`:下方左对齐\n* `bottom`:下方居中\n* `bottom-end`:下方右对齐\n* `left-start`:左侧顶部对齐\n* `left`:左侧居中\n* `left-end`:左侧底部对齐\n* `right-start`:右侧顶部对齐\n* `right`:右侧居中\n* `right-end`:右侧底部对齐",
"values": [
{
"name": "auto",
"description": "自动判断位置"
},
{
"name": "top-start",
"description": "上方左对齐"
},
{
"name": "top",
"description": "上方居中"
},
{
"name": "top-end",
"description": "上方右对齐"
},
{
"name": "bottom-start",
"description": "下方左对齐"
},
{
"name": "bottom",
"description": "下方居中"
},
{
"name": "bottom-end",
"description": "下方右对齐"
},
{
"name": "left-start",
"description": "左侧顶部对齐"
},
{
"name": "left",
"description": "左侧居中"
},
{
"name": "left-end",
"description": "左侧底部对齐"
},
{
"name": "right-start",
"description": "右侧顶部对齐"
},
{
"name": "right",
"description": "右侧居中"
},
{
"name": "right-end",
"description": "右侧底部对齐"
}
],
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/dropdown#attributes-placement"
}
]
},
{
"name": "stay-open-on-click",
"description": "点击 [`<mdui-menu-item>`](https://www.mdui.org/zh-cn/docs/2/components/menu#menu-item-api) 后,下拉组件是否保持打开状态",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/dropdown#attributes-stay-open-on-click"
}
]
},
{
"name": "open-delay",
"description": "鼠标悬浮触发下拉组件打开的延时,单位为毫秒",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/dropdown#attributes-open-delay"
}
]
},
{
"name": "close-delay",
"description": "鼠标悬浮触发下拉组件关闭的延时,单位为毫秒",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/dropdown#attributes-close-delay"
}
]
},
{
"name": "open-on-pointer",
"description": "是否在触发下拉组件的光标位置打开下拉组件,常用于打开鼠标右键菜单",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/dropdown#attributes-open-on-pointer"
}
]
}
],
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/dropdown"
},
{
"name": "Github",
"url": "https://github.com/zdhxiong/mdui/blob/v2/packages/mdui/src/components/dropdown/index.ts"
}
]
},
{
"name": "mdui-fab",
"description": "浮动操作按钮组件\n\n```html\n<mdui-fab icon=\"edit\"></mdui-fab>\n```",
"attributes": [
{
"name": "variant",
"description": "FAB 的形状,此组件的不同形状之间只有颜色不一样。可选值包括:\n\n* `primary`:使用 Primary container 背景色\n* `surface`:使用 Surface container high 背景色\n* `secondary`:使用 Secondary container 背景色\n* `tertiary`:使用 Tertiary container 背景色",
"values": [
{
"name": "primary",
"description": "使用 Primary container 背景色"
},
{
"name": "surface",
"description": "使用 Surface container high 背景色"
},
{
"name": "secondary",
"description": "使用 Secondary container 背景色"
},
{
"name": "tertiary",
"description": "使用 Tertiary container 背景色"
}
],
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/fab#attributes-variant"
}
]
},
{
"name": "size",
"description": "FAB 的大小。可选值包括:\n* `normal`:普通大小 FAB\n* `small`:小型 FAB\n* `large`:大型 FAB",
"values": [
{
"name": "normal",
"description": "普通大小 FAB"
},
{
"name": "small",
"description": "小型 FAB"
},
{
"name": "large",
"description": "大型 FAB"
}
],
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/fab#attributes-size"
}
]
},
{
"name": "icon",
"description": "Material Icons 图标名。也可以通过 `slot=\"icon\"` 设置",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/fab#attributes-icon"
}
]
},
{
"name": "extended",
"description": "是否为展开状态",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/fab#attributes-extended"
}
]
},
{
"name": "href",
"description": "链接的目标 URL。\n\n如果设置了此属性组件内部将渲染为 `<a>` 元素,并可以使用链接相关的属性。",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/fab#attributes-href"
}
]
},
{
"name": "download",
"description": "下载链接的目标。\n\n**Note**:仅在设置了 `href` 属性时,此属性才有效。",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/fab#attributes-download"
}
]
},
{
"name": "target",
"description": "链接的打开方式。可选值包括:\n\n* `_blank`:在新窗口中打开链接\n* `_parent`:在父框架中打开链接\n* `_self`:默认。在当前框架中打开链接\n* `_top`:在整个窗口中打开链接\n\n**Note**:仅在设置了 `href` 属性时,此属性才有效。",
"values": [
{
"name": "_blank",
"description": "在新窗口中打开链接"
},
{
"name": "_parent",
"description": "在父框架中打开链接"
},
{
"name": "_self",
"description": "默认。在当前框架中打开链接"
},
{
"name": "_top",
"description": "在整个窗口中打开链接"
}
],
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/fab#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` 属性时可用。",
"values": [
{
"name": "alternate",
"description": "当前文档的替代版本"
},
{
"name": "author",
"description": "当前文档或文章的作者"
},
{
"name": "bookmark",
"description": "永久链接到最近的祖先章节"
},
{
"name": "external",
"description": "引用的文档与当前文档不在同一站点"
},
{
"name": "help",
"description": "链接到相关的帮助文档"
},
{
"name": "license",
"description": "当前文档的主要内容由被引用文件的版权许可覆盖"
},
{
"name": "me",
"description": "当前文档代表链接内容的所有者"
},
{
"name": "next",
"description": "当前文档是系列中的一部分,被引用的文档是系列的下一个文档"
},
{
"name": "nofollow",
"description": "当前文档的作者或发布者不认可被引用的文件"
},
{
"name": "noreferrer",
"description": "不包含 `Referer` 头。类似于 `noopener` 的效果"
},
{
"name": "opener",
"description": "如果超链接会创建一个顶级浏览上下文(即 `target` 属性值为 `_blank`),则创建一个辅助浏览上下文"
},
{
"name": "prev",
"description": "当前文档是系列的一部分,被引用的文档是系列的上一个文档"
},
{
"name": "search",
"description": "提供一个资源链接,可用于搜索当前文件及其相关页面"
},
{
"name": "tag",
"description": "提供一个适用于当前文档的标签(由给定地址识别)"
}
],
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/fab#attributes-rel"
}
]
},
{
"name": "autofocus",
"description": "是否在页面加载完成后自动获取焦点",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/fab#attributes-autofocus"
}
]
},
{
"name": "tabindex",
"description": "元素在使用 Tab 键切换焦点时的顺序",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/fab#attributes-tabindex"
}
]
},
{
"name": "disabled",
"description": "是否禁用",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/fab#attributes-disabled"
}
]
},
{
"name": "loading",
"description": "是否处于加载中状态",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/fab#attributes-loading"
}
]
},
{
"name": "name",
"description": "按钮的名称,将与表单数据一起提交。\n\n**Note**:仅在未设置 `href` 属性时,此属性才有效。",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/fab#attributes-name"
}
]
},
{
"name": "value",
"description": "按钮的初始值,将与表单数据一起提交。\n\n**Note**:仅在未设置 `href` 属性时,此属性才有效。",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/fab#attributes-value"
}
]
},
{
"name": "type",
"description": "按钮的类型。默认类型为 `button`。可选类型包括:\n\n* `submit`:点击按钮会提交表单数据到服务器\n* `reset`:点击按钮会将表单中的所有字段重置为初始值\n* `button`:此类型的按钮没有默认行为\n\n**Note**:仅在未指定 `href` 属性时,此属性才有效。",
"values": [
{
"name": "submit",
"description": "此按钮将表单数据提交给服务器"
},
{
"name": "reset",
"description": "此按钮重置所有组件为初始值"
},
{
"name": "button",
"description": "此按钮没有默认行为"
}
],
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/fab#attributes-type"
}
]
},
{
"name": "form",
"description": "关联的 `<form>` 元素。此属性值应为同一页面中的一个 `<form>` 元素的 `id`。\n\n如果未指定此属性则该元素必须是 `<form>` 元素的子元素。通过此属性,你可以将元素放置在页面的任何位置,而不仅仅是 `<form>` 元素的子元素。\n\n**Note**:仅在未指定 `href` 属性时,此属性才有效。",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/fab#attributes-form"
}
]
},
{
"name": "formaction",
"description": "指定提交表单的 URL。\n\n如果指定了此属性将覆盖 `<form>` 元素的 `action` 属性。\n\n**Note**:仅在未指定 `href` 属性且 `type=\"submit\"` 时,此属性才有效。",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/fab#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\"` 时,此属性才有效。",
"values": [
{
"name": "application/x-www-form-urlencoded",
"description": "未指定该属性时的默认值"
},
{
"name": "multipart/form-data",
"description": "当表单包含 `<input type=\"file\">` 元素时使用"
},
{
"name": "text/plain",
"description": "HTML5 新增,用于调试"
}
],
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/fab#attributes-formenctype"
}
]
},
{
"name": "formmethod",
"description": "指定提交表单时使用的 HTTP 方法。可选值包括:\n\n* `post`:表单数据包含在表单内容中,发送到服务器\n* `get`:表单数据以 `?` 作为分隔符附加到表单的 URI 属性中,生成的 URI 发送到服务器。当表单没有副作用,并且仅包含 ASCII 字符时,使用此方法\n\n如果设置了此属性将覆盖 `<form>` 元素的 `method` 属性。\n\n**Note**:仅在未设置 `href` 属性且 `type=\"submit\"` 时,此属性才有效。",
"values": [
{
"name": "post",
"description": "表单数据包含在表单内容中,发送到服务器"
},
{
"name": "get",
"description": "表单数据以 `?` 作为分隔符附加到表单的 URI 属性中,生成的 URI 发送到服务器。当表单没有副作用,并且仅包含 ASCII 字符时,使用此方法"
}
],
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/fab#attributes-formmethod"
}
]
},
{
"name": "formnovalidate",
"description": "如果设置了此属性,表单提交时将不执行表单验证。\n\n如果设置了此属性将覆盖 `<form>` 元素的 `novalidate` 属性。\n\n**Note**:仅在未设置 `href` 属性且 `type=\"submit\"` 时,此属性才有效。",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/fab#attributes-formnovalidate"
}
]
},
{
"name": "formtarget",
"description": "提交表单后接收到的响应应显示在何处。可选值包括:\n\n* `_self`:默认选项,在当前框架中打开\n* `_blank`:在新窗口中打开\n* `_parent`:在父框架中打开\n* `_top`:在整个窗口中打开\n\n如果设置了此属性将覆盖 `<form>` 元素的 `target` 属性。\n\n**Note**:仅在未设置 `href` 属性且 `type=\"submit\"` 时,此属性才有效。",
"values": [
{
"name": "_self",
"description": "默认选项,在当前框架中打开"
},
{
"name": "_blank",
"description": "在新窗口中打开"
},
{
"name": "_parent",
"description": "在父框架中打开"
},
{
"name": "_top",
"description": "在整个窗口中打开"
}
],
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/fab#attributes-formtarget"
}
]
}
],
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/fab"
},
{
"name": "Github",
"url": "https://github.com/zdhxiong/mdui/blob/v2/packages/mdui/src/components/fab/index.ts"
}
]
},
{
"name": "mdui-icon",
"description": "图标组件\n\n```html\n<mdui-icon name=\"search\"></mdui-icon>\n```",
"attributes": [
{
"name": "name",
"description": "Material Icons 图标名",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/icon#attributes-name"
}
]
},
{
"name": "src",
"description": "svg 图标的路径",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/icon#attributes-src"
}
]
}
],
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/icon"
},
{
"name": "Github",
"url": "https://github.com/zdhxiong/mdui/blob/v2/packages/mdui/src/components/icon/index.ts"
}
]
},
{
"name": "mdui-layout-item",
"description": "布局项组件\n\n```html\n<mdui-layout>\n <mdui-layout-item></mdui-layout-item>\n <mdui-layout-item></mdui-layout-item>\n <mdui-layout-main></mdui-layout-main>\n</mdui-layout>\n```",
"attributes": [
{
"name": "placement",
"description": "组件的位置。可选值包括:\n\n* `top`:上方\n* `bottom`:下方\n* `left`:左侧\n* `right`:右侧",
"values": [
{
"name": "top",
"description": "上方"
},
{
"name": "bottom",
"description": "下方"
},
{
"name": "left",
"description": "左侧"
},
{
"name": "right",
"description": "右侧"
}
],
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/layout#layout-item-attributes-placement"
}
]
},
{
"name": "order",
"description": "该组件在 [`<mdui-layout>`](https://www.mdui.org/zh-cn/docs/2/components/layout) 中的布局顺序,按从小到大排序。默认为 `0`",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/layout#layout-item-attributes-order"
}
]
}
],
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/layout"
},
{
"name": "Github",
"url": "https://github.com/zdhxiong/mdui/blob/v2/packages/mdui/src/components/layout/layout-item.ts"
}
]
},
{
"name": "mdui-layout-main",
"description": "布局主体内容组件\n\n```html\n<mdui-layout>\n <mdui-layout-item></mdui-layout-item>\n <mdui-layout-item></mdui-layout-item>\n <mdui-layout-main></mdui-layout-main>\n</mdui-layout>\n```",
"attributes": [],
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/layout"
},
{
"name": "Github",
"url": "https://github.com/zdhxiong/mdui/blob/v2/packages/mdui/src/components/layout/layout-main.ts"
}
]
},
{
"name": "mdui-layout",
"description": "布局组件\n\n```html\n<mdui-layout>\n <mdui-layout-item></mdui-layout-item>\n <mdui-layout-item></mdui-layout-item>\n <mdui-layout-main></mdui-layout-main>\n</mdui-layout>\n```",
"attributes": [
{
"name": "full-height",
"description": "设置当前布局的高度为 100%",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/layout#layout-attributes-full-height"
}
]
}
],
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/layout"
},
{
"name": "Github",
"url": "https://github.com/zdhxiong/mdui/blob/v2/packages/mdui/src/components/layout/layout.ts"
}
]
},
{
"name": "mdui-linear-progress",
"description": "线性进度指示器组件\n\n```html\n<mdui-linear-progress></mdui-linear-progress>\n```",
"attributes": [
{
"name": "max",
"description": "进度指示器的最大值。默认为 `1`",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/linear-progress#attributes-max"
}
]
},
{
"name": "value",
"description": "进度指示器的当前值。如果未指定该值,则处于不确定状态",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/linear-progress#attributes-value"
}
]
}
],
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/linear-progress"
},
{
"name": "Github",
"url": "https://github.com/zdhxiong/mdui/blob/v2/packages/mdui/src/components/linear-progress/index.ts"
}
]
},
{
"name": "mdui-list-item",
"description": "列表项组件。需配合 `<mdui-list>` 组件使用\n\n```html\n<mdui-list>\n <mdui-list-subheader>Subheader</mdui-list-subheader>\n <mdui-list-item>Item 1</mdui-list-item>\n <mdui-list-item>Item 2</mdui-list-item>\n</mdui-list>\n```",
"attributes": [
{
"name": "headline",
"description": "主文本。也可以通过 default slot 设置",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/list#list-item-attributes-headline"
}
]
},
{
"name": "headline-line",
"description": "主文本行数,超过限制后将截断显示。默认无行数限制。可选值包括:\n\n* `1`:显示单行,超出后截断\n* `2`:显示两行,超出后截断\n* `3`:显示三行,超出后截断",
"values": [
{
"name": "1",
"description": "显示单行,超出后截断"
},
{
"name": "2",
"description": "显示两行,超出后截断"
},
{
"name": "3",
"description": "显示三行,超出后截断"
}
],
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/list#list-item-attributes-headline-line"
}
]
},
{
"name": "description",
"description": "副文本。也可以通过 `slot=\"description\"` 设置",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/list#list-item-attributes-description"
}
]
},
{
"name": "description-line",
"description": "副文本行数,超过限制后将截断显示。默认无行数限制。可选值包括:\n\n* `1`:显示单行,超出后截断\n* `2`:显示两行,超出后截断\n* `3`:显示三行,超出后截断",
"values": [
{
"name": "1",
"description": "显示单行,超出后截断"
},
{
"name": "2",
"description": "显示两行,超出后截断"
},
{
"name": "3",
"description": "显示三行,超出后截断"
}
],
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/list#list-item-attributes-description-line"
}
]
},
{
"name": "icon",
"description": "左侧的 Material Icons 图标名。也可以通过 `slot=\"icon\"` 设置",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/list#list-item-attributes-icon"
}
]
},
{
"name": "end-icon",
"description": "右侧的 Material Icons 图标名。也可以通过 `slot=\"end-icon\"` 设置",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/list#list-item-attributes-end-icon"
}
]
},
{
"name": "disabled",
"description": "是否禁用该列表项,禁用后,列表项将变为灰色,且其中的 [`<mdui-checkbox>`](https://www.mdui.org/zh-cn/docs/2/components/checkbox)、[`<mdui-radio>`](https://www.mdui.org/zh-cn/docs/2/components/radio)、[`<mdui-switch>`](https://www.mdui.org/zh-cn/docs/2/components/switch) 等也将禁用",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/list#list-item-attributes-disabled"
}
]
},
{
"name": "active",
"description": "是否激活该列表项",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/list#list-item-attributes-active"
}
]
},
{
"name": "nonclickable",
"description": "是否使列表项不可点击。设置后,列表项中的 [`<mdui-checkbox>`](https://www.mdui.org/zh-cn/docs/2/components/checkbox)、[`<mdui-radio>`](https://www.mdui.org/zh-cn/docs/2/components/radio)、[`<mdui-switch>`](https://www.mdui.org/zh-cn/docs/2/components/switch) 等仍可交互",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/list#list-item-attributes-nonclickable"
}
]
},
{
"name": "rounded",
"description": "是否使用圆角形状的列表项",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/list#list-item-attributes-rounded"
}
]
},
{
"name": "alignment",
"description": "列表项的垂直对齐方式。可选值包括:\n\n* `start`:顶部对齐\n* `center`:居中对齐\n* `end`:底部对齐",
"values": [
{
"name": "start",
"description": "顶部对齐"
},
{
"name": "center",
"description": "居中对齐"
},
{
"name": "end",
"description": "底部对齐"
}
],
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/list#list-item-attributes-alignment"
}
]
},
{
"name": "href",
"description": "链接的目标 URL。\n\n如果设置了此属性组件内部将渲染为 `<a>` 元素,并可以使用链接相关的属性。",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/list#list-item-attributes-href"
}
]
},
{
"name": "download",
"description": "下载链接的目标。\n\n**Note**:仅在设置了 `href` 属性时,此属性才有效。",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/list#list-item-attributes-download"
}
]
},
{
"name": "target",
"description": "链接的打开方式。可选值包括:\n\n* `_blank`:在新窗口中打开链接\n* `_parent`:在父框架中打开链接\n* `_self`:默认。在当前框架中打开链接\n* `_top`:在整个窗口中打开链接\n\n**Note**:仅在设置了 `href` 属性时,此属性才有效。",
"values": [
{
"name": "_blank",
"description": "在新窗口中打开链接"
},
{
"name": "_parent",
"description": "在父框架中打开链接"
},
{
"name": "_self",
"description": "默认。在当前框架中打开链接"
},
{
"name": "_top",
"description": "在整个窗口中打开链接"
}
],
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/list#list-item-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` 属性时可用。",
"values": [
{
"name": "alternate",
"description": "当前文档的替代版本"
},
{
"name": "author",
"description": "当前文档或文章的作者"
},
{
"name": "bookmark",
"description": "永久链接到最近的祖先章节"
},
{
"name": "external",
"description": "引用的文档与当前文档不在同一站点"
},
{
"name": "help",
"description": "链接到相关的帮助文档"
},
{
"name": "license",
"description": "当前文档的主要内容由被引用文件的版权许可覆盖"
},
{
"name": "me",
"description": "当前文档代表链接内容的所有者"
},
{
"name": "next",
"description": "当前文档是系列中的一部分,被引用的文档是系列的下一个文档"
},
{
"name": "nofollow",
"description": "当前文档的作者或发布者不认可被引用的文件"
},
{
"name": "noreferrer",
"description": "不包含 `Referer` 头。类似于 `noopener` 的效果"
},
{
"name": "opener",
"description": "如果超链接会创建一个顶级浏览上下文(即 `target` 属性值为 `_blank`),则创建一个辅助浏览上下文"
},
{
"name": "prev",
"description": "当前文档是系列的一部分,被引用的文档是系列的上一个文档"
},
{
"name": "search",
"description": "提供一个资源链接,可用于搜索当前文件及其相关页面"
},
{
"name": "tag",
"description": "提供一个适用于当前文档的标签(由给定地址识别)"
}
],
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/list#list-item-attributes-rel"
}
]
},
{
"name": "autofocus",
"description": "是否在页面加载完成后自动获取焦点",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/list#list-item-attributes-autofocus"
}
]
},
{
"name": "tabindex",
"description": "元素在使用 Tab 键切换焦点时的顺序",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/list#list-item-attributes-tabindex"
}
]
}
],
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/list"
},
{
"name": "Github",
"url": "https://github.com/zdhxiong/mdui/blob/v2/packages/mdui/src/components/list/list-item.ts"
}
]
},
{
"name": "mdui-list-subheader",
"description": "列表标题组件。需配合 `<mdui-list>` 组件使用\n\n```html\n<mdui-list>\n <mdui-list-subheader>Subheader</mdui-list-subheader>\n <mdui-list-item>Item 1</mdui-list-item>\n <mdui-list-item>Item 2</mdui-list-item>\n</mdui-list>\n```",
"attributes": [],
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/list"
},
{
"name": "Github",
"url": "https://github.com/zdhxiong/mdui/blob/v2/packages/mdui/src/components/list/list-subheader.ts"
}
]
},
{
"name": "mdui-list",
"description": "列表组件。需配合 `<mdui-list-item>` 组件使用\n\n```html\n<mdui-list>\n <mdui-list-subheader>Subheader</mdui-list-subheader>\n <mdui-list-item>Item 1</mdui-list-item>\n <mdui-list-item>Item 2</mdui-list-item>\n</mdui-list>\n```",
"attributes": [],
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/list"
},
{
"name": "Github",
"url": "https://github.com/zdhxiong/mdui/blob/v2/packages/mdui/src/components/list/list.ts"
}
]
},
{
"name": "mdui-menu-item",
"description": "菜单项组件。需配合 `<mdui-menu>` 组件使用\n\n```html\n<mdui-menu>\n <mdui-menu-item>Item 1</mdui-menu-item>\n <mdui-menu-item>Item 2</mdui-menu-item>\n</mdui-menu>\n```",
"attributes": [
{
"name": "value",
"description": "菜单项的值",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/menu#menu-item-attributes-value"
}
]
},
{
"name": "disabled",
"description": "是否禁用菜单项",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/menu#menu-item-attributes-disabled"
}
]
},
{
"name": "icon",
"description": "左侧的 Material Icons 图标名。也可以通过 `slot=\"icon\"` 设置\n\n如果左侧不需要显示图标但需要预留一个图标的位置可传入空字符串进行占位",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/menu#menu-item-attributes-icon"
}
]
},
{
"name": "end-icon",
"description": "右侧的 Material Icons 图标名。也可以通过 `slot=\"end-icon\"` 设置",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/menu#menu-item-attributes-end-icon"
}
]
},
{
"name": "end-text",
"description": "右侧的文本。也可以通过 `slot=\"end-text\"` 设置",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/menu#menu-item-attributes-end-text"
}
]
},
{
"name": "selected-icon",
"description": "选中状态的 Material Icons 图标名。也可以通过 `slot=\"selected-icon\"` 设置",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/menu#menu-item-attributes-selected-icon"
}
]
},
{
"name": "submenu-open",
"description": "是否打开子菜单",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/menu#menu-item-attributes-submenu-open"
}
]
},
{
"name": "href",
"description": "链接的目标 URL。\n\n如果设置了此属性组件内部将渲染为 `<a>` 元素,并可以使用链接相关的属性。",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/menu#menu-item-attributes-href"
}
]
},
{
"name": "download",
"description": "下载链接的目标。\n\n**Note**:仅在设置了 `href` 属性时,此属性才有效。",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/menu#menu-item-attributes-download"
}
]
},
{
"name": "target",
"description": "链接的打开方式。可选值包括:\n\n* `_blank`:在新窗口中打开链接\n* `_parent`:在父框架中打开链接\n* `_self`:默认。在当前框架中打开链接\n* `_top`:在整个窗口中打开链接\n\n**Note**:仅在设置了 `href` 属性时,此属性才有效。",
"values": [
{
"name": "_blank",
"description": "在新窗口中打开链接"
},
{
"name": "_parent",
"description": "在父框架中打开链接"
},
{
"name": "_self",
"description": "默认。在当前框架中打开链接"
},
{
"name": "_top",
"description": "在整个窗口中打开链接"
}
],
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/menu#menu-item-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` 属性时可用。",
"values": [
{
"name": "alternate",
"description": "当前文档的替代版本"
},
{
"name": "author",
"description": "当前文档或文章的作者"
},
{
"name": "bookmark",
"description": "永久链接到最近的祖先章节"
},
{
"name": "external",
"description": "引用的文档与当前文档不在同一站点"
},
{
"name": "help",
"description": "链接到相关的帮助文档"
},
{
"name": "license",
"description": "当前文档的主要内容由被引用文件的版权许可覆盖"
},
{
"name": "me",
"description": "当前文档代表链接内容的所有者"
},
{
"name": "next",
"description": "当前文档是系列中的一部分,被引用的文档是系列的下一个文档"
},
{
"name": "nofollow",
"description": "当前文档的作者或发布者不认可被引用的文件"
},
{
"name": "noreferrer",
"description": "不包含 `Referer` 头。类似于 `noopener` 的效果"
},
{
"name": "opener",
"description": "如果超链接会创建一个顶级浏览上下文(即 `target` 属性值为 `_blank`),则创建一个辅助浏览上下文"
},
{
"name": "prev",
"description": "当前文档是系列的一部分,被引用的文档是系列的上一个文档"
},
{
"name": "search",
"description": "提供一个资源链接,可用于搜索当前文件及其相关页面"
},
{
"name": "tag",
"description": "提供一个适用于当前文档的标签(由给定地址识别)"
}
],
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/menu#menu-item-attributes-rel"
}
]
},
{
"name": "autofocus",
"description": "是否在页面加载完成后自动获取焦点",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/menu#menu-item-attributes-autofocus"
}
]
},
{
"name": "tabindex",
"description": "元素在使用 Tab 键切换焦点时的顺序",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/menu#menu-item-attributes-tabindex"
}
]
}
],
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/menu"
},
{
"name": "Github",
"url": "https://github.com/zdhxiong/mdui/blob/v2/packages/mdui/src/components/menu/menu-item.ts"
}
]
},
{
"name": "mdui-menu",
"description": "菜单组件。需配合 `<mdui-menu-item>` 组件使用\n\n```html\n<mdui-menu>\n <mdui-menu-item>Item 1</mdui-menu-item>\n <mdui-menu-item>Item 2</mdui-menu-item>\n</mdui-menu>\n```",
"attributes": [
{
"name": "selects",
"description": "菜单项的可选状态。默认不可选。可选值包括:\n\n* `single`:单选\n* `multiple`:多选",
"values": [
{
"name": "single",
"description": "单选"
},
{
"name": "multiple",
"description": "多选"
}
],
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/menu#menu-attributes-selects"
}
]
},
{
"name": "value",
"description": "当前选中的 `<mdui-menu-item>` 的值。\n\n**Note**:该属性的 HTML 属性始终为字符串,仅在 `selects=\"single\"` 时可通过 HTML 属性设置初始值;该属性的 JavaScript 属性值在 `selects=\"single\"` 时为字符串,在 `selects=\"multiple\"` 时为字符串数组。因此,在 `selects=\"multiple\"` 时,若要修改该值,只能通过修改 JavaScript 属性值实现。",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/menu#menu-attributes-value"
}
]
},
{
"name": "dense",
"description": "菜单项是否使用紧凑布局",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/menu#menu-attributes-dense"
}
]
},
{
"name": "submenu-trigger",
"description": "子菜单的触发方式,支持多个值,用空格分隔。可选值包括:\n\n* `click`:点击菜单项时打开子菜单\n* `hover`:鼠标悬浮到菜单项上时打开子菜单\n* `focus`:聚焦到菜单项上时打开子菜单\n* `manual`:仅能通过编程方式打开和关闭子菜单,不能再指定其他触发方式",
"values": [
{
"name": "click",
"description": "点击菜单项时打开子菜单"
},
{
"name": "hover",
"description": "鼠标悬浮到菜单项上时打开子菜单"
},
{
"name": "focus",
"description": "聚焦到菜单项上时打开子菜单"
},
{
"name": "manual",
"description": "仅能通过编程方式打开和关闭子菜单,不能再指定其他触发方式"
}
],
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/menu#menu-attributes-submenu-trigger"
}
]
},
{
"name": "submenu-open-delay",
"description": "鼠标悬浮触发子菜单打开的延时,单位毫秒",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/menu#menu-attributes-submenu-open-delay"
}
]
},
{
"name": "submenu-close-delay",
"description": "鼠标悬浮触发子菜单关闭的延时,单位毫秒",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/menu#menu-attributes-submenu-close-delay"
}
]
}
],
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/menu"
},
{
"name": "Github",
"url": "https://github.com/zdhxiong/mdui/blob/v2/packages/mdui/src/components/menu/menu.ts"
}
]
},
{
"name": "mdui-navigation-bar-item",
"description": "底部导航栏项组件。需配合 `<mdui-navigation-bar>` 组件使用\n\n```html\n<mdui-navigation-bar>\n <mdui-navigation-bar-item icon=\"place\">Item 1</mdui-navigation-bar-item>\n <mdui-navigation-bar-item icon=\"commute\">Item 2</mdui-navigation-bar-item>\n <mdui-navigation-bar-item icon=\"people\">Item 3</mdui-navigation-bar-item>\n</mdui-navigation-bar>\n```",
"attributes": [
{
"name": "icon",
"description": "未激活状态的 Material Icons 图标名。也可以通过 `slot=\"icon\"` 设置",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/navigation-bar#navigation-bar-item-attributes-icon"
}
]
},
{
"name": "active-icon",
"description": "激活状态的 Material Icons 图标名。也可以通过 `slot=\"active-icon\"` 设置",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/navigation-bar#navigation-bar-item-attributes-active-icon"
}
]
},
{
"name": "value",
"description": "导航项的值",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/navigation-bar#navigation-bar-item-attributes-value"
}
]
},
{
"name": "href",
"description": "链接的目标 URL。\n\n如果设置了此属性组件内部将渲染为 `<a>` 元素,并可以使用链接相关的属性。",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/navigation-bar#navigation-bar-item-attributes-href"
}
]
},
{
"name": "download",
"description": "下载链接的目标。\n\n**Note**:仅在设置了 `href` 属性时,此属性才有效。",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/navigation-bar#navigation-bar-item-attributes-download"
}
]
},
{
"name": "target",
"description": "链接的打开方式。可选值包括:\n\n* `_blank`:在新窗口中打开链接\n* `_parent`:在父框架中打开链接\n* `_self`:默认。在当前框架中打开链接\n* `_top`:在整个窗口中打开链接\n\n**Note**:仅在设置了 `href` 属性时,此属性才有效。",
"values": [
{
"name": "_blank",
"description": "在新窗口中打开链接"
},
{
"name": "_parent",
"description": "在父框架中打开链接"
},
{
"name": "_self",
"description": "默认。在当前框架中打开链接"
},
{
"name": "_top",
"description": "在整个窗口中打开链接"
}
],
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/navigation-bar#navigation-bar-item-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` 属性时可用。",
"values": [
{
"name": "alternate",
"description": "当前文档的替代版本"
},
{
"name": "author",
"description": "当前文档或文章的作者"
},
{
"name": "bookmark",
"description": "永久链接到最近的祖先章节"
},
{
"name": "external",
"description": "引用的文档与当前文档不在同一站点"
},
{
"name": "help",
"description": "链接到相关的帮助文档"
},
{
"name": "license",
"description": "当前文档的主要内容由被引用文件的版权许可覆盖"
},
{
"name": "me",
"description": "当前文档代表链接内容的所有者"
},
{
"name": "next",
"description": "当前文档是系列中的一部分,被引用的文档是系列的下一个文档"
},
{
"name": "nofollow",
"description": "当前文档的作者或发布者不认可被引用的文件"
},
{
"name": "noreferrer",
"description": "不包含 `Referer` 头。类似于 `noopener` 的效果"
},
{
"name": "opener",
"description": "如果超链接会创建一个顶级浏览上下文(即 `target` 属性值为 `_blank`),则创建一个辅助浏览上下文"
},
{
"name": "prev",
"description": "当前文档是系列的一部分,被引用的文档是系列的上一个文档"
},
{
"name": "search",
"description": "提供一个资源链接,可用于搜索当前文件及其相关页面"
},
{
"name": "tag",
"description": "提供一个适用于当前文档的标签(由给定地址识别)"
}
],
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/navigation-bar#navigation-bar-item-attributes-rel"
}
]
},
{
"name": "autofocus",
"description": "是否在页面加载完成后自动获取焦点",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/navigation-bar#navigation-bar-item-attributes-autofocus"
}
]
},
{
"name": "tabindex",
"description": "元素在使用 Tab 键切换焦点时的顺序",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/navigation-bar#navigation-bar-item-attributes-tabindex"
}
]
}
],
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/navigation-bar"
},
{
"name": "Github",
"url": "https://github.com/zdhxiong/mdui/blob/v2/packages/mdui/src/components/navigation-bar/navigation-bar-item.ts"
}
]
},
{
"name": "mdui-navigation-bar",
"description": "底部导航栏组件。需配合 `<mdui-navigation-bar-item>` 组件使用\n\n```html\n<mdui-navigation-bar>\n <mdui-navigation-bar-item icon=\"place\">Item 1</mdui-navigation-bar-item>\n <mdui-navigation-bar-item icon=\"commute\">Item 2</mdui-navigation-bar-item>\n <mdui-navigation-bar-item icon=\"people\">Item 3</mdui-navigation-bar-item>\n</mdui-navigation-bar>\n```",
"attributes": [
{
"name": "hide",
"description": "是否隐藏",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/navigation-bar#navigation-bar-attributes-hide"
}
]
},
{
"name": "label-visibility",
"description": "文本的可视状态。可选值包括:\n\n* `auto`当选项小于等于3个时始终显示文本当选项大于3个时仅显示选中状态的文本\n* `selected`:仅在选中状态显示文本\n* `labeled`:始终显示文本\n* `unlabeled`:始终不显示文本",
"values": [
{
"name": "auto",
"description": "当选项小于等于3个时始终显示文本当选项大于3个时仅显示选中状态的文本"
},
{
"name": "selected",
"description": "仅在选中状态显示文本"
},
{
"name": "labeled",
"description": "始终显示文本"
},
{
"name": "unlabeled",
"description": "始终不显示文本"
}
],
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/navigation-bar#navigation-bar-attributes-label-visibility"
}
]
},
{
"name": "value",
"description": "当前选中的 `<mdui-navigation-bar-item>` 的值",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/navigation-bar#navigation-bar-attributes-value"
}
]
},
{
"name": "scroll-behavior",
"description": "滚动行为。可选值包括:\n\n* `hide`:滚动时隐藏",
"values": [
{
"name": "hide"
},
{
"name": "shrink"
},
{
"name": "elevate"
}
],
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/navigation-bar#navigation-bar-attributes-scroll-behavior"
}
]
},
{
"name": "scroll-target",
"description": "需要监听其滚动事件的元素。值可以是 CSS 选择器、DOM 元素、或 [JQ 对象](https://www.mdui.org/zh-cn/docs/2/functions/jq)。默认监听 `window` 的滚动事件",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/navigation-bar#navigation-bar-attributes-scroll-target"
}
]
},
{
"name": "scroll-threshold",
"description": "在滚动多少距离之后触发滚动行为,单位为 `px`",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/navigation-bar#navigation-bar-attributes-scroll-threshold"
}
]
},
{
"name": "order",
"description": "该组件在 [`<mdui-layout>`](https://www.mdui.org/zh-cn/docs/2/components/layout) 中的布局顺序,按从小到大排序。默认为 `0`",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/navigation-bar#navigation-bar-attributes-order"
}
]
}
],
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/navigation-bar"
},
{
"name": "Github",
"url": "https://github.com/zdhxiong/mdui/blob/v2/packages/mdui/src/components/navigation-bar/navigation-bar.ts"
}
]
},
{
"name": "mdui-navigation-drawer",
"description": "侧边抽屉栏组件\n\n```html\n<mdui-navigation-drawer>content</mdui-navigation-drawer>\n```",
"attributes": [
{
"name": "open",
"description": "是否打开抽屉栏",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/navigation-drawer#attributes-open"
}
]
},
{
"name": "modal",
"description": "抽屉栏打开时,是否显示遮罩层\n\n在窄屏设备上屏幕宽度小于 [`--mdui-breakpoint-md`](https://www.mdui.org/zh-cn/docs/2/styles/design-tokens#breakpoint)),会始终显示遮罩层,无视该参数",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/navigation-drawer#attributes-modal"
}
]
},
{
"name": "close-on-esc",
"description": "在有遮罩层的情况下,按下 ESC 键是否关闭抽屉栏",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/navigation-drawer#attributes-close-on-esc"
}
]
},
{
"name": "close-on-overlay-click",
"description": "点击遮罩层时,是否关闭抽屉栏",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/navigation-drawer#attributes-close-on-overlay-click"
}
]
},
{
"name": "placement",
"description": "抽屉栏的位置。可选值包括:\n\n* `left`:左侧\n* `right`:右侧",
"values": [
{
"name": "left",
"description": "左侧"
},
{
"name": "right",
"description": "右侧"
}
],
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/navigation-drawer#attributes-placement"
}
]
},
{
"name": "contained",
"description": "默认情况下,抽屉栏相对于 `body` 元素显示。当该参数设置为 `true` 时,抽屉栏将相对于其父元素显示。\n\n**Note**:设置该属性时,必须在父元素上手动设置样式 `position: relative; overflow: hidden;`。",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/navigation-drawer#attributes-contained"
}
]
},
{
"name": "order",
"description": "该组件在 [`<mdui-layout>`](https://www.mdui.org/zh-cn/docs/2/components/layout) 中的布局顺序,按从小到大排序。默认为 `0`",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/navigation-drawer#attributes-order"
}
]
}
],
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/navigation-drawer"
},
{
"name": "Github",
"url": "https://github.com/zdhxiong/mdui/blob/v2/packages/mdui/src/components/navigation-drawer/index.ts"
}
]
},
{
"name": "mdui-navigation-rail-item",
"description": "侧边导航项组件。需配合 `<mdui-navigation-rail>` 组件使用\n\n```html\n<mdui-navigation-rail>\n <mdui-navigation-rail-item icon=\"watch_later\">Recent</mdui-navigation-rail-item>\n <mdui-navigation-rail-item icon=\"image\">Images</mdui-navigation-rail-item>\n <mdui-navigation-rail-item icon=\"library_music\">Library</mdui-navigation-rail-item>\n</mdui-navigation-rail>\n```",
"attributes": [
{
"name": "icon",
"description": "未激活状态下的 Material Icons 图标名。也可以通过 `slot=\"icon\"` 设置",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/navigation-rail#navigation-rail-item-attributes-icon"
}
]
},
{
"name": "active-icon",
"description": "激活状态下的 Material Icons 图标名。也可以通过 `slot=\"active-icon\"` 设置",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/navigation-rail#navigation-rail-item-attributes-active-icon"
}
]
},
{
"name": "value",
"description": "导航项的值",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/navigation-rail#navigation-rail-item-attributes-value"
}
]
},
{
"name": "href",
"description": "链接的目标 URL。\n\n如果设置了此属性组件内部将渲染为 `<a>` 元素,并可以使用链接相关的属性。",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/navigation-rail#navigation-rail-item-attributes-href"
}
]
},
{
"name": "download",
"description": "下载链接的目标。\n\n**Note**:仅在设置了 `href` 属性时,此属性才有效。",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/navigation-rail#navigation-rail-item-attributes-download"
}
]
},
{
"name": "target",
"description": "链接的打开方式。可选值包括:\n\n* `_blank`:在新窗口中打开链接\n* `_parent`:在父框架中打开链接\n* `_self`:默认。在当前框架中打开链接\n* `_top`:在整个窗口中打开链接\n\n**Note**:仅在设置了 `href` 属性时,此属性才有效。",
"values": [
{
"name": "_blank",
"description": "在新窗口中打开链接"
},
{
"name": "_parent",
"description": "在父框架中打开链接"
},
{
"name": "_self",
"description": "默认。在当前框架中打开链接"
},
{
"name": "_top",
"description": "在整个窗口中打开链接"
}
],
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/navigation-rail#navigation-rail-item-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` 属性时可用。",
"values": [
{
"name": "alternate",
"description": "当前文档的替代版本"
},
{
"name": "author",
"description": "当前文档或文章的作者"
},
{
"name": "bookmark",
"description": "永久链接到最近的祖先章节"
},
{
"name": "external",
"description": "引用的文档与当前文档不在同一站点"
},
{
"name": "help",
"description": "链接到相关的帮助文档"
},
{
"name": "license",
"description": "当前文档的主要内容由被引用文件的版权许可覆盖"
},
{
"name": "me",
"description": "当前文档代表链接内容的所有者"
},
{
"name": "next",
"description": "当前文档是系列中的一部分,被引用的文档是系列的下一个文档"
},
{
"name": "nofollow",
"description": "当前文档的作者或发布者不认可被引用的文件"
},
{
"name": "noreferrer",
"description": "不包含 `Referer` 头。类似于 `noopener` 的效果"
},
{
"name": "opener",
"description": "如果超链接会创建一个顶级浏览上下文(即 `target` 属性值为 `_blank`),则创建一个辅助浏览上下文"
},
{
"name": "prev",
"description": "当前文档是系列的一部分,被引用的文档是系列的上一个文档"
},
{
"name": "search",
"description": "提供一个资源链接,可用于搜索当前文件及其相关页面"
},
{
"name": "tag",
"description": "提供一个适用于当前文档的标签(由给定地址识别)"
}
],
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/navigation-rail#navigation-rail-item-attributes-rel"
}
]
},
{
"name": "autofocus",
"description": "是否在页面加载完成后自动获取焦点",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/navigation-rail#navigation-rail-item-attributes-autofocus"
}
]
},
{
"name": "tabindex",
"description": "元素在使用 Tab 键切换焦点时的顺序",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/navigation-rail#navigation-rail-item-attributes-tabindex"
}
]
}
],
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/navigation-rail"
},
{
"name": "Github",
"url": "https://github.com/zdhxiong/mdui/blob/v2/packages/mdui/src/components/navigation-rail/navigation-rail-item.ts"
}
]
},
{
"name": "mdui-navigation-rail",
"description": "侧边导航栏组件。需配合 `<mdui-navigation-rail-item>` 组件使用\n\n```html\n<mdui-navigation-rail>\n <mdui-navigation-rail-item icon=\"watch_later\">Recent</mdui-navigation-rail-item>\n <mdui-navigation-rail-item icon=\"image\">Images</mdui-navigation-rail-item>\n <mdui-navigation-rail-item icon=\"library_music\">Library</mdui-navigation-rail-item>\n</mdui-navigation-rail>\n```",
"attributes": [
{
"name": "value",
"description": "当前选中的 `<mdui-navigation-rail-item>` 的值",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/navigation-rail#navigation-rail-attributes-value"
}
]
},
{
"name": "placement",
"description": "导航栏的位置。可选值包括:\n\n* `left`:左侧\n* `right`:右侧",
"values": [
{
"name": "left",
"description": "左侧"
},
{
"name": "right",
"description": "右侧"
}
],
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/navigation-rail#navigation-rail-attributes-placement"
}
]
},
{
"name": "alignment",
"description": "`<mdui-navigation-rail-item>` 元素的对齐方式。可选值包括:\n\n* `start`:顶部对齐\n* `center`:居中对齐\n* `end`:底部对齐",
"values": [
{
"name": "start",
"description": "顶部对齐"
},
{
"name": "center",
"description": "居中对齐"
},
{
"name": "end",
"description": "底部对齐"
}
],
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/navigation-rail#navigation-rail-attributes-alignment"
}
]
},
{
"name": "contained",
"description": "默认情况下,导航栏相对于 `body` 元素显示。当该参数设置为 `true` 时,导航栏将相对于其父元素显示。\n\n**Note**:设置该属性时,必须在父元素上手动设置样式 `position: relative;`。",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/navigation-rail#navigation-rail-attributes-contained"
}
]
},
{
"name": "divider",
"description": "是否在导航栏和页面内容之间添加分割线",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/navigation-rail#navigation-rail-attributes-divider"
}
]
},
{
"name": "order",
"description": "该组件在 [`<mdui-layout>`](https://www.mdui.org/zh-cn/docs/2/components/layout) 中的布局顺序,按从小到大排序。默认为 `0`",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/navigation-rail#navigation-rail-attributes-order"
}
]
}
],
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/navigation-rail"
},
{
"name": "Github",
"url": "https://github.com/zdhxiong/mdui/blob/v2/packages/mdui/src/components/navigation-rail/navigation-rail.ts"
}
]
},
{
"name": "mdui-radio-group",
"description": "单选框组组件。需配合 `<mdui-radio>` 组件使用\n\n```html\n<mdui-radio-group value=\"chinese\">\n <mdui-radio value=\"chinese\">Chinese</mdui-radio>\n <mdui-radio value=\"english\">English</mdui-radio>\n</mdui-radio-group>\n```",
"attributes": [
{
"name": "disabled",
"description": "是否禁用此组件",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/radio#radio-group-attributes-disabled"
}
]
},
{
"name": "form",
"description": "关联的 `<form>` 元素。此属性值应为同一页面中的一个 `<form>` 元素的 `id`。\n\n如果未指定此属性则该元素必须是 `<form>` 元素的子元素。通过此属性,你可以将元素放置在页面的任何位置,而不仅仅是 `<form>` 元素的子元素。",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/radio#radio-group-attributes-form"
}
]
},
{
"name": "name",
"description": "单选框组的名称,将与表单数据一起提交",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/radio#radio-group-attributes-name"
}
]
},
{
"name": "value",
"description": "单选框组的名称,将于表单数据一起提交",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/radio#radio-group-attributes-value"
}
]
},
{
"name": "required",
"description": "提交表单时,是否必须选中其中一个单选框",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/radio#radio-group-attributes-required"
}
]
}
],
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/radio"
},
{
"name": "Github",
"url": "https://github.com/zdhxiong/mdui/blob/v2/packages/mdui/src/components/radio/radio-group.ts"
}
]
},
{
"name": "mdui-radio",
"description": "单选框组件。需配合 `<mdui-radio-group>` 组件使用\n\n```html\n<mdui-radio-group value=\"chinese\">\n <mdui-radio value=\"chinese\">Chinese</mdui-radio>\n <mdui-radio value=\"english\">English</mdui-radio>\n</mdui-radio-group>\n```",
"attributes": [
{
"name": "value",
"description": "当前单选项的值",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/radio#radio-attributes-value"
}
]
},
{
"name": "disabled",
"description": "是否禁用当前单选项",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/radio#radio-attributes-disabled"
}
]
},
{
"name": "checked",
"description": "当前单选项是否已选中",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/radio#radio-attributes-checked"
}
]
},
{
"name": "unchecked-icon",
"description": "未选中状态的 Material Icons 图标名。也可以通过 `slot=\"unchecked-icon\"` 设置",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/radio#radio-attributes-unchecked-icon"
}
]
},
{
"name": "checked-icon",
"description": "选中状态的 Material Icons 图标名。也可以通过 `slot=\"checked-icon\"` 设置",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/radio#radio-attributes-checked-icon"
}
]
},
{
"name": "autofocus",
"description": "是否在页面加载完成后自动获取焦点",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/radio#radio-attributes-autofocus"
}
]
},
{
"name": "tabindex",
"description": "元素在使用 Tab 键切换焦点时的顺序",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/radio#radio-attributes-tabindex"
}
]
}
],
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/radio"
},
{
"name": "Github",
"url": "https://github.com/zdhxiong/mdui/blob/v2/packages/mdui/src/components/radio/radio.ts"
}
]
},
{
"name": "mdui-range-slider",
"description": "范围滑块组件\n\n```html\n<mdui-range-slider></mdui-range-slider>\n```",
"attributes": [
{
"name": "autofocus",
"description": "是否在页面加载完成后自动获取焦点",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/range-slider#attributes-autofocus"
}
]
},
{
"name": "tabindex",
"description": "元素在使用 Tab 键切换焦点时的顺序",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/range-slider#attributes-tabindex"
}
]
},
{
"name": "min",
"description": "滑块的最小值,默认为 `0`",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/range-slider#attributes-min"
}
]
},
{
"name": "max",
"description": "滑块的最大值,默认为 `100`",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/range-slider#attributes-max"
}
]
},
{
"name": "step",
"description": "步进间隔,默认为 `1`",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/range-slider#attributes-step"
}
]
},
{
"name": "tickmarks",
"description": "是否添加刻度标记",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/range-slider#attributes-tickmarks"
}
]
},
{
"name": "nolabel",
"description": "是否隐藏文本提示",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/range-slider#attributes-nolabel"
}
]
},
{
"name": "disabled",
"description": "是否被禁用",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/range-slider#attributes-disabled"
}
]
},
{
"name": "form",
"description": "关联的 `<form>` 元素。此属性值应为同一页面中的一个 `<form>` 元素的 `id`。\n\n如果未指定此属性则该元素必须是 `<form>` 元素的子元素。通过此属性,你可以将元素放置在页面的任何位置,而不仅仅是 `<form>` 元素的子元素。",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/range-slider#attributes-form"
}
]
},
{
"name": "name",
"description": "滑块的名称,该名称将与表单数据一起提交",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/range-slider#attributes-name"
}
]
}
],
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/range-slider"
},
{
"name": "Github",
"url": "https://github.com/zdhxiong/mdui/blob/v2/packages/mdui/src/components/range-slider/index.ts"
}
]
},
{
"name": "mdui-segmented-button-group",
"description": "分段按钮组件。需配合 `<mdui-segmented-button>` 组件使用\n\n```html\n<mdui-segmented-button-group>\n <mdui-segmented-button>Day</mdui-segmented-button>\n <mdui-segmented-button>Week</mdui-segmented-button>\n <mdui-segmented-button>Month</mdui-segmented-button>\n</mdui-segmented-button-group>\n```",
"attributes": [
{
"name": "full-width",
"description": "是否填满父元素宽度",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/segmented-button#segmented-button-group-attributes-full-width"
}
]
},
{
"name": "selects",
"description": "分段按钮的可选中状态,默认为不可选中。可选值包括:\n\n* `single`:单选\n* `multiple`:多选",
"values": [
{
"name": "single",
"description": "单选"
},
{
"name": "multiple",
"description": "多选"
}
],
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/segmented-button#segmented-button-group-attributes-selects"
}
]
},
{
"name": "disabled",
"description": "是否为禁用状态",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/segmented-button#segmented-button-group-attributes-disabled"
}
]
},
{
"name": "required",
"description": "提交表单时,是否必须选中",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/segmented-button#segmented-button-group-attributes-required"
}
]
},
{
"name": "form",
"description": "关联的 `<form>` 元素。此属性值应为同一页面中的一个 `<form>` 元素的 `id`。\n\n如果未指定此属性则该元素必须是 `<form>` 元素的子元素。通过此属性,你可以将元素放置在页面的任何位置,而不仅仅是 `<form>` 元素的子元素。",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/segmented-button#segmented-button-group-attributes-form"
}
]
},
{
"name": "name",
"description": "提交表单时的名称,将与表单数据一起提交",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/segmented-button#segmented-button-group-attributes-name"
}
]
},
{
"name": "value",
"description": "当前选中的 `<mdui-segmented-button>` 的值。\n\n**Note**:该属性的 HTML 属性始终为字符串,且仅在 `selects=\"single\"` 时可以通过 HTML 属性设置初始值。该属性的 JavaScript 属性值在 `selects=\"single\"` 时为字符串,在 `selects=\"multiple\"` 时为字符串数组。所以,在 `selects=\"multiple\"` 时,如果要修改该值,只能通过修改 JavaScript 属性值实现。",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/segmented-button#segmented-button-group-attributes-value"
}
]
}
],
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/segmented-button"
},
{
"name": "Github",
"url": "https://github.com/zdhxiong/mdui/blob/v2/packages/mdui/src/components/segmented-button/segmented-button-group.ts"
}
]
},
{
"name": "mdui-segmented-button",
"description": "分段按钮项组件。需配合 `<mdui-segmented-button-group>` 组件使用\n\n```html\n<mdui-segmented-button-group>\n <mdui-segmented-button>Day</mdui-segmented-button>\n <mdui-segmented-button>Week</mdui-segmented-button>\n <mdui-segmented-button>Month</mdui-segmented-button>\n</mdui-segmented-button-group>\n```",
"attributes": [
{
"name": "icon",
"description": "左侧的 Material Icons 图标名。也可以通过 `slot=\"icon\"` 设置",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/segmented-button#segmented-button-attributes-icon"
}
]
},
{
"name": "end-icon",
"description": "右侧的 Material Icons 图标名。也可以通过 `slot=\"end-icon\"` 设置",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/segmented-button#segmented-button-attributes-end-icon"
}
]
},
{
"name": "selected-icon",
"description": "选中状态的 Material Icons 图标名。也可以通过 `slot=\"selected-icon\"` 设置",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/segmented-button#segmented-button-attributes-selected-icon"
}
]
},
{
"name": "href",
"description": "链接的目标 URL。\n\n如果设置了此属性组件内部将渲染为 `<a>` 元素,并可以使用链接相关的属性。",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/segmented-button#segmented-button-attributes-href"
}
]
},
{
"name": "download",
"description": "下载链接的目标。\n\n**Note**:仅在设置了 `href` 属性时,此属性才有效。",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/segmented-button#segmented-button-attributes-download"
}
]
},
{
"name": "target",
"description": "链接的打开方式。可选值包括:\n\n* `_blank`:在新窗口中打开链接\n* `_parent`:在父框架中打开链接\n* `_self`:默认。在当前框架中打开链接\n* `_top`:在整个窗口中打开链接\n\n**Note**:仅在设置了 `href` 属性时,此属性才有效。",
"values": [
{
"name": "_blank",
"description": "在新窗口中打开链接"
},
{
"name": "_parent",
"description": "在父框架中打开链接"
},
{
"name": "_self",
"description": "默认。在当前框架中打开链接"
},
{
"name": "_top",
"description": "在整个窗口中打开链接"
}
],
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/segmented-button#segmented-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` 属性时可用。",
"values": [
{
"name": "alternate",
"description": "当前文档的替代版本"
},
{
"name": "author",
"description": "当前文档或文章的作者"
},
{
"name": "bookmark",
"description": "永久链接到最近的祖先章节"
},
{
"name": "external",
"description": "引用的文档与当前文档不在同一站点"
},
{
"name": "help",
"description": "链接到相关的帮助文档"
},
{
"name": "license",
"description": "当前文档的主要内容由被引用文件的版权许可覆盖"
},
{
"name": "me",
"description": "当前文档代表链接内容的所有者"
},
{
"name": "next",
"description": "当前文档是系列中的一部分,被引用的文档是系列的下一个文档"
},
{
"name": "nofollow",
"description": "当前文档的作者或发布者不认可被引用的文件"
},
{
"name": "noreferrer",
"description": "不包含 `Referer` 头。类似于 `noopener` 的效果"
},
{
"name": "opener",
"description": "如果超链接会创建一个顶级浏览上下文(即 `target` 属性值为 `_blank`),则创建一个辅助浏览上下文"
},
{
"name": "prev",
"description": "当前文档是系列的一部分,被引用的文档是系列的上一个文档"
},
{
"name": "search",
"description": "提供一个资源链接,可用于搜索当前文件及其相关页面"
},
{
"name": "tag",
"description": "提供一个适用于当前文档的标签(由给定地址识别)"
}
],
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/segmented-button#segmented-button-attributes-rel"
}
]
},
{
"name": "autofocus",
"description": "是否在页面加载完成后自动获取焦点",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/segmented-button#segmented-button-attributes-autofocus"
}
]
},
{
"name": "tabindex",
"description": "元素在使用 Tab 键切换焦点时的顺序",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/segmented-button#segmented-button-attributes-tabindex"
}
]
},
{
"name": "disabled",
"description": "是否禁用",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/segmented-button#segmented-button-attributes-disabled"
}
]
},
{
"name": "loading",
"description": "是否处于加载中状态",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/segmented-button#segmented-button-attributes-loading"
}
]
},
{
"name": "name",
"description": "按钮的名称,将与表单数据一起提交。\n\n**Note**:仅在未设置 `href` 属性时,此属性才有效。",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/segmented-button#segmented-button-attributes-name"
}
]
},
{
"name": "value",
"description": "按钮的初始值,将与表单数据一起提交。\n\n**Note**:仅在未设置 `href` 属性时,此属性才有效。",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/segmented-button#segmented-button-attributes-value"
}
]
},
{
"name": "type",
"description": "按钮的类型。默认类型为 `button`。可选类型包括:\n\n* `submit`:点击按钮会提交表单数据到服务器\n* `reset`:点击按钮会将表单中的所有字段重置为初始值\n* `button`:此类型的按钮没有默认行为\n\n**Note**:仅在未指定 `href` 属性时,此属性才有效。",
"values": [
{
"name": "submit",
"description": "此按钮将表单数据提交给服务器"
},
{
"name": "reset",
"description": "此按钮重置所有组件为初始值"
},
{
"name": "button",
"description": "此按钮没有默认行为"
}
],
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/segmented-button#segmented-button-attributes-type"
}
]
},
{
"name": "form",
"description": "关联的 `<form>` 元素。此属性值应为同一页面中的一个 `<form>` 元素的 `id`。\n\n如果未指定此属性则该元素必须是 `<form>` 元素的子元素。通过此属性,你可以将元素放置在页面的任何位置,而不仅仅是 `<form>` 元素的子元素。\n\n**Note**:仅在未指定 `href` 属性时,此属性才有效。",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/segmented-button#segmented-button-attributes-form"
}
]
},
{
"name": "formaction",
"description": "指定提交表单的 URL。\n\n如果指定了此属性将覆盖 `<form>` 元素的 `action` 属性。\n\n**Note**:仅在未指定 `href` 属性且 `type=\"submit\"` 时,此属性才有效。",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/segmented-button#segmented-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\"` 时,此属性才有效。",
"values": [
{
"name": "application/x-www-form-urlencoded",
"description": "未指定该属性时的默认值"
},
{
"name": "multipart/form-data",
"description": "当表单包含 `<input type=\"file\">` 元素时使用"
},
{
"name": "text/plain",
"description": "HTML5 新增,用于调试"
}
],
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/segmented-button#segmented-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\"` 时,此属性才有效。",
"values": [
{
"name": "post",
"description": "表单数据包含在表单内容中,发送到服务器"
},
{
"name": "get",
"description": "表单数据以 `?` 作为分隔符附加到表单的 URI 属性中,生成的 URI 发送到服务器。当表单没有副作用,并且仅包含 ASCII 字符时,使用此方法"
}
],
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/segmented-button#segmented-button-attributes-formmethod"
}
]
},
{
"name": "formnovalidate",
"description": "如果设置了此属性,表单提交时将不执行表单验证。\n\n如果设置了此属性将覆盖 `<form>` 元素的 `novalidate` 属性。\n\n**Note**:仅在未设置 `href` 属性且 `type=\"submit\"` 时,此属性才有效。",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/segmented-button#segmented-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\"` 时,此属性才有效。",
"values": [
{
"name": "_self",
"description": "默认选项,在当前框架中打开"
},
{
"name": "_blank",
"description": "在新窗口中打开"
},
{
"name": "_parent",
"description": "在父框架中打开"
},
{
"name": "_top",
"description": "在整个窗口中打开"
}
],
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/segmented-button#segmented-button-attributes-formtarget"
}
]
}
],
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/segmented-button"
},
{
"name": "Github",
"url": "https://github.com/zdhxiong/mdui/blob/v2/packages/mdui/src/components/segmented-button/segmented-button.ts"
}
]
},
{
"name": "mdui-select",
"description": "选择框组件。需配合 `<mdui-menu-item>` 组件使用\n\n```html\n<mdui-select>\n <mdui-menu-item value=\"item-1\">Item 1</mdui-menu-item>\n <mdui-menu-item value=\"item-2\">Item 2</mdui-menu-item>\n</mdui-select>\n```",
"attributes": [
{
"name": "variant",
"description": "选择框的样式。可选值包括:\n\n* `filled`:带背景色的选择框,视觉效果较强\n* `outlined`:带边框的选择框,视觉效果较弱",
"values": [
{
"name": "filled",
"description": "带背景色的选择框,视觉效果较强"
},
{
"name": "outlined",
"description": "带边框的选择框,视觉效果较弱"
}
],
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/select#attributes-variant"
}
]
},
{
"name": "multiple",
"description": "是否支持多选",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/select#attributes-multiple"
}
]
},
{
"name": "name",
"description": "选择框的名称,将与表单数据一起提交",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/select#attributes-name"
}
]
},
{
"name": "value",
"description": "选择框的值,将与表单数据一起提交。\n\n如果未指定 `multiple` 属性,该值为字符串;如果指定了 `multiple` 属性该值为字符串数组。HTML 属性只能设置字符串值;如果需要设置数组值,请通过 JavaScript 属性设置。",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/select#attributes-value"
}
]
},
{
"name": "label",
"description": "标签文本",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/select#attributes-label"
}
]
},
{
"name": "placeholder",
"description": "占位符文本",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/select#attributes-placeholder"
}
]
},
{
"name": "helper",
"description": "选择框底部的帮助文本。也可以通过 `slot=\"helper\"` 设置",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/select#attributes-helper"
}
]
},
{
"name": "clearable",
"description": "是否可以清空选择框",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/select#attributes-clearable"
}
]
},
{
"name": "clear-icon",
"description": "当选择框可清空时,显示在选择框右侧的清空按钮的 Material Icons 图标名。也可以通过 `slot=\"clear-icon\"` 设置",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/select#attributes-clear-icon"
}
]
},
{
"name": "placement",
"description": "选择框的位置。可选值包括:\n\n* `auto`:自动判断位置\n* `bottom`:位于下方\n* `top`:位于上方",
"values": [
{
"name": "auto",
"description": "自动判断位置"
},
{
"name": "bottom",
"description": "位于下方"
},
{
"name": "top",
"description": "位于上方"
}
],
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/select#attributes-placement"
}
]
},
{
"name": "end-aligned",
"description": "文本是否右对齐",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/select#attributes-end-aligned"
}
]
},
{
"name": "prefix",
"description": "选择框的前缀文本。仅在聚焦状态,或选择框有值时才会显示。也可以通过 `slot=\"prefix\"` 设置",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/select#attributes-prefix"
}
]
},
{
"name": "suffix",
"description": "选择框的后缀文本。仅在聚焦状态,或选择框有值时才会显示。也可以通过 `slot=\"suffix\"` 设置",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/select#attributes-suffix"
}
]
},
{
"name": "icon",
"description": "选择框的前缀图标的 Material Icons 图标名。也可以通过 `slot=\"icon\"` 设置",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/select#attributes-icon"
}
]
},
{
"name": "end-icon",
"description": "选择框的后缀图标的 Material Icons 图标名。也可以通过 `slot=\"end-icon\"` 设置",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/select#attributes-end-icon"
}
]
},
{
"name": "error-icon",
"description": "表单字段验证失败时,显示在选择框右侧的 Material Icons 图标名。也可以通过 `slot=\"error-icon\"` 设置",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/select#attributes-error-icon"
}
]
},
{
"name": "form",
"description": "关联的 `<form>` 元素。此属性值应为同一页面中的一个 `<form>` 元素的 `id`。\n\n如果未指定此属性则该元素必须是 `<form>` 元素的子元素。通过此属性,你可以将元素放置在页面的任何位置,而不仅仅是 `<form>` 元素的子元素。",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/select#attributes-form"
}
]
},
{
"name": "readonly",
"description": "是否为只读状态",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/select#attributes-readonly"
}
]
},
{
"name": "disabled",
"description": "是否为禁用状态",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/select#attributes-disabled"
}
]
},
{
"name": "required",
"description": "提交表单时,是否必须填写该字段",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/select#attributes-required"
}
]
},
{
"name": "autofocus",
"description": "是否在页面加载完成后自动获取焦点",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/select#attributes-autofocus"
}
]
},
{
"name": "tabindex",
"description": "元素在使用 Tab 键切换焦点时的顺序",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/select#attributes-tabindex"
}
]
}
],
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/select"
},
{
"name": "Github",
"url": "https://github.com/zdhxiong/mdui/blob/v2/packages/mdui/src/components/select/index.ts"
}
]
},
{
"name": "mdui-slider",
"description": "滑块组件\n\n```html\n<mdui-slider></mdui-slider>\n```",
"attributes": [
{
"name": "value",
"description": "滑块的值,将于表单数据一起提交",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/slider#attributes-value"
}
]
},
{
"name": "autofocus",
"description": "是否在页面加载完成后自动获取焦点",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/slider#attributes-autofocus"
}
]
},
{
"name": "tabindex",
"description": "元素在使用 Tab 键切换焦点时的顺序",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/slider#attributes-tabindex"
}
]
},
{
"name": "min",
"description": "滑块的最小值,默认为 `0`",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/slider#attributes-min"
}
]
},
{
"name": "max",
"description": "滑块的最大值,默认为 `100`",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/slider#attributes-max"
}
]
},
{
"name": "step",
"description": "步进间隔,默认为 `1`",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/slider#attributes-step"
}
]
},
{
"name": "tickmarks",
"description": "是否添加刻度标记",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/slider#attributes-tickmarks"
}
]
},
{
"name": "nolabel",
"description": "是否隐藏文本提示",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/slider#attributes-nolabel"
}
]
},
{
"name": "disabled",
"description": "是否被禁用",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/slider#attributes-disabled"
}
]
},
{
"name": "form",
"description": "关联的 `<form>` 元素。此属性值应为同一页面中的一个 `<form>` 元素的 `id`。\n\n如果未指定此属性则该元素必须是 `<form>` 元素的子元素。通过此属性,你可以将元素放置在页面的任何位置,而不仅仅是 `<form>` 元素的子元素。",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/slider#attributes-form"
}
]
},
{
"name": "name",
"description": "滑块的名称,该名称将与表单数据一起提交",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/slider#attributes-name"
}
]
}
],
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/slider"
},
{
"name": "Github",
"url": "https://github.com/zdhxiong/mdui/blob/v2/packages/mdui/src/components/slider/index.ts"
}
]
},
{
"name": "mdui-snackbar",
"description": "消息条组件\n\n```html\n<mdui-snackbar>message</mdui-snackbar>\n```",
"attributes": [
{
"name": "open",
"description": "是否显示 Snackbar",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/snackbar#attributes-open"
}
]
},
{
"name": "placement",
"description": "Snackbar 的显示位置。默认为 `bottom`。可选值包括:\n\n* `top`:顶部居中\n* `top-start`:顶部左对齐\n* `top-end`:顶部右对齐\n* `bottom`:底部居中\n* `bottom-start`:底部左对齐\n* `bottom-end`:底部右对齐",
"values": [
{
"name": "top",
"description": "顶部居中"
},
{
"name": "top-start",
"description": "顶部左对齐"
},
{
"name": "top-end",
"description": "顶部右对齐"
},
{
"name": "bottom",
"description": "底部居中"
},
{
"name": "bottom-start",
"description": "底部左对齐"
},
{
"name": "bottom-end",
"description": "底部右对齐"
}
],
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/snackbar#attributes-placement"
}
]
},
{
"name": "action",
"description": "操作按钮的文本。也可以通过 `slot=\"action\"` 设置操作按钮",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/snackbar#attributes-action"
}
]
},
{
"name": "action-loading",
"description": "操作按钮是否处于加载中状态",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/snackbar#attributes-action-loading"
}
]
},
{
"name": "closeable",
"description": "是否在右侧显示关闭按钮",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/snackbar#attributes-closeable"
}
]
},
{
"name": "close-icon",
"description": "关闭按钮的 Material Icons 图标名。也可以通过 `slot=\"close-icon\"` 设置",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/snackbar#attributes-close-icon"
}
]
},
{
"name": "message-line",
"description": "消息文本的最大显示行数。默认不限制。可选值包括:\n\n* `1`:最多显示一行\n* `2`:最多显示两行",
"values": [
{
"name": "1",
"description": "最多显示一行"
},
{
"name": "2",
"description": "最多显示两行"
}
],
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/snackbar#attributes-message-line"
}
]
},
{
"name": "auto-close-delay",
"description": "自动关闭的延迟时间(单位:毫秒)。设置为 `0` 则不自动关闭。默认为 5000 毫秒",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/snackbar#attributes-auto-close-delay"
}
]
},
{
"name": "close-on-outside-click",
"description": "点击或触摸 Snackbar 以外的区域时,是否关闭 Snackbar",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/snackbar#attributes-close-on-outside-click"
}
]
}
],
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/snackbar"
},
{
"name": "Github",
"url": "https://github.com/zdhxiong/mdui/blob/v2/packages/mdui/src/components/snackbar/index.ts"
}
]
},
{
"name": "mdui-switch",
"description": "开关切换组件\n\n```html\n<mdui-switch></mdui-switch>\n```",
"attributes": [
{
"name": "disabled",
"description": "是否为禁用状态",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/switch#attributes-disabled"
}
]
},
{
"name": "checked",
"description": "是否为选中状态",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/switch#attributes-checked"
}
]
},
{
"name": "unchecked-icon",
"description": "未选中状态的 Material Icons 图标名。也可以通过 `slot=\"unchecked-icon\"` 设置",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/switch#attributes-unchecked-icon"
}
]
},
{
"name": "checked-icon",
"description": "选中状态的 Material Icons 图标名。也可以通过 `slot=\"checked-icon\"` 设置\n\n默认为 `check` 图标,可传入空字符串移除默认图标",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/switch#attributes-checked-icon"
}
]
},
{
"name": "required",
"description": "提交表单时,是否必须选中此开关",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/switch#attributes-required"
}
]
},
{
"name": "form",
"description": "关联的 `<form>` 元素。此属性值应为同一页面中的一个 `<form>` 元素的 `id`。\n\n如果未指定此属性则该元素必须是 `<form>` 元素的子元素。通过此属性,你可以将元素放置在页面的任何位置,而不仅仅是 `<form>` 元素的子元素。",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/switch#attributes-form"
}
]
},
{
"name": "name",
"description": "开关的名称,将与表单数据一起提交",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/switch#attributes-name"
}
]
},
{
"name": "value",
"description": "开关的值,将于表单数据一起提交",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/switch#attributes-value"
}
]
},
{
"name": "autofocus",
"description": "是否在页面加载完成后自动获取焦点",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/switch#attributes-autofocus"
}
]
},
{
"name": "tabindex",
"description": "元素在使用 Tab 键切换焦点时的顺序",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/switch#attributes-tabindex"
}
]
}
],
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/switch"
},
{
"name": "Github",
"url": "https://github.com/zdhxiong/mdui/blob/v2/packages/mdui/src/components/switch/index.ts"
}
]
},
{
"name": "mdui-tab-panel",
"description": "选项卡面板项组件。需配合 `<mdui-tabs>` 和 `<mdui-tab>` 组件使用\n\n```html\n<mdui-tabs value=\"tab-1\">\n <mdui-tab value=\"tab-1\">Tab 1</mdui-tab>\n <mdui-tab value=\"tab-2\">Tab 2</mdui-tab>\n <mdui-tab value=\"tab-3\">Tab 3</mdui-tab>\n\n <mdui-tab-panel slot=\"panel\" value=\"tab-1\">Panel 1</mdui-tab-panel>\n <mdui-tab-panel slot=\"panel\" value=\"tab-2\">Panel 2</mdui-tab-panel>\n <mdui-tab-panel slot=\"panel\" value=\"tab-3\">Panel 3</mdui-tab-panel>\n</mdui-tabs>\n```",
"attributes": [
{
"name": "value",
"description": "选项卡面板项的值",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/tabs#tab-panel-attributes-value"
}
]
}
],
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/tabs"
},
{
"name": "Github",
"url": "https://github.com/zdhxiong/mdui/blob/v2/packages/mdui/src/components/tabs/tab-panel.ts"
}
]
},
{
"name": "mdui-tab",
"description": "选项卡导航项组件。需配合 `<mdui-tabs>` 和 `<mdui-tab-panel>` 组件使用\n\n```html\n<mdui-tabs value=\"tab-1\">\n <mdui-tab value=\"tab-1\">Tab 1</mdui-tab>\n <mdui-tab value=\"tab-2\">Tab 2</mdui-tab>\n <mdui-tab value=\"tab-3\">Tab 3</mdui-tab>\n\n <mdui-tab-panel slot=\"panel\" value=\"tab-1\">Panel 1</mdui-tab-panel>\n <mdui-tab-panel slot=\"panel\" value=\"tab-2\">Panel 2</mdui-tab-panel>\n <mdui-tab-panel slot=\"panel\" value=\"tab-3\">Panel 3</mdui-tab-panel>\n</mdui-tabs>\n```",
"attributes": [
{
"name": "value",
"description": "选项卡导航项的值",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/tabs#tab-attributes-value"
}
]
},
{
"name": "icon",
"description": "Material Icons 图标名。也可以通过 `slot=\"icon\"` 设置",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/tabs#tab-attributes-icon"
}
]
},
{
"name": "inline",
"description": "是否把图标和文本水平排列",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/tabs#tab-attributes-inline"
}
]
},
{
"name": "autofocus",
"description": "是否在页面加载完成后自动获取焦点",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/tabs#tab-attributes-autofocus"
}
]
},
{
"name": "tabindex",
"description": "元素在使用 Tab 键切换焦点时的顺序",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/tabs#tab-attributes-tabindex"
}
]
}
],
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/tabs"
},
{
"name": "Github",
"url": "https://github.com/zdhxiong/mdui/blob/v2/packages/mdui/src/components/tabs/tab.ts"
}
]
},
{
"name": "mdui-tabs",
"description": "选项卡组件。需配合 `<mdui-tab>` 和 `<mdui-tab-panel>` 组件使用\n\n```html\n<mdui-tabs value=\"tab-1\">\n <mdui-tab value=\"tab-1\">Tab 1</mdui-tab>\n <mdui-tab value=\"tab-2\">Tab 2</mdui-tab>\n <mdui-tab value=\"tab-3\">Tab 3</mdui-tab>\n\n <mdui-tab-panel slot=\"panel\" value=\"tab-1\">Panel 1</mdui-tab-panel>\n <mdui-tab-panel slot=\"panel\" value=\"tab-2\">Panel 2</mdui-tab-panel>\n <mdui-tab-panel slot=\"panel\" value=\"tab-3\">Panel 3</mdui-tab-panel>\n</mdui-tabs>\n```",
"attributes": [
{
"name": "variant",
"description": "选项卡形状。可选值包括:\n\n* `primary`:适用于位于 `<mdui-top-app-bar>` 下方,用于切换应用的主页面的场景\n* `secondary`:适用于位于页面中,用于切换一组相关内容的场景",
"values": [
{
"name": "primary",
"description": "适用于位于 `<mdui-top-app-bar>` 下方,用于切换应用的主页面的场景"
},
{
"name": "secondary",
"description": "适用于位于页面中,用于切换一组相关内容的场景"
}
],
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/tabs#tabs-attributes-variant"
}
]
},
{
"name": "value",
"description": "当前激活的 `<mdui-tab>` 的值",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/tabs#tabs-attributes-value"
}
]
},
{
"name": "placement",
"description": "选项卡位置。默认为 `top-start`。可选值包括:\n\n* `top-start`:位于上方,左对齐\n* `top`:位于上方,居中对齐\n* `top-end`:位于上方,右对齐\n* `bottom-start`:位于下方,左对齐\n* `bottom`:位于下方,居中对齐\n* `bottom-end`:位于下方,右对齐\n* `left-start`:位于左侧,顶部对齐\n* `left`:位于左侧,居中对齐\n* `left-end`:位于左侧,底部对齐\n* `right-start`:位于右侧,顶部对齐\n* `right`:位于右侧,居中对齐\n* `right-end`:位于右侧,底部对齐",
"values": [
{
"name": "top-start",
"description": "位于上方,左对齐"
},
{
"name": "top",
"description": "位于上方,居中对齐"
},
{
"name": "top-end",
"description": "位于上方,右对齐"
},
{
"name": "bottom-start",
"description": "位于下方,左对齐"
},
{
"name": "bottom",
"description": "位于下方,居中对齐"
},
{
"name": "bottom-end",
"description": "位于下方,右对齐"
},
{
"name": "left-start",
"description": "位于左侧,顶部对齐"
},
{
"name": "left",
"description": "位于左侧,居中对齐"
},
{
"name": "left-end",
"description": "位于左侧,底部对齐"
},
{
"name": "right-start",
"description": "位于右侧,顶部对齐"
},
{
"name": "right",
"description": "位于右侧,居中对齐"
},
{
"name": "right-end",
"description": "位于右侧,底部对齐"
}
],
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/tabs#tabs-attributes-placement"
}
]
},
{
"name": "full-width",
"description": "是否填满父元素宽度",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/tabs#tabs-attributes-full-width"
}
]
}
],
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/tabs"
},
{
"name": "Github",
"url": "https://github.com/zdhxiong/mdui/blob/v2/packages/mdui/src/components/tabs/tabs.ts"
}
]
},
{
"name": "mdui-text-field",
"description": "文本框组件\n\n```html\n<mdui-text-field label=\"Text Field\"></mdui-text-field>\n```",
"attributes": [
{
"name": "variant",
"description": "文本框的形状。默认为 `filled`。可选值包括:\n\n* `filled`:带背景色的文本框,视觉效果较强\n* `outlined`:带边框的文本框,视觉效果较弱",
"values": [
{
"name": "filled",
"description": "带背景色的文本框,视觉效果较强"
},
{
"name": "outlined",
"description": "带边框的文本框,视觉效果较弱"
}
],
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/text-field#attributes-variant"
}
]
},
{
"name": "type",
"description": "文本框输入类型。默认为 `text`。可选值包括:\n\n* `text`:默认值。文本字段\n* `number`:只能输入数字。拥有动态键盘的设备上会显示数字键盘\n* `password`:用于输入密码,其值会被遮盖\n* `url`:用于输入 URL会验证 URL 格式。在支持动态键盘的设备上有相应的键盘\n* `email`:用于输入邮箱地址,会验证邮箱格式。在支持动态键盘的设备上有相应的键盘\n* `search`:用于搜索框。拥有动态键盘的设备上的回车图标会变成搜索图标\n* `tel`:用于输入电话号码。拥有动态键盘的设备上会显示电话数字键盘\n* `hidden`:隐藏该控件,但其值仍会提交到服务器\n* `date`:输入日期的控件(年、月、日,不包括时间)。在支持的浏览器激活时打开日期选择器或年月日的数字滚轮\n* `datetime-local`:输入日期和时间的控件,不包括时区。在支持的浏览器激活时打开日期选择器或年月日的数字滚轮\n* `month`:输入年和月的控件,没有时区\n* `time`:用于输入时间的控件,不包括时区\n* `week`:用于输入以年和周数组成的日期,不带时区",
"values": [
{
"name": "text",
"description": "默认值。文本字段"
},
{
"name": "number",
"description": "只能输入数字。拥有动态键盘的设备上会显示数字键盘"
},
{
"name": "password",
"description": "用于输入密码,其值会被遮盖"
},
{
"name": "url",
"description": "用于输入 URL会验证 URL 格式。在支持动态键盘的设备上有相应的键盘"
},
{
"name": "email",
"description": "用于输入邮箱地址,会验证邮箱格式。在支持动态键盘的设备上有相应的键盘"
},
{
"name": "search",
"description": "用于搜索框。拥有动态键盘的设备上的回车图标会变成搜索图标"
},
{
"name": "tel",
"description": "用于输入电话号码。拥有动态键盘的设备上会显示电话数字键盘"
},
{
"name": "hidden",
"description": "隐藏该控件,但其值仍会提交到服务器"
},
{
"name": "date",
"description": "输入日期的控件(年、月、日,不包括时间)。在支持的浏览器激活时打开日期选择器或年月日的数字滚轮"
},
{
"name": "datetime-local",
"description": "输入日期和时间的控件,不包括时区。在支持的浏览器激活时打开日期选择器或年月日的数字滚轮"
},
{
"name": "month",
"description": "输入年和月的控件,没有时区"
},
{
"name": "time",
"description": "用于输入时间的控件,不包括时区"
},
{
"name": "week",
"description": "用于输入以年和周数组成的日期,不带时区"
}
],
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/text-field#attributes-type"
}
]
},
{
"name": "name",
"description": "文本框名称,将与表单数据一起提交",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/text-field#attributes-name"
}
]
},
{
"name": "value",
"description": "文本框的值,将与表单数据一起提交",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/text-field#attributes-value"
}
]
},
{
"name": "label",
"description": "标签文本",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/text-field#attributes-label"
}
]
},
{
"name": "placeholder",
"description": "占位符文本",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/text-field#attributes-placeholder"
}
]
},
{
"name": "helper",
"description": "文本框底部的帮助文本。也可以通过 `slot=\"helper\"` 设置",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/text-field#attributes-helper"
}
]
},
{
"name": "helper-on-focus",
"description": "是否仅在获得焦点时,显示底部的帮助文本",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/text-field#attributes-helper-on-focus"
}
]
},
{
"name": "clearable",
"description": "是否可清空文本框内容",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/text-field#attributes-clearable"
}
]
},
{
"name": "clear-icon",
"description": "可清空文本框时,显示在文本框右侧的清空按钮的 Material Icons 图标名。也可以通过 `slot=\"clear-icon\"` 设置",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/text-field#attributes-clear-icon"
}
]
},
{
"name": "end-aligned",
"description": "是否将文本右对齐",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/text-field#attributes-end-aligned"
}
]
},
{
"name": "prefix",
"description": "文本框的前缀文本。只在文本框聚焦或有值时显示。也可以通过 `slot=\"prefix\"` 设置",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/text-field#attributes-prefix"
}
]
},
{
"name": "suffix",
"description": "文本框的后缀文本。只在文本框聚焦或有值时显示。也可以通过 `slot=\"suffix\"` 设置",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/text-field#attributes-suffix"
}
]
},
{
"name": "icon",
"description": "文本框的前缀图标的 Material Icons 图标名。也可以通过 `slot=\"icon\"` 设置",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/text-field#attributes-icon"
}
]
},
{
"name": "end-icon",
"description": "文本框的后缀图标的 Material Icons 图标名。也可以通过 `slot=\"end-icon\"` 设置",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/text-field#attributes-end-icon"
}
]
},
{
"name": "error-icon",
"description": "表单字段验证失败时,显示在文本框右侧的 Material Icons 图标名。也可以通过 `slot=\"error-icon\"` 设置",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/text-field#attributes-error-icon"
}
]
},
{
"name": "form",
"description": "关联的 `<form>` 元素。此属性值应为同一页面中的一个 `<form>` 元素的 `id`。\n\n如果未指定此属性则该元素必须是 `<form>` 元素的子元素。通过此属性,你可以将元素放置在页面的任何位置,而不仅仅是 `<form>` 元素的子元素。",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/text-field#attributes-form"
}
]
},
{
"name": "readonly",
"description": "是否为只读模式",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/text-field#attributes-readonly"
}
]
},
{
"name": "disabled",
"description": "是否禁用输入框",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/text-field#attributes-disabled"
}
]
},
{
"name": "required",
"description": "提交表单时,是否必须填写该字段",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/text-field#attributes-required"
}
]
},
{
"name": "rows",
"description": "文本框的固定显示行数",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/text-field#attributes-rows"
}
]
},
{
"name": "autosize",
"description": "是否根据输入内容自动调整文本框高度",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/text-field#attributes-autosize"
}
]
},
{
"name": "min-rows",
"description": "`autosize` 为 `true` 时,文本框的最小行数",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/text-field#attributes-min-rows"
}
]
},
{
"name": "max-rows",
"description": "`autosize` 为 `true` 时,文本框的最大行数",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/text-field#attributes-max-rows"
}
]
},
{
"name": "minlength",
"description": "允许输入的最小字符数",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/text-field#attributes-minlength"
}
]
},
{
"name": "maxlength",
"description": "允许输入的最大字符数",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/text-field#attributes-maxlength"
}
]
},
{
"name": "counter",
"description": "是否显示字数统计,只在 `maxlength` 被指定时有效",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/text-field#attributes-counter"
}
]
},
{
"name": "min",
"description": "当 `type` 为 `number` 时,允许输入的最小数值",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/text-field#attributes-min"
}
]
},
{
"name": "max",
"description": "当 `type` 为 `number` 时,允许输入的最大数值",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/text-field#attributes-max"
}
]
},
{
"name": "step",
"description": "`type` 为 `number` 时,数值增减的步长",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/text-field#attributes-step"
}
]
},
{
"name": "pattern",
"description": "用于表单验证的正则表达式",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/text-field#attributes-pattern"
}
]
},
{
"name": "toggle-password",
"description": "`type` 为 `password` 时,设置此属性会添加一个切换按钮,用于在明文和密文之间切换",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/text-field#attributes-toggle-password"
}
]
},
{
"name": "show-password-icon",
"description": "密码切换按钮的 Material Icons 图标,当密码为明文时显示。也可以通过 `slot=\"show-password-icon\"` 设置",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/text-field#attributes-show-password-icon"
}
]
},
{
"name": "hide-password-icon",
"description": "密码切换按钮的 Material Icons 图标,当密码为密文时显示。也可以通过 `slot=\"hide-password-icon\"` 设置",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/text-field#attributes-hide-password-icon"
}
]
},
{
"name": "autocapitalize",
"description": "iOS 的非标准属性,用于控制文本首字母是否自动大写。在 iOS5 及以后的版本上有效。可选值包括:\n\n* `none`:禁用首字母大写\n* `sentences`:句子首字母大写\n* `words`:单词首字母大写\n* `characters`:所有字母大写",
"values": [
{
"name": "none",
"description": "禁用首字母大写"
},
{
"name": "sentences",
"description": "句子首字母大写"
},
{
"name": "words",
"description": "单词首字母大写"
},
{
"name": "characters",
"description": "所有字母大写"
}
],
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/text-field#attributes-autocapitalize"
}
]
},
{
"name": "autocorrect",
"description": "`input` 元素的 `autocorrect` 属性",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/text-field#attributes-autocorrect"
}
]
},
{
"name": "autocomplete",
"description": "`input` 元素的 `autocomplete` 属性",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/text-field#attributes-autocomplete"
}
]
},
{
"name": "enterkeyhint",
"description": "`input` 元素的 `enterkeyhint` 属性,用于定制虚拟键盘上的 Enter 键的显示文本或图标。具体显示效果取决于用户使用的设备和语言。可选值包括:\n\n* `enter`:插入新行\n* `done`:完成输入,关闭虚拟键盘\n* `go`:导航到输入文本的目标\n* `next`:移动到下一个输入项\n* `previous`:移动到上一个输入项\n* `search`:导航到搜索结果\n* `send`:发送文本信息",
"values": [
{
"name": "enter",
"description": "插入新行"
},
{
"name": "done",
"description": "完成输入,关闭虚拟键盘"
},
{
"name": "go",
"description": "导航到输入文本的目标"
},
{
"name": "next",
"description": "移动到下一个输入项"
},
{
"name": "previous",
"description": "移动到上一个输入项"
},
{
"name": "search",
"description": "导航到搜索结果"
},
{
"name": "send",
"description": "发送文本信息"
}
],
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/text-field#attributes-enterkeyhint"
}
]
},
{
"name": "spellcheck",
"description": "是否启用拼写检查",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/text-field#attributes-spellcheck"
}
]
},
{
"name": "inputmode",
"description": "`input` 元素的 `inputmode` 属性,用于定制虚拟键盘的类型。可选值包括:\n\n* `none`:无虚拟键盘。在需要实现自己的键盘输入控件时很有用\n* `text`:标准文本输入键盘\n* `decimal`:小数输入键盘,除了数字之外可能会有小数点 `.` 或者千分符逗号 `,`\n* `numeric`:显示 0-9 的数字键盘\n* `tel`:手机数字键盘,包含 0-9 数字、星号 `*` 或者井号 `#` 键\n* `search`:为搜索输入优化的虚拟键盘,提交按钮通常会显示 `search` 或者 “搜索”\n* `email`:为邮件地址输入优化的虚拟键盘,通常会有 `@ .` 等键\n* `url`:为 URL 输入优化的虚拟键盘,通常会有 `. / #` 等键",
"values": [
{
"name": "none",
"description": "无虚拟键盘。在需要实现自己的键盘输入控件时很有用"
},
{
"name": "text",
"description": "标准文本输入键盘"
},
{
"name": "decimal",
"description": "小数输入键盘,除了数字之外可能会有小数点 `.` 或者千分符逗号 `,`"
},
{
"name": "numeric",
"description": "显示 0-9 的数字键盘"
},
{
"name": "tel",
"description": "手机数字键盘,包含 0-9 数字、星号 `*` 或者井号 `#` 键"
},
{
"name": "search",
"description": "为搜索输入优化的虚拟键盘,提交按钮通常会显示 `search` 或者 “搜索”"
},
{
"name": "email",
"description": "为邮件地址输入优化的虚拟键盘,通常会有 `@ .` 等键"
},
{
"name": "url",
"description": "为 URL 输入优化的虚拟键盘,通常会有 `. / #` 等键"
}
],
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/text-field#attributes-inputmode"
}
]
},
{
"name": "autofocus",
"description": "是否在页面加载完成后自动获取焦点",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/text-field#attributes-autofocus"
}
]
},
{
"name": "tabindex",
"description": "元素在使用 Tab 键切换焦点时的顺序",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/text-field#attributes-tabindex"
}
]
}
],
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/text-field"
},
{
"name": "Github",
"url": "https://github.com/zdhxiong/mdui/blob/v2/packages/mdui/src/components/text-field/index.ts"
}
]
},
{
"name": "mdui-tooltip",
"description": "工具提示组件\n\n```html\n<mdui-tooltip content=\"tooltip content\">\n <mdui-button>button</mdui-button>\n</mdui-tooltip>\n```",
"attributes": [
{
"name": "variant",
"description": "tooltip 的形状。默认为 `plain`。可选值包括:\n\n* `plain`:纯文本,适用于简单的单行文本\n* `rich`:富文本,可以包含标题、正文和操作按钮",
"values": [
{
"name": "plain",
"description": "纯文本,适用于简单的单行文本"
},
{
"name": "rich",
"description": "富文本,可以包含标题、正文和操作按钮"
}
],
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/tooltip#attributes-variant"
}
]
},
{
"name": "placement",
"description": "tooltip 的位置。默认为 `auto`。可选值包括:\n\n* `auto`:自动判断位置。`variant=\"plan\"` 时,优先使用 `top``variant=\"rich\"` 时,优先使用 `bottom-right`\n* `top-left`:位于左上方\n* `top-start`:位于上方,左对齐\n* `top`:位于上方,居中对齐\n* `top-end`:位于上方,右对齐\n* `top-right`:位于右上方\n* `bottom-left`:位于左下方\n* `bottom-start`:位于下方,左对齐\n* `bottom`:位于下方,居中对齐\n* `bottom-end`:位于下方,右对齐\n* `bottom-right`:位于右下方\n* `left-start`:位于左侧,顶部对齐\n* `left`:位于左侧,居中对齐\n* `left-end`:位于左侧,底部对齐\n* `right-start`:位于右侧,顶部对齐\n* `right`:位于右侧,居中对齐\n* `right-end`:位于右侧,底部对齐",
"values": [
{
"name": "auto",
"description": "自动判断位置"
},
{
"name": "top-left",
"description": "位于左上方"
},
{
"name": "top-start",
"description": "位于上方,左对齐"
},
{
"name": "top",
"description": "位于上方,居中对齐"
},
{
"name": "top-end",
"description": "位于上方,右对齐"
},
{
"name": "top-right",
"description": "位于右上方"
},
{
"name": "bottom-left",
"description": "位于左下方"
},
{
"name": "bottom-start",
"description": "位于下方,左对齐"
},
{
"name": "bottom",
"description": "位于下方,居中对齐"
},
{
"name": "bottom-end",
"description": "位于下方,右对齐"
},
{
"name": "bottom-right",
"description": "位于右下方"
},
{
"name": "left-start",
"description": "位于左侧,顶部对齐"
},
{
"name": "left",
"description": "位于左侧,居中对齐"
},
{
"name": "left-end",
"description": "位于左侧,底部对齐"
},
{
"name": "right-start",
"description": "位于右侧,顶部对齐"
},
{
"name": "right",
"description": "位于右侧,居中对齐"
},
{
"name": "right-end",
"description": "位于右侧,底部对齐"
}
],
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/tooltip#attributes-placement"
}
]
},
{
"name": "open-delay",
"description": "鼠标悬浮触发显示的延时,单位为毫秒",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/tooltip#attributes-open-delay"
}
]
},
{
"name": "close-delay",
"description": "鼠标悬浮触发隐藏的延时,单位为毫秒",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/tooltip#attributes-close-delay"
}
]
},
{
"name": "headline",
"description": "tooltip 的标题。仅 `variant=\"rich\"` 时可使用。也可以通过 `slot=\"headline\"` 设置",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/tooltip#attributes-headline"
}
]
},
{
"name": "content",
"description": "tooltip 的内容。也可以通过 `slot=\"content\"` 设置",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/tooltip#attributes-content"
}
]
},
{
"name": "trigger",
"description": "触发方式,支持多个值,用空格分隔。可选值包括:\n\n* `click`:点击时触发\n* `hover`:鼠标悬浮时触发\n* `focus`:聚焦时触发\n* `manual`:只能通过编程方式打开和关闭 tooltip不能再指定其他触发方式",
"values": [
{
"name": "click",
"description": "点击时触发"
},
{
"name": "hover",
"description": "鼠标悬浮时触发"
},
{
"name": "focus",
"description": "聚焦时触发"
},
{
"name": "manual",
"description": "只能通过编程方式打开和关闭 tooltip不能再指定其他触发方式"
}
],
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/tooltip#attributes-trigger"
}
]
},
{
"name": "disabled",
"description": "是否禁用 tooltip",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/tooltip#attributes-disabled"
}
]
},
{
"name": "open",
"description": "是否显示 tooltip",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/tooltip#attributes-open"
}
]
}
],
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/tooltip"
},
{
"name": "Github",
"url": "https://github.com/zdhxiong/mdui/blob/v2/packages/mdui/src/components/tooltip/index.ts"
}
]
},
{
"name": "mdui-top-app-bar-title",
"description": "顶部应用栏标题组件。需配合 `<mdui-top-app-bar>` 组件使用\n\n```html\n<mdui-top-app-bar>\n <mdui-button-icon icon=\"menu\"></mdui-button-icon>\n <mdui-top-app-bar-title>Title</mdui-top-app-bar-title>\n <div style=\"flex-grow: 1\"></div>\n <mdui-button-icon icon=\"more_vert\"></mdui-button-icon>\n</mdui-top-app-bar>\n```",
"attributes": [],
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/top-app-bar"
},
{
"name": "Github",
"url": "https://github.com/zdhxiong/mdui/blob/v2/packages/mdui/src/components/top-app-bar/top-app-bar-title.ts"
}
]
},
{
"name": "mdui-top-app-bar",
"description": "顶部应用栏组件\n\n```html\n<mdui-top-app-bar>\n <mdui-button-icon icon=\"menu\"></mdui-button-icon>\n <mdui-top-app-bar-title>Title</mdui-top-app-bar-title>\n <div style=\"flex-grow: 1\"></div>\n <mdui-button-icon icon=\"more_vert\"></mdui-button-icon>\n</mdui-top-app-bar>\n```",
"attributes": [
{
"name": "variant",
"description": "顶部应用栏的形状。默认为 `small`。可选值包括:\n\n* `center-aligned`:小型应用栏,标题居中\n* `small`:小型应用栏\n* `medium`:中型应用栏\n* `large`:大型应用栏",
"values": [
{
"name": "center-aligned",
"description": "小型应用栏,标题居中"
},
{
"name": "small",
"description": "小型应用栏"
},
{
"name": "medium",
"description": "中型应用栏"
},
{
"name": "large",
"description": "大型应用栏"
}
],
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/top-app-bar#top-app-bar-attributes-variant"
}
]
},
{
"name": "hide",
"description": "是否隐藏",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/top-app-bar#top-app-bar-attributes-hide"
}
]
},
{
"name": "shrink",
"description": "是否缩小为 `variant=\"small\"` 的样式,仅在 `variant=\"medium\"` 或 `variant=\"large\"` 时生效",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/top-app-bar#top-app-bar-attributes-shrink"
}
]
},
{
"name": "scroll-behavior",
"description": "滚动行为。可同时使用多个值,用空格分隔。可选值包括:\n\n* `hide`:滚动时隐藏\n* `shrink`:在中型、大型应用栏中可使用,滚动时缩小成小型应用栏的样式\n* `elevate`:滚动时添加阴影",
"values": [
{
"name": "hide"
},
{
"name": "shrink"
},
{
"name": "elevate"
}
],
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/top-app-bar#top-app-bar-attributes-scroll-behavior"
}
]
},
{
"name": "scroll-target",
"description": "需要监听其滚动事件的元素。值可以是 CSS 选择器、DOM 元素、或 [JQ 对象](https://www.mdui.org/zh-cn/docs/2/functions/jq)。默认监听 `window` 的滚动事件",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/top-app-bar#top-app-bar-attributes-scroll-target"
}
]
},
{
"name": "scroll-threshold",
"description": "在滚动多少距离之后触发滚动行为,单位为 `px`",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/top-app-bar#top-app-bar-attributes-scroll-threshold"
}
]
},
{
"name": "order",
"description": "该组件在 [`<mdui-layout>`](https://www.mdui.org/zh-cn/docs/2/components/layout) 中的布局顺序,按从小到大排序。默认为 `0`",
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/top-app-bar#top-app-bar-attributes-order"
}
]
}
],
"references": [
{
"name": "开发文档",
"url": "https://www.mdui.org/zh-cn/docs/2/components/top-app-bar"
},
{
"name": "Github",
"url": "https://github.com/zdhxiong/mdui/blob/v2/packages/mdui/src/components/top-app-bar/top-app-bar.ts"
}
]
}
]
}