mdui

{ "version": 1.1, "tags": [ { "name": "mdui-avatar", "description": "Avatar Component \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 of the avatar image.", "references": [ { "name": "Docs", "url": "https://www.mdui.org/en/docs/2/components/avatar#attributes-src" } ] }, { "name": "fit", "description": "Image resizing method, similar to the native CSS [`object-fit`](https://developer.mozilla.org/en-US/docs/Web/CSS/object-fit). Possible values:\n\n* `contain`: Scales the image to fit within the box while maintaining the aspect ratio. The image will be \"letterboxed\" if the aspect ratios do not match.\n* `cover`: Scales the image to fill the box while maintaining the aspect ratio. The image will be clipped if the aspect ratios do not match.\n* `fill`: Default. Scales the image to fill the box. The image will be stretched if the aspect ratios do not match.\n* `none`: No resizing.\n* `scale-down`: Scales as if `none` or `contain` were specified, choosing the smaller result.", "values": [ { "name": "contain", "description": "Scales the image to fit within the box while maintaining the aspect ratio. The image will be \"letterboxed\" if the aspect ratios do not match." }, { "name": "cover", "description": "Scales the image to fill the box while maintaining the aspect ratio. The image will be clipped if the aspect ratios do not match." }, { "name": "fill", "description": "Default. Scales the image to fill the box. The image will be stretched if the aspect ratios do not match." }, { "name": "none", "description": "No resizing." }, { "name": "scale-down", "description": "Scales as if `none` or `contain` were specified, choosing the smaller result." } ], "references": [ { "name": "Docs", "url": "https://www.mdui.org/en/docs/2/components/avatar#attributes-fit" } ] }, { "name": "icon", "description": "The Material Icons name for the avatar.", "references": [ { "name": "Docs", "url": "https://www.mdui.org/en/docs/2/components/avatar#attributes-icon" } ] }, { "name": "label", "description": "Text description of the avatar.", "references": [ { "name": "Docs", "url": "https://www.mdui.org/en/docs/2/components/avatar#attributes-label" } ] } ], "references": [ { "name": "Docs", "url": "https://www.mdui.org/en/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": "Badge Component \n\n```html\n<mdui-badge>12</mdui-badge>\n```", "attributes": [ { "name": "variant", "description": "Defines the badge shape. Possible values:\n* `small`: A small badge without text.\n* `large`: A large badge with displayed text.", "values": [ { "name": "small", "description": "A small badge without text." }, { "name": "large", "description": "A large badge with displayed text." } ], "references": [ { "name": "Docs", "url": "https://www.mdui.org/en/docs/2/components/badge#attributes-variant" } ] } ], "references": [ { "name": "Docs", "url": "https://www.mdui.org/en/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": "Bottom App Bar Component \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": "Hides the bottom app bar when set.", "references": [ { "name": "Docs", "url": "https://www.mdui.org/en/docs/2/components/bottom-app-bar#attributes-hide" } ] }, { "name": "fab-detach", "description": "When set, detaches the [`<mdui-fab>`](https://www.mdui.org/en/docs/2/components/fab) from the bottom app bar. The [`<mdui-fab>`](https://www.mdui.org/en/docs/2/components/fab) remains on the page even after the app bar is hidden.", "references": [ { "name": "Docs", "url": "https://www.mdui.org/en/docs/2/components/bottom-app-bar#attributes-fab-detach" } ] }, { "name": "scroll-behavior", "description": "Defines the scroll behavior. Possible values:\n\n* `hide`: Hides when scrolling.", "values": [ { "name": "hide" }, { "name": "shrink" }, { "name": "elevate" } ], "references": [ { "name": "Docs", "url": "https://www.mdui.org/en/docs/2/components/bottom-app-bar#attributes-scroll-behavior" } ] }, { "name": "scroll-target", "description": "The element that listens for scroll events. Accepts a CSS selector, DOM element, or [JQ object](https://www.mdui.org/en/docs/2/functions/jq). Defaults to `window`.", "references": [ { "name": "Docs", "url": "https://www.mdui.org/en/docs/2/components/bottom-app-bar#attributes-scroll-target" } ] }, { "name": "scroll-threshold", "description": "The scroll distance (in pixels) that triggers the scroll behavior.", "references": [ { "name": "Docs", "url": "https://www.mdui.org/en/docs/2/components/bottom-app-bar#attributes-scroll-threshold" } ] }, { "name": "order", "description": "Specifies the layout order within the [`<mdui-layout>`](https://www.mdui.org/en/docs/2/components/layout) component. Items are sorted in ascending order. The default value is `0`.", "references": [ { "name": "Docs", "url": "https://www.mdui.org/en/docs/2/components/bottom-app-bar#attributes-order" } ] } ], "references": [ { "name": "Docs", "url": "https://www.mdui.org/en/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": "Icon Button Component \n\n```html\n<mdui-button-icon icon=\"search\"></mdui-button-icon>\n```", "attributes": [ { "name": "variant", "description": "Defines the icon button style. Possible values:\n* `standard`: For low-priority actions.\n* `filled`: Has the strongest visual effect, suitable for high-priority actions.\n* `tonal`: A visual effect between `filled` and `outlined`, suitable for medium to high-priority actions.\n* `outlined`: For medium-priority actions.", "values": [ { "name": "standard", "description": "For low-priority actions." }, { "name": "filled", "description": "Has the strongest visual effect, suitable for high-priority actions." }, { "name": "tonal", "description": "A visual effect between `filled` and `outlined`, suitable for medium to high-priority actions." }, { "name": "outlined", "description": "For medium-priority actions." } ], "references": [ { "name": "Docs", "url": "https://www.mdui.org/en/docs/2/components/button-icon#attributes-variant" } ] }, { "name": "icon", "description": "Specifies the Material Icons name. Alternatively, use the default slot.", "references": [ { "name": "Docs", "url": "https://www.mdui.org/en/docs/2/components/button-icon#attributes-icon" } ] }, { "name": "selected-icon", "description": "Specifies the Material Icons name when selected. Alternatively, use `slot=\"selected-icon\"`.", "references": [ { "name": "Docs", "url": "https://www.mdui.org/en/docs/2/components/button-icon#attributes-selected-icon" } ] }, { "name": "selectable", "description": "Indicates if the button is selectable.", "references": [ { "name": "Docs", "url": "https://www.mdui.org/en/docs/2/components/button-icon#attributes-selectable" } ] }, { "name": "selected", "description": "Indicates if the button is selected.", "references": [ { "name": "Docs", "url": "https://www.mdui.org/en/docs/2/components/button-icon#attributes-selected" } ] }, { "name": "href", "description": "The URL for the hyperlink. If specified, the component renders as an `<a>` element and can use link-related attributes.", "references": [ { "name": "Docs", "url": "https://www.mdui.org/en/docs/2/components/button-icon#attributes-href" } ] }, { "name": "download", "description": "Instructs the browser to treat the linked URL as a download.\n\n**Note**: This is only available when `href` is specified.", "references": [ { "name": "Docs", "url": "https://www.mdui.org/en/docs/2/components/button-icon#attributes-download" } ] }, { "name": "target", "description": "Defines where to display the linked URL. Possible values:\n\n* `_blank`: Opens in a new tab or window.\n* `_parent`: Opens in the parent browsing context or `_self` if no parent exists.\n* `_self`: Opens in the current browsing context. (Default).\n* `_top`: Opens in the topmost browsing context or `_self` if no ancestors exist.\n\n**Note**: This is only available when `href` is specified.", "values": [ { "name": "_blank", "description": "Opens in a new tab or window." }, { "name": "_parent", "description": "Opens in the parent browsing context or `_self` if no parent exists." }, { "name": "_self", "description": "Opens in the current browsing context. (Default)." }, { "name": "_top", "description": "Opens in the topmost browsing context or `_self` if no ancestors exist." } ], "references": [ { "name": "Docs", "url": "https://www.mdui.org/en/docs/2/components/button-icon#attributes-target" } ] }, { "name": "rel", "description": "Specifies the relationship of the linked URL as space-separated link types. Possible values:\n\n* `alternate`: Alternate versions of the current document.\n* `author`: Author of the current document or article.\n* `bookmark`: Permanent link for the nearest ancestor section.\n* `external`: The referenced document is not part of the same site as the current document.\n* `help`: Link to context-sensitive help.\n* `license`: Indicates that the main content of the current document is covered by the copyright license described by the referenced document.\n* `me`: Indicates that the current document represents the person who owns the linked content.\n* `next`: Indicates that the current document is part of a series and the next document in the series is the referenced document.\n* `nofollow`: Indicates that the current document's original author or publisher does not endorse the referenced document.\n* `noreferrer`: No `Referer` header will be included. Also has the same effect as `noopener`.\n* `opener`: Creates an auxiliary browsing context if the hyperlink would otherwise create a top-level browsing context that is not an auxiliary browsing context (i.e., has \"`_blank`\" as `target` attribute value).\n* `prev`: Indicates that the current document is part of a series and the previous document in the series is the referenced document.\n* `search`: Links to a resource that can be used to search through the current document and its related pages.\n* `tag`: Gives a tag (identified by the given address) that applies to the current document.\n\n**Note**: This is only available when `href` is specified.", "values": [ { "name": "alternate", "description": "Alternate versions of the current document." }, { "name": "author", "description": "Author of the current document or article." }, { "name": "bookmark", "description": "Permanent link for the nearest ancestor section." }, { "name": "external", "description": "The referenced document is not part of the same site as the current document." }, { "name": "help", "description": "Link to context-sensitive help." }, { "name": "license", "description": "Indicates that the main content of the current document is covered by the copyright license described by the referenced document." }, { "name": "me", "description": "Indicates that the current document represents the person who owns the linked content." }, { "name": "next", "description": "Indicates that the current document is part of a series and the next document in the series is the referenced document." }, { "name": "nofollow", "description": "Indicates that the current document's original author or publisher does not endorse the referenced document." }, { "name": "noreferrer", "description": "No `Referer` header will be included. Also has the same effect as `noopener`." }, { "name": "opener", "description": "Creates an auxiliary browsing context if the hyperlink would otherwise create a top-level browsing context that is not an auxiliary browsing context (i.e., has \"`_blank`\" as `target` attribute value)." }, { "name": "prev", "description": "Indicates that the current document is part of a series and the previous document in the series is the referenced document." }, { "name": "search", "description": "Links to a resource that can be used to search through the current document and its related pages." }, { "name": "tag", "description": "Gives a tag (identified by the given address) that applies to the current document." } ], "references": [ { "name": "Docs", "url": "https://www.mdui.org/en/docs/2/components/button-icon#attributes-rel" } ] }, { "name": "autofocus", "description": "Determines if the element should be focused when the page loads.", "references": [ { "name": "Docs", "url": "https://www.mdui.org/en/docs/2/components/button-icon#attributes-autofocus" } ] }, { "name": "tabindex", "description": "Specifies the order in which the element receives focus when navigating with the Tab key.", "references": [ { "name": "Docs", "url": "https://www.mdui.org/en/docs/2/components/button-icon#attributes-tabindex" } ] }, { "name": "disabled", "description": "Disables the element.", "references": [ { "name": "Docs", "url": "https://www.mdui.org/en/docs/2/components/button-icon#attributes-disabled" } ] }, { "name": "loading", "description": "Indicates that the element is in a loading state.", "references": [ { "name": "Docs", "url": "https://www.mdui.org/en/docs/2/components/button-icon#attributes-loading" } ] }, { "name": "name", "description": "The button's name, which is submitted with form data.\n\n**Note**: This is only available when `href` is not specified.", "references": [ { "name": "Docs", "url": "https://www.mdui.org/en/docs/2/components/button-icon#attributes-name" } ] }, { "name": "value", "description": "The button's value, which is submitted with form data.\n\n**Note**: This is only available when `href` is not specified.", "references": [ { "name": "Docs", "url": "https://www.mdui.org/en/docs/2/components/button-icon#attributes-value" } ] }, { "name": "type", "description": "Defines the button's default behavior. The default is `button`. Possible values:\n\n* `submit`: Submits the form data to the server.\n* `reset`: Resets all the controls to their initial values.\n* `button`: No default behavior, does nothing when pressed by default.\n\n**Note**: This is only available when `href` is not specified.", "values": [ { "name": "submit", "description": "Submits the form data to the server." }, { "name": "reset", "description": "Resets all the controls to their initial values." }, { "name": "button", "description": "No default behavior, does nothing when pressed by default." } ], "references": [ { "name": "Docs", "url": "https://www.mdui.org/en/docs/2/components/button-icon#attributes-type" } ] }, { "name": "form", "description": "Associates the button with a `<form>` element. The value should be the `id` of a `<form>` in the same document. If not set, the button is associated with its parent `<form>`, if any.\n\nThis attribute allows button elements to be associated with `<form>`s anywhere in the document, not just inside a `<form>`.\n\n**Note**: Only available when `href` is not specified.", "references": [ { "name": "Docs", "url": "https://www.mdui.org/en/docs/2/components/button-icon#attributes-form" } ] }, { "name": "formaction", "description": "Specifies the URL that processes the button's submitted information. Overrides the `action` attribute of the button's form owner.\n\n**Note**: Only available when `href` is not specified and `type=\"submit\"`.", "references": [ { "name": "Docs", "url": "https://www.mdui.org/en/docs/2/components/button-icon#attributes-formaction" } ] }, { "name": "formenctype", "description": "Specifies the form data encoding method. Possible values:\n\n* `application/x-www-form-urlencoded`: Default if the attribute is not used.\n* `multipart/form-data`: Used for `<input>` elements with `type` set to `file`.\n* `text/plain`: For debugging, not for real form submission.\n\nOverrides the `enctype` attribute of the button's form owner.\n\n**Note**: Only available when `href` is not specified and `type=\"submit\"`.", "values": [ { "name": "application/x-www-form-urlencoded", "description": "Default if the attribute is not used." }, { "name": "multipart/form-data", "description": "Used for `<input>` elements with `type` set to `file`." }, { "name": "text/plain", "description": "For debugging, not for real form submission." } ], "references": [ { "name": "Docs", "url": "https://www.mdui.org/en/docs/2/components/button-icon#attributes-formenctype" } ] }, { "name": "formmethod", "description": "Specifies the HTTP method for form submission. Possible values:\n\n* `post`: Form data included in HTTP request body.\n* `get`: Form data appended to `action` URL.\n\nOverrides the `method` attribute of the button's form owner.\n\n**Note**: Only available when `href` is not specified and `type=\"submit\"`.", "values": [ { "name": "post", "description": "Form data included in HTTP request body." }, { "name": "get", "description": "Form data appended to `action` URL." } ], "references": [ { "name": "Docs", "url": "https://www.mdui.org/en/docs/2/components/button-icon#attributes-formmethod" } ] }, { "name": "formnovalidate", "description": "Specifies that the form should not be validated on submission. Overrides the `novalidate` attribute of the button's form owner.\n\n**Note**: Only available when `href` is not specified and `type=\"submit\"`.", "references": [ { "name": "Docs", "url": "https://www.mdui.org/en/docs/2/components/button-icon#attributes-formnovalidate" } ] }, { "name": "formtarget", "description": "Specifies where to display the form submission response. Possible values:\n\n* `_self`: Current browsing context. (Default).\n* `_blank`: New tab or window.\n* `_parent`: Parent browsing context or `_self` if no parent.\n* `_top`: Topmost browsing context or `_self` if no ancestors.\n\nOverrides the `target` attribute of the button's form owner.\n\n**Note**: Only available when `href` is not specified and `type=\"submit\"`.", "values": [ { "name": "_self", "description": "Current browsing context. (Default)." }, { "name": "_blank", "description": "New tab or window." }, { "name": "_parent", "description": "Parent browsing context or `_self` if no parent." }, { "name": "_top", "description": "Topmost browsing context or `_self` if no ancestors." } ], "references": [ { "name": "Docs", "url": "https://www.mdui.org/en/docs/2/components/button-icon#attributes-formtarget" } ] } ], "references": [ { "name": "Docs", "url": "https://www.mdui.org/en/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": "Button Component \n\n```html\n<mdui-button>Button</mdui-button>\n```", "attributes": [ { "name": "variant", "description": "Defines the button style. Possible values:\n* `elevated`: A shadowed button for visual distinction.\n* `filled`: Used for final actions like 'Save' or 'Confirm'.\n* `tonal`: A mix between `filled` and `outlined`, suitable for medium to high-priority actions.\n* `outlined`: A bordered button for medium-priority and secondary actions.\n* `text`: A text button for low-priority actions.", "values": [ { "name": "elevated", "description": "A shadowed button for visual distinction." }, { "name": "filled", "description": "Used for final actions like 'Save' or 'Confirm'." }, { "name": "tonal", "description": "A mix between `filled` and `outlined`, suitable for medium to high-priority actions." }, { "name": "outlined", "description": "A bordered button for medium-priority and secondary actions." }, { "name": "text", "description": "A text button for low-priority actions." } ], "references": [ { "name": "Docs", "url": "https://www.mdui.org/en/docs/2/components/button#attributes-variant" } ] }, { "name": "full-width", "description": "If set, the button will fill the width of its parent element.", "references": [ { "name": "Docs", "url": "https://www.mdui.org/en/docs/2/components/button#attributes-full-width" } ] }, { "name": "icon", "description": "Specifies the Material Icons name on the left. Alternatively, use `slot=\"icon\"`.", "references": [ { "name": "Docs", "url": "https://www.mdui.org/en/docs/2/components/button#attributes-icon" } ] }, { "name": "end-icon", "description": "Specifies the Material Icons name on the right. Alternatively, use `slot=\"end-icon\"`.", "references": [ { "name": "Docs", "url": "https://www.mdui.org/en/docs/2/components/button#attributes-end-icon" } ] }, { "name": "href", "description": "The URL for the hyperlink. If provided, the component is rendered as an `<a>` element and can use link-related attributes.", "references": [ { "name": "Docs", "url": "https://www.mdui.org/en/docs/2/components/button#attributes-href" } ] }, { "name": "download", "description": "Instructs the browser to download the linked URL.\n\n**Note**: This is only available when `href` is specified.", "references": [ { "name": "Docs", "url": "https://www.mdui.org/en/docs/2/components/button#attributes-download" } ] }, { "name": "target", "description": "Defines where to open the linked URL. Possible values:\n\n* `_blank`: Opens in a new tab or window.\n* `_parent`: Opens in the parent browsing context or `_self` if no parent.\n* `_self`: Opens in the current browsing context. (Default).\n* `_top`: Opens in the topmost browsing context or `_self` if no ancestors.\n\n**Note**: This is only available when `href` is specified.", "values": [ { "name": "_blank", "description": "Opens in a new tab or window." }, { "name": "_parent", "description": "Opens in the parent browsing context or `_self` if no parent." }, { "name": "_self", "description": "Opens in the current browsing context. (Default)." }, { "name": "_top", "description": "Opens in the topmost browsing context or `_self` if no ancestors." } ], "references": [ { "name": "Docs", "url": "https://www.mdui.org/en/docs/2/components/button#attributes-target" } ] }, { "name": "rel", "description": "Specifies the relationship of the linked URL as space-separated link types. Possible values:\n\n* `alternate`: Alternate versions of the current document.\n* `author`: The author of the current document or article.\n* `bookmark`: The permalink for the nearest ancestor section.\n* `external`: The referenced document is not part of the same site as the current document.\n* `help`: A link to context-sensitive help.\n* `license`: Indicates that the main content of the current document is covered by the copyright license described by the referenced document.\n* `me`: Indicates that the current document represents the person who owns the linked content.\n* `next`: Indicates that the current document is part of a series and the next document in the series is the referenced document.\n* `nofollow`: Indicates that the current document's original author or publisher does not endorse the referenced document.\n* `noreferrer`: No `Referer` header will be included. Also has the same effect as `noopener`.\n* `opener`: Creates an auxiliary browsing context if the hyperlink would otherwise create a top-level browsing context that is not an auxiliary browsing context (i.e., has \"`_blank`\" as `target` attribute value).\n* `prev`: Indicates that the current document is part of a series and the previous document in the series is the referenced document.\n* `search`: Links to a resource that can be used to search through the current document and its related pages.\n* `tag`: Gives a tag (identified by the given address) that applies to the current document.\n\n**Note**: This is only available when `href` is specified.", "values": [ { "name": "alternate", "description": "Alternate versions of the current document." }, { "name": "author", "description": "The author of the current document or article." }, { "name": "bookmark", "description": "The permalink for the nearest ancestor section." }, { "name": "external", "description": "The referenced document is not part of the same site as the current document." }, { "name": "help", "description": "A link to context-sensitive help." }, { "name": "license", "description": "Indicates that the main content of the current document is covered by the copyright license described by the referenced document." }, { "name": "me", "description": "Indicates that the current document represents the person who owns the linked content." }, { "name": "next", "description": "Indicates that the current document is part of a series and the next document in the series is the referenced document." }, { "name": "nofollow", "description": "Indicates that the current document's original author or publisher does not endorse the referenced document." }, { "name": "noreferrer", "description": "No `Referer` header will be included. Also has the same effect as `noopener`." }, { "name": "opener", "description": "Creates an auxiliary browsing context if the hyperlink would otherwise create a top-level browsing context that is not an auxiliary browsing context (i.e., has \"`_blank`\" as `target` attribute value)." }, { "name": "prev", "description": "Indicates that the current document is part of a series and the previous document in the series is the referenced document." }, { "name": "search", "description": "Links to a resource that can be used to search through the current document and its related pages." }, { "name": "tag", "description": "Gives a tag (identified by the given address) that applies to the current document." } ], "references": [ { "name": "Docs", "url": "https://www.mdui.org/en/docs/2/components/button#attributes-rel" } ] }, { "name": "autofocus", "description": "Specifies that the element should be focused when the page loads.", "references": [ { "name": "Docs", "url": "https://www.mdui.org/en/docs/2/components/button#attributes-autofocus" } ] }, { "name": "tabindex", "description": "Defines the order in which the element receives focus when navigating with the Tab key.", "references": [ { "name": "Docs", "url": "https://www.mdui.org/en/docs/2/components/button#attributes-tabindex" } ] }, { "name": "disabled", "description": "Disables the element.", "references": [ { "name": "Docs", "url": "https://www.mdui.org/en/docs/2/components/button#attributes-disabled" } ] }, { "name": "loading", "description": "Indicates that the element is in a loading state.", "references": [ { "name": "Docs", "url": "https://www.mdui.org/en/docs/2/components/button#attributes-loading" } ] }, { "name": "name", "description": "The button's name, which is submitted with form data.\n\n**Note**: This is only available when `href` is not specified.", "references": [ { "name": "Docs", "url": "https://www.mdui.org/en/docs/2/components/button#attributes-name" } ] }, { "name": "value", "description": "The button's value, which is submitted with form data.\n\n**Note**: This is only available when `href` is not specified.", "references": [ { "name": "Docs", "url": "https://www.mdui.org/en/docs/2/components/button#attributes-value" } ] }, { "name": "type", "description": "Defines the button's default behavior. The default is `button`. Possible values:\n\n* `submit`: Submits the form data to the server.\n* `reset`: Resets all the controls to their initial values.\n* `button`: No default behavior, does nothing when pressed by default.\n\n**Note**: This is only available when `href` is not specified.", "values": [ { "name": "submit", "description": "Submits the form data to the server." }, { "name": "reset", "description": "Resets all the controls to their initial values." }, { "name": "button", "description": "No default behavior, does nothing when pressed by default." } ], "references": [ { "name": "Docs", "url": "https://www.mdui.org/en/docs/2/components/button#attributes-type" } ] }, { "name": "form", "description": "Associates the button with a `<form>` element. The value should be the `id` of a `<form>` in the same document. If not set, the button is associated with its parent `<form>`, if any.\n\nThis attribute allows button elements to be associated with `<form>`s anywhere in the document, not just inside a `<form>`.\n\n**Note**: Only available when `href` is not specified.", "references": [ { "name": "Docs", "url": "https://www.mdui.org/en/docs/2/components/button#attributes-form" } ] }, { "name": "formaction", "description": "Specifies the URL that processes the button's submitted information. Overrides the `action` attribute of the button's form owner.\n\n**Note**: Only available when `href` is not specified and `type=\"submit\"`.", "references": [ { "name": "Docs", "url": "https://www.mdui.org/en/docs/2/components/button#attributes-formaction" } ] }, { "name": "formenctype", "description": "Specifies the form data encoding method. Possible values:\n\n* `application/x-www-form-urlencoded`: Default if the attribute is not used.\n* `multipart/form-data`: Used for `<input>` elements with `type` set to `file`.\n* `text/plain`: For debugging, not for real form submission.\n\nOverrides the `enctype` attribute of the button's form owner.\n\n**Note**: Only available when `href` is not specified and `type=\"submit\"`.", "values": [ { "name": "application/x-www-form-urlencoded", "description": "Default if the attribute is not used." }, { "name": "multipart/form-data", "description": "Used for `<input>` elements with `type` set to `file`." }, { "name": "text/plain", "description": "For debugging, not for real form submission." } ], "references": [ { "name": "Docs", "url": "https://www.mdui.org/en/docs/2/components/button#attributes-formenctype" } ] }, { "name": "formmethod", "description": "Specifies the HTTP method for form submission. Possible values:\n\n* `post`: Form data included in HTTP request body.\n* `get`: Form data appended to `action` URL.\n\nOverrides the `method` attribute of the button's form owner.\n\n**Note**: Only available when `href` is not specified and `type=\"submit\"`.", "values": [ { "name": "post", "description": "Form data included in HTTP request body." }, { "name": "get", "description": "Form data appended to `action` URL." } ], "references": [ { "name": "Docs", "url": "https://www.mdui.org/en/docs/2/components/button#attributes-formmethod" } ] }, { "name": "formnovalidate", "description": "Specifies that the form should not be validated on submission. Overrides the `novalidate` attribute of the button's form owner.\n\n**Note**: Only available when `href` is not specified and `type=\"submit\"`.", "references": [ { "name": "Docs", "url": "https://www.mdui.org/en/docs/2/components/button#attributes-formnovalidate" } ] }, { "name": "formtarget", "description": "Specifies where to display the form submission response. Possible values:\n\n* `_self`: Current browsing context. (Default).\n* `_blank`: New tab or window.\n* `_parent`: Parent browsing context or `_self` if no parent.\n* `_top`: Topmost browsing context or `_self` if no ancestors.\n\nOverrides the `target` attribute of the button's form owner.\n\n**Note**: Only available when `href` is not specified and `type=\"submit\"`.", "values": [ { "name": "_self", "description": "Current browsing context. (Default)." }, { "name": "_blank", "description": "New tab or window." }, { "name": "_parent", "description": "Parent browsing context or `_self` if no parent." }, { "name": "_top", "description": "Topmost browsing context or `_self` if no ancestors." } ], "references": [ { "name": "Docs", "url": "https://www.mdui.org/en/docs/2/components/button#attributes-formtarget" } ] } ], "references": [ { "name": "Docs", "url": "https://www.mdui.org/en/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": "Card Component \n\n```html\n<mdui-card>card content</mdui-card>\n```", "attributes": [ { "name": "variant", "description": "Defines the card style. Possible values:\n* `elevated`: Shadowed, providing more visual separation from the background than `filled`, but less than `outlined`.\n* `filled`: Provides minimal visual separation from the background.\n* `outlined`: Bordered, providing maximum visual separation from the background.", "values": [ { "name": "elevated", "description": "Shadowed, providing more visual separation from the background than `filled`, but less than `outlined`." }, { "name": "filled", "description": "Provides minimal visual separation from the background." }, { "name": "outlined", "description": "Bordered, providing maximum visual separation from the background." } ], "references": [ { "name": "Docs", "url": "https://www.mdui.org/en/docs/2/components/card#attributes-variant" } ] }, { "name": "clickable", "description": "Makes the card clickable. When set, a mouse hover effect and click ripple effect are added.", "references": [ { "name": "Docs", "url": "https://www.mdui.org/en/docs/2/components/card#attributes-clickable" } ] }, { "name": "disabled", "description": "Disables the card.", "references": [ { "name": "Docs", "url": "https://www.mdui.org/en/docs/2/components/card#attributes-disabled" } ] }, { "name": "href", "description": "The URL for the hyperlink. If specified, the component renders as an `<a>` element and can use link-related attributes.", "references": [ { "name": "Docs", "url": "https://www.mdui.org/en/docs/2/components/card#attributes-href" } ] }, { "name": "download", "description": "Instructs the browser to treat the linked URL as a download.\n\n**Note**: This is only available when `href` is specified.", "references": [ { "name": "Docs", "url": "https://www.mdui.org/en/docs/2/components/card#attributes-download" } ] }, { "name": "target", "description": "Defines where to display the linked URL. Possible values:\n\n* `_blank`: Opens in a new tab or window.\n* `_parent`: Opens in the parent browsing context or `_self` if no parent exists.\n* `_self`: Opens in the current browsing context. (Default).\n* `_top`: Opens in the topmost browsing context or `_self` if no ancestors exist.\n\n**Note**: This is only available when `href` is specified.", "values": [ { "name": "_blank", "description": "Opens in a new tab or window." }, { "name": "_parent", "description": "Opens in the parent browsing context or `_self` if no parent exists." }, { "name": "_self", "description": "Opens in the current browsing context. (Default)." }, { "name": "_top", "description": "Opens in the topmost browsing context or `_self` if no ancestors exist." } ], "references": [ { "name": "Docs", "url": "https://www.mdui.org/en/docs/2/components/card#attributes-target" } ] }, { "name": "rel", "description": "Specifies the relationship of the linked URL as space-separated link types. Possible values:\n\n* `alternate`: Alternate versions of the current document.\n* `author`: Author of the current document or article.\n* `bookmark`: Permanent link for the nearest ancestor section.\n* `external`: The referenced document is not part of the same site as the current document.\n* `help`: Link to context-sensitive help.\n* `license`: Indicates that the main content of the current document is covered by the copyright license described by the referenced document.\n* `me`: Indicates that the current document represents the person who owns the linked content.\n* `next`: Indicates that the current document is part of a series and the next document in the series is the referenced document.\n* `nofollow`: Indicates that the current document's original author or publisher does not endorse the referenced document.\n* `noreferrer`: No `Referer` header will be included. Also has the same effect as `noopener`.\n* `opener`: Creates an auxiliary browsing context if the hyperlink would otherwise create a top-level browsing context that is not an auxiliary browsing context (i.e., has \"`_blank`\" as `target` attribute value).\n* `prev`: Indicates that the current document is part of a series and the previous document in the series is the referenced document.\n* `search`: Links to a resource that can be used to search through the current document and its related pages.\n* `tag`: Gives a tag (identified by the given address) that applies to the current document.\n\n**Note**: This is only available when `href` is specified.", "values": [ { "name": "alternate", "description": "Alternate versions of the current document." }, { "name": "author", "description": "Author of the current document or article." }, { "name": "bookmark", "description": "Permanent link for the nearest ancestor section." }, { "name": "external", "description": "The referenced document is not part of the same site as the current document." }, { "name": "help", "description": "Link to context-sensitive help." }, { "name": "license", "description": "Indicates that the main content of the current document is covered by the copyright license described by the referenced document." }, { "name": "me", "description": "Indicates that the current document represents the person who owns the linked content." }, { "name": "next", "description": "Indicates that the current document is part of a series and the next document in the series is the