mdui 2.0.2 → 2.0.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/components/avatar/index.d.ts +17 -15
- package/components/avatar/index.js +7 -6
- package/components/badge/index.d.ts +11 -8
- package/components/badge/index.js +9 -7
- package/components/bottom-app-bar/index.d.ts +11 -4
- package/components/bottom-app-bar/index.js +8 -9
- package/components/button/button-base-style.js +1 -1
- package/components/button/button-base.d.ts +46 -47
- package/components/button/button-base.js +27 -25
- package/components/button/index.d.ts +19 -14
- package/components/button/index.js +12 -12
- package/components/button-icon/index.d.ts +15 -9
- package/components/button-icon/index.js +8 -9
- package/components/card/index.d.ts +15 -11
- package/components/card/index.js +10 -9
- package/components/checkbox/index.d.ts +30 -23
- package/components/checkbox/index.js +25 -25
- package/components/chip/index.d.ts +27 -20
- package/components/chip/index.js +19 -20
- package/components/circular-progress/index.d.ts +6 -4
- package/components/circular-progress/index.js +4 -3
- package/components/collapse/collapse-item.d.ts +17 -6
- package/components/collapse/collapse-item.js +7 -7
- package/components/collapse/collapse.d.ts +16 -11
- package/components/collapse/collapse.js +10 -10
- package/components/dialog/index.d.ts +22 -15
- package/components/dialog/index.js +23 -27
- package/components/divider/index.d.ts +7 -5
- package/components/divider/index.js +6 -5
- package/components/dropdown/index.d.ts +44 -37
- package/components/dropdown/index.js +50 -48
- package/components/fab/index.d.ts +12 -7
- package/components/fab/index.js +6 -6
- package/components/icon/index.d.ts +4 -2
- package/components/icon/index.js +3 -2
- package/components/layout/layout-item-base.d.ts +3 -2
- package/components/layout/layout-item-base.js +2 -2
- package/components/layout/layout-item.d.ts +11 -10
- package/components/layout/layout-item.js +6 -6
- package/components/layout/layout-main.d.ts +6 -4
- package/components/layout/layout-main.js +5 -4
- package/components/layout/layout.d.ts +6 -4
- package/components/layout/layout.js +5 -4
- package/components/linear-progress/index.d.ts +8 -6
- package/components/linear-progress/index.js +6 -5
- package/components/list/list-item-style.js +1 -1
- package/components/list/list-item.d.ts +24 -20
- package/components/list/list-item.js +10 -9
- package/components/list/list-subheader.d.ts +6 -4
- package/components/list/list-subheader.js +5 -4
- package/components/list/list.d.ts +5 -3
- package/components/list/list.js +4 -3
- package/components/menu/menu-item.d.ts +15 -7
- package/components/menu/menu-item.js +11 -15
- package/components/menu/menu.d.ts +20 -20
- package/components/menu/menu.js +13 -13
- package/components/navigation-bar/navigation-bar-item.d.ts +12 -8
- package/components/navigation-bar/navigation-bar-item.js +7 -6
- package/components/navigation-bar/navigation-bar.d.ts +17 -9
- package/components/navigation-bar/navigation-bar.js +15 -13
- package/components/navigation-drawer/index.d.ts +27 -21
- package/components/navigation-drawer/index.js +51 -38
- package/components/navigation-drawer/style.js +1 -1
- package/components/navigation-rail/navigation-rail-item.d.ts +13 -9
- package/components/navigation-rail/navigation-rail-item.js +7 -6
- package/components/navigation-rail/navigation-rail.d.ts +14 -12
- package/components/navigation-rail/navigation-rail.js +13 -12
- package/components/radio/radio-group.d.ts +20 -15
- package/components/radio/radio-group.js +21 -24
- package/components/radio/radio.d.ts +11 -6
- package/components/radio/radio.js +7 -7
- package/components/range-slider/index.d.ts +13 -8
- package/components/range-slider/index.js +10 -7
- package/components/ripple/index.d.ts +4 -2
- package/components/ripple/index.js +3 -2
- package/components/ripple/ripple-mixin.d.ts +1 -1
- package/components/ripple/ripple-mixin.js +0 -1
- package/components/segmented-button/segmented-button-group-style.js +1 -1
- package/components/segmented-button/segmented-button-group.d.ts +23 -22
- package/components/segmented-button/segmented-button-group.js +20 -23
- package/components/segmented-button/segmented-button.d.ts +9 -4
- package/components/segmented-button/segmented-button.js +3 -3
- package/components/select/index.d.ts +42 -35
- package/components/select/index.js +24 -25
- package/components/slider/index.d.ts +9 -2
- package/components/slider/index.js +5 -10
- package/components/slider/slider-base.d.ts +22 -18
- package/components/slider/slider-base.js +40 -21
- package/components/snackbar/index.d.ts +30 -23
- package/components/snackbar/index.js +25 -25
- package/components/switch/index.d.ts +24 -17
- package/components/switch/index.js +18 -18
- package/components/tabs/tab-panel.d.ts +7 -5
- package/components/tabs/tab-panel.js +5 -4
- package/components/tabs/tab.d.ts +13 -9
- package/components/tabs/tab.js +8 -7
- package/components/tabs/tabs.d.ts +24 -21
- package/components/tabs/tabs.js +24 -21
- package/components/text-field/index.d.ts +62 -54
- package/components/text-field/index.js +37 -37
- package/components/tooltip/index.d.ts +40 -33
- package/components/tooltip/index.js +45 -43
- package/components/top-app-bar/top-app-bar-title.d.ts +8 -6
- package/components/top-app-bar/top-app-bar-title.js +7 -6
- package/components/top-app-bar/top-app-bar.d.ts +12 -6
- package/components/top-app-bar/top-app-bar.js +9 -10
- package/css-data.en.json +2826 -0
- package/css-data.zh-cn.json +374 -367
- package/custom-elements.json +3844 -3824
- package/html-data.en.json +6551 -0
- package/html-data.zh-cn.json +1621 -1636
- package/jsx.en.d.ts +3303 -0
- package/jsx.zh-cn.d.ts +3351 -0
- package/mdui.esm.js +9 -9
- package/mdui.global.js +9 -9
- package/package.json +7 -5
- package/web-types.en.json +11718 -0
- package/web-types.zh-cn.json +3613 -3623
package/jsx.en.d.ts
ADDED
|
@@ -0,0 +1,3303 @@
|
|
|
1
|
+
import React from 'react';
|
|
2
|
+
import { JQ } from '@mdui/jq';
|
|
3
|
+
|
|
4
|
+
type HTMLElementProps = React.DetailedHTMLProps<React.HTMLAttributes<HTMLElement>, HTMLElement>;
|
|
5
|
+
|
|
6
|
+
declare global {
|
|
7
|
+
namespace JSX {
|
|
8
|
+
interface IntrinsicElements {
|
|
9
|
+
/**
|
|
10
|
+
* Avatar Component
|
|
11
|
+
*
|
|
12
|
+
* ```html
|
|
13
|
+
* <mdui-avatar src="https://avatars githubusercontent com/u/3030330?s=40&v=4"></mdui-avatar>
|
|
14
|
+
* ```
|
|
15
|
+
* @see https://www.mdui.org/en/docs/2/components/avatar
|
|
16
|
+
*/
|
|
17
|
+
'mdui-avatar': {
|
|
18
|
+
/**
|
|
19
|
+
* URL of the avatar image.
|
|
20
|
+
* @see https://www.mdui.org/en/docs/2/components/avatar#attributes-src
|
|
21
|
+
*/
|
|
22
|
+
'src'?: string;
|
|
23
|
+
/**
|
|
24
|
+
* Image resizing method, similar to the native CSS [`object-fit`](https://developer.mozilla.org/en-US/docs/Web/CSS/object-fit). Possible values:
|
|
25
|
+
*
|
|
26
|
+
* * `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.
|
|
27
|
+
* * `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.
|
|
28
|
+
* * `fill`: Default. Scales the image to fill the box. The image will be stretched if the aspect ratios do not match.
|
|
29
|
+
* * `none`: No resizing.
|
|
30
|
+
* * `scale-down`: Scales as if `none` or `contain` were specified, choosing the smaller result.
|
|
31
|
+
* @see https://www.mdui.org/en/docs/2/components/avatar#attributes-fit
|
|
32
|
+
*/
|
|
33
|
+
'fit'?: 'contain' | 'cover' | 'fill' | 'none' | 'scale-down';
|
|
34
|
+
/**
|
|
35
|
+
* The Material Icons name for the avatar.
|
|
36
|
+
* @see https://www.mdui.org/en/docs/2/components/avatar#attributes-icon
|
|
37
|
+
*/
|
|
38
|
+
'icon'?: string;
|
|
39
|
+
/**
|
|
40
|
+
* Text description of the avatar.
|
|
41
|
+
* @see https://www.mdui.org/en/docs/2/components/avatar#attributes-label
|
|
42
|
+
*/
|
|
43
|
+
'label'?: string;
|
|
44
|
+
} & HTMLElementProps;
|
|
45
|
+
/**
|
|
46
|
+
* Badge Component
|
|
47
|
+
*
|
|
48
|
+
* ```html
|
|
49
|
+
* <mdui-badge>12</mdui-badge>
|
|
50
|
+
* ```
|
|
51
|
+
* @see https://www.mdui.org/en/docs/2/components/badge
|
|
52
|
+
*/
|
|
53
|
+
'mdui-badge': {
|
|
54
|
+
/**
|
|
55
|
+
* Defines the badge shape. Possible values:
|
|
56
|
+
* * `small`: A small badge without text.
|
|
57
|
+
* * `large`: A large badge with displayed text.
|
|
58
|
+
* @see https://www.mdui.org/en/docs/2/components/badge#attributes-variant
|
|
59
|
+
*/
|
|
60
|
+
'variant'?: 'small' | 'large';
|
|
61
|
+
} & HTMLElementProps;
|
|
62
|
+
/**
|
|
63
|
+
* Bottom App Bar Component
|
|
64
|
+
*
|
|
65
|
+
* ```html
|
|
66
|
+
* <mdui-bottom-app-bar>
|
|
67
|
+
* <mdui-button-icon icon="check_box--outlined"></mdui-button-icon>
|
|
68
|
+
* <mdui-button-icon icon="edit--outlined"></mdui-button-icon>
|
|
69
|
+
* <mdui-button-icon icon="mic_none--outlined"></mdui-button-icon>
|
|
70
|
+
* <mdui-button-icon icon="image--outlined"></mdui-button-icon>
|
|
71
|
+
* <div style="flex-grow: 1"></div>
|
|
72
|
+
* <mdui-fab icon="add"></mdui-fab>
|
|
73
|
+
* </mdui-bottom-app-bar>
|
|
74
|
+
* ```
|
|
75
|
+
* @see https://www.mdui.org/en/docs/2/components/bottom-app-bar
|
|
76
|
+
*/
|
|
77
|
+
'mdui-bottom-app-bar': {
|
|
78
|
+
/**
|
|
79
|
+
* Hides the bottom app bar when set.
|
|
80
|
+
* @see https://www.mdui.org/en/docs/2/components/bottom-app-bar#attributes-hide
|
|
81
|
+
*/
|
|
82
|
+
'hide'?: boolean;
|
|
83
|
+
/**
|
|
84
|
+
* 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.
|
|
85
|
+
* @see https://www.mdui.org/en/docs/2/components/bottom-app-bar#attributes-fab-detach
|
|
86
|
+
*/
|
|
87
|
+
'fab-detach'?: boolean;
|
|
88
|
+
/**
|
|
89
|
+
* Defines the scroll behavior. Possible values:
|
|
90
|
+
*
|
|
91
|
+
* * `hide`: Hides when scrolling.
|
|
92
|
+
* @see https://www.mdui.org/en/docs/2/components/bottom-app-bar#attributes-scroll-behavior
|
|
93
|
+
*/
|
|
94
|
+
'scroll-behavior'?: 'hide';
|
|
95
|
+
/**
|
|
96
|
+
* 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`.
|
|
97
|
+
* @see https://www.mdui.org/en/docs/2/components/bottom-app-bar#attributes-scroll-target
|
|
98
|
+
*/
|
|
99
|
+
'scroll-target'?: string | HTMLElement | JQ<HTMLElement>;
|
|
100
|
+
/**
|
|
101
|
+
* The scroll distance (in pixels) that triggers the scroll behavior.
|
|
102
|
+
* @see https://www.mdui.org/en/docs/2/components/bottom-app-bar#attributes-scroll-threshold
|
|
103
|
+
*/
|
|
104
|
+
'scroll-threshold'?: number;
|
|
105
|
+
/**
|
|
106
|
+
* 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`.
|
|
107
|
+
* @see https://www.mdui.org/en/docs/2/components/bottom-app-bar#attributes-order
|
|
108
|
+
*/
|
|
109
|
+
'order'?: number;
|
|
110
|
+
} & HTMLElementProps;
|
|
111
|
+
/**
|
|
112
|
+
* Button Component
|
|
113
|
+
*
|
|
114
|
+
* ```html
|
|
115
|
+
* <mdui-button>Button</mdui-button>
|
|
116
|
+
* ```
|
|
117
|
+
* @see https://www.mdui.org/en/docs/2/components/button
|
|
118
|
+
*/
|
|
119
|
+
'mdui-button': {
|
|
120
|
+
/**
|
|
121
|
+
* Defines the button style. Possible values:
|
|
122
|
+
* * `elevated`: A shadowed button for visual distinction.
|
|
123
|
+
* * `filled`: Used for final actions like 'Save' or 'Confirm'.
|
|
124
|
+
* * `tonal`: A mix between `filled` and `outlined`, suitable for medium to high-priority actions.
|
|
125
|
+
* * `outlined`: A bordered button for medium-priority and secondary actions.
|
|
126
|
+
* * `text`: A text button for low-priority actions.
|
|
127
|
+
* @see https://www.mdui.org/en/docs/2/components/button#attributes-variant
|
|
128
|
+
*/
|
|
129
|
+
'variant'?: 'elevated' | 'filled' | 'tonal' | 'outlined' | 'text';
|
|
130
|
+
/**
|
|
131
|
+
* If set, the button will fill the width of its parent element.
|
|
132
|
+
* @see https://www.mdui.org/en/docs/2/components/button#attributes-full-width
|
|
133
|
+
*/
|
|
134
|
+
'full-width'?: boolean;
|
|
135
|
+
/**
|
|
136
|
+
* Specifies the Material Icons name on the left. Alternatively, use `slot="icon"`.
|
|
137
|
+
* @see https://www.mdui.org/en/docs/2/components/button#attributes-icon
|
|
138
|
+
*/
|
|
139
|
+
'icon'?: string;
|
|
140
|
+
/**
|
|
141
|
+
* Specifies the Material Icons name on the right. Alternatively, use `slot="end-icon"`.
|
|
142
|
+
* @see https://www.mdui.org/en/docs/2/components/button#attributes-end-icon
|
|
143
|
+
*/
|
|
144
|
+
'end-icon'?: string;
|
|
145
|
+
/**
|
|
146
|
+
* The URL for the hyperlink. If provided, the component is rendered as an `<a>` element and can use link-related attributes.
|
|
147
|
+
* @see https://www.mdui.org/en/docs/2/components/button#attributes-href
|
|
148
|
+
*/
|
|
149
|
+
'href'?: string;
|
|
150
|
+
/**
|
|
151
|
+
* Instructs the browser to download the linked URL.
|
|
152
|
+
*
|
|
153
|
+
* **Note**: This is only available when `href` is specified.
|
|
154
|
+
* @see https://www.mdui.org/en/docs/2/components/button#attributes-download
|
|
155
|
+
*/
|
|
156
|
+
'download'?: string;
|
|
157
|
+
/**
|
|
158
|
+
* Defines where to open the linked URL. Possible values:
|
|
159
|
+
*
|
|
160
|
+
* * `_blank`: Opens in a new tab or window.
|
|
161
|
+
* * `_parent`: Opens in the parent browsing context or `_self` if no parent.
|
|
162
|
+
* * `_self`: Opens in the current browsing context. (Default).
|
|
163
|
+
* * `_top`: Opens in the topmost browsing context or `_self` if no ancestors.
|
|
164
|
+
*
|
|
165
|
+
* **Note**: This is only available when `href` is specified.
|
|
166
|
+
* @see https://www.mdui.org/en/docs/2/components/button#attributes-target
|
|
167
|
+
*/
|
|
168
|
+
'target'?: '_blank' | '_parent' | '_self' | '_top';
|
|
169
|
+
/**
|
|
170
|
+
* Specifies the relationship of the linked URL as space-separated link types. Possible values:
|
|
171
|
+
*
|
|
172
|
+
* * `alternate`: Alternate versions of the current document.
|
|
173
|
+
* * `author`: The author of the current document or article.
|
|
174
|
+
* * `bookmark`: The permalink for the nearest ancestor section.
|
|
175
|
+
* * `external`: The referenced document is not part of the same site as the current document.
|
|
176
|
+
* * `help`: A link to context-sensitive help.
|
|
177
|
+
* * `license`: Indicates that the main content of the current document is covered by the copyright license described by the referenced document.
|
|
178
|
+
* * `me`: Indicates that the current document represents the person who owns the linked content.
|
|
179
|
+
* * `next`: Indicates that the current document is part of a series and the next document in the series is the referenced document.
|
|
180
|
+
* * `nofollow`: Indicates that the current document's original author or publisher does not endorse the referenced document.
|
|
181
|
+
* * `noreferrer`: No `Referer` header will be included. Also has the same effect as `noopener`.
|
|
182
|
+
* * `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).
|
|
183
|
+
* * `prev`: Indicates that the current document is part of a series and the previous document in the series is the referenced document.
|
|
184
|
+
* * `search`: Links to a resource that can be used to search through the current document and its related pages.
|
|
185
|
+
* * `tag`: Gives a tag (identified by the given address) that applies to the current document.
|
|
186
|
+
*
|
|
187
|
+
* **Note**: This is only available when `href` is specified.
|
|
188
|
+
* @see https://www.mdui.org/en/docs/2/components/button#attributes-rel
|
|
189
|
+
*/
|
|
190
|
+
'rel'?: 'alternate' | 'author' | 'bookmark' | 'external' | 'help' | 'license' | 'me' | 'next' | 'nofollow' | 'noreferrer' | 'opener' | 'prev' | 'search' | 'tag';
|
|
191
|
+
/**
|
|
192
|
+
* Specifies that the element should be focused when the page loads.
|
|
193
|
+
* @see https://www.mdui.org/en/docs/2/components/button#attributes-autofocus
|
|
194
|
+
*/
|
|
195
|
+
'autofocus'?: boolean;
|
|
196
|
+
/**
|
|
197
|
+
* Defines the order in which the element receives focus when navigating with the Tab key.
|
|
198
|
+
* @see https://www.mdui.org/en/docs/2/components/button#attributes-tabindex
|
|
199
|
+
*/
|
|
200
|
+
'tabindex'?: number;
|
|
201
|
+
/**
|
|
202
|
+
* Disables the element.
|
|
203
|
+
* @see https://www.mdui.org/en/docs/2/components/button#attributes-disabled
|
|
204
|
+
*/
|
|
205
|
+
'disabled'?: boolean;
|
|
206
|
+
/**
|
|
207
|
+
* Indicates that the element is in a loading state.
|
|
208
|
+
* @see https://www.mdui.org/en/docs/2/components/button#attributes-loading
|
|
209
|
+
*/
|
|
210
|
+
'loading'?: boolean;
|
|
211
|
+
/**
|
|
212
|
+
* The button's name, which is submitted with form data.
|
|
213
|
+
*
|
|
214
|
+
* **Note**: This is only available when `href` is not specified.
|
|
215
|
+
* @see https://www.mdui.org/en/docs/2/components/button#attributes-name
|
|
216
|
+
*/
|
|
217
|
+
'name'?: string;
|
|
218
|
+
/**
|
|
219
|
+
* The button's value, which is submitted with form data.
|
|
220
|
+
*
|
|
221
|
+
* **Note**: This is only available when `href` is not specified.
|
|
222
|
+
* @see https://www.mdui.org/en/docs/2/components/button#attributes-value
|
|
223
|
+
*/
|
|
224
|
+
'value'?: string;
|
|
225
|
+
/**
|
|
226
|
+
* Defines the button's default behavior. The default is `button`. Possible values:
|
|
227
|
+
*
|
|
228
|
+
* * `submit`: Submits the form data to the server.
|
|
229
|
+
* * `reset`: Resets all the controls to their initial values.
|
|
230
|
+
* * `button`: No default behavior, does nothing when pressed by default.
|
|
231
|
+
*
|
|
232
|
+
* **Note**: This is only available when `href` is not specified.
|
|
233
|
+
* @see https://www.mdui.org/en/docs/2/components/button#attributes-type
|
|
234
|
+
*/
|
|
235
|
+
'type'?: 'submit' | 'reset' | 'button';
|
|
236
|
+
/**
|
|
237
|
+
* 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.
|
|
238
|
+
*
|
|
239
|
+
* This attribute allows button elements to be associated with `<form>`s anywhere in the document, not just inside a `<form>`.
|
|
240
|
+
*
|
|
241
|
+
* **Note**: Only available when `href` is not specified.
|
|
242
|
+
* @see https://www.mdui.org/en/docs/2/components/button#attributes-form
|
|
243
|
+
*/
|
|
244
|
+
'form'?: string;
|
|
245
|
+
/**
|
|
246
|
+
* Specifies the URL that processes the button's submitted information. Overrides the `action` attribute of the button's form owner.
|
|
247
|
+
*
|
|
248
|
+
* **Note**: Only available when `href` is not specified and `type="submit"`.
|
|
249
|
+
* @see https://www.mdui.org/en/docs/2/components/button#attributes-formaction
|
|
250
|
+
*/
|
|
251
|
+
'formaction'?: string;
|
|
252
|
+
/**
|
|
253
|
+
* Specifies the form data encoding method. Possible values:
|
|
254
|
+
*
|
|
255
|
+
* * `application/x-www-form-urlencoded`: Default if the attribute is not used.
|
|
256
|
+
* * `multipart/form-data`: Used for `<input>` elements with `type` set to `file`.
|
|
257
|
+
* * `text/plain`: For debugging, not for real form submission.
|
|
258
|
+
*
|
|
259
|
+
* Overrides the `enctype` attribute of the button's form owner.
|
|
260
|
+
*
|
|
261
|
+
* **Note**: Only available when `href` is not specified and `type="submit"`.
|
|
262
|
+
* @see https://www.mdui.org/en/docs/2/components/button#attributes-formenctype
|
|
263
|
+
*/
|
|
264
|
+
'formenctype'?: 'application/x-www-form-urlencoded' | 'multipart/form-data' | 'text/plain';
|
|
265
|
+
/**
|
|
266
|
+
* Specifies the HTTP method for form submission. Possible values:
|
|
267
|
+
*
|
|
268
|
+
* * `post`: Form data included in HTTP request body.
|
|
269
|
+
* * `get`: Form data appended to `action` URL.
|
|
270
|
+
*
|
|
271
|
+
* Overrides the `method` attribute of the button's form owner.
|
|
272
|
+
*
|
|
273
|
+
* **Note**: Only available when `href` is not specified and `type="submit"`.
|
|
274
|
+
* @see https://www.mdui.org/en/docs/2/components/button#attributes-formmethod
|
|
275
|
+
*/
|
|
276
|
+
'formmethod'?: 'post' | 'get';
|
|
277
|
+
/**
|
|
278
|
+
* Specifies that the form should not be validated on submission. Overrides the `novalidate` attribute of the button's form owner.
|
|
279
|
+
*
|
|
280
|
+
* **Note**: Only available when `href` is not specified and `type="submit"`.
|
|
281
|
+
* @see https://www.mdui.org/en/docs/2/components/button#attributes-formnovalidate
|
|
282
|
+
*/
|
|
283
|
+
'formnovalidate'?: boolean;
|
|
284
|
+
/**
|
|
285
|
+
* Specifies where to display the form submission response. Possible values:
|
|
286
|
+
*
|
|
287
|
+
* * `_self`: Current browsing context. (Default).
|
|
288
|
+
* * `_blank`: New tab or window.
|
|
289
|
+
* * `_parent`: Parent browsing context or `_self` if no parent.
|
|
290
|
+
* * `_top`: Topmost browsing context or `_self` if no ancestors.
|
|
291
|
+
*
|
|
292
|
+
* Overrides the `target` attribute of the button's form owner.
|
|
293
|
+
*
|
|
294
|
+
* **Note**: Only available when `href` is not specified and `type="submit"`.
|
|
295
|
+
* @see https://www.mdui.org/en/docs/2/components/button#attributes-formtarget
|
|
296
|
+
*/
|
|
297
|
+
'formtarget'?: '_self' | '_blank' | '_parent' | '_top';
|
|
298
|
+
} & HTMLElementProps;
|
|
299
|
+
/**
|
|
300
|
+
* Icon Button Component
|
|
301
|
+
*
|
|
302
|
+
* ```html
|
|
303
|
+
* <mdui-button-icon icon="search"></mdui-button-icon>
|
|
304
|
+
* ```
|
|
305
|
+
* @see https://www.mdui.org/en/docs/2/components/button-icon
|
|
306
|
+
*/
|
|
307
|
+
'mdui-button-icon': {
|
|
308
|
+
/**
|
|
309
|
+
* Defines the icon button style. Possible values:
|
|
310
|
+
* * `standard`: For low-priority actions.
|
|
311
|
+
* * `filled`: Has the strongest visual effect, suitable for high-priority actions.
|
|
312
|
+
* * `tonal`: A visual effect between `filled` and `outlined`, suitable for medium to high-priority actions.
|
|
313
|
+
* * `outlined`: For medium-priority actions.
|
|
314
|
+
* @see https://www.mdui.org/en/docs/2/components/button-icon#attributes-variant
|
|
315
|
+
*/
|
|
316
|
+
'variant'?: 'standard' | 'filled' | 'tonal' | 'outlined';
|
|
317
|
+
/**
|
|
318
|
+
* Specifies the Material Icons name. Alternatively, use the default slot.
|
|
319
|
+
* @see https://www.mdui.org/en/docs/2/components/button-icon#attributes-icon
|
|
320
|
+
*/
|
|
321
|
+
'icon'?: string;
|
|
322
|
+
/**
|
|
323
|
+
* Specifies the Material Icons name when selected. Alternatively, use `slot="selected-icon"`.
|
|
324
|
+
* @see https://www.mdui.org/en/docs/2/components/button-icon#attributes-selected-icon
|
|
325
|
+
*/
|
|
326
|
+
'selected-icon'?: string;
|
|
327
|
+
/**
|
|
328
|
+
* Indicates if the button is selectable.
|
|
329
|
+
* @see https://www.mdui.org/en/docs/2/components/button-icon#attributes-selectable
|
|
330
|
+
*/
|
|
331
|
+
'selectable'?: boolean;
|
|
332
|
+
/**
|
|
333
|
+
* Indicates if the button is selected.
|
|
334
|
+
* @see https://www.mdui.org/en/docs/2/components/button-icon#attributes-selected
|
|
335
|
+
*/
|
|
336
|
+
'selected'?: boolean;
|
|
337
|
+
/**
|
|
338
|
+
* The URL for the hyperlink. If provided, the component is rendered as an `<a>` element and can use link-related attributes.
|
|
339
|
+
* @see https://www.mdui.org/en/docs/2/components/button-icon#attributes-href
|
|
340
|
+
*/
|
|
341
|
+
'href'?: string;
|
|
342
|
+
/**
|
|
343
|
+
* Instructs the browser to download the linked URL.
|
|
344
|
+
*
|
|
345
|
+
* **Note**: This is only available when `href` is specified.
|
|
346
|
+
* @see https://www.mdui.org/en/docs/2/components/button-icon#attributes-download
|
|
347
|
+
*/
|
|
348
|
+
'download'?: string;
|
|
349
|
+
/**
|
|
350
|
+
* Defines where to open the linked URL. Possible values:
|
|
351
|
+
*
|
|
352
|
+
* * `_blank`: Opens in a new tab or window.
|
|
353
|
+
* * `_parent`: Opens in the parent browsing context or `_self` if no parent.
|
|
354
|
+
* * `_self`: Opens in the current browsing context. (Default).
|
|
355
|
+
* * `_top`: Opens in the topmost browsing context or `_self` if no ancestors.
|
|
356
|
+
*
|
|
357
|
+
* **Note**: This is only available when `href` is specified.
|
|
358
|
+
* @see https://www.mdui.org/en/docs/2/components/button-icon#attributes-target
|
|
359
|
+
*/
|
|
360
|
+
'target'?: '_blank' | '_parent' | '_self' | '_top';
|
|
361
|
+
/**
|
|
362
|
+
* Specifies the relationship of the linked URL as space-separated link types. Possible values:
|
|
363
|
+
*
|
|
364
|
+
* * `alternate`: Alternate versions of the current document.
|
|
365
|
+
* * `author`: The author of the current document or article.
|
|
366
|
+
* * `bookmark`: The permalink for the nearest ancestor section.
|
|
367
|
+
* * `external`: The referenced document is not part of the same site as the current document.
|
|
368
|
+
* * `help`: A link to context-sensitive help.
|
|
369
|
+
* * `license`: Indicates that the main content of the current document is covered by the copyright license described by the referenced document.
|
|
370
|
+
* * `me`: Indicates that the current document represents the person who owns the linked content.
|
|
371
|
+
* * `next`: Indicates that the current document is part of a series and the next document in the series is the referenced document.
|
|
372
|
+
* * `nofollow`: Indicates that the current document's original author or publisher does not endorse the referenced document.
|
|
373
|
+
* * `noreferrer`: No `Referer` header will be included. Also has the same effect as `noopener`.
|
|
374
|
+
* * `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).
|
|
375
|
+
* * `prev`: Indicates that the current document is part of a series and the previous document in the series is the referenced document.
|
|
376
|
+
* * `search`: Links to a resource that can be used to search through the current document and its related pages.
|
|
377
|
+
* * `tag`: Gives a tag (identified by the given address) that applies to the current document.
|
|
378
|
+
*
|
|
379
|
+
* **Note**: This is only available when `href` is specified.
|
|
380
|
+
* @see https://www.mdui.org/en/docs/2/components/button-icon#attributes-rel
|
|
381
|
+
*/
|
|
382
|
+
'rel'?: 'alternate' | 'author' | 'bookmark' | 'external' | 'help' | 'license' | 'me' | 'next' | 'nofollow' | 'noreferrer' | 'opener' | 'prev' | 'search' | 'tag';
|
|
383
|
+
/**
|
|
384
|
+
* Specifies that the element should be focused when the page loads.
|
|
385
|
+
* @see https://www.mdui.org/en/docs/2/components/button-icon#attributes-autofocus
|
|
386
|
+
*/
|
|
387
|
+
'autofocus'?: boolean;
|
|
388
|
+
/**
|
|
389
|
+
* Defines the order in which the element receives focus when navigating with the Tab key.
|
|
390
|
+
* @see https://www.mdui.org/en/docs/2/components/button-icon#attributes-tabindex
|
|
391
|
+
*/
|
|
392
|
+
'tabindex'?: number;
|
|
393
|
+
/**
|
|
394
|
+
* Disables the element.
|
|
395
|
+
* @see https://www.mdui.org/en/docs/2/components/button-icon#attributes-disabled
|
|
396
|
+
*/
|
|
397
|
+
'disabled'?: boolean;
|
|
398
|
+
/**
|
|
399
|
+
* Indicates that the element is in a loading state.
|
|
400
|
+
* @see https://www.mdui.org/en/docs/2/components/button-icon#attributes-loading
|
|
401
|
+
*/
|
|
402
|
+
'loading'?: boolean;
|
|
403
|
+
/**
|
|
404
|
+
* The button's name, which is submitted with form data.
|
|
405
|
+
*
|
|
406
|
+
* **Note**: This is only available when `href` is not specified.
|
|
407
|
+
* @see https://www.mdui.org/en/docs/2/components/button-icon#attributes-name
|
|
408
|
+
*/
|
|
409
|
+
'name'?: string;
|
|
410
|
+
/**
|
|
411
|
+
* The button's value, which is submitted with form data.
|
|
412
|
+
*
|
|
413
|
+
* **Note**: This is only available when `href` is not specified.
|
|
414
|
+
* @see https://www.mdui.org/en/docs/2/components/button-icon#attributes-value
|
|
415
|
+
*/
|
|
416
|
+
'value'?: string;
|
|
417
|
+
/**
|
|
418
|
+
* Defines the button's default behavior. The default is `button`. Possible values:
|
|
419
|
+
*
|
|
420
|
+
* * `submit`: Submits the form data to the server.
|
|
421
|
+
* * `reset`: Resets all the controls to their initial values.
|
|
422
|
+
* * `button`: No default behavior, does nothing when pressed by default.
|
|
423
|
+
*
|
|
424
|
+
* **Note**: This is only available when `href` is not specified.
|
|
425
|
+
* @see https://www.mdui.org/en/docs/2/components/button-icon#attributes-type
|
|
426
|
+
*/
|
|
427
|
+
'type'?: 'submit' | 'reset' | 'button';
|
|
428
|
+
/**
|
|
429
|
+
* 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.
|
|
430
|
+
*
|
|
431
|
+
* This attribute allows button elements to be associated with `<form>`s anywhere in the document, not just inside a `<form>`.
|
|
432
|
+
*
|
|
433
|
+
* **Note**: Only available when `href` is not specified.
|
|
434
|
+
* @see https://www.mdui.org/en/docs/2/components/button-icon#attributes-form
|
|
435
|
+
*/
|
|
436
|
+
'form'?: string;
|
|
437
|
+
/**
|
|
438
|
+
* Specifies the URL that processes the button's submitted information. Overrides the `action` attribute of the button's form owner.
|
|
439
|
+
*
|
|
440
|
+
* **Note**: Only available when `href` is not specified and `type="submit"`.
|
|
441
|
+
* @see https://www.mdui.org/en/docs/2/components/button-icon#attributes-formaction
|
|
442
|
+
*/
|
|
443
|
+
'formaction'?: string;
|
|
444
|
+
/**
|
|
445
|
+
* Specifies the form data encoding method. Possible values:
|
|
446
|
+
*
|
|
447
|
+
* * `application/x-www-form-urlencoded`: Default if the attribute is not used.
|
|
448
|
+
* * `multipart/form-data`: Used for `<input>` elements with `type` set to `file`.
|
|
449
|
+
* * `text/plain`: For debugging, not for real form submission.
|
|
450
|
+
*
|
|
451
|
+
* Overrides the `enctype` attribute of the button's form owner.
|
|
452
|
+
*
|
|
453
|
+
* **Note**: Only available when `href` is not specified and `type="submit"`.
|
|
454
|
+
* @see https://www.mdui.org/en/docs/2/components/button-icon#attributes-formenctype
|
|
455
|
+
*/
|
|
456
|
+
'formenctype'?: 'application/x-www-form-urlencoded' | 'multipart/form-data' | 'text/plain';
|
|
457
|
+
/**
|
|
458
|
+
* Specifies the HTTP method for form submission. Possible values:
|
|
459
|
+
*
|
|
460
|
+
* * `post`: Form data included in HTTP request body.
|
|
461
|
+
* * `get`: Form data appended to `action` URL.
|
|
462
|
+
*
|
|
463
|
+
* Overrides the `method` attribute of the button's form owner.
|
|
464
|
+
*
|
|
465
|
+
* **Note**: Only available when `href` is not specified and `type="submit"`.
|
|
466
|
+
* @see https://www.mdui.org/en/docs/2/components/button-icon#attributes-formmethod
|
|
467
|
+
*/
|
|
468
|
+
'formmethod'?: 'post' | 'get';
|
|
469
|
+
/**
|
|
470
|
+
* Specifies that the form should not be validated on submission. Overrides the `novalidate` attribute of the button's form owner.
|
|
471
|
+
*
|
|
472
|
+
* **Note**: Only available when `href` is not specified and `type="submit"`.
|
|
473
|
+
* @see https://www.mdui.org/en/docs/2/components/button-icon#attributes-formnovalidate
|
|
474
|
+
*/
|
|
475
|
+
'formnovalidate'?: boolean;
|
|
476
|
+
/**
|
|
477
|
+
* Specifies where to display the form submission response. Possible values:
|
|
478
|
+
*
|
|
479
|
+
* * `_self`: Current browsing context. (Default).
|
|
480
|
+
* * `_blank`: New tab or window.
|
|
481
|
+
* * `_parent`: Parent browsing context or `_self` if no parent.
|
|
482
|
+
* * `_top`: Topmost browsing context or `_self` if no ancestors.
|
|
483
|
+
*
|
|
484
|
+
* Overrides the `target` attribute of the button's form owner.
|
|
485
|
+
*
|
|
486
|
+
* **Note**: Only available when `href` is not specified and `type="submit"`.
|
|
487
|
+
* @see https://www.mdui.org/en/docs/2/components/button-icon#attributes-formtarget
|
|
488
|
+
*/
|
|
489
|
+
'formtarget'?: '_self' | '_blank' | '_parent' | '_top';
|
|
490
|
+
} & HTMLElementProps;
|
|
491
|
+
/**
|
|
492
|
+
* Card Component
|
|
493
|
+
*
|
|
494
|
+
* ```html
|
|
495
|
+
* <mdui-card>card content</mdui-card>
|
|
496
|
+
* ```
|
|
497
|
+
* @see https://www.mdui.org/en/docs/2/components/card
|
|
498
|
+
*/
|
|
499
|
+
'mdui-card': {
|
|
500
|
+
/**
|
|
501
|
+
* Defines the card style. Possible values:
|
|
502
|
+
* * `elevated`: Shadowed, providing more visual separation from the background than `filled`, but less than `outlined`.
|
|
503
|
+
* * `filled`: Provides minimal visual separation from the background.
|
|
504
|
+
* * `outlined`: Bordered, providing maximum visual separation from the background.
|
|
505
|
+
* @see https://www.mdui.org/en/docs/2/components/card#attributes-variant
|
|
506
|
+
*/
|
|
507
|
+
'variant'?: 'elevated' | 'filled' | 'outlined';
|
|
508
|
+
/**
|
|
509
|
+
* Makes the card clickable. When set, a mouse hover effect and click ripple effect are added.
|
|
510
|
+
* @see https://www.mdui.org/en/docs/2/components/card#attributes-clickable
|
|
511
|
+
*/
|
|
512
|
+
'clickable'?: boolean;
|
|
513
|
+
/**
|
|
514
|
+
* Disables the card.
|
|
515
|
+
* @see https://www.mdui.org/en/docs/2/components/card#attributes-disabled
|
|
516
|
+
*/
|
|
517
|
+
'disabled'?: boolean;
|
|
518
|
+
/**
|
|
519
|
+
* The URL for the hyperlink. If specified, the component renders as an `<a>` element and can use link-related attributes.
|
|
520
|
+
* @see https://www.mdui.org/en/docs/2/components/card#attributes-href
|
|
521
|
+
*/
|
|
522
|
+
'href'?: string;
|
|
523
|
+
/**
|
|
524
|
+
* Instructs the browser to treat the linked URL as a download.
|
|
525
|
+
*
|
|
526
|
+
* **Note**: This is only available when `href` is specified.
|
|
527
|
+
* @see https://www.mdui.org/en/docs/2/components/card#attributes-download
|
|
528
|
+
*/
|
|
529
|
+
'download'?: string;
|
|
530
|
+
/**
|
|
531
|
+
* Defines where to display the linked URL. Possible values:
|
|
532
|
+
*
|
|
533
|
+
* * `_blank`: Opens in a new tab or window.
|
|
534
|
+
* * `_parent`: Opens in the parent browsing context or `_self` if no parent exists.
|
|
535
|
+
* * `_self`: Opens in the current browsing context. (Default).
|
|
536
|
+
* * `_top`: Opens in the topmost browsing context or `_self` if no ancestors exist.
|
|
537
|
+
*
|
|
538
|
+
* **Note**: This is only available when `href` is specified.
|
|
539
|
+
* @see https://www.mdui.org/en/docs/2/components/card#attributes-target
|
|
540
|
+
*/
|
|
541
|
+
'target'?: '_blank' | '_parent' | '_self' | '_top';
|
|
542
|
+
/**
|
|
543
|
+
* Specifies the relationship of the linked URL as space-separated link types. Possible values:
|
|
544
|
+
*
|
|
545
|
+
* * `alternate`: Alternate versions of the current document.
|
|
546
|
+
* * `author`: Author of the current document or article.
|
|
547
|
+
* * `bookmark`: Permanent link for the nearest ancestor section.
|
|
548
|
+
* * `external`: The referenced document is not part of the same site as the current document.
|
|
549
|
+
* * `help`: Link to context-sensitive help.
|
|
550
|
+
* * `license`: Indicates that the main content of the current document is covered by the copyright license described by the referenced document.
|
|
551
|
+
* * `me`: Indicates that the current document represents the person who owns the linked content.
|
|
552
|
+
* * `next`: Indicates that the current document is part of a series and the next document in the series is the referenced document.
|
|
553
|
+
* * `nofollow`: Indicates that the current document's original author or publisher does not endorse the referenced document.
|
|
554
|
+
* * `noreferrer`: No `Referer` header will be included. Also has the same effect as `noopener`.
|
|
555
|
+
* * `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).
|
|
556
|
+
* * `prev`: Indicates that the current document is part of a series and the previous document in the series is the referenced document.
|
|
557
|
+
* * `search`: Links to a resource that can be used to search through the current document and its related pages.
|
|
558
|
+
* * `tag`: Gives a tag (identified by the given address) that applies to the current document.
|
|
559
|
+
*
|
|
560
|
+
* **Note**: This is only available when `href` is specified.
|
|
561
|
+
* @see https://www.mdui.org/en/docs/2/components/card#attributes-rel
|
|
562
|
+
*/
|
|
563
|
+
'rel'?: 'alternate' | 'author' | 'bookmark' | 'external' | 'help' | 'license' | 'me' | 'next' | 'nofollow' | 'noreferrer' | 'opener' | 'prev' | 'search' | 'tag';
|
|
564
|
+
/**
|
|
565
|
+
* Determines if the element should be focused when the page loads.
|
|
566
|
+
* @see https://www.mdui.org/en/docs/2/components/card#attributes-autofocus
|
|
567
|
+
*/
|
|
568
|
+
'autofocus'?: boolean;
|
|
569
|
+
/**
|
|
570
|
+
* Specifies the order in which the element receives focus when navigating with the Tab key.
|
|
571
|
+
* @see https://www.mdui.org/en/docs/2/components/card#attributes-tabindex
|
|
572
|
+
*/
|
|
573
|
+
'tabindex'?: number;
|
|
574
|
+
} & HTMLElementProps;
|
|
575
|
+
/**
|
|
576
|
+
* Checkbox Component
|
|
577
|
+
*
|
|
578
|
+
* ```html
|
|
579
|
+
* <mdui-checkbox>Checkbox</mdui-checkbox>
|
|
580
|
+
* ```
|
|
581
|
+
* @see https://www.mdui.org/en/docs/2/components/checkbox
|
|
582
|
+
*/
|
|
583
|
+
'mdui-checkbox': {
|
|
584
|
+
/**
|
|
585
|
+
* Dsiables the checkbox.
|
|
586
|
+
* @see https://www.mdui.org/en/docs/2/components/checkbox#attributes-disabled
|
|
587
|
+
*/
|
|
588
|
+
'disabled'?: boolean;
|
|
589
|
+
/**
|
|
590
|
+
* Sets the checkbox to the checked state.
|
|
591
|
+
* @see https://www.mdui.org/en/docs/2/components/checkbox#attributes-checked
|
|
592
|
+
*/
|
|
593
|
+
'checked'?: boolean;
|
|
594
|
+
/**
|
|
595
|
+
* Sets the checkbox to an indeterminate state.
|
|
596
|
+
* @see https://www.mdui.org/en/docs/2/components/checkbox#attributes-indeterminate
|
|
597
|
+
*/
|
|
598
|
+
'indeterminate'?: boolean;
|
|
599
|
+
/**
|
|
600
|
+
* Requires the checkbox to be checked for form submission.
|
|
601
|
+
* @see https://www.mdui.org/en/docs/2/components/checkbox#attributes-required
|
|
602
|
+
*/
|
|
603
|
+
'required'?: boolean;
|
|
604
|
+
/**
|
|
605
|
+
* Associates the checkbox with a `<form>` element. The value should be the `id` of a `<form>` in the same document. If not set, the checkbox is associated with its parent `<form>`, if any.
|
|
606
|
+
*
|
|
607
|
+
* This attribute allows checkbox elements to be associated with `<form>`s anywhere in the document, not just inside a `<form>`.
|
|
608
|
+
* @see https://www.mdui.org/en/docs/2/components/checkbox#attributes-form
|
|
609
|
+
*/
|
|
610
|
+
'form'?: string;
|
|
611
|
+
/**
|
|
612
|
+
* Sets the checkbox's name, which is submitted with form data.
|
|
613
|
+
* @see https://www.mdui.org/en/docs/2/components/checkbox#attributes-name
|
|
614
|
+
*/
|
|
615
|
+
'name'?: string;
|
|
616
|
+
/**
|
|
617
|
+
* Sets the checkbox's value, which is submitted with form data.
|
|
618
|
+
* @see https://www.mdui.org/en/docs/2/components/checkbox#attributes-value
|
|
619
|
+
*/
|
|
620
|
+
'value'?: string;
|
|
621
|
+
/**
|
|
622
|
+
* Sets the Material Icons name for the unchecked state. Alternatively, use `slot="unchecked-icon"`.
|
|
623
|
+
* @see https://www.mdui.org/en/docs/2/components/checkbox#attributes-unchecked-icon
|
|
624
|
+
*/
|
|
625
|
+
'unchecked-icon'?: string;
|
|
626
|
+
/**
|
|
627
|
+
* Sets the Material Icons name for the checked state. Alternatively, use `slot="checked-icon"`.
|
|
628
|
+
* @see https://www.mdui.org/en/docs/2/components/checkbox#attributes-checked-icon
|
|
629
|
+
*/
|
|
630
|
+
'checked-icon'?: string;
|
|
631
|
+
/**
|
|
632
|
+
* Sets the Material Icons name for the indeterminate state. Alternatively, use `slot="indeterminate-icon"`.
|
|
633
|
+
* @see https://www.mdui.org/en/docs/2/components/checkbox#attributes-indeterminate-icon
|
|
634
|
+
*/
|
|
635
|
+
'indeterminate-icon'?: string;
|
|
636
|
+
/**
|
|
637
|
+
* Determines if the element should be focused when the page loads.
|
|
638
|
+
* @see https://www.mdui.org/en/docs/2/components/checkbox#attributes-autofocus
|
|
639
|
+
*/
|
|
640
|
+
'autofocus'?: boolean;
|
|
641
|
+
/**
|
|
642
|
+
* Specifies the order in which the element receives focus when navigating with the Tab key.
|
|
643
|
+
* @see https://www.mdui.org/en/docs/2/components/checkbox#attributes-tabindex
|
|
644
|
+
*/
|
|
645
|
+
'tabindex'?: number;
|
|
646
|
+
} & HTMLElementProps;
|
|
647
|
+
/**
|
|
648
|
+
* Chip Component
|
|
649
|
+
*
|
|
650
|
+
* ```html
|
|
651
|
+
* <mdui-chip>Chip</mdui-chip>
|
|
652
|
+
* ```
|
|
653
|
+
* @see https://www.mdui.org/en/docs/2/components/chip
|
|
654
|
+
*/
|
|
655
|
+
'mdui-chip': {
|
|
656
|
+
/**
|
|
657
|
+
* Defines the chip type. Possible values:
|
|
658
|
+
*
|
|
659
|
+
* * `assist`: Displays auxiliary actions related to the context, such as sharing and favoriting on a meal ordering page.
|
|
660
|
+
* * `filter`: Filters content, like search results on a search results page.
|
|
661
|
+
* * `input`: Represents fragments of user input, such as contacts in the 'To' field in Gmail.
|
|
662
|
+
* * `suggestion`: Provides dynamically generated suggestions to simplify user actions, like message predictions in a chat application.
|
|
663
|
+
* @see https://www.mdui.org/en/docs/2/components/chip#attributes-variant
|
|
664
|
+
*/
|
|
665
|
+
'variant'?: 'assist' | 'filter' | 'input' | 'suggestion';
|
|
666
|
+
/**
|
|
667
|
+
* Gives the chip a shadow.
|
|
668
|
+
* @see https://www.mdui.org/en/docs/2/components/chip#attributes-elevated
|
|
669
|
+
*/
|
|
670
|
+
'elevated'?: boolean;
|
|
671
|
+
/**
|
|
672
|
+
* Makes the chip selectable.
|
|
673
|
+
* @see https://www.mdui.org/en/docs/2/components/chip#attributes-selectable
|
|
674
|
+
*/
|
|
675
|
+
'selectable'?: boolean;
|
|
676
|
+
/**
|
|
677
|
+
* Marks the chip as selected.
|
|
678
|
+
* @see https://www.mdui.org/en/docs/2/components/chip#attributes-selected
|
|
679
|
+
*/
|
|
680
|
+
'selected'?: boolean;
|
|
681
|
+
/**
|
|
682
|
+
* Makes the chip deletable. When set, a delete icon appears on the right.
|
|
683
|
+
* @see https://www.mdui.org/en/docs/2/components/chip#attributes-deletable
|
|
684
|
+
*/
|
|
685
|
+
'deletable'?: boolean;
|
|
686
|
+
/**
|
|
687
|
+
* Sets the Material Icons name for the left icon. Alternatively, use `slot="icon"`.
|
|
688
|
+
* @see https://www.mdui.org/en/docs/2/components/chip#attributes-icon
|
|
689
|
+
*/
|
|
690
|
+
'icon'?: string;
|
|
691
|
+
/**
|
|
692
|
+
* Sets the Material Icons name for the left icon when selected. Alternatively, use `slot="selected-icon"`.
|
|
693
|
+
* @see https://www.mdui.org/en/docs/2/components/chip#attributes-selected-icon
|
|
694
|
+
*/
|
|
695
|
+
'selected-icon'?: string;
|
|
696
|
+
/**
|
|
697
|
+
* Sets the Material Icons name for the right icon. Alternatively, use `slot="end-icon"`.
|
|
698
|
+
* @see https://www.mdui.org/en/docs/2/components/chip#attributes-end-icon
|
|
699
|
+
*/
|
|
700
|
+
'end-icon'?: string;
|
|
701
|
+
/**
|
|
702
|
+
* Sets the Material Icons name for the delete icon when deletable. Alternatively, use `slot="delete-icon"`.
|
|
703
|
+
* @see https://www.mdui.org/en/docs/2/components/chip#attributes-delete-icon
|
|
704
|
+
*/
|
|
705
|
+
'delete-icon'?: string;
|
|
706
|
+
/**
|
|
707
|
+
* The URL for the hyperlink. If provided, the component is rendered as an `<a>` element and can use link-related attributes.
|
|
708
|
+
* @see https://www.mdui.org/en/docs/2/components/chip#attributes-href
|
|
709
|
+
*/
|
|
710
|
+
'href'?: string;
|
|
711
|
+
/**
|
|
712
|
+
* Instructs the browser to download the linked URL.
|
|
713
|
+
*
|
|
714
|
+
* **Note**: This is only available when `href` is specified.
|
|
715
|
+
* @see https://www.mdui.org/en/docs/2/components/chip#attributes-download
|
|
716
|
+
*/
|
|
717
|
+
'download'?: string;
|
|
718
|
+
/**
|
|
719
|
+
* Defines where to open the linked URL. Possible values:
|
|
720
|
+
*
|
|
721
|
+
* * `_blank`: Opens in a new tab or window.
|
|
722
|
+
* * `_parent`: Opens in the parent browsing context or `_self` if no parent.
|
|
723
|
+
* * `_self`: Opens in the current browsing context. (Default).
|
|
724
|
+
* * `_top`: Opens in the topmost browsing context or `_self` if no ancestors.
|
|
725
|
+
*
|
|
726
|
+
* **Note**: This is only available when `href` is specified.
|
|
727
|
+
* @see https://www.mdui.org/en/docs/2/components/chip#attributes-target
|
|
728
|
+
*/
|
|
729
|
+
'target'?: '_blank' | '_parent' | '_self' | '_top';
|
|
730
|
+
/**
|
|
731
|
+
* Specifies the relationship of the linked URL as space-separated link types. Possible values:
|
|
732
|
+
*
|
|
733
|
+
* * `alternate`: Alternate versions of the current document.
|
|
734
|
+
* * `author`: The author of the current document or article.
|
|
735
|
+
* * `bookmark`: The permalink for the nearest ancestor section.
|
|
736
|
+
* * `external`: The referenced document is not part of the same site as the current document.
|
|
737
|
+
* * `help`: A link to context-sensitive help.
|
|
738
|
+
* * `license`: Indicates that the main content of the current document is covered by the copyright license described by the referenced document.
|
|
739
|
+
* * `me`: Indicates that the current document represents the person who owns the linked content.
|
|
740
|
+
* * `next`: Indicates that the current document is part of a series and the next document in the series is the referenced document.
|
|
741
|
+
* * `nofollow`: Indicates that the current document's original author or publisher does not endorse the referenced document.
|
|
742
|
+
* * `noreferrer`: No `Referer` header will be included. Also has the same effect as `noopener`.
|
|
743
|
+
* * `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).
|
|
744
|
+
* * `prev`: Indicates that the current document is part of a series and the previous document in the series is the referenced document.
|
|
745
|
+
* * `search`: Links to a resource that can be used to search through the current document and its related pages.
|
|
746
|
+
* * `tag`: Gives a tag (identified by the given address) that applies to the current document.
|
|
747
|
+
*
|
|
748
|
+
* **Note**: This is only available when `href` is specified.
|
|
749
|
+
* @see https://www.mdui.org/en/docs/2/components/chip#attributes-rel
|
|
750
|
+
*/
|
|
751
|
+
'rel'?: 'alternate' | 'author' | 'bookmark' | 'external' | 'help' | 'license' | 'me' | 'next' | 'nofollow' | 'noreferrer' | 'opener' | 'prev' | 'search' | 'tag';
|
|
752
|
+
/**
|
|
753
|
+
* Specifies that the element should be focused when the page loads.
|
|
754
|
+
* @see https://www.mdui.org/en/docs/2/components/chip#attributes-autofocus
|
|
755
|
+
*/
|
|
756
|
+
'autofocus'?: boolean;
|
|
757
|
+
/**
|
|
758
|
+
* Defines the order in which the element receives focus when navigating with the Tab key.
|
|
759
|
+
* @see https://www.mdui.org/en/docs/2/components/chip#attributes-tabindex
|
|
760
|
+
*/
|
|
761
|
+
'tabindex'?: number;
|
|
762
|
+
/**
|
|
763
|
+
* Disables the element.
|
|
764
|
+
* @see https://www.mdui.org/en/docs/2/components/chip#attributes-disabled
|
|
765
|
+
*/
|
|
766
|
+
'disabled'?: boolean;
|
|
767
|
+
/**
|
|
768
|
+
* Indicates that the element is in a loading state.
|
|
769
|
+
* @see https://www.mdui.org/en/docs/2/components/chip#attributes-loading
|
|
770
|
+
*/
|
|
771
|
+
'loading'?: boolean;
|
|
772
|
+
/**
|
|
773
|
+
* The button's name, which is submitted with form data.
|
|
774
|
+
*
|
|
775
|
+
* **Note**: This is only available when `href` is not specified.
|
|
776
|
+
* @see https://www.mdui.org/en/docs/2/components/chip#attributes-name
|
|
777
|
+
*/
|
|
778
|
+
'name'?: string;
|
|
779
|
+
/**
|
|
780
|
+
* The button's value, which is submitted with form data.
|
|
781
|
+
*
|
|
782
|
+
* **Note**: This is only available when `href` is not specified.
|
|
783
|
+
* @see https://www.mdui.org/en/docs/2/components/chip#attributes-value
|
|
784
|
+
*/
|
|
785
|
+
'value'?: string;
|
|
786
|
+
/**
|
|
787
|
+
* Defines the button's default behavior. The default is `button`. Possible values:
|
|
788
|
+
*
|
|
789
|
+
* * `submit`: Submits the form data to the server.
|
|
790
|
+
* * `reset`: Resets all the controls to their initial values.
|
|
791
|
+
* * `button`: No default behavior, does nothing when pressed by default.
|
|
792
|
+
*
|
|
793
|
+
* **Note**: This is only available when `href` is not specified.
|
|
794
|
+
* @see https://www.mdui.org/en/docs/2/components/chip#attributes-type
|
|
795
|
+
*/
|
|
796
|
+
'type'?: 'submit' | 'reset' | 'button';
|
|
797
|
+
/**
|
|
798
|
+
* 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.
|
|
799
|
+
*
|
|
800
|
+
* This attribute allows button elements to be associated with `<form>`s anywhere in the document, not just inside a `<form>`.
|
|
801
|
+
*
|
|
802
|
+
* **Note**: Only available when `href` is not specified.
|
|
803
|
+
* @see https://www.mdui.org/en/docs/2/components/chip#attributes-form
|
|
804
|
+
*/
|
|
805
|
+
'form'?: string;
|
|
806
|
+
/**
|
|
807
|
+
* Specifies the URL that processes the button's submitted information. Overrides the `action` attribute of the button's form owner.
|
|
808
|
+
*
|
|
809
|
+
* **Note**: Only available when `href` is not specified and `type="submit"`.
|
|
810
|
+
* @see https://www.mdui.org/en/docs/2/components/chip#attributes-formaction
|
|
811
|
+
*/
|
|
812
|
+
'formaction'?: string;
|
|
813
|
+
/**
|
|
814
|
+
* Specifies the form data encoding method. Possible values:
|
|
815
|
+
*
|
|
816
|
+
* * `application/x-www-form-urlencoded`: Default if the attribute is not used.
|
|
817
|
+
* * `multipart/form-data`: Used for `<input>` elements with `type` set to `file`.
|
|
818
|
+
* * `text/plain`: For debugging, not for real form submission.
|
|
819
|
+
*
|
|
820
|
+
* Overrides the `enctype` attribute of the button's form owner.
|
|
821
|
+
*
|
|
822
|
+
* **Note**: Only available when `href` is not specified and `type="submit"`.
|
|
823
|
+
* @see https://www.mdui.org/en/docs/2/components/chip#attributes-formenctype
|
|
824
|
+
*/
|
|
825
|
+
'formenctype'?: 'application/x-www-form-urlencoded' | 'multipart/form-data' | 'text/plain';
|
|
826
|
+
/**
|
|
827
|
+
* Specifies the HTTP method for form submission. Possible values:
|
|
828
|
+
*
|
|
829
|
+
* * `post`: Form data included in HTTP request body.
|
|
830
|
+
* * `get`: Form data appended to `action` URL.
|
|
831
|
+
*
|
|
832
|
+
* Overrides the `method` attribute of the button's form owner.
|
|
833
|
+
*
|
|
834
|
+
* **Note**: Only available when `href` is not specified and `type="submit"`.
|
|
835
|
+
* @see https://www.mdui.org/en/docs/2/components/chip#attributes-formmethod
|
|
836
|
+
*/
|
|
837
|
+
'formmethod'?: 'post' | 'get';
|
|
838
|
+
/**
|
|
839
|
+
* Specifies that the form should not be validated on submission. Overrides the `novalidate` attribute of the button's form owner.
|
|
840
|
+
*
|
|
841
|
+
* **Note**: Only available when `href` is not specified and `type="submit"`.
|
|
842
|
+
* @see https://www.mdui.org/en/docs/2/components/chip#attributes-formnovalidate
|
|
843
|
+
*/
|
|
844
|
+
'formnovalidate'?: boolean;
|
|
845
|
+
/**
|
|
846
|
+
* Specifies where to display the form submission response. Possible values:
|
|
847
|
+
*
|
|
848
|
+
* * `_self`: Current browsing context. (Default).
|
|
849
|
+
* * `_blank`: New tab or window.
|
|
850
|
+
* * `_parent`: Parent browsing context or `_self` if no parent.
|
|
851
|
+
* * `_top`: Topmost browsing context or `_self` if no ancestors.
|
|
852
|
+
*
|
|
853
|
+
* Overrides the `target` attribute of the button's form owner.
|
|
854
|
+
*
|
|
855
|
+
* **Note**: Only available when `href` is not specified and `type="submit"`.
|
|
856
|
+
* @see https://www.mdui.org/en/docs/2/components/chip#attributes-formtarget
|
|
857
|
+
*/
|
|
858
|
+
'formtarget'?: '_self' | '_blank' | '_parent' | '_top';
|
|
859
|
+
} & HTMLElementProps;
|
|
860
|
+
/**
|
|
861
|
+
* Circular Progress Component
|
|
862
|
+
*
|
|
863
|
+
* ```html
|
|
864
|
+
* <mdui-circular-progress></mdui-circular-progress>
|
|
865
|
+
* ```
|
|
866
|
+
* @see https://www.mdui.org/en/docs/2/components/circular-progress
|
|
867
|
+
*/
|
|
868
|
+
'mdui-circular-progress': {
|
|
869
|
+
/**
|
|
870
|
+
* Sets the maximum value for the progress indicator. The default value is `1`.
|
|
871
|
+
* @see https://www.mdui.org/en/docs/2/components/circular-progress#attributes-max
|
|
872
|
+
*/
|
|
873
|
+
'max'?: number;
|
|
874
|
+
/**
|
|
875
|
+
* Sets the current value of the progress indicator. If not specified, the progress indicator is in an indeterminate state.
|
|
876
|
+
* @see https://www.mdui.org/en/docs/2/components/circular-progress#attributes-value
|
|
877
|
+
*/
|
|
878
|
+
'value'?: number;
|
|
879
|
+
} & HTMLElementProps;
|
|
880
|
+
/**
|
|
881
|
+
* Collapse Panel Component It should be used in conjunction with the `<mdui-collapse-item>` component
|
|
882
|
+
*
|
|
883
|
+
* ```html
|
|
884
|
+
* <mdui-collapse>
|
|
885
|
+
* <mdui-collapse-item header="header-1">content-1</mdui-collapse-item>
|
|
886
|
+
* <mdui-collapse-item header="header-2">content-2</mdui-collapse-item>
|
|
887
|
+
* </mdui-collapse>
|
|
888
|
+
* ```
|
|
889
|
+
* @see https://www.mdui.org/en/docs/2/components/collapse
|
|
890
|
+
*/
|
|
891
|
+
'mdui-collapse': {
|
|
892
|
+
/**
|
|
893
|
+
* Activates accordion mode.
|
|
894
|
+
* @see https://www.mdui.org/en/docs/2/components/collapse#collapse-attributes-accordion
|
|
895
|
+
*/
|
|
896
|
+
'accordion'?: boolean;
|
|
897
|
+
/**
|
|
898
|
+
* Specifies the open `<mdui-collapse-item>` value.
|
|
899
|
+
*
|
|
900
|
+
* Note: The HTML attribute is always a string and can only be initially set when `accordion` is `true`. The JavaScript property value is a string when `accordion` is `true` and a string array when `accordion` is `false`. To modify this value when `accordion` is `false`, you must change the JavaScript property.
|
|
901
|
+
* @see https://www.mdui.org/en/docs/2/components/collapse#collapse-attributes-value
|
|
902
|
+
*/
|
|
903
|
+
'value'?: string | string[];
|
|
904
|
+
/**
|
|
905
|
+
* Disables the collapsible panel.
|
|
906
|
+
* @see https://www.mdui.org/en/docs/2/components/collapse#collapse-attributes-disabled
|
|
907
|
+
*/
|
|
908
|
+
'disabled'?: boolean;
|
|
909
|
+
} & HTMLElementProps;
|
|
910
|
+
/**
|
|
911
|
+
* Collapse Item Component It should be used in conjunction with the `<mdui-collapse>` component
|
|
912
|
+
*
|
|
913
|
+
* ```html
|
|
914
|
+
* <mdui-collapse>
|
|
915
|
+
* <mdui-collapse-item header="header-1">content-1</mdui-collapse-item>
|
|
916
|
+
* <mdui-collapse-item header="header-2">content-2</mdui-collapse-item>
|
|
917
|
+
* </mdui-collapse>
|
|
918
|
+
* ```
|
|
919
|
+
* @see https://www.mdui.org/en/docs/2/components/collapse
|
|
920
|
+
*/
|
|
921
|
+
'mdui-collapse-item': {
|
|
922
|
+
/**
|
|
923
|
+
* Specifies the value of the collapsible panel item.
|
|
924
|
+
* @see https://www.mdui.org/en/docs/2/components/collapse#collapse-item-attributes-value
|
|
925
|
+
*/
|
|
926
|
+
'value'?: string;
|
|
927
|
+
/**
|
|
928
|
+
* Sets the header text for the collapsible panel item.
|
|
929
|
+
* @see https://www.mdui.org/en/docs/2/components/collapse#collapse-item-attributes-header
|
|
930
|
+
*/
|
|
931
|
+
'header'?: string;
|
|
932
|
+
/**
|
|
933
|
+
* Disables the collapsible panel item.
|
|
934
|
+
* @see https://www.mdui.org/en/docs/2/components/collapse#collapse-item-attributes-disabled
|
|
935
|
+
*/
|
|
936
|
+
'disabled'?: boolean;
|
|
937
|
+
/**
|
|
938
|
+
* Identifies the element that triggers the collapse on click. This can be a CSS selector, a DOM element, or a [JQ object](https://www.mdui.org/en/docs/2/functions/jq). By default, the entire header area is the trigger.
|
|
939
|
+
* @see https://www.mdui.org/en/docs/2/components/collapse#collapse-item-attributes-trigger
|
|
940
|
+
*/
|
|
941
|
+
'trigger'?: string | HTMLElement | JQ<HTMLElement>;
|
|
942
|
+
} & HTMLElementProps;
|
|
943
|
+
/**
|
|
944
|
+
* Dialog Component
|
|
945
|
+
*
|
|
946
|
+
* ```html
|
|
947
|
+
* <mdui-dialog>content</mdui-dialog>
|
|
948
|
+
* ```
|
|
949
|
+
* @see https://www.mdui.org/en/docs/2/components/dialog
|
|
950
|
+
*/
|
|
951
|
+
'mdui-dialog': {
|
|
952
|
+
/**
|
|
953
|
+
* Sets the Material Icons name for the top icon. Alternatively, use `slot="icon"`.
|
|
954
|
+
* @see https://www.mdui.org/en/docs/2/components/dialog#attributes-icon
|
|
955
|
+
*/
|
|
956
|
+
'icon'?: string;
|
|
957
|
+
/**
|
|
958
|
+
* Sets the dialog title. Alternatively, use `slot="headline"`.
|
|
959
|
+
* @see https://www.mdui.org/en/docs/2/components/dialog#attributes-headline
|
|
960
|
+
*/
|
|
961
|
+
'headline'?: string;
|
|
962
|
+
/**
|
|
963
|
+
* Sets the text below the title. Alternatively, use `slot="description"`.
|
|
964
|
+
* @see https://www.mdui.org/en/docs/2/components/dialog#attributes-description
|
|
965
|
+
*/
|
|
966
|
+
'description'?: string;
|
|
967
|
+
/**
|
|
968
|
+
* Opens the dialog.
|
|
969
|
+
* @see https://www.mdui.org/en/docs/2/components/dialog#attributes-open
|
|
970
|
+
*/
|
|
971
|
+
'open'?: boolean;
|
|
972
|
+
/**
|
|
973
|
+
* Sets the dialog to full-screen.
|
|
974
|
+
* @see https://www.mdui.org/en/docs/2/components/dialog#attributes-fullscreen
|
|
975
|
+
*/
|
|
976
|
+
'fullscreen'?: boolean;
|
|
977
|
+
/**
|
|
978
|
+
* Closes the dialog when the ESC key is pressed.
|
|
979
|
+
* @see https://www.mdui.org/en/docs/2/components/dialog#attributes-close-on-esc
|
|
980
|
+
*/
|
|
981
|
+
'close-on-esc'?: boolean;
|
|
982
|
+
/**
|
|
983
|
+
* Closes the dialog when the overlay is clicked.
|
|
984
|
+
* @see https://www.mdui.org/en/docs/2/components/dialog#attributes-close-on-overlay-click
|
|
985
|
+
*/
|
|
986
|
+
'close-on-overlay-click'?: boolean;
|
|
987
|
+
/**
|
|
988
|
+
* Stacks the bottom action buttons vertically.
|
|
989
|
+
* @see https://www.mdui.org/en/docs/2/components/dialog#attributes-stacked-actions
|
|
990
|
+
*/
|
|
991
|
+
'stacked-actions'?: boolean;
|
|
992
|
+
} & HTMLElementProps;
|
|
993
|
+
/**
|
|
994
|
+
* Divider Component
|
|
995
|
+
*
|
|
996
|
+
* ```html
|
|
997
|
+
* <mdui-divider></mdui-divider>
|
|
998
|
+
* ```
|
|
999
|
+
* @see https://www.mdui.org/en/docs/2/components/divider
|
|
1000
|
+
*/
|
|
1001
|
+
'mdui-divider': {
|
|
1002
|
+
/**
|
|
1003
|
+
* Displays the divider vertically.
|
|
1004
|
+
* @see https://www.mdui.org/en/docs/2/components/divider#attributes-vertical
|
|
1005
|
+
*/
|
|
1006
|
+
'vertical'?: boolean;
|
|
1007
|
+
/**
|
|
1008
|
+
* Adds an inset from the left side.
|
|
1009
|
+
* @see https://www.mdui.org/en/docs/2/components/divider#attributes-inset
|
|
1010
|
+
*/
|
|
1011
|
+
'inset'?: boolean;
|
|
1012
|
+
/**
|
|
1013
|
+
* Adds insets from both the left and right sides.
|
|
1014
|
+
* @see https://www.mdui.org/en/docs/2/components/divider#attributes-middle
|
|
1015
|
+
*/
|
|
1016
|
+
'middle'?: boolean;
|
|
1017
|
+
} & HTMLElementProps;
|
|
1018
|
+
/**
|
|
1019
|
+
* Dropdown Component
|
|
1020
|
+
*
|
|
1021
|
+
* ```html
|
|
1022
|
+
* <mdui-dropdown>
|
|
1023
|
+
* <mdui-button slot="trigger">open dropdown</mdui-button>
|
|
1024
|
+
* <mdui-menu>
|
|
1025
|
+
* <mdui-menu-item>Item 1</mdui-menu-item>
|
|
1026
|
+
* <mdui-menu-item>Item 2</mdui-menu-item>
|
|
1027
|
+
* </mdui-menu>
|
|
1028
|
+
* </mdui-dropdown>
|
|
1029
|
+
* ```
|
|
1030
|
+
* @see https://www.mdui.org/en/docs/2/components/dropdown
|
|
1031
|
+
*/
|
|
1032
|
+
'mdui-dropdown': {
|
|
1033
|
+
/**
|
|
1034
|
+
* Opens the dropdown.
|
|
1035
|
+
* @see https://www.mdui.org/en/docs/2/components/dropdown#attributes-open
|
|
1036
|
+
*/
|
|
1037
|
+
'open'?: boolean;
|
|
1038
|
+
/**
|
|
1039
|
+
* Disables the dropdown.
|
|
1040
|
+
* @see https://www.mdui.org/en/docs/2/components/dropdown#attributes-disabled
|
|
1041
|
+
*/
|
|
1042
|
+
'disabled'?: boolean;
|
|
1043
|
+
/**
|
|
1044
|
+
* Defines the trigger method for the dropdown. Supports multiple space-separated values. Possible values:
|
|
1045
|
+
*
|
|
1046
|
+
* * `click`: Trigger on click.
|
|
1047
|
+
* * `hover`: Trigger on mouse hover.
|
|
1048
|
+
* * `focus`: Trigger on focus.
|
|
1049
|
+
* * `contextmenu`: Trigger on right-click or touch long press.
|
|
1050
|
+
* * `manual`: If used, the dropdown can only be opened and closed programmatically, and no other trigger methods can be specified.
|
|
1051
|
+
* @see https://www.mdui.org/en/docs/2/components/dropdown#attributes-trigger
|
|
1052
|
+
*/
|
|
1053
|
+
'trigger'?: 'click' | 'hover' | 'focus' | 'contextmenu' | 'manual' | string;
|
|
1054
|
+
/**
|
|
1055
|
+
* Sets the position of the dropdown. Possible values:
|
|
1056
|
+
*
|
|
1057
|
+
* * `auto`: Automatically determine the position.
|
|
1058
|
+
* * `top-start`: Above and left-aligned.
|
|
1059
|
+
* * `top`: Above and centered.
|
|
1060
|
+
* * `top-end`: Above and right-aligned.
|
|
1061
|
+
* * `bottom-start`: Below and left-aligned.
|
|
1062
|
+
* * `bottom`: Below and centered.
|
|
1063
|
+
* * `bottom-end`: Below and right-aligned.
|
|
1064
|
+
* * `left-start`: Left and top-aligned.
|
|
1065
|
+
* * `left`: Left and centered.
|
|
1066
|
+
* * `left-end`: Left and bottom-aligned.
|
|
1067
|
+
* * `right-start`: Right and top-aligned.
|
|
1068
|
+
* * `right`: Right and centered.
|
|
1069
|
+
* * `right-end`: Right and bottom-aligned.
|
|
1070
|
+
* @see https://www.mdui.org/en/docs/2/components/dropdown#attributes-placement
|
|
1071
|
+
*/
|
|
1072
|
+
'placement'?: 'auto' | 'top-start' | 'top' | 'top-end' | 'bottom-start' | 'bottom' | 'bottom-end' | 'left-start' | 'left' | 'left-end' | 'right-start' | 'right' | 'right-end';
|
|
1073
|
+
/**
|
|
1074
|
+
* Keeps the dropdown open after clicking an [`<mdui-menu-item>`](https://www.mdui.org/en/docs/2/components/menu#menu-item-api).
|
|
1075
|
+
* @see https://www.mdui.org/en/docs/2/components/dropdown#attributes-stay-open-on-click
|
|
1076
|
+
*/
|
|
1077
|
+
'stay-open-on-click'?: boolean;
|
|
1078
|
+
/**
|
|
1079
|
+
* Sets the delay (in ms) for opening the dropdown on hover.
|
|
1080
|
+
* @see https://www.mdui.org/en/docs/2/components/dropdown#attributes-open-delay
|
|
1081
|
+
*/
|
|
1082
|
+
'open-delay'?: number;
|
|
1083
|
+
/**
|
|
1084
|
+
* Sets the delay (in ms) for closing the dropdown on hover.
|
|
1085
|
+
* @see https://www.mdui.org/en/docs/2/components/dropdown#attributes-close-delay
|
|
1086
|
+
*/
|
|
1087
|
+
'close-delay'?: number;
|
|
1088
|
+
/**
|
|
1089
|
+
* Opens the dropdown at the cursor position. This is typically used for context menus.
|
|
1090
|
+
* @see https://www.mdui.org/en/docs/2/components/dropdown#attributes-open-on-pointer
|
|
1091
|
+
*/
|
|
1092
|
+
'open-on-pointer'?: boolean;
|
|
1093
|
+
} & HTMLElementProps;
|
|
1094
|
+
/**
|
|
1095
|
+
* Floating Action Button Component
|
|
1096
|
+
*
|
|
1097
|
+
* ```html
|
|
1098
|
+
* <mdui-fab icon="edit"></mdui-fab>
|
|
1099
|
+
* ```
|
|
1100
|
+
* @see https://www.mdui.org/en/docs/2/components/fab
|
|
1101
|
+
*/
|
|
1102
|
+
'mdui-fab': {
|
|
1103
|
+
/**
|
|
1104
|
+
* Sets the FAB color. Possible values:
|
|
1105
|
+
*
|
|
1106
|
+
* * `primary`: Uses the primary container background color.
|
|
1107
|
+
* * `surface`: Uses the surface container high background color.
|
|
1108
|
+
* * `secondary`: Uses the secondary container background color.
|
|
1109
|
+
* * `tertiary`: Uses the tertiary container background color.
|
|
1110
|
+
* @see https://www.mdui.org/en/docs/2/components/fab#attributes-variant
|
|
1111
|
+
*/
|
|
1112
|
+
'variant'?: 'primary' | 'surface' | 'secondary' | 'tertiary';
|
|
1113
|
+
/**
|
|
1114
|
+
* Sets the FAB size. Possible values:
|
|
1115
|
+
* * `normal`: Sets the FAB to a normal size.
|
|
1116
|
+
* * `small`: Sets the FAB to a small size.
|
|
1117
|
+
* * `large`: Sets the FAB to a large size.
|
|
1118
|
+
* @see https://www.mdui.org/en/docs/2/components/fab#attributes-size
|
|
1119
|
+
*/
|
|
1120
|
+
'size'?: 'normal' | 'small' | 'large';
|
|
1121
|
+
/**
|
|
1122
|
+
* Sets the Material Icons name. Alternatively, use `slot="icon"`.
|
|
1123
|
+
* @see https://www.mdui.org/en/docs/2/components/fab#attributes-icon
|
|
1124
|
+
*/
|
|
1125
|
+
'icon'?: string;
|
|
1126
|
+
/**
|
|
1127
|
+
* Indicates if the FAB is in the extended state.
|
|
1128
|
+
* @see https://www.mdui.org/en/docs/2/components/fab#attributes-extended
|
|
1129
|
+
*/
|
|
1130
|
+
'extended'?: boolean;
|
|
1131
|
+
/**
|
|
1132
|
+
* The URL for the hyperlink. If provided, the component is rendered as an `<a>` element and can use link-related attributes.
|
|
1133
|
+
* @see https://www.mdui.org/en/docs/2/components/fab#attributes-href
|
|
1134
|
+
*/
|
|
1135
|
+
'href'?: string;
|
|
1136
|
+
/**
|
|
1137
|
+
* Instructs the browser to download the linked URL.
|
|
1138
|
+
*
|
|
1139
|
+
* **Note**: This is only available when `href` is specified.
|
|
1140
|
+
* @see https://www.mdui.org/en/docs/2/components/fab#attributes-download
|
|
1141
|
+
*/
|
|
1142
|
+
'download'?: string;
|
|
1143
|
+
/**
|
|
1144
|
+
* Defines where to open the linked URL. Possible values:
|
|
1145
|
+
*
|
|
1146
|
+
* * `_blank`: Opens in a new tab or window.
|
|
1147
|
+
* * `_parent`: Opens in the parent browsing context or `_self` if no parent.
|
|
1148
|
+
* * `_self`: Opens in the current browsing context. (Default).
|
|
1149
|
+
* * `_top`: Opens in the topmost browsing context or `_self` if no ancestors.
|
|
1150
|
+
*
|
|
1151
|
+
* **Note**: This is only available when `href` is specified.
|
|
1152
|
+
* @see https://www.mdui.org/en/docs/2/components/fab#attributes-target
|
|
1153
|
+
*/
|
|
1154
|
+
'target'?: '_blank' | '_parent' | '_self' | '_top';
|
|
1155
|
+
/**
|
|
1156
|
+
* Specifies the relationship of the linked URL as space-separated link types. Possible values:
|
|
1157
|
+
*
|
|
1158
|
+
* * `alternate`: Alternate versions of the current document.
|
|
1159
|
+
* * `author`: The author of the current document or article.
|
|
1160
|
+
* * `bookmark`: The permalink for the nearest ancestor section.
|
|
1161
|
+
* * `external`: The referenced document is not part of the same site as the current document.
|
|
1162
|
+
* * `help`: A link to context-sensitive help.
|
|
1163
|
+
* * `license`: Indicates that the main content of the current document is covered by the copyright license described by the referenced document.
|
|
1164
|
+
* * `me`: Indicates that the current document represents the person who owns the linked content.
|
|
1165
|
+
* * `next`: Indicates that the current document is part of a series and the next document in the series is the referenced document.
|
|
1166
|
+
* * `nofollow`: Indicates that the current document's original author or publisher does not endorse the referenced document.
|
|
1167
|
+
* * `noreferrer`: No `Referer` header will be included. Also has the same effect as `noopener`.
|
|
1168
|
+
* * `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).
|
|
1169
|
+
* * `prev`: Indicates that the current document is part of a series and the previous document in the series is the referenced document.
|
|
1170
|
+
* * `search`: Links to a resource that can be used to search through the current document and its related pages.
|
|
1171
|
+
* * `tag`: Gives a tag (identified by the given address) that applies to the current document.
|
|
1172
|
+
*
|
|
1173
|
+
* **Note**: This is only available when `href` is specified.
|
|
1174
|
+
* @see https://www.mdui.org/en/docs/2/components/fab#attributes-rel
|
|
1175
|
+
*/
|
|
1176
|
+
'rel'?: 'alternate' | 'author' | 'bookmark' | 'external' | 'help' | 'license' | 'me' | 'next' | 'nofollow' | 'noreferrer' | 'opener' | 'prev' | 'search' | 'tag';
|
|
1177
|
+
/**
|
|
1178
|
+
* Specifies that the element should be focused when the page loads.
|
|
1179
|
+
* @see https://www.mdui.org/en/docs/2/components/fab#attributes-autofocus
|
|
1180
|
+
*/
|
|
1181
|
+
'autofocus'?: boolean;
|
|
1182
|
+
/**
|
|
1183
|
+
* Defines the order in which the element receives focus when navigating with the Tab key.
|
|
1184
|
+
* @see https://www.mdui.org/en/docs/2/components/fab#attributes-tabindex
|
|
1185
|
+
*/
|
|
1186
|
+
'tabindex'?: number;
|
|
1187
|
+
/**
|
|
1188
|
+
* Disables the element.
|
|
1189
|
+
* @see https://www.mdui.org/en/docs/2/components/fab#attributes-disabled
|
|
1190
|
+
*/
|
|
1191
|
+
'disabled'?: boolean;
|
|
1192
|
+
/**
|
|
1193
|
+
* Indicates that the element is in a loading state.
|
|
1194
|
+
* @see https://www.mdui.org/en/docs/2/components/fab#attributes-loading
|
|
1195
|
+
*/
|
|
1196
|
+
'loading'?: boolean;
|
|
1197
|
+
/**
|
|
1198
|
+
* The button's name, which is submitted with form data.
|
|
1199
|
+
*
|
|
1200
|
+
* **Note**: This is only available when `href` is not specified.
|
|
1201
|
+
* @see https://www.mdui.org/en/docs/2/components/fab#attributes-name
|
|
1202
|
+
*/
|
|
1203
|
+
'name'?: string;
|
|
1204
|
+
/**
|
|
1205
|
+
* The button's value, which is submitted with form data.
|
|
1206
|
+
*
|
|
1207
|
+
* **Note**: This is only available when `href` is not specified.
|
|
1208
|
+
* @see https://www.mdui.org/en/docs/2/components/fab#attributes-value
|
|
1209
|
+
*/
|
|
1210
|
+
'value'?: string;
|
|
1211
|
+
/**
|
|
1212
|
+
* Defines the button's default behavior. The default is `button`. Possible values:
|
|
1213
|
+
*
|
|
1214
|
+
* * `submit`: Submits the form data to the server.
|
|
1215
|
+
* * `reset`: Resets all the controls to their initial values.
|
|
1216
|
+
* * `button`: No default behavior, does nothing when pressed by default.
|
|
1217
|
+
*
|
|
1218
|
+
* **Note**: This is only available when `href` is not specified.
|
|
1219
|
+
* @see https://www.mdui.org/en/docs/2/components/fab#attributes-type
|
|
1220
|
+
*/
|
|
1221
|
+
'type'?: 'submit' | 'reset' | 'button';
|
|
1222
|
+
/**
|
|
1223
|
+
* 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.
|
|
1224
|
+
*
|
|
1225
|
+
* This attribute allows button elements to be associated with `<form>`s anywhere in the document, not just inside a `<form>`.
|
|
1226
|
+
*
|
|
1227
|
+
* **Note**: Only available when `href` is not specified.
|
|
1228
|
+
* @see https://www.mdui.org/en/docs/2/components/fab#attributes-form
|
|
1229
|
+
*/
|
|
1230
|
+
'form'?: string;
|
|
1231
|
+
/**
|
|
1232
|
+
* Specifies the URL that processes the button's submitted information. Overrides the `action` attribute of the button's form owner.
|
|
1233
|
+
*
|
|
1234
|
+
* **Note**: Only available when `href` is not specified and `type="submit"`.
|
|
1235
|
+
* @see https://www.mdui.org/en/docs/2/components/fab#attributes-formaction
|
|
1236
|
+
*/
|
|
1237
|
+
'formaction'?: string;
|
|
1238
|
+
/**
|
|
1239
|
+
* Specifies the form data encoding method. Possible values:
|
|
1240
|
+
*
|
|
1241
|
+
* * `application/x-www-form-urlencoded`: Default if the attribute is not used.
|
|
1242
|
+
* * `multipart/form-data`: Used for `<input>` elements with `type` set to `file`.
|
|
1243
|
+
* * `text/plain`: For debugging, not for real form submission.
|
|
1244
|
+
*
|
|
1245
|
+
* Overrides the `enctype` attribute of the button's form owner.
|
|
1246
|
+
*
|
|
1247
|
+
* **Note**: Only available when `href` is not specified and `type="submit"`.
|
|
1248
|
+
* @see https://www.mdui.org/en/docs/2/components/fab#attributes-formenctype
|
|
1249
|
+
*/
|
|
1250
|
+
'formenctype'?: 'application/x-www-form-urlencoded' | 'multipart/form-data' | 'text/plain';
|
|
1251
|
+
/**
|
|
1252
|
+
* Specifies the HTTP method for form submission. Possible values:
|
|
1253
|
+
*
|
|
1254
|
+
* * `post`: Form data included in HTTP request body.
|
|
1255
|
+
* * `get`: Form data appended to `action` URL.
|
|
1256
|
+
*
|
|
1257
|
+
* Overrides the `method` attribute of the button's form owner.
|
|
1258
|
+
*
|
|
1259
|
+
* **Note**: Only available when `href` is not specified and `type="submit"`.
|
|
1260
|
+
* @see https://www.mdui.org/en/docs/2/components/fab#attributes-formmethod
|
|
1261
|
+
*/
|
|
1262
|
+
'formmethod'?: 'post' | 'get';
|
|
1263
|
+
/**
|
|
1264
|
+
* Specifies that the form should not be validated on submission. Overrides the `novalidate` attribute of the button's form owner.
|
|
1265
|
+
*
|
|
1266
|
+
* **Note**: Only available when `href` is not specified and `type="submit"`.
|
|
1267
|
+
* @see https://www.mdui.org/en/docs/2/components/fab#attributes-formnovalidate
|
|
1268
|
+
*/
|
|
1269
|
+
'formnovalidate'?: boolean;
|
|
1270
|
+
/**
|
|
1271
|
+
* Specifies where to display the form submission response. Possible values:
|
|
1272
|
+
*
|
|
1273
|
+
* * `_self`: Current browsing context. (Default).
|
|
1274
|
+
* * `_blank`: New tab or window.
|
|
1275
|
+
* * `_parent`: Parent browsing context or `_self` if no parent.
|
|
1276
|
+
* * `_top`: Topmost browsing context or `_self` if no ancestors.
|
|
1277
|
+
*
|
|
1278
|
+
* Overrides the `target` attribute of the button's form owner.
|
|
1279
|
+
*
|
|
1280
|
+
* **Note**: Only available when `href` is not specified and `type="submit"`.
|
|
1281
|
+
* @see https://www.mdui.org/en/docs/2/components/fab#attributes-formtarget
|
|
1282
|
+
*/
|
|
1283
|
+
'formtarget'?: '_self' | '_blank' | '_parent' | '_top';
|
|
1284
|
+
} & HTMLElementProps;
|
|
1285
|
+
/**
|
|
1286
|
+
* Icon Component
|
|
1287
|
+
*
|
|
1288
|
+
* ```html
|
|
1289
|
+
* <mdui-icon name="search"></mdui-icon>
|
|
1290
|
+
* ```
|
|
1291
|
+
* @see https://www.mdui.org/en/docs/2/components/icon
|
|
1292
|
+
*/
|
|
1293
|
+
'mdui-icon': {
|
|
1294
|
+
/**
|
|
1295
|
+
* Specifies the name of the Material Icons.
|
|
1296
|
+
* @see https://www.mdui.org/en/docs/2/components/icon#attributes-name
|
|
1297
|
+
*/
|
|
1298
|
+
'name'?: string;
|
|
1299
|
+
/**
|
|
1300
|
+
* Specifies the path of the SVG icon.
|
|
1301
|
+
* @see https://www.mdui.org/en/docs/2/components/icon#attributes-src
|
|
1302
|
+
*/
|
|
1303
|
+
'src'?: string;
|
|
1304
|
+
} & HTMLElementProps;
|
|
1305
|
+
/**
|
|
1306
|
+
* Layout Component
|
|
1307
|
+
*
|
|
1308
|
+
* ```html
|
|
1309
|
+
* <mdui-layout>
|
|
1310
|
+
* <mdui-layout-item></mdui-layout-item>
|
|
1311
|
+
* <mdui-layout-item></mdui-layout-item>
|
|
1312
|
+
* <mdui-layout-main></mdui-layout-main>
|
|
1313
|
+
* </mdui-layout>
|
|
1314
|
+
* ```
|
|
1315
|
+
* @see https://www.mdui.org/en/docs/2/components/layout
|
|
1316
|
+
*/
|
|
1317
|
+
'mdui-layout': {
|
|
1318
|
+
/**
|
|
1319
|
+
* Sets the layout height to 100%.
|
|
1320
|
+
* @see https://www.mdui.org/en/docs/2/components/layout#layout-attributes-full-height
|
|
1321
|
+
*/
|
|
1322
|
+
'full-height'?: boolean;
|
|
1323
|
+
} & HTMLElementProps;
|
|
1324
|
+
/**
|
|
1325
|
+
* Layout Item Component
|
|
1326
|
+
*
|
|
1327
|
+
* ```html
|
|
1328
|
+
* <mdui-layout>
|
|
1329
|
+
* <mdui-layout-item></mdui-layout-item>
|
|
1330
|
+
* <mdui-layout-item></mdui-layout-item>
|
|
1331
|
+
* <mdui-layout-main></mdui-layout-main>
|
|
1332
|
+
* </mdui-layout>
|
|
1333
|
+
* ```
|
|
1334
|
+
* @see https://www.mdui.org/en/docs/2/components/layout
|
|
1335
|
+
*/
|
|
1336
|
+
'mdui-layout-item': {
|
|
1337
|
+
/**
|
|
1338
|
+
* Determines the component's position. Possible values:
|
|
1339
|
+
*
|
|
1340
|
+
* * `top`: Positions the component at the top.
|
|
1341
|
+
* * `bottom`: Positions the component at the bottom.
|
|
1342
|
+
* * `left`: Positions the component on the left.
|
|
1343
|
+
* * `right`: Positions the component on the right.
|
|
1344
|
+
* @see https://www.mdui.org/en/docs/2/components/layout#layout-item-attributes-placement
|
|
1345
|
+
*/
|
|
1346
|
+
'placement'?: 'top' | 'bottom' | 'left' | 'right';
|
|
1347
|
+
/**
|
|
1348
|
+
* 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`.
|
|
1349
|
+
* @see https://www.mdui.org/en/docs/2/components/layout#layout-item-attributes-order
|
|
1350
|
+
*/
|
|
1351
|
+
'order'?: number;
|
|
1352
|
+
} & HTMLElementProps;
|
|
1353
|
+
/**
|
|
1354
|
+
* Layout Main Component
|
|
1355
|
+
*
|
|
1356
|
+
* ```html
|
|
1357
|
+
* <mdui-layout>
|
|
1358
|
+
* <mdui-layout-item></mdui-layout-item>
|
|
1359
|
+
* <mdui-layout-item></mdui-layout-item>
|
|
1360
|
+
* <mdui-layout-main></mdui-layout-main>
|
|
1361
|
+
* </mdui-layout>
|
|
1362
|
+
* ```
|
|
1363
|
+
* @see https://www.mdui.org/en/docs/2/components/layout
|
|
1364
|
+
*/
|
|
1365
|
+
'mdui-layout-main': {
|
|
1366
|
+
|
|
1367
|
+
} & HTMLElementProps;
|
|
1368
|
+
/**
|
|
1369
|
+
* Linear Progress Component
|
|
1370
|
+
*
|
|
1371
|
+
* ```html
|
|
1372
|
+
* <mdui-linear-progress></mdui-linear-progress>
|
|
1373
|
+
* ```
|
|
1374
|
+
* @see https://www.mdui.org/en/docs/2/components/linear-progress
|
|
1375
|
+
*/
|
|
1376
|
+
'mdui-linear-progress': {
|
|
1377
|
+
/**
|
|
1378
|
+
* Sets the maximum value for the progress indicator. The default value is `1`.
|
|
1379
|
+
* @see https://www.mdui.org/en/docs/2/components/linear-progress#attributes-max
|
|
1380
|
+
*/
|
|
1381
|
+
'max'?: number;
|
|
1382
|
+
/**
|
|
1383
|
+
* Sets the current value of the progress indicator. If not specified, the progress indicator is in an indeterminate state.
|
|
1384
|
+
* @see https://www.mdui.org/en/docs/2/components/linear-progress#attributes-value
|
|
1385
|
+
*/
|
|
1386
|
+
'value'?: number;
|
|
1387
|
+
} & HTMLElementProps;
|
|
1388
|
+
/**
|
|
1389
|
+
* List Component It should be used in conjunction with the `<mdui-list-item>` component
|
|
1390
|
+
*
|
|
1391
|
+
* ```html
|
|
1392
|
+
* <mdui-list>
|
|
1393
|
+
* <mdui-list-subheader>Subheader</mdui-list-subheader>
|
|
1394
|
+
* <mdui-list-item>Item 1</mdui-list-item>
|
|
1395
|
+
* <mdui-list-item>Item 2</mdui-list-item>
|
|
1396
|
+
* </mdui-list>
|
|
1397
|
+
* ```
|
|
1398
|
+
* @see https://www.mdui.org/en/docs/2/components/list
|
|
1399
|
+
*/
|
|
1400
|
+
'mdui-list': {
|
|
1401
|
+
|
|
1402
|
+
} & HTMLElementProps;
|
|
1403
|
+
/**
|
|
1404
|
+
* List Item Component It should be used in conjunction with the `<mdui-list>` component
|
|
1405
|
+
*
|
|
1406
|
+
* ```html
|
|
1407
|
+
* <mdui-list>
|
|
1408
|
+
* <mdui-list-subheader>Subheader</mdui-list-subheader>
|
|
1409
|
+
* <mdui-list-item>Item 1</mdui-list-item>
|
|
1410
|
+
* <mdui-list-item>Item 2</mdui-list-item>
|
|
1411
|
+
* </mdui-list>
|
|
1412
|
+
* ```
|
|
1413
|
+
* @see https://www.mdui.org/en/docs/2/components/list
|
|
1414
|
+
*/
|
|
1415
|
+
'mdui-list-item': {
|
|
1416
|
+
/**
|
|
1417
|
+
* Main text. Alternatively, use the default slot.
|
|
1418
|
+
* @see https://www.mdui.org/en/docs/2/components/list#list-item-attributes-headline
|
|
1419
|
+
*/
|
|
1420
|
+
'headline'?: string;
|
|
1421
|
+
/**
|
|
1422
|
+
* Line limit for main text. Truncates after exceeding. Default is no limit. Possible values:
|
|
1423
|
+
*
|
|
1424
|
+
* * `1`: Single-line text, truncates after exceeding
|
|
1425
|
+
* * `2`: Double-line text, truncates after exceeding.
|
|
1426
|
+
* * `3`: Triple-line text, truncates after exceeding.
|
|
1427
|
+
* @see https://www.mdui.org/en/docs/2/components/list#list-item-attributes-headline-line
|
|
1428
|
+
*/
|
|
1429
|
+
'headline-line'?: 1 | 2 | 3;
|
|
1430
|
+
/**
|
|
1431
|
+
* Subtext. Alternatively, use `slot="description"`.
|
|
1432
|
+
* @see https://www.mdui.org/en/docs/2/components/list#list-item-attributes-description
|
|
1433
|
+
*/
|
|
1434
|
+
'description'?: string;
|
|
1435
|
+
/**
|
|
1436
|
+
* Line limit for subtext. Truncates after exceeding. Default is no limit. Possible values:
|
|
1437
|
+
*
|
|
1438
|
+
* * `1`: Single-line text, truncates after exceeding
|
|
1439
|
+
* * `2`: Double-line text, truncates after exceeding.
|
|
1440
|
+
* * `3`: Triple-line text, truncates after exceeding.
|
|
1441
|
+
* @see https://www.mdui.org/en/docs/2/components/list#list-item-attributes-description-line
|
|
1442
|
+
*/
|
|
1443
|
+
'description-line'?: 1 | 2 | 3;
|
|
1444
|
+
/**
|
|
1445
|
+
* Material Icons name on the left. Alternatively, use `slot="icon"`.
|
|
1446
|
+
* @see https://www.mdui.org/en/docs/2/components/list#list-item-attributes-icon
|
|
1447
|
+
*/
|
|
1448
|
+
'icon'?: string;
|
|
1449
|
+
/**
|
|
1450
|
+
* Material Icons name on the right. Alternatively, use `slot="end-icon"`.
|
|
1451
|
+
* @see https://www.mdui.org/en/docs/2/components/list#list-item-attributes-end-icon
|
|
1452
|
+
*/
|
|
1453
|
+
'end-icon'?: string;
|
|
1454
|
+
/**
|
|
1455
|
+
* Disables the list item. Grays out the item and disables elements like [`<mdui-checkbox>`](https://www.mdui.org/en/docs/2/components/checkbox), [`<mdui-radio>`](https://www.mdui.org/en/docs/2/components/radio), [`<mdui-switch>`](https://www.mdui.org/en/docs/2/components/switch).
|
|
1456
|
+
* @see https://www.mdui.org/en/docs/2/components/list#list-item-attributes-disabled
|
|
1457
|
+
*/
|
|
1458
|
+
'disabled'?: boolean;
|
|
1459
|
+
/**
|
|
1460
|
+
* Activates the list item.
|
|
1461
|
+
* @see https://www.mdui.org/en/docs/2/components/list#list-item-attributes-active
|
|
1462
|
+
*/
|
|
1463
|
+
'active'?: boolean;
|
|
1464
|
+
/**
|
|
1465
|
+
* Makes the list item non-clickable. Elements like [`<mdui-checkbox>`](https://www.mdui.org/en/docs/2/components/checkbox), [`<mdui-radio>`](https://www.mdui.org/en/docs/2/components/radio), [`<mdui-switch>`](https://www.mdui.org/en/docs/2/components/switch) remain interactive.
|
|
1466
|
+
* @see https://www.mdui.org/en/docs/2/components/list#list-item-attributes-nonclickable
|
|
1467
|
+
*/
|
|
1468
|
+
'nonclickable'?: boolean;
|
|
1469
|
+
/**
|
|
1470
|
+
* Applies rounded style to the list item.
|
|
1471
|
+
* @see https://www.mdui.org/en/docs/2/components/list#list-item-attributes-rounded
|
|
1472
|
+
*/
|
|
1473
|
+
'rounded'?: boolean;
|
|
1474
|
+
/**
|
|
1475
|
+
* Vertical alignment of the list item. Possible values:
|
|
1476
|
+
*
|
|
1477
|
+
* * `start`: Top alignment.
|
|
1478
|
+
* * `center`: Center alignment.
|
|
1479
|
+
* * `end`: Bottom alignment.
|
|
1480
|
+
* @see https://www.mdui.org/en/docs/2/components/list#list-item-attributes-alignment
|
|
1481
|
+
*/
|
|
1482
|
+
'alignment'?: 'start' | 'center' | 'end';
|
|
1483
|
+
/**
|
|
1484
|
+
* The URL for the hyperlink. If specified, the component renders as an `<a>` element and can use link-related attributes.
|
|
1485
|
+
* @see https://www.mdui.org/en/docs/2/components/list#list-item-attributes-href
|
|
1486
|
+
*/
|
|
1487
|
+
'href'?: string;
|
|
1488
|
+
/**
|
|
1489
|
+
* Instructs the browser to treat the linked URL as a download.
|
|
1490
|
+
*
|
|
1491
|
+
* **Note**: This is only available when `href` is specified.
|
|
1492
|
+
* @see https://www.mdui.org/en/docs/2/components/list#list-item-attributes-download
|
|
1493
|
+
*/
|
|
1494
|
+
'download'?: string;
|
|
1495
|
+
/**
|
|
1496
|
+
* Defines where to display the linked URL. Possible values:
|
|
1497
|
+
*
|
|
1498
|
+
* * `_blank`: Opens in a new tab or window.
|
|
1499
|
+
* * `_parent`: Opens in the parent browsing context or `_self` if no parent exists.
|
|
1500
|
+
* * `_self`: Opens in the current browsing context. (Default).
|
|
1501
|
+
* * `_top`: Opens in the topmost browsing context or `_self` if no ancestors exist.
|
|
1502
|
+
*
|
|
1503
|
+
* **Note**: This is only available when `href` is specified.
|
|
1504
|
+
* @see https://www.mdui.org/en/docs/2/components/list#list-item-attributes-target
|
|
1505
|
+
*/
|
|
1506
|
+
'target'?: '_blank' | '_parent' | '_self' | '_top';
|
|
1507
|
+
/**
|
|
1508
|
+
* Specifies the relationship of the linked URL as space-separated link types. Possible values:
|
|
1509
|
+
*
|
|
1510
|
+
* * `alternate`: Alternate versions of the current document.
|
|
1511
|
+
* * `author`: Author of the current document or article.
|
|
1512
|
+
* * `bookmark`: Permanent link for the nearest ancestor section.
|
|
1513
|
+
* * `external`: The referenced document is not part of the same site as the current document.
|
|
1514
|
+
* * `help`: Link to context-sensitive help.
|
|
1515
|
+
* * `license`: Indicates that the main content of the current document is covered by the copyright license described by the referenced document.
|
|
1516
|
+
* * `me`: Indicates that the current document represents the person who owns the linked content.
|
|
1517
|
+
* * `next`: Indicates that the current document is part of a series and the next document in the series is the referenced document.
|
|
1518
|
+
* * `nofollow`: Indicates that the current document's original author or publisher does not endorse the referenced document.
|
|
1519
|
+
* * `noreferrer`: No `Referer` header will be included. Also has the same effect as `noopener`.
|
|
1520
|
+
* * `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).
|
|
1521
|
+
* * `prev`: Indicates that the current document is part of a series and the previous document in the series is the referenced document.
|
|
1522
|
+
* * `search`: Links to a resource that can be used to search through the current document and its related pages.
|
|
1523
|
+
* * `tag`: Gives a tag (identified by the given address) that applies to the current document.
|
|
1524
|
+
*
|
|
1525
|
+
* **Note**: This is only available when `href` is specified.
|
|
1526
|
+
* @see https://www.mdui.org/en/docs/2/components/list#list-item-attributes-rel
|
|
1527
|
+
*/
|
|
1528
|
+
'rel'?: 'alternate' | 'author' | 'bookmark' | 'external' | 'help' | 'license' | 'me' | 'next' | 'nofollow' | 'noreferrer' | 'opener' | 'prev' | 'search' | 'tag';
|
|
1529
|
+
/**
|
|
1530
|
+
* Determines if the element should be focused when the page loads.
|
|
1531
|
+
* @see https://www.mdui.org/en/docs/2/components/list#list-item-attributes-autofocus
|
|
1532
|
+
*/
|
|
1533
|
+
'autofocus'?: boolean;
|
|
1534
|
+
/**
|
|
1535
|
+
* Specifies the order in which the element receives focus when navigating with the Tab key.
|
|
1536
|
+
* @see https://www.mdui.org/en/docs/2/components/list#list-item-attributes-tabindex
|
|
1537
|
+
*/
|
|
1538
|
+
'tabindex'?: number;
|
|
1539
|
+
} & HTMLElementProps;
|
|
1540
|
+
/**
|
|
1541
|
+
* List Subheader Component It should be used in conjunction with the `<mdui-list>` component
|
|
1542
|
+
*
|
|
1543
|
+
* ```html
|
|
1544
|
+
* <mdui-list>
|
|
1545
|
+
* <mdui-list-subheader>Subheader</mdui-list-subheader>
|
|
1546
|
+
* <mdui-list-item>Item 1</mdui-list-item>
|
|
1547
|
+
* <mdui-list-item>Item 2</mdui-list-item>
|
|
1548
|
+
* </mdui-list>
|
|
1549
|
+
* ```
|
|
1550
|
+
* @see https://www.mdui.org/en/docs/2/components/list
|
|
1551
|
+
*/
|
|
1552
|
+
'mdui-list-subheader': {
|
|
1553
|
+
|
|
1554
|
+
} & HTMLElementProps;
|
|
1555
|
+
/**
|
|
1556
|
+
* Menu Component It should be used in conjunction with the `<mdui-menu-item>` component
|
|
1557
|
+
*
|
|
1558
|
+
* ```html
|
|
1559
|
+
* <mdui-menu>
|
|
1560
|
+
* <mdui-menu-item>Item 1</mdui-menu-item>
|
|
1561
|
+
* <mdui-menu-item>Item 2</mdui-menu-item>
|
|
1562
|
+
* </mdui-menu>
|
|
1563
|
+
* ```
|
|
1564
|
+
* @see https://www.mdui.org/en/docs/2/components/menu
|
|
1565
|
+
*/
|
|
1566
|
+
'mdui-menu': {
|
|
1567
|
+
/**
|
|
1568
|
+
* Defines the selectable state of menu items. Defaults to non-selectable. Possible values:
|
|
1569
|
+
*
|
|
1570
|
+
* * `single`: Only one item can be selected at a time.
|
|
1571
|
+
* * `multiple`: Multiple items can be selected.
|
|
1572
|
+
* @see https://www.mdui.org/en/docs/2/components/menu#menu-attributes-selects
|
|
1573
|
+
*/
|
|
1574
|
+
'selects'?: 'single' | 'multiple';
|
|
1575
|
+
/**
|
|
1576
|
+
* The value of the selected `<mdui-menu-item>`.
|
|
1577
|
+
*
|
|
1578
|
+
* Note: The HTML attribute is always a string and can only be set as an initial value when `selects="single"`. The JavaScript property value is a string when `selects="single"` and an array of strings when `selects="multiple"`. In `selects="multiple"`, this value can only be modified by changing the JavaScript property.
|
|
1579
|
+
* @see https://www.mdui.org/en/docs/2/components/menu#menu-attributes-value
|
|
1580
|
+
*/
|
|
1581
|
+
'value'?: string | string[];
|
|
1582
|
+
/**
|
|
1583
|
+
* Indicates whether the menu items use a compact layout.
|
|
1584
|
+
* @see https://www.mdui.org/en/docs/2/components/menu#menu-attributes-dense
|
|
1585
|
+
*/
|
|
1586
|
+
'dense'?: boolean;
|
|
1587
|
+
/**
|
|
1588
|
+
* Defines the trigger method for submenus. Supports multiple values separated by spaces. Possible values:
|
|
1589
|
+
*
|
|
1590
|
+
* * `click`: Open submenu when clicking on a menu item.
|
|
1591
|
+
* * `hover`: Open submenu when hovering over a menu item.
|
|
1592
|
+
* * `focus`: Open submenu when focusing on a menu item.
|
|
1593
|
+
* * `manual`: Only programmatically open and close submenus, no other trigger methods can be specified.
|
|
1594
|
+
* @see https://www.mdui.org/en/docs/2/components/menu#menu-attributes-submenu-trigger
|
|
1595
|
+
*/
|
|
1596
|
+
'submenu-trigger'?: 'click' | 'hover' | 'focus' | 'manual' | string;
|
|
1597
|
+
/**
|
|
1598
|
+
* Specifies the delay (in milliseconds) for opening a submenu via hover.
|
|
1599
|
+
* @see https://www.mdui.org/en/docs/2/components/menu#menu-attributes-submenu-open-delay
|
|
1600
|
+
*/
|
|
1601
|
+
'submenu-open-delay'?: number;
|
|
1602
|
+
/**
|
|
1603
|
+
* Specifies the delay (in milliseconds) for closing a submenu via hover.
|
|
1604
|
+
* @see https://www.mdui.org/en/docs/2/components/menu#menu-attributes-submenu-close-delay
|
|
1605
|
+
*/
|
|
1606
|
+
'submenu-close-delay'?: number;
|
|
1607
|
+
} & HTMLElementProps;
|
|
1608
|
+
/**
|
|
1609
|
+
* Menu Item Component
|
|
1610
|
+
*
|
|
1611
|
+
* ```html
|
|
1612
|
+
* <mdui-menu>
|
|
1613
|
+
* <mdui-menu-item>Item 1</mdui-menu-item>
|
|
1614
|
+
* <mdui-menu-item>Item 2</mdui-menu-item>
|
|
1615
|
+
* </mdui-menu>
|
|
1616
|
+
* ```
|
|
1617
|
+
* @see https://www.mdui.org/en/docs/2/components/menu
|
|
1618
|
+
*/
|
|
1619
|
+
'mdui-menu-item': {
|
|
1620
|
+
/**
|
|
1621
|
+
* The value of the menu item.
|
|
1622
|
+
* @see https://www.mdui.org/en/docs/2/components/menu#menu-item-attributes-value
|
|
1623
|
+
*/
|
|
1624
|
+
'value'?: string;
|
|
1625
|
+
/**
|
|
1626
|
+
* Disables the menu item.
|
|
1627
|
+
* @see https://www.mdui.org/en/docs/2/components/menu#menu-item-attributes-disabled
|
|
1628
|
+
*/
|
|
1629
|
+
'disabled'?: boolean;
|
|
1630
|
+
/**
|
|
1631
|
+
* Specifies the Material Icons name for the left icon. Alternatively, use `slot="icon"`. An empty string reserves space for an icon.
|
|
1632
|
+
* @see https://www.mdui.org/en/docs/2/components/menu#menu-item-attributes-icon
|
|
1633
|
+
*/
|
|
1634
|
+
'icon'?: string;
|
|
1635
|
+
/**
|
|
1636
|
+
* Specifies the Material Icons name for the right icon. Alternatively, use `slot="end-icon"`.
|
|
1637
|
+
* @see https://www.mdui.org/en/docs/2/components/menu#menu-item-attributes-end-icon
|
|
1638
|
+
*/
|
|
1639
|
+
'end-icon'?: string;
|
|
1640
|
+
/**
|
|
1641
|
+
* Specifies the right text. Alternatively, use `slot="end-text"`.
|
|
1642
|
+
* @see https://www.mdui.org/en/docs/2/components/menu#menu-item-attributes-end-text
|
|
1643
|
+
*/
|
|
1644
|
+
'end-text'?: string;
|
|
1645
|
+
/**
|
|
1646
|
+
* Specifies the Material Icons name for the selected state. Alternatively, use `slot="selected-icon"`.
|
|
1647
|
+
* @see https://www.mdui.org/en/docs/2/components/menu#menu-item-attributes-selected-icon
|
|
1648
|
+
*/
|
|
1649
|
+
'selected-icon'?: string;
|
|
1650
|
+
/**
|
|
1651
|
+
* Opens the submenu.
|
|
1652
|
+
* @see https://www.mdui.org/en/docs/2/components/menu#menu-item-attributes-submenu-open
|
|
1653
|
+
*/
|
|
1654
|
+
'submenu-open'?: boolean;
|
|
1655
|
+
/**
|
|
1656
|
+
* The URL for the hyperlink. If specified, the component renders as an `<a>` element and can use link-related attributes.
|
|
1657
|
+
* @see https://www.mdui.org/en/docs/2/components/menu#menu-item-attributes-href
|
|
1658
|
+
*/
|
|
1659
|
+
'href'?: string;
|
|
1660
|
+
/**
|
|
1661
|
+
* Instructs the browser to treat the linked URL as a download.
|
|
1662
|
+
*
|
|
1663
|
+
* **Note**: This is only available when `href` is specified.
|
|
1664
|
+
* @see https://www.mdui.org/en/docs/2/components/menu#menu-item-attributes-download
|
|
1665
|
+
*/
|
|
1666
|
+
'download'?: string;
|
|
1667
|
+
/**
|
|
1668
|
+
* Defines where to display the linked URL. Possible values:
|
|
1669
|
+
*
|
|
1670
|
+
* * `_blank`: Opens in a new tab or window.
|
|
1671
|
+
* * `_parent`: Opens in the parent browsing context or `_self` if no parent exists.
|
|
1672
|
+
* * `_self`: Opens in the current browsing context. (Default).
|
|
1673
|
+
* * `_top`: Opens in the topmost browsing context or `_self` if no ancestors exist.
|
|
1674
|
+
*
|
|
1675
|
+
* **Note**: This is only available when `href` is specified.
|
|
1676
|
+
* @see https://www.mdui.org/en/docs/2/components/menu#menu-item-attributes-target
|
|
1677
|
+
*/
|
|
1678
|
+
'target'?: '_blank' | '_parent' | '_self' | '_top';
|
|
1679
|
+
/**
|
|
1680
|
+
* Specifies the relationship of the linked URL as space-separated link types. Possible values:
|
|
1681
|
+
*
|
|
1682
|
+
* * `alternate`: Alternate versions of the current document.
|
|
1683
|
+
* * `author`: Author of the current document or article.
|
|
1684
|
+
* * `bookmark`: Permanent link for the nearest ancestor section.
|
|
1685
|
+
* * `external`: The referenced document is not part of the same site as the current document.
|
|
1686
|
+
* * `help`: Link to context-sensitive help.
|
|
1687
|
+
* * `license`: Indicates that the main content of the current document is covered by the copyright license described by the referenced document.
|
|
1688
|
+
* * `me`: Indicates that the current document represents the person who owns the linked content.
|
|
1689
|
+
* * `next`: Indicates that the current document is part of a series and the next document in the series is the referenced document.
|
|
1690
|
+
* * `nofollow`: Indicates that the current document's original author or publisher does not endorse the referenced document.
|
|
1691
|
+
* * `noreferrer`: No `Referer` header will be included. Also has the same effect as `noopener`.
|
|
1692
|
+
* * `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).
|
|
1693
|
+
* * `prev`: Indicates that the current document is part of a series and the previous document in the series is the referenced document.
|
|
1694
|
+
* * `search`: Links to a resource that can be used to search through the current document and its related pages.
|
|
1695
|
+
* * `tag`: Gives a tag (identified by the given address) that applies to the current document.
|
|
1696
|
+
*
|
|
1697
|
+
* **Note**: This is only available when `href` is specified.
|
|
1698
|
+
* @see https://www.mdui.org/en/docs/2/components/menu#menu-item-attributes-rel
|
|
1699
|
+
*/
|
|
1700
|
+
'rel'?: 'alternate' | 'author' | 'bookmark' | 'external' | 'help' | 'license' | 'me' | 'next' | 'nofollow' | 'noreferrer' | 'opener' | 'prev' | 'search' | 'tag';
|
|
1701
|
+
/**
|
|
1702
|
+
* Determines if the element should be focused when the page loads.
|
|
1703
|
+
* @see https://www.mdui.org/en/docs/2/components/menu#menu-item-attributes-autofocus
|
|
1704
|
+
*/
|
|
1705
|
+
'autofocus'?: boolean;
|
|
1706
|
+
/**
|
|
1707
|
+
* Specifies the order in which the element receives focus when navigating with the Tab key.
|
|
1708
|
+
* @see https://www.mdui.org/en/docs/2/components/menu#menu-item-attributes-tabindex
|
|
1709
|
+
*/
|
|
1710
|
+
'tabindex'?: number;
|
|
1711
|
+
} & HTMLElementProps;
|
|
1712
|
+
/**
|
|
1713
|
+
* Navigation Bar Component It should be used in conjunction with the `<mdui-navigation-bar-item>` component
|
|
1714
|
+
*
|
|
1715
|
+
* ```html
|
|
1716
|
+
* <mdui-navigation-bar>
|
|
1717
|
+
* <mdui-navigation-bar-item icon="place">Item 1</mdui-navigation-bar-item>
|
|
1718
|
+
* <mdui-navigation-bar-item icon="commute">Item 2</mdui-navigation-bar-item>
|
|
1719
|
+
* <mdui-navigation-bar-item icon="people">Item 3</mdui-navigation-bar-item>
|
|
1720
|
+
* </mdui-navigation-bar>
|
|
1721
|
+
* ```
|
|
1722
|
+
* @see https://www.mdui.org/en/docs/2/components/navigation-bar
|
|
1723
|
+
*/
|
|
1724
|
+
'mdui-navigation-bar': {
|
|
1725
|
+
/**
|
|
1726
|
+
* Hides the navigation bar when set.
|
|
1727
|
+
* @see https://www.mdui.org/en/docs/2/components/navigation-bar#navigation-bar-attributes-hide
|
|
1728
|
+
*/
|
|
1729
|
+
'hide'?: boolean;
|
|
1730
|
+
/**
|
|
1731
|
+
* Specifies the visibility of the text. Possible values:
|
|
1732
|
+
*
|
|
1733
|
+
* * `auto`: Visible if there are 3 or fewer options, otherwise only the selected state is visible.
|
|
1734
|
+
* * `selected`: Only visible in the selected state.
|
|
1735
|
+
* * `labeled`: Always visible.
|
|
1736
|
+
* * `unlabeled`: Never visible.
|
|
1737
|
+
* @see https://www.mdui.org/en/docs/2/components/navigation-bar#navigation-bar-attributes-label-visibility
|
|
1738
|
+
*/
|
|
1739
|
+
'label-visibility'?: 'auto' | 'selected' | 'labeled' | 'unlabeled';
|
|
1740
|
+
/**
|
|
1741
|
+
* The value of the selected `<mdui-navigation-bar-item>`.
|
|
1742
|
+
* @see https://www.mdui.org/en/docs/2/components/navigation-bar#navigation-bar-attributes-value
|
|
1743
|
+
*/
|
|
1744
|
+
'value'?: string;
|
|
1745
|
+
/**
|
|
1746
|
+
* Defines the scroll behavior. Possible values:
|
|
1747
|
+
*
|
|
1748
|
+
* * `hide`: Hides when scrolling.
|
|
1749
|
+
* @see https://www.mdui.org/en/docs/2/components/navigation-bar#navigation-bar-attributes-scroll-behavior
|
|
1750
|
+
*/
|
|
1751
|
+
'scroll-behavior'?: 'hide';
|
|
1752
|
+
/**
|
|
1753
|
+
* 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`.
|
|
1754
|
+
* @see https://www.mdui.org/en/docs/2/components/navigation-bar#navigation-bar-attributes-scroll-target
|
|
1755
|
+
*/
|
|
1756
|
+
'scroll-target'?: string | HTMLElement | JQ<HTMLElement>;
|
|
1757
|
+
/**
|
|
1758
|
+
* The scroll distance (in pixels) that triggers the scroll behavior.
|
|
1759
|
+
* @see https://www.mdui.org/en/docs/2/components/navigation-bar#navigation-bar-attributes-scroll-threshold
|
|
1760
|
+
*/
|
|
1761
|
+
'scroll-threshold'?: number;
|
|
1762
|
+
/**
|
|
1763
|
+
* 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`.
|
|
1764
|
+
* @see https://www.mdui.org/en/docs/2/components/navigation-bar#navigation-bar-attributes-order
|
|
1765
|
+
*/
|
|
1766
|
+
'order'?: number;
|
|
1767
|
+
} & HTMLElementProps;
|
|
1768
|
+
/**
|
|
1769
|
+
* Navigation Bar Item Component It should be used in conjunction with the `<mdui-navigation-bar>` component
|
|
1770
|
+
*
|
|
1771
|
+
* ```html
|
|
1772
|
+
* <mdui-navigation-bar>
|
|
1773
|
+
* <mdui-navigation-bar-item icon="place">Item 1</mdui-navigation-bar-item>
|
|
1774
|
+
* <mdui-navigation-bar-item icon="commute">Item 2</mdui-navigation-bar-item>
|
|
1775
|
+
* <mdui-navigation-bar-item icon="people">Item 3</mdui-navigation-bar-item>
|
|
1776
|
+
* </mdui-navigation-bar>
|
|
1777
|
+
* ```
|
|
1778
|
+
* @see https://www.mdui.org/en/docs/2/components/navigation-bar
|
|
1779
|
+
*/
|
|
1780
|
+
'mdui-navigation-bar-item': {
|
|
1781
|
+
/**
|
|
1782
|
+
* Specifies the Material Icons name for the inactive state. Alternatively, use `slot="icon"`.
|
|
1783
|
+
* @see https://www.mdui.org/en/docs/2/components/navigation-bar#navigation-bar-item-attributes-icon
|
|
1784
|
+
*/
|
|
1785
|
+
'icon'?: string;
|
|
1786
|
+
/**
|
|
1787
|
+
* Specifies the Material Icons name for the active state. Alternatively, use `slot="active-icon"`.
|
|
1788
|
+
* @see https://www.mdui.org/en/docs/2/components/navigation-bar#navigation-bar-item-attributes-active-icon
|
|
1789
|
+
*/
|
|
1790
|
+
'active-icon'?: string;
|
|
1791
|
+
/**
|
|
1792
|
+
* The value of the navigation item.
|
|
1793
|
+
* @see https://www.mdui.org/en/docs/2/components/navigation-bar#navigation-bar-item-attributes-value
|
|
1794
|
+
*/
|
|
1795
|
+
'value'?: string;
|
|
1796
|
+
/**
|
|
1797
|
+
* The URL for the hyperlink. If specified, the component renders as an `<a>` element and can use link-related attributes.
|
|
1798
|
+
* @see https://www.mdui.org/en/docs/2/components/navigation-bar#navigation-bar-item-attributes-href
|
|
1799
|
+
*/
|
|
1800
|
+
'href'?: string;
|
|
1801
|
+
/**
|
|
1802
|
+
* Instructs the browser to treat the linked URL as a download.
|
|
1803
|
+
*
|
|
1804
|
+
* **Note**: This is only available when `href` is specified.
|
|
1805
|
+
* @see https://www.mdui.org/en/docs/2/components/navigation-bar#navigation-bar-item-attributes-download
|
|
1806
|
+
*/
|
|
1807
|
+
'download'?: string;
|
|
1808
|
+
/**
|
|
1809
|
+
* Defines where to display the linked URL. Possible values:
|
|
1810
|
+
*
|
|
1811
|
+
* * `_blank`: Opens in a new tab or window.
|
|
1812
|
+
* * `_parent`: Opens in the parent browsing context or `_self` if no parent exists.
|
|
1813
|
+
* * `_self`: Opens in the current browsing context. (Default).
|
|
1814
|
+
* * `_top`: Opens in the topmost browsing context or `_self` if no ancestors exist.
|
|
1815
|
+
*
|
|
1816
|
+
* **Note**: This is only available when `href` is specified.
|
|
1817
|
+
* @see https://www.mdui.org/en/docs/2/components/navigation-bar#navigation-bar-item-attributes-target
|
|
1818
|
+
*/
|
|
1819
|
+
'target'?: '_blank' | '_parent' | '_self' | '_top';
|
|
1820
|
+
/**
|
|
1821
|
+
* Specifies the relationship of the linked URL as space-separated link types. Possible values:
|
|
1822
|
+
*
|
|
1823
|
+
* * `alternate`: Alternate versions of the current document.
|
|
1824
|
+
* * `author`: Author of the current document or article.
|
|
1825
|
+
* * `bookmark`: Permanent link for the nearest ancestor section.
|
|
1826
|
+
* * `external`: The referenced document is not part of the same site as the current document.
|
|
1827
|
+
* * `help`: Link to context-sensitive help.
|
|
1828
|
+
* * `license`: Indicates that the main content of the current document is covered by the copyright license described by the referenced document.
|
|
1829
|
+
* * `me`: Indicates that the current document represents the person who owns the linked content.
|
|
1830
|
+
* * `next`: Indicates that the current document is part of a series and the next document in the series is the referenced document.
|
|
1831
|
+
* * `nofollow`: Indicates that the current document's original author or publisher does not endorse the referenced document.
|
|
1832
|
+
* * `noreferrer`: No `Referer` header will be included. Also has the same effect as `noopener`.
|
|
1833
|
+
* * `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).
|
|
1834
|
+
* * `prev`: Indicates that the current document is part of a series and the previous document in the series is the referenced document.
|
|
1835
|
+
* * `search`: Links to a resource that can be used to search through the current document and its related pages.
|
|
1836
|
+
* * `tag`: Gives a tag (identified by the given address) that applies to the current document.
|
|
1837
|
+
*
|
|
1838
|
+
* **Note**: This is only available when `href` is specified.
|
|
1839
|
+
* @see https://www.mdui.org/en/docs/2/components/navigation-bar#navigation-bar-item-attributes-rel
|
|
1840
|
+
*/
|
|
1841
|
+
'rel'?: 'alternate' | 'author' | 'bookmark' | 'external' | 'help' | 'license' | 'me' | 'next' | 'nofollow' | 'noreferrer' | 'opener' | 'prev' | 'search' | 'tag';
|
|
1842
|
+
/**
|
|
1843
|
+
* Determines if the element should be focused when the page loads.
|
|
1844
|
+
* @see https://www.mdui.org/en/docs/2/components/navigation-bar#navigation-bar-item-attributes-autofocus
|
|
1845
|
+
*/
|
|
1846
|
+
'autofocus'?: boolean;
|
|
1847
|
+
/**
|
|
1848
|
+
* Specifies the order in which the element receives focus when navigating with the Tab key.
|
|
1849
|
+
* @see https://www.mdui.org/en/docs/2/components/navigation-bar#navigation-bar-item-attributes-tabindex
|
|
1850
|
+
*/
|
|
1851
|
+
'tabindex'?: number;
|
|
1852
|
+
} & HTMLElementProps;
|
|
1853
|
+
/**
|
|
1854
|
+
* Navigation Drawer Component
|
|
1855
|
+
*
|
|
1856
|
+
* ```html
|
|
1857
|
+
* <mdui-navigation-drawer>content</mdui-navigation-drawer>
|
|
1858
|
+
* ```
|
|
1859
|
+
* @see https://www.mdui.org/en/docs/2/components/navigation-drawer
|
|
1860
|
+
*/
|
|
1861
|
+
'mdui-navigation-drawer': {
|
|
1862
|
+
/**
|
|
1863
|
+
* Opens the navigation drawer.
|
|
1864
|
+
* @see https://www.mdui.org/en/docs/2/components/navigation-drawer#attributes-open
|
|
1865
|
+
*/
|
|
1866
|
+
'open'?: boolean;
|
|
1867
|
+
/**
|
|
1868
|
+
* Displays an overlay when open.
|
|
1869
|
+
*
|
|
1870
|
+
* On narrow devices (screen width < [`--mdui-breakpoint-md`](https://www.mdui.org/en/docs/2/styles/design-tokens#breakpoint)), the overlay always displays.
|
|
1871
|
+
* @see https://www.mdui.org/en/docs/2/components/navigation-drawer#attributes-modal
|
|
1872
|
+
*/
|
|
1873
|
+
'modal'?: boolean;
|
|
1874
|
+
/**
|
|
1875
|
+
* Closes the drawer when the ESC key is pressed and an overlay is present.
|
|
1876
|
+
* @see https://www.mdui.org/en/docs/2/components/navigation-drawer#attributes-close-on-esc
|
|
1877
|
+
*/
|
|
1878
|
+
'close-on-esc'?: boolean;
|
|
1879
|
+
/**
|
|
1880
|
+
* Closes the drawer when the overlay is clicked.
|
|
1881
|
+
* @see https://www.mdui.org/en/docs/2/components/navigation-drawer#attributes-close-on-overlay-click
|
|
1882
|
+
*/
|
|
1883
|
+
'close-on-overlay-click'?: boolean;
|
|
1884
|
+
/**
|
|
1885
|
+
* Sets the drawer's display position. Possible values:
|
|
1886
|
+
*
|
|
1887
|
+
* * `left`: Display on the left side.
|
|
1888
|
+
* * `right`: Display on the right side.
|
|
1889
|
+
* @see https://www.mdui.org/en/docs/2/components/navigation-drawer#attributes-placement
|
|
1890
|
+
*/
|
|
1891
|
+
'placement'?: 'left' | 'right';
|
|
1892
|
+
/**
|
|
1893
|
+
* By default, the navigation drawer displays relative to the `body` element. When set, it displays relative to its parent element.
|
|
1894
|
+
*
|
|
1895
|
+
* Note: You must add `position: relative; overflow: hidden;` style to the parent element when this attribute is set.
|
|
1896
|
+
* @see https://www.mdui.org/en/docs/2/components/navigation-drawer#attributes-contained
|
|
1897
|
+
*/
|
|
1898
|
+
'contained'?: boolean;
|
|
1899
|
+
/**
|
|
1900
|
+
* 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`.
|
|
1901
|
+
* @see https://www.mdui.org/en/docs/2/components/navigation-drawer#attributes-order
|
|
1902
|
+
*/
|
|
1903
|
+
'order'?: number;
|
|
1904
|
+
} & HTMLElementProps;
|
|
1905
|
+
/**
|
|
1906
|
+
* Navigation Rail Component It should be used in conjunction with the `<mdui-navigation-rail-item>` component
|
|
1907
|
+
*
|
|
1908
|
+
* ```html
|
|
1909
|
+
* <mdui-navigation-rail>
|
|
1910
|
+
* <mdui-navigation-rail-item icon="watch_later">Recent</mdui-navigation-rail-item>
|
|
1911
|
+
* <mdui-navigation-rail-item icon="image">Images</mdui-navigation-rail-item>
|
|
1912
|
+
* <mdui-navigation-rail-item icon="library_music">Library</mdui-navigation-rail-item>
|
|
1913
|
+
* </mdui-navigation-rail>
|
|
1914
|
+
* ```
|
|
1915
|
+
* @see https://www.mdui.org/en/docs/2/components/navigation-rail
|
|
1916
|
+
*/
|
|
1917
|
+
'mdui-navigation-rail': {
|
|
1918
|
+
/**
|
|
1919
|
+
* The value of the selected `<mdui-navigation-rail-item>`.
|
|
1920
|
+
* @see https://www.mdui.org/en/docs/2/components/navigation-rail#navigation-rail-attributes-value
|
|
1921
|
+
*/
|
|
1922
|
+
'value'?: string;
|
|
1923
|
+
/**
|
|
1924
|
+
* Sets the navigation bar's position. Possible values:
|
|
1925
|
+
*
|
|
1926
|
+
* * `left`: Display on the left.
|
|
1927
|
+
* * `right`: Display on the right.
|
|
1928
|
+
* @see https://www.mdui.org/en/docs/2/components/navigation-rail#navigation-rail-attributes-placement
|
|
1929
|
+
*/
|
|
1930
|
+
'placement'?: 'left' | 'right';
|
|
1931
|
+
/**
|
|
1932
|
+
* Sets the alignment of `<mdui-navigation-rail-item>`. Possible values:
|
|
1933
|
+
*
|
|
1934
|
+
* * `start`: Aligns to the top.
|
|
1935
|
+
* * `center`: Aligns to the center.
|
|
1936
|
+
* * `end`: Aligns to the bottom.
|
|
1937
|
+
* @see https://www.mdui.org/en/docs/2/components/navigation-rail#navigation-rail-attributes-alignment
|
|
1938
|
+
*/
|
|
1939
|
+
'alignment'?: 'start' | 'center' | 'end';
|
|
1940
|
+
/**
|
|
1941
|
+
* By default, the navigation rail displays relative to the `body` element. When set, it displays relative to its parent element.
|
|
1942
|
+
*
|
|
1943
|
+
* Note: You must add `position: relative; overflow: hidden;` style to the parent element when this attribute is set.
|
|
1944
|
+
* @see https://www.mdui.org/en/docs/2/components/navigation-rail#navigation-rail-attributes-contained
|
|
1945
|
+
*/
|
|
1946
|
+
'contained'?: boolean;
|
|
1947
|
+
/**
|
|
1948
|
+
* Adds a divider between the navigation bar and the page content.
|
|
1949
|
+
* @see https://www.mdui.org/en/docs/2/components/navigation-rail#navigation-rail-attributes-divider
|
|
1950
|
+
*/
|
|
1951
|
+
'divider'?: boolean;
|
|
1952
|
+
/**
|
|
1953
|
+
* 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`.
|
|
1954
|
+
* @see https://www.mdui.org/en/docs/2/components/navigation-rail#navigation-rail-attributes-order
|
|
1955
|
+
*/
|
|
1956
|
+
'order'?: number;
|
|
1957
|
+
} & HTMLElementProps;
|
|
1958
|
+
/**
|
|
1959
|
+
* Navigation Rail Item Component It should be used in conjunction with the `<mdui-navigation-rail>` component
|
|
1960
|
+
*
|
|
1961
|
+
* ```html
|
|
1962
|
+
* <mdui-navigation-rail>
|
|
1963
|
+
* <mdui-navigation-rail-item icon="watch_later">Recent</mdui-navigation-rail-item>
|
|
1964
|
+
* <mdui-navigation-rail-item icon="image">Images</mdui-navigation-rail-item>
|
|
1965
|
+
* <mdui-navigation-rail-item icon="library_music">Library</mdui-navigation-rail-item>
|
|
1966
|
+
* </mdui-navigation-rail>
|
|
1967
|
+
* ```
|
|
1968
|
+
* @see https://www.mdui.org/en/docs/2/components/navigation-rail
|
|
1969
|
+
*/
|
|
1970
|
+
'mdui-navigation-rail-item': {
|
|
1971
|
+
/**
|
|
1972
|
+
* Specifies the Material Icons name for the inactive state. Alternatively, use `slot="icon"`.
|
|
1973
|
+
* @see https://www.mdui.org/en/docs/2/components/navigation-rail#navigation-rail-item-attributes-icon
|
|
1974
|
+
*/
|
|
1975
|
+
'icon'?: string;
|
|
1976
|
+
/**
|
|
1977
|
+
* Specifies the Material Icons name for the active state. Alternatively, use `slot="active-icon"`.
|
|
1978
|
+
* @see https://www.mdui.org/en/docs/2/components/navigation-rail#navigation-rail-item-attributes-active-icon
|
|
1979
|
+
*/
|
|
1980
|
+
'active-icon'?: string;
|
|
1981
|
+
/**
|
|
1982
|
+
* The value of the navigation item.
|
|
1983
|
+
* @see https://www.mdui.org/en/docs/2/components/navigation-rail#navigation-rail-item-attributes-value
|
|
1984
|
+
*/
|
|
1985
|
+
'value'?: string;
|
|
1986
|
+
/**
|
|
1987
|
+
* The URL for the hyperlink. If specified, the component renders as an `<a>` element and can use link-related attributes.
|
|
1988
|
+
* @see https://www.mdui.org/en/docs/2/components/navigation-rail#navigation-rail-item-attributes-href
|
|
1989
|
+
*/
|
|
1990
|
+
'href'?: string;
|
|
1991
|
+
/**
|
|
1992
|
+
* Instructs the browser to treat the linked URL as a download.
|
|
1993
|
+
*
|
|
1994
|
+
* **Note**: This is only available when `href` is specified.
|
|
1995
|
+
* @see https://www.mdui.org/en/docs/2/components/navigation-rail#navigation-rail-item-attributes-download
|
|
1996
|
+
*/
|
|
1997
|
+
'download'?: string;
|
|
1998
|
+
/**
|
|
1999
|
+
* Defines where to display the linked URL. Possible values:
|
|
2000
|
+
*
|
|
2001
|
+
* * `_blank`: Opens in a new tab or window.
|
|
2002
|
+
* * `_parent`: Opens in the parent browsing context or `_self` if no parent exists.
|
|
2003
|
+
* * `_self`: Opens in the current browsing context. (Default).
|
|
2004
|
+
* * `_top`: Opens in the topmost browsing context or `_self` if no ancestors exist.
|
|
2005
|
+
*
|
|
2006
|
+
* **Note**: This is only available when `href` is specified.
|
|
2007
|
+
* @see https://www.mdui.org/en/docs/2/components/navigation-rail#navigation-rail-item-attributes-target
|
|
2008
|
+
*/
|
|
2009
|
+
'target'?: '_blank' | '_parent' | '_self' | '_top';
|
|
2010
|
+
/**
|
|
2011
|
+
* Specifies the relationship of the linked URL as space-separated link types. Possible values:
|
|
2012
|
+
*
|
|
2013
|
+
* * `alternate`: Alternate versions of the current document.
|
|
2014
|
+
* * `author`: Author of the current document or article.
|
|
2015
|
+
* * `bookmark`: Permanent link for the nearest ancestor section.
|
|
2016
|
+
* * `external`: The referenced document is not part of the same site as the current document.
|
|
2017
|
+
* * `help`: Link to context-sensitive help.
|
|
2018
|
+
* * `license`: Indicates that the main content of the current document is covered by the copyright license described by the referenced document.
|
|
2019
|
+
* * `me`: Indicates that the current document represents the person who owns the linked content.
|
|
2020
|
+
* * `next`: Indicates that the current document is part of a series and the next document in the series is the referenced document.
|
|
2021
|
+
* * `nofollow`: Indicates that the current document's original author or publisher does not endorse the referenced document.
|
|
2022
|
+
* * `noreferrer`: No `Referer` header will be included. Also has the same effect as `noopener`.
|
|
2023
|
+
* * `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).
|
|
2024
|
+
* * `prev`: Indicates that the current document is part of a series and the previous document in the series is the referenced document.
|
|
2025
|
+
* * `search`: Links to a resource that can be used to search through the current document and its related pages.
|
|
2026
|
+
* * `tag`: Gives a tag (identified by the given address) that applies to the current document.
|
|
2027
|
+
*
|
|
2028
|
+
* **Note**: This is only available when `href` is specified.
|
|
2029
|
+
* @see https://www.mdui.org/en/docs/2/components/navigation-rail#navigation-rail-item-attributes-rel
|
|
2030
|
+
*/
|
|
2031
|
+
'rel'?: 'alternate' | 'author' | 'bookmark' | 'external' | 'help' | 'license' | 'me' | 'next' | 'nofollow' | 'noreferrer' | 'opener' | 'prev' | 'search' | 'tag';
|
|
2032
|
+
/**
|
|
2033
|
+
* Determines if the element should be focused when the page loads.
|
|
2034
|
+
* @see https://www.mdui.org/en/docs/2/components/navigation-rail#navigation-rail-item-attributes-autofocus
|
|
2035
|
+
*/
|
|
2036
|
+
'autofocus'?: boolean;
|
|
2037
|
+
/**
|
|
2038
|
+
* Specifies the order in which the element receives focus when navigating with the Tab key.
|
|
2039
|
+
* @see https://www.mdui.org/en/docs/2/components/navigation-rail#navigation-rail-item-attributes-tabindex
|
|
2040
|
+
*/
|
|
2041
|
+
'tabindex'?: number;
|
|
2042
|
+
} & HTMLElementProps;
|
|
2043
|
+
/**
|
|
2044
|
+
* Radio Component It should be used in conjunction with the `<mdui-radio-group>` component
|
|
2045
|
+
*
|
|
2046
|
+
* ```html
|
|
2047
|
+
* <mdui-radio-group value="chinese">
|
|
2048
|
+
* <mdui-radio value="chinese">Chinese</mdui-radio>
|
|
2049
|
+
* <mdui-radio value="english">English</mdui-radio>
|
|
2050
|
+
* </mdui-radio-group>
|
|
2051
|
+
* ```
|
|
2052
|
+
* @see https://www.mdui.org/en/docs/2/components/radio
|
|
2053
|
+
*/
|
|
2054
|
+
'mdui-radio': {
|
|
2055
|
+
/**
|
|
2056
|
+
* Specifies the value of the radio.
|
|
2057
|
+
* @see https://www.mdui.org/en/docs/2/components/radio#radio-attributes-value
|
|
2058
|
+
*/
|
|
2059
|
+
'value'?: string;
|
|
2060
|
+
/**
|
|
2061
|
+
* Disables the radio when set.
|
|
2062
|
+
* @see https://www.mdui.org/en/docs/2/components/radio#radio-attributes-disabled
|
|
2063
|
+
*/
|
|
2064
|
+
'disabled'?: boolean;
|
|
2065
|
+
/**
|
|
2066
|
+
* Sets the radio to the checked state.
|
|
2067
|
+
* @see https://www.mdui.org/en/docs/2/components/radio#radio-attributes-checked
|
|
2068
|
+
*/
|
|
2069
|
+
'checked'?: boolean;
|
|
2070
|
+
/**
|
|
2071
|
+
* Specifies the Material Icons name for the unchecked state. Alternatively, use `slot="unchecked-icon"`.
|
|
2072
|
+
* @see https://www.mdui.org/en/docs/2/components/radio#radio-attributes-unchecked-icon
|
|
2073
|
+
*/
|
|
2074
|
+
'unchecked-icon'?: string;
|
|
2075
|
+
/**
|
|
2076
|
+
* Specifies the Material Icons name for the checked state. Alternatively, use `slot="checked-icon"`.
|
|
2077
|
+
* @see https://www.mdui.org/en/docs/2/components/radio#radio-attributes-checked-icon
|
|
2078
|
+
*/
|
|
2079
|
+
'checked-icon'?: string;
|
|
2080
|
+
/**
|
|
2081
|
+
* Determines if the element should be focused when the page loads.
|
|
2082
|
+
* @see https://www.mdui.org/en/docs/2/components/radio#radio-attributes-autofocus
|
|
2083
|
+
*/
|
|
2084
|
+
'autofocus'?: boolean;
|
|
2085
|
+
/**
|
|
2086
|
+
* Specifies the order in which the element receives focus when navigating with the Tab key.
|
|
2087
|
+
* @see https://www.mdui.org/en/docs/2/components/radio#radio-attributes-tabindex
|
|
2088
|
+
*/
|
|
2089
|
+
'tabindex'?: number;
|
|
2090
|
+
} & HTMLElementProps;
|
|
2091
|
+
/**
|
|
2092
|
+
* Radio Group Component It should be used in conjunction with the `<mdui-radio>` component
|
|
2093
|
+
*
|
|
2094
|
+
* ```html
|
|
2095
|
+
* <mdui-radio-group value="chinese">
|
|
2096
|
+
* <mdui-radio value="chinese">Chinese</mdui-radio>
|
|
2097
|
+
* <mdui-radio value="english">English</mdui-radio>
|
|
2098
|
+
* </mdui-radio-group>
|
|
2099
|
+
* ```
|
|
2100
|
+
* @see https://www.mdui.org/en/docs/2/components/radio
|
|
2101
|
+
*/
|
|
2102
|
+
'mdui-radio-group': {
|
|
2103
|
+
/**
|
|
2104
|
+
* Disables the radio group when set.
|
|
2105
|
+
* @see https://www.mdui.org/en/docs/2/components/radio#radio-group-attributes-disabled
|
|
2106
|
+
*/
|
|
2107
|
+
'disabled'?: boolean;
|
|
2108
|
+
/**
|
|
2109
|
+
* Associates the radio group with a `<form>` element. The value should be the `id` of a `<form>` in the same document. If not set, the radio group is associated with its parent `<form>`, if any.
|
|
2110
|
+
*
|
|
2111
|
+
* This attribute allows radio group elements to be associated with `<form>`s anywhere in the document, not just inside a `<form>`.
|
|
2112
|
+
* @see https://www.mdui.org/en/docs/2/components/radio#radio-group-attributes-form
|
|
2113
|
+
*/
|
|
2114
|
+
'form'?: string;
|
|
2115
|
+
/**
|
|
2116
|
+
* The name of the radio group, which is submitted with form data.
|
|
2117
|
+
* @see https://www.mdui.org/en/docs/2/components/radio#radio-group-attributes-name
|
|
2118
|
+
*/
|
|
2119
|
+
'name'?: string;
|
|
2120
|
+
/**
|
|
2121
|
+
* The value of the selected radio button, which is submitted with form data.
|
|
2122
|
+
* @see https://www.mdui.org/en/docs/2/components/radio#radio-group-attributes-value
|
|
2123
|
+
*/
|
|
2124
|
+
'value'?: string;
|
|
2125
|
+
/**
|
|
2126
|
+
* Requires a radio selection when the form is submitted.
|
|
2127
|
+
* @see https://www.mdui.org/en/docs/2/components/radio#radio-group-attributes-required
|
|
2128
|
+
*/
|
|
2129
|
+
'required'?: boolean;
|
|
2130
|
+
} & HTMLElementProps;
|
|
2131
|
+
/**
|
|
2132
|
+
* Range Slider Component
|
|
2133
|
+
*
|
|
2134
|
+
* ```html
|
|
2135
|
+
* <mdui-range-slider></mdui-range-slider>
|
|
2136
|
+
* ```
|
|
2137
|
+
* @see https://www.mdui.org/en/docs/2/components/range-slider
|
|
2138
|
+
*/
|
|
2139
|
+
'mdui-range-slider': {
|
|
2140
|
+
/**
|
|
2141
|
+
* Determines if the element should be focused when the page loads.
|
|
2142
|
+
* @see https://www.mdui.org/en/docs/2/components/range-slider#attributes-autofocus
|
|
2143
|
+
*/
|
|
2144
|
+
'autofocus'?: boolean;
|
|
2145
|
+
/**
|
|
2146
|
+
* Specifies the order in which the element receives focus when navigating with the Tab key.
|
|
2147
|
+
* @see https://www.mdui.org/en/docs/2/components/range-slider#attributes-tabindex
|
|
2148
|
+
*/
|
|
2149
|
+
'tabindex'?: number;
|
|
2150
|
+
/**
|
|
2151
|
+
* Specifies the minimum value. Default is `0`.
|
|
2152
|
+
* @see https://www.mdui.org/en/docs/2/components/range-slider#attributes-min
|
|
2153
|
+
*/
|
|
2154
|
+
'min'?: number;
|
|
2155
|
+
/**
|
|
2156
|
+
* Specifies the maximum value. Default is `100`.
|
|
2157
|
+
* @see https://www.mdui.org/en/docs/2/components/range-slider#attributes-max
|
|
2158
|
+
*/
|
|
2159
|
+
'max'?: number;
|
|
2160
|
+
/**
|
|
2161
|
+
* Specifies the step interval. Default is `1`.
|
|
2162
|
+
* @see https://www.mdui.org/en/docs/2/components/range-slider#attributes-step
|
|
2163
|
+
*/
|
|
2164
|
+
'step'?: number;
|
|
2165
|
+
/**
|
|
2166
|
+
* Adds tickmarks to the slider.
|
|
2167
|
+
* @see https://www.mdui.org/en/docs/2/components/range-slider#attributes-tickmarks
|
|
2168
|
+
*/
|
|
2169
|
+
'tickmarks'?: boolean;
|
|
2170
|
+
/**
|
|
2171
|
+
* Hides the tooltip.
|
|
2172
|
+
* @see https://www.mdui.org/en/docs/2/components/range-slider#attributes-nolabel
|
|
2173
|
+
*/
|
|
2174
|
+
'nolabel'?: boolean;
|
|
2175
|
+
/**
|
|
2176
|
+
* Disables the slider.
|
|
2177
|
+
* @see https://www.mdui.org/en/docs/2/components/range-slider#attributes-disabled
|
|
2178
|
+
*/
|
|
2179
|
+
'disabled'?: boolean;
|
|
2180
|
+
/**
|
|
2181
|
+
* Associates the slider with a `<form>` element. The value should be the `id` of a `<form>` in the same document. If not set, the slider is associated with its parent `<form>`, if any.
|
|
2182
|
+
*
|
|
2183
|
+
* This attribute allows slider elements to be associated with `<form>`s anywhere in the document, not just inside a `<form>`.
|
|
2184
|
+
* @see https://www.mdui.org/en/docs/2/components/range-slider#attributes-form
|
|
2185
|
+
*/
|
|
2186
|
+
'form'?: string;
|
|
2187
|
+
/**
|
|
2188
|
+
* Specifies the slider's name, which is submitted with the form data.
|
|
2189
|
+
* @see https://www.mdui.org/en/docs/2/components/range-slider#attributes-name
|
|
2190
|
+
*/
|
|
2191
|
+
'name'?: string;
|
|
2192
|
+
} & HTMLElementProps;
|
|
2193
|
+
/**
|
|
2194
|
+
* Segmented Button Component It should be used in conjunction with the `<mdui-segmented-button-group>` component
|
|
2195
|
+
*
|
|
2196
|
+
* ```html
|
|
2197
|
+
* <mdui-segmented-button-group>
|
|
2198
|
+
* <mdui-segmented-button>Day</mdui-segmented-button>
|
|
2199
|
+
* <mdui-segmented-button>Week</mdui-segmented-button>
|
|
2200
|
+
* <mdui-segmented-button>Month</mdui-segmented-button>
|
|
2201
|
+
* </mdui-segmented-button-group>
|
|
2202
|
+
* ```
|
|
2203
|
+
* @see https://www.mdui.org/en/docs/2/components/segmented-button
|
|
2204
|
+
*/
|
|
2205
|
+
'mdui-segmented-button': {
|
|
2206
|
+
/**
|
|
2207
|
+
* Specifies the Material Icons name for the left icon. Alternatively, use `slot="icon"`.
|
|
2208
|
+
* @see https://www.mdui.org/en/docs/2/components/segmented-button#segmented-button-attributes-icon
|
|
2209
|
+
*/
|
|
2210
|
+
'icon'?: string;
|
|
2211
|
+
/**
|
|
2212
|
+
* Specifies the Material Icons name for the right icon. Alternatively, use `slot="end-icon"`.
|
|
2213
|
+
* @see https://www.mdui.org/en/docs/2/components/segmented-button#segmented-button-attributes-end-icon
|
|
2214
|
+
*/
|
|
2215
|
+
'end-icon'?: string;
|
|
2216
|
+
/**
|
|
2217
|
+
* Specifies the Material Icons name for the selected state. Alternatively, use `slot="selected-icon"`.
|
|
2218
|
+
* @see https://www.mdui.org/en/docs/2/components/segmented-button#segmented-button-attributes-selected-icon
|
|
2219
|
+
*/
|
|
2220
|
+
'selected-icon'?: string;
|
|
2221
|
+
/**
|
|
2222
|
+
* The URL for the hyperlink. If provided, the component is rendered as an `<a>` element and can use link-related attributes.
|
|
2223
|
+
* @see https://www.mdui.org/en/docs/2/components/segmented-button#segmented-button-attributes-href
|
|
2224
|
+
*/
|
|
2225
|
+
'href'?: string;
|
|
2226
|
+
/**
|
|
2227
|
+
* Instructs the browser to download the linked URL.
|
|
2228
|
+
*
|
|
2229
|
+
* **Note**: This is only available when `href` is specified.
|
|
2230
|
+
* @see https://www.mdui.org/en/docs/2/components/segmented-button#segmented-button-attributes-download
|
|
2231
|
+
*/
|
|
2232
|
+
'download'?: string;
|
|
2233
|
+
/**
|
|
2234
|
+
* Defines where to open the linked URL. Possible values:
|
|
2235
|
+
*
|
|
2236
|
+
* * `_blank`: Opens in a new tab or window.
|
|
2237
|
+
* * `_parent`: Opens in the parent browsing context or `_self` if no parent.
|
|
2238
|
+
* * `_self`: Opens in the current browsing context. (Default).
|
|
2239
|
+
* * `_top`: Opens in the topmost browsing context or `_self` if no ancestors.
|
|
2240
|
+
*
|
|
2241
|
+
* **Note**: This is only available when `href` is specified.
|
|
2242
|
+
* @see https://www.mdui.org/en/docs/2/components/segmented-button#segmented-button-attributes-target
|
|
2243
|
+
*/
|
|
2244
|
+
'target'?: '_blank' | '_parent' | '_self' | '_top';
|
|
2245
|
+
/**
|
|
2246
|
+
* Specifies the relationship of the linked URL as space-separated link types. Possible values:
|
|
2247
|
+
*
|
|
2248
|
+
* * `alternate`: Alternate versions of the current document.
|
|
2249
|
+
* * `author`: The author of the current document or article.
|
|
2250
|
+
* * `bookmark`: The permalink for the nearest ancestor section.
|
|
2251
|
+
* * `external`: The referenced document is not part of the same site as the current document.
|
|
2252
|
+
* * `help`: A link to context-sensitive help.
|
|
2253
|
+
* * `license`: Indicates that the main content of the current document is covered by the copyright license described by the referenced document.
|
|
2254
|
+
* * `me`: Indicates that the current document represents the person who owns the linked content.
|
|
2255
|
+
* * `next`: Indicates that the current document is part of a series and the next document in the series is the referenced document.
|
|
2256
|
+
* * `nofollow`: Indicates that the current document's original author or publisher does not endorse the referenced document.
|
|
2257
|
+
* * `noreferrer`: No `Referer` header will be included. Also has the same effect as `noopener`.
|
|
2258
|
+
* * `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).
|
|
2259
|
+
* * `prev`: Indicates that the current document is part of a series and the previous document in the series is the referenced document.
|
|
2260
|
+
* * `search`: Links to a resource that can be used to search through the current document and its related pages.
|
|
2261
|
+
* * `tag`: Gives a tag (identified by the given address) that applies to the current document.
|
|
2262
|
+
*
|
|
2263
|
+
* **Note**: This is only available when `href` is specified.
|
|
2264
|
+
* @see https://www.mdui.org/en/docs/2/components/segmented-button#segmented-button-attributes-rel
|
|
2265
|
+
*/
|
|
2266
|
+
'rel'?: 'alternate' | 'author' | 'bookmark' | 'external' | 'help' | 'license' | 'me' | 'next' | 'nofollow' | 'noreferrer' | 'opener' | 'prev' | 'search' | 'tag';
|
|
2267
|
+
/**
|
|
2268
|
+
* Specifies that the element should be focused when the page loads.
|
|
2269
|
+
* @see https://www.mdui.org/en/docs/2/components/segmented-button#segmented-button-attributes-autofocus
|
|
2270
|
+
*/
|
|
2271
|
+
'autofocus'?: boolean;
|
|
2272
|
+
/**
|
|
2273
|
+
* Defines the order in which the element receives focus when navigating with the Tab key.
|
|
2274
|
+
* @see https://www.mdui.org/en/docs/2/components/segmented-button#segmented-button-attributes-tabindex
|
|
2275
|
+
*/
|
|
2276
|
+
'tabindex'?: number;
|
|
2277
|
+
/**
|
|
2278
|
+
* Disables the element.
|
|
2279
|
+
* @see https://www.mdui.org/en/docs/2/components/segmented-button#segmented-button-attributes-disabled
|
|
2280
|
+
*/
|
|
2281
|
+
'disabled'?: boolean;
|
|
2282
|
+
/**
|
|
2283
|
+
* Indicates that the element is in a loading state.
|
|
2284
|
+
* @see https://www.mdui.org/en/docs/2/components/segmented-button#segmented-button-attributes-loading
|
|
2285
|
+
*/
|
|
2286
|
+
'loading'?: boolean;
|
|
2287
|
+
/**
|
|
2288
|
+
* The button's name, which is submitted with form data.
|
|
2289
|
+
*
|
|
2290
|
+
* **Note**: This is only available when `href` is not specified.
|
|
2291
|
+
* @see https://www.mdui.org/en/docs/2/components/segmented-button#segmented-button-attributes-name
|
|
2292
|
+
*/
|
|
2293
|
+
'name'?: string;
|
|
2294
|
+
/**
|
|
2295
|
+
* The button's value, which is submitted with form data.
|
|
2296
|
+
*
|
|
2297
|
+
* **Note**: This is only available when `href` is not specified.
|
|
2298
|
+
* @see https://www.mdui.org/en/docs/2/components/segmented-button#segmented-button-attributes-value
|
|
2299
|
+
*/
|
|
2300
|
+
'value'?: string;
|
|
2301
|
+
/**
|
|
2302
|
+
* Defines the button's default behavior. The default is `button`. Possible values:
|
|
2303
|
+
*
|
|
2304
|
+
* * `submit`: Submits the form data to the server.
|
|
2305
|
+
* * `reset`: Resets all the controls to their initial values.
|
|
2306
|
+
* * `button`: No default behavior, does nothing when pressed by default.
|
|
2307
|
+
*
|
|
2308
|
+
* **Note**: This is only available when `href` is not specified.
|
|
2309
|
+
* @see https://www.mdui.org/en/docs/2/components/segmented-button#segmented-button-attributes-type
|
|
2310
|
+
*/
|
|
2311
|
+
'type'?: 'submit' | 'reset' | 'button';
|
|
2312
|
+
/**
|
|
2313
|
+
* 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.
|
|
2314
|
+
*
|
|
2315
|
+
* This attribute allows button elements to be associated with `<form>`s anywhere in the document, not just inside a `<form>`.
|
|
2316
|
+
*
|
|
2317
|
+
* **Note**: Only available when `href` is not specified.
|
|
2318
|
+
* @see https://www.mdui.org/en/docs/2/components/segmented-button#segmented-button-attributes-form
|
|
2319
|
+
*/
|
|
2320
|
+
'form'?: string;
|
|
2321
|
+
/**
|
|
2322
|
+
* Specifies the URL that processes the button's submitted information. Overrides the `action` attribute of the button's form owner.
|
|
2323
|
+
*
|
|
2324
|
+
* **Note**: Only available when `href` is not specified and `type="submit"`.
|
|
2325
|
+
* @see https://www.mdui.org/en/docs/2/components/segmented-button#segmented-button-attributes-formaction
|
|
2326
|
+
*/
|
|
2327
|
+
'formaction'?: string;
|
|
2328
|
+
/**
|
|
2329
|
+
* Specifies the form data encoding method. Possible values:
|
|
2330
|
+
*
|
|
2331
|
+
* * `application/x-www-form-urlencoded`: Default if the attribute is not used.
|
|
2332
|
+
* * `multipart/form-data`: Used for `<input>` elements with `type` set to `file`.
|
|
2333
|
+
* * `text/plain`: For debugging, not for real form submission.
|
|
2334
|
+
*
|
|
2335
|
+
* Overrides the `enctype` attribute of the button's form owner.
|
|
2336
|
+
*
|
|
2337
|
+
* **Note**: Only available when `href` is not specified and `type="submit"`.
|
|
2338
|
+
* @see https://www.mdui.org/en/docs/2/components/segmented-button#segmented-button-attributes-formenctype
|
|
2339
|
+
*/
|
|
2340
|
+
'formenctype'?: 'application/x-www-form-urlencoded' | 'multipart/form-data' | 'text/plain';
|
|
2341
|
+
/**
|
|
2342
|
+
* Specifies the HTTP method for form submission. Possible values:
|
|
2343
|
+
*
|
|
2344
|
+
* * `post`: Form data included in HTTP request body.
|
|
2345
|
+
* * `get`: Form data appended to `action` URL.
|
|
2346
|
+
*
|
|
2347
|
+
* Overrides the `method` attribute of the button's form owner.
|
|
2348
|
+
*
|
|
2349
|
+
* **Note**: Only available when `href` is not specified and `type="submit"`.
|
|
2350
|
+
* @see https://www.mdui.org/en/docs/2/components/segmented-button#segmented-button-attributes-formmethod
|
|
2351
|
+
*/
|
|
2352
|
+
'formmethod'?: 'post' | 'get';
|
|
2353
|
+
/**
|
|
2354
|
+
* Specifies that the form should not be validated on submission. Overrides the `novalidate` attribute of the button's form owner.
|
|
2355
|
+
*
|
|
2356
|
+
* **Note**: Only available when `href` is not specified and `type="submit"`.
|
|
2357
|
+
* @see https://www.mdui.org/en/docs/2/components/segmented-button#segmented-button-attributes-formnovalidate
|
|
2358
|
+
*/
|
|
2359
|
+
'formnovalidate'?: boolean;
|
|
2360
|
+
/**
|
|
2361
|
+
* Specifies where to display the form submission response. Possible values:
|
|
2362
|
+
*
|
|
2363
|
+
* * `_self`: Current browsing context. (Default).
|
|
2364
|
+
* * `_blank`: New tab or window.
|
|
2365
|
+
* * `_parent`: Parent browsing context or `_self` if no parent.
|
|
2366
|
+
* * `_top`: Topmost browsing context or `_self` if no ancestors.
|
|
2367
|
+
*
|
|
2368
|
+
* Overrides the `target` attribute of the button's form owner.
|
|
2369
|
+
*
|
|
2370
|
+
* **Note**: Only available when `href` is not specified and `type="submit"`.
|
|
2371
|
+
* @see https://www.mdui.org/en/docs/2/components/segmented-button#segmented-button-attributes-formtarget
|
|
2372
|
+
*/
|
|
2373
|
+
'formtarget'?: '_self' | '_blank' | '_parent' | '_top';
|
|
2374
|
+
} & HTMLElementProps;
|
|
2375
|
+
/**
|
|
2376
|
+
* Segmented Button Group Component It should be used in conjunction with the `<mdui-segmented-button>` component
|
|
2377
|
+
*
|
|
2378
|
+
* ```html
|
|
2379
|
+
* <mdui-segmented-button-group>
|
|
2380
|
+
* <mdui-segmented-button>Day</mdui-segmented-button>
|
|
2381
|
+
* <mdui-segmented-button>Week</mdui-segmented-button>
|
|
2382
|
+
* <mdui-segmented-button>Month</mdui-segmented-button>
|
|
2383
|
+
* </mdui-segmented-button-group>
|
|
2384
|
+
* ```
|
|
2385
|
+
* @see https://www.mdui.org/en/docs/2/components/segmented-button
|
|
2386
|
+
*/
|
|
2387
|
+
'mdui-segmented-button-group': {
|
|
2388
|
+
/**
|
|
2389
|
+
* If set, the segmented button group will fill the width of its parent element.
|
|
2390
|
+
* @see https://www.mdui.org/en/docs/2/components/segmented-button#segmented-button-group-attributes-full-width
|
|
2391
|
+
*/
|
|
2392
|
+
'full-width'?: boolean;
|
|
2393
|
+
/**
|
|
2394
|
+
* Defines selectable states. Default is non-selectable. Possible values:
|
|
2395
|
+
*
|
|
2396
|
+
* * `single`: Only one can be selected.
|
|
2397
|
+
* * `multiple`: Multiple selections are allowed.
|
|
2398
|
+
* @see https://www.mdui.org/en/docs/2/components/segmented-button#segmented-button-group-attributes-selects
|
|
2399
|
+
*/
|
|
2400
|
+
'selects'?: 'single' | 'multiple';
|
|
2401
|
+
/**
|
|
2402
|
+
* Disables the segmented button group when set.
|
|
2403
|
+
* @see https://www.mdui.org/en/docs/2/components/segmented-button#segmented-button-group-attributes-disabled
|
|
2404
|
+
*/
|
|
2405
|
+
'disabled'?: boolean;
|
|
2406
|
+
/**
|
|
2407
|
+
* Requires a selection when the form is submitted.
|
|
2408
|
+
* @see https://www.mdui.org/en/docs/2/components/segmented-button#segmented-button-group-attributes-required
|
|
2409
|
+
*/
|
|
2410
|
+
'required'?: boolean;
|
|
2411
|
+
/**
|
|
2412
|
+
* Associates the segmented button group with a `<form>` element. The value should be the `id` of a `<form>` in the same document. If not set, the segmented button group is associated with its parent `<form>`, if any.
|
|
2413
|
+
*
|
|
2414
|
+
* This attribute allows segmented button group elements to be associated with `<form>`s anywhere in the document, not just inside a `<form>`.
|
|
2415
|
+
* @see https://www.mdui.org/en/docs/2/components/segmented-button#segmented-button-group-attributes-form
|
|
2416
|
+
*/
|
|
2417
|
+
'form'?: string;
|
|
2418
|
+
/**
|
|
2419
|
+
* The name of the segmented button group, which is submitted with form data.
|
|
2420
|
+
* @see https://www.mdui.org/en/docs/2/components/segmented-button#segmented-button-group-attributes-name
|
|
2421
|
+
*/
|
|
2422
|
+
'name'?: string;
|
|
2423
|
+
/**
|
|
2424
|
+
* The value of the selected `<mdui-segmented-button>`. This value is submitted with form data.
|
|
2425
|
+
*
|
|
2426
|
+
* Note: The HTML attribute is always a string and can only be set as an initial value when `selects="single"`. The JavaScript property is a string when `selects="single"` and an array of strings when `selects="multiple"`. In `selects="multiple"`, this value can only be modified by changing the JavaScript property.
|
|
2427
|
+
* @see https://www.mdui.org/en/docs/2/components/segmented-button#segmented-button-group-attributes-value
|
|
2428
|
+
*/
|
|
2429
|
+
'value'?: string | string[];
|
|
2430
|
+
} & HTMLElementProps;
|
|
2431
|
+
/**
|
|
2432
|
+
* Select Component It should be used in conjunction with the `<mdui-menu-item>` component
|
|
2433
|
+
*
|
|
2434
|
+
* ```html
|
|
2435
|
+
* <mdui-select>
|
|
2436
|
+
* <mdui-menu-item value="item-1">Item 1</mdui-menu-item>
|
|
2437
|
+
* <mdui-menu-item value="item-2">Item 2</mdui-menu-item>
|
|
2438
|
+
* </mdui-select>
|
|
2439
|
+
* ```
|
|
2440
|
+
* @see https://www.mdui.org/en/docs/2/components/select
|
|
2441
|
+
*/
|
|
2442
|
+
'mdui-select': {
|
|
2443
|
+
/**
|
|
2444
|
+
* Defines the select style. Possible values:
|
|
2445
|
+
*
|
|
2446
|
+
* * `filled`: Solid background, strong visual emphasis.
|
|
2447
|
+
* * `outlined`: Bordered, less visual emphasis.
|
|
2448
|
+
* @see https://www.mdui.org/en/docs/2/components/select#attributes-variant
|
|
2449
|
+
*/
|
|
2450
|
+
'variant'?: 'filled' | 'outlined';
|
|
2451
|
+
/**
|
|
2452
|
+
* Enables multiple selections.
|
|
2453
|
+
* @see https://www.mdui.org/en/docs/2/components/select#attributes-multiple
|
|
2454
|
+
*/
|
|
2455
|
+
'multiple'?: boolean;
|
|
2456
|
+
/**
|
|
2457
|
+
* Name of the select, which is submitted with form data.
|
|
2458
|
+
* @see https://www.mdui.org/en/docs/2/components/select#attributes-name
|
|
2459
|
+
*/
|
|
2460
|
+
'name'?: string;
|
|
2461
|
+
/**
|
|
2462
|
+
* Value of the select, which is submitted with form data.
|
|
2463
|
+
*
|
|
2464
|
+
* If `multiple` is not set, the value is a string; if set, it's an array of strings. HTML attributes can only set string values; array values must be set via JavaScript property.
|
|
2465
|
+
* @see https://www.mdui.org/en/docs/2/components/select#attributes-value
|
|
2466
|
+
*/
|
|
2467
|
+
'value'?: string | string[];
|
|
2468
|
+
/**
|
|
2469
|
+
* Label text.
|
|
2470
|
+
* @see https://www.mdui.org/en/docs/2/components/select#attributes-label
|
|
2471
|
+
*/
|
|
2472
|
+
'label'?: string;
|
|
2473
|
+
/**
|
|
2474
|
+
* Placeholder text.
|
|
2475
|
+
* @see https://www.mdui.org/en/docs/2/components/select#attributes-placeholder
|
|
2476
|
+
*/
|
|
2477
|
+
'placeholder'?: string;
|
|
2478
|
+
/**
|
|
2479
|
+
* Helper text displayed below the select. Alternatively, use `slot="helper"`.
|
|
2480
|
+
* @see https://www.mdui.org/en/docs/2/components/select#attributes-helper
|
|
2481
|
+
*/
|
|
2482
|
+
'helper'?: string;
|
|
2483
|
+
/**
|
|
2484
|
+
* Allows the select to be cleared.
|
|
2485
|
+
* @see https://www.mdui.org/en/docs/2/components/select#attributes-clearable
|
|
2486
|
+
*/
|
|
2487
|
+
'clearable'?: boolean;
|
|
2488
|
+
/**
|
|
2489
|
+
* Material Icons name for the clear button displayed on the right of the select when clearable. Alternatively, use `slot="clear-icon"`.
|
|
2490
|
+
* @see https://www.mdui.org/en/docs/2/components/select#attributes-clear-icon
|
|
2491
|
+
*/
|
|
2492
|
+
'clear-icon'?: string;
|
|
2493
|
+
/**
|
|
2494
|
+
* Select placement. Possible values:
|
|
2495
|
+
*
|
|
2496
|
+
* * `auto`: Automatically determined.
|
|
2497
|
+
* * `bottom`: Below the input.
|
|
2498
|
+
* * `top`: Above the input.
|
|
2499
|
+
* @see https://www.mdui.org/en/docs/2/components/select#attributes-placement
|
|
2500
|
+
*/
|
|
2501
|
+
'placement'?: 'auto' | 'bottom' | 'top';
|
|
2502
|
+
/**
|
|
2503
|
+
* Aligns text to the right.
|
|
2504
|
+
* @see https://www.mdui.org/en/docs/2/components/select#attributes-end-aligned
|
|
2505
|
+
*/
|
|
2506
|
+
'end-aligned'?: boolean;
|
|
2507
|
+
/**
|
|
2508
|
+
* Prefix text of the select. Displayed only when the select is focused or has a value. Alternatively, use `slot="prefix"`.
|
|
2509
|
+
* @see https://www.mdui.org/en/docs/2/components/select#attributes-prefix
|
|
2510
|
+
*/
|
|
2511
|
+
'prefix'?: string;
|
|
2512
|
+
/**
|
|
2513
|
+
* Suffix text of the select. Displayed only when the select is focused or has a value. Alternatively, use `slot="suffix"`.
|
|
2514
|
+
* @see https://www.mdui.org/en/docs/2/components/select#attributes-suffix
|
|
2515
|
+
*/
|
|
2516
|
+
'suffix'?: string;
|
|
2517
|
+
/**
|
|
2518
|
+
* Material Icons name for the prefix icon. Alternatively, use `slot="icon"`.
|
|
2519
|
+
* @see https://www.mdui.org/en/docs/2/components/select#attributes-icon
|
|
2520
|
+
*/
|
|
2521
|
+
'icon'?: string;
|
|
2522
|
+
/**
|
|
2523
|
+
* Material Icons name for the suffix icon. Alternatively, use `slot="end-icon"`.
|
|
2524
|
+
* @see https://www.mdui.org/en/docs/2/components/select#attributes-end-icon
|
|
2525
|
+
*/
|
|
2526
|
+
'end-icon'?: string;
|
|
2527
|
+
/**
|
|
2528
|
+
* Material Icons name displayed on the right when form field validation fails. Alternatively, use `slot="error-icon"`.
|
|
2529
|
+
* @see https://www.mdui.org/en/docs/2/components/select#attributes-error-icon
|
|
2530
|
+
*/
|
|
2531
|
+
'error-icon'?: string;
|
|
2532
|
+
/**
|
|
2533
|
+
* Associates the select with a `<form>` element. The value should be the `id` of a `<form>` in the same document. If not set, the select is associated with its parent `<form>`, if any.
|
|
2534
|
+
*
|
|
2535
|
+
* This attribute allows select elements to be associated with `<form>`s anywhere in the document, not just inside a `<form>`.
|
|
2536
|
+
* @see https://www.mdui.org/en/docs/2/components/select#attributes-form
|
|
2537
|
+
*/
|
|
2538
|
+
'form'?: string;
|
|
2539
|
+
/**
|
|
2540
|
+
* Makes the select read-only.
|
|
2541
|
+
* @see https://www.mdui.org/en/docs/2/components/select#attributes-readonly
|
|
2542
|
+
*/
|
|
2543
|
+
'readonly'?: boolean;
|
|
2544
|
+
/**
|
|
2545
|
+
* Disables the select.
|
|
2546
|
+
* @see https://www.mdui.org/en/docs/2/components/select#attributes-disabled
|
|
2547
|
+
*/
|
|
2548
|
+
'disabled'?: boolean;
|
|
2549
|
+
/**
|
|
2550
|
+
* Requires a selection when the form is submitted.
|
|
2551
|
+
* @see https://www.mdui.org/en/docs/2/components/select#attributes-required
|
|
2552
|
+
*/
|
|
2553
|
+
'required'?: boolean;
|
|
2554
|
+
/**
|
|
2555
|
+
* Determines if the element should be focused when the page loads.
|
|
2556
|
+
* @see https://www.mdui.org/en/docs/2/components/select#attributes-autofocus
|
|
2557
|
+
*/
|
|
2558
|
+
'autofocus'?: boolean;
|
|
2559
|
+
/**
|
|
2560
|
+
* Specifies the order in which the element receives focus when navigating with the Tab key.
|
|
2561
|
+
* @see https://www.mdui.org/en/docs/2/components/select#attributes-tabindex
|
|
2562
|
+
*/
|
|
2563
|
+
'tabindex'?: number;
|
|
2564
|
+
} & HTMLElementProps;
|
|
2565
|
+
/**
|
|
2566
|
+
* Slider Component
|
|
2567
|
+
*
|
|
2568
|
+
* ```html
|
|
2569
|
+
* <mdui-slider></mdui-slider>
|
|
2570
|
+
* ```
|
|
2571
|
+
* @see https://www.mdui.org/en/docs/2/components/slider
|
|
2572
|
+
*/
|
|
2573
|
+
'mdui-slider': {
|
|
2574
|
+
/**
|
|
2575
|
+
* The value of the slider, which is submitted with form data.
|
|
2576
|
+
* @see https://www.mdui.org/en/docs/2/components/slider#attributes-value
|
|
2577
|
+
*/
|
|
2578
|
+
'value'?: number;
|
|
2579
|
+
/**
|
|
2580
|
+
* Determines if the element should be focused when the page loads.
|
|
2581
|
+
* @see https://www.mdui.org/en/docs/2/components/slider#attributes-autofocus
|
|
2582
|
+
*/
|
|
2583
|
+
'autofocus'?: boolean;
|
|
2584
|
+
/**
|
|
2585
|
+
* Specifies the order in which the element receives focus when navigating with the Tab key.
|
|
2586
|
+
* @see https://www.mdui.org/en/docs/2/components/slider#attributes-tabindex
|
|
2587
|
+
*/
|
|
2588
|
+
'tabindex'?: number;
|
|
2589
|
+
/**
|
|
2590
|
+
* Specifies the minimum value. Default is `0`.
|
|
2591
|
+
* @see https://www.mdui.org/en/docs/2/components/slider#attributes-min
|
|
2592
|
+
*/
|
|
2593
|
+
'min'?: number;
|
|
2594
|
+
/**
|
|
2595
|
+
* Specifies the maximum value. Default is `100`.
|
|
2596
|
+
* @see https://www.mdui.org/en/docs/2/components/slider#attributes-max
|
|
2597
|
+
*/
|
|
2598
|
+
'max'?: number;
|
|
2599
|
+
/**
|
|
2600
|
+
* Specifies the step interval. Default is `1`.
|
|
2601
|
+
* @see https://www.mdui.org/en/docs/2/components/slider#attributes-step
|
|
2602
|
+
*/
|
|
2603
|
+
'step'?: number;
|
|
2604
|
+
/**
|
|
2605
|
+
* Adds tickmarks to the slider.
|
|
2606
|
+
* @see https://www.mdui.org/en/docs/2/components/slider#attributes-tickmarks
|
|
2607
|
+
*/
|
|
2608
|
+
'tickmarks'?: boolean;
|
|
2609
|
+
/**
|
|
2610
|
+
* Hides the tooltip.
|
|
2611
|
+
* @see https://www.mdui.org/en/docs/2/components/slider#attributes-nolabel
|
|
2612
|
+
*/
|
|
2613
|
+
'nolabel'?: boolean;
|
|
2614
|
+
/**
|
|
2615
|
+
* Disables the slider.
|
|
2616
|
+
* @see https://www.mdui.org/en/docs/2/components/slider#attributes-disabled
|
|
2617
|
+
*/
|
|
2618
|
+
'disabled'?: boolean;
|
|
2619
|
+
/**
|
|
2620
|
+
* Associates the slider with a `<form>` element. The value should be the `id` of a `<form>` in the same document. If not set, the slider is associated with its parent `<form>`, if any.
|
|
2621
|
+
*
|
|
2622
|
+
* This attribute allows slider elements to be associated with `<form>`s anywhere in the document, not just inside a `<form>`.
|
|
2623
|
+
* @see https://www.mdui.org/en/docs/2/components/slider#attributes-form
|
|
2624
|
+
*/
|
|
2625
|
+
'form'?: string;
|
|
2626
|
+
/**
|
|
2627
|
+
* Specifies the slider's name, which is submitted with the form data.
|
|
2628
|
+
* @see https://www.mdui.org/en/docs/2/components/slider#attributes-name
|
|
2629
|
+
*/
|
|
2630
|
+
'name'?: string;
|
|
2631
|
+
} & HTMLElementProps;
|
|
2632
|
+
/**
|
|
2633
|
+
* Snackbar Component
|
|
2634
|
+
*
|
|
2635
|
+
* ```html
|
|
2636
|
+
* <mdui-snackbar>message</mdui-snackbar>
|
|
2637
|
+
* ```
|
|
2638
|
+
* @see https://www.mdui.org/en/docs/2/components/snackbar
|
|
2639
|
+
*/
|
|
2640
|
+
'mdui-snackbar': {
|
|
2641
|
+
/**
|
|
2642
|
+
* Opens the Snackbar.
|
|
2643
|
+
* @see https://www.mdui.org/en/docs/2/components/snackbar#attributes-open
|
|
2644
|
+
*/
|
|
2645
|
+
'open'?: boolean;
|
|
2646
|
+
/**
|
|
2647
|
+
* Snackbar placement. Default is `bottom`. Possible values:
|
|
2648
|
+
*
|
|
2649
|
+
* * `top`: Top, centered.
|
|
2650
|
+
* * `top-start`: Top, left-aligned.
|
|
2651
|
+
* * `top-end`: Top, right-aligned.
|
|
2652
|
+
* * `bottom`: Bottom, centered.
|
|
2653
|
+
* * `bottom-start`: Bottom, left-aligned.
|
|
2654
|
+
* * `bottom-end`: Bottom, right-aligned.
|
|
2655
|
+
* @see https://www.mdui.org/en/docs/2/components/snackbar#attributes-placement
|
|
2656
|
+
*/
|
|
2657
|
+
'placement'?: 'top' | 'top-start' | 'top-end' | 'bottom' | 'bottom-start' | 'bottom-end';
|
|
2658
|
+
/**
|
|
2659
|
+
* Text for the action button. Alternatively, use `slot="action"`.
|
|
2660
|
+
* @see https://www.mdui.org/en/docs/2/components/snackbar#attributes-action
|
|
2661
|
+
*/
|
|
2662
|
+
'action'?: string;
|
|
2663
|
+
/**
|
|
2664
|
+
* Indicates if the action button is in the loading state.
|
|
2665
|
+
* @see https://www.mdui.org/en/docs/2/components/snackbar#attributes-action-loading
|
|
2666
|
+
*/
|
|
2667
|
+
'action-loading'?: boolean;
|
|
2668
|
+
/**
|
|
2669
|
+
* Shows a close button on the right.
|
|
2670
|
+
* @see https://www.mdui.org/en/docs/2/components/snackbar#attributes-closeable
|
|
2671
|
+
*/
|
|
2672
|
+
'closeable'?: boolean;
|
|
2673
|
+
/**
|
|
2674
|
+
* Material Icons name for the close button. Alternatively, use `slot="close-icon"`.
|
|
2675
|
+
* @see https://www.mdui.org/en/docs/2/components/snackbar#attributes-close-icon
|
|
2676
|
+
*/
|
|
2677
|
+
'close-icon'?: string;
|
|
2678
|
+
/**
|
|
2679
|
+
* Maximum lines for message text. Default is unlimited. Possible values:
|
|
2680
|
+
*
|
|
2681
|
+
* * `1`: Single line.
|
|
2682
|
+
* * `2`: Two lines.
|
|
2683
|
+
* @see https://www.mdui.org/en/docs/2/components/snackbar#attributes-message-line
|
|
2684
|
+
*/
|
|
2685
|
+
'message-line'?: 1 | 2;
|
|
2686
|
+
/**
|
|
2687
|
+
* Automatically closes the Snackbar after a specified time (in milliseconds). Set to `0` to disable auto-closing. Default is 5 seconds.
|
|
2688
|
+
* @see https://www.mdui.org/en/docs/2/components/snackbar#attributes-auto-close-delay
|
|
2689
|
+
*/
|
|
2690
|
+
'auto-close-delay'?: number;
|
|
2691
|
+
/**
|
|
2692
|
+
* Closes the Snackbar when clicking or touching outside the Snackbar area.
|
|
2693
|
+
* @see https://www.mdui.org/en/docs/2/components/snackbar#attributes-close-on-outside-click
|
|
2694
|
+
*/
|
|
2695
|
+
'close-on-outside-click'?: boolean;
|
|
2696
|
+
} & HTMLElementProps;
|
|
2697
|
+
/**
|
|
2698
|
+
* Switch Component
|
|
2699
|
+
*
|
|
2700
|
+
* ```html
|
|
2701
|
+
* <mdui-switch></mdui-switch>
|
|
2702
|
+
* ```
|
|
2703
|
+
* @see https://www.mdui.org/en/docs/2/components/switch
|
|
2704
|
+
*/
|
|
2705
|
+
'mdui-switch': {
|
|
2706
|
+
/**
|
|
2707
|
+
* Disables the switch.
|
|
2708
|
+
* @see https://www.mdui.org/en/docs/2/components/switch#attributes-disabled
|
|
2709
|
+
*/
|
|
2710
|
+
'disabled'?: boolean;
|
|
2711
|
+
/**
|
|
2712
|
+
* Sets the switch to the checked state.
|
|
2713
|
+
* @see https://www.mdui.org/en/docs/2/components/switch#attributes-checked
|
|
2714
|
+
*/
|
|
2715
|
+
'checked'?: boolean;
|
|
2716
|
+
/**
|
|
2717
|
+
* The Material Icons name for the unchecked state. Alternatively, use `slot="unchecked-icon"`.
|
|
2718
|
+
* @see https://www.mdui.org/en/docs/2/components/switch#attributes-unchecked-icon
|
|
2719
|
+
*/
|
|
2720
|
+
'unchecked-icon'?: string;
|
|
2721
|
+
/**
|
|
2722
|
+
* The Material Icons name for the checked state. Alternatively, use `slot="checked-icon"`. Defaults to the `check` icon; an empty string removes the default icon.
|
|
2723
|
+
* @see https://www.mdui.org/en/docs/2/components/switch#attributes-checked-icon
|
|
2724
|
+
*/
|
|
2725
|
+
'checked-icon'?: string;
|
|
2726
|
+
/**
|
|
2727
|
+
* The switch must be checked when submitting the form.
|
|
2728
|
+
* @see https://www.mdui.org/en/docs/2/components/switch#attributes-required
|
|
2729
|
+
*/
|
|
2730
|
+
'required'?: boolean;
|
|
2731
|
+
/**
|
|
2732
|
+
* Associates the switch with a `<form>` element. The value should be the `id` of a `<form>` in the same document. If not set, the switch is associated with its parent `<form>`, if any.
|
|
2733
|
+
*
|
|
2734
|
+
* This attribute allows switch elements to be associated with `<form>`s anywhere in the document, not just inside a `<form>`.
|
|
2735
|
+
* @see https://www.mdui.org/en/docs/2/components/switch#attributes-form
|
|
2736
|
+
*/
|
|
2737
|
+
'form'?: string;
|
|
2738
|
+
/**
|
|
2739
|
+
* The name of the switch, which is submitted with form data.
|
|
2740
|
+
* @see https://www.mdui.org/en/docs/2/components/switch#attributes-name
|
|
2741
|
+
*/
|
|
2742
|
+
'name'?: string;
|
|
2743
|
+
/**
|
|
2744
|
+
* The value of the switch, which is submitted with form data.
|
|
2745
|
+
* @see https://www.mdui.org/en/docs/2/components/switch#attributes-value
|
|
2746
|
+
*/
|
|
2747
|
+
'value'?: string;
|
|
2748
|
+
/**
|
|
2749
|
+
* Determines if the element should be focused when the page loads.
|
|
2750
|
+
* @see https://www.mdui.org/en/docs/2/components/switch#attributes-autofocus
|
|
2751
|
+
*/
|
|
2752
|
+
'autofocus'?: boolean;
|
|
2753
|
+
/**
|
|
2754
|
+
* Specifies the order in which the element receives focus when navigating with the Tab key.
|
|
2755
|
+
* @see https://www.mdui.org/en/docs/2/components/switch#attributes-tabindex
|
|
2756
|
+
*/
|
|
2757
|
+
'tabindex'?: number;
|
|
2758
|
+
} & HTMLElementProps;
|
|
2759
|
+
/**
|
|
2760
|
+
* Tab Component It should be used in conjunction with the `<mdui-tabs>` and `<mdui-tab-panel>` components
|
|
2761
|
+
*
|
|
2762
|
+
* ```html
|
|
2763
|
+
* <mdui-tabs value="tab-1">
|
|
2764
|
+
* <mdui-tab value="tab-1">Tab 1</mdui-tab>
|
|
2765
|
+
* <mdui-tab value="tab-2">Tab 2</mdui-tab>
|
|
2766
|
+
* <mdui-tab value="tab-3">Tab 3</mdui-tab>
|
|
2767
|
+
*
|
|
2768
|
+
* <mdui-tab-panel slot="panel" value="tab-1">Panel 1</mdui-tab-panel>
|
|
2769
|
+
* <mdui-tab-panel slot="panel" value="tab-2">Panel 2</mdui-tab-panel>
|
|
2770
|
+
* <mdui-tab-panel slot="panel" value="tab-3">Panel 3</mdui-tab-panel>
|
|
2771
|
+
* </mdui-tabs>
|
|
2772
|
+
* ```
|
|
2773
|
+
* @see https://www.mdui.org/en/docs/2/components/tabs
|
|
2774
|
+
*/
|
|
2775
|
+
'mdui-tab': {
|
|
2776
|
+
/**
|
|
2777
|
+
* Specifies the tab value.
|
|
2778
|
+
* @see https://www.mdui.org/en/docs/2/components/tabs#tab-attributes-value
|
|
2779
|
+
*/
|
|
2780
|
+
'value'?: string;
|
|
2781
|
+
/**
|
|
2782
|
+
* Specifies the Material Icons name. Alternatively, use `slot="icon"`.
|
|
2783
|
+
* @see https://www.mdui.org/en/docs/2/components/tabs#tab-attributes-icon
|
|
2784
|
+
*/
|
|
2785
|
+
'icon'?: string;
|
|
2786
|
+
/**
|
|
2787
|
+
* Arranges the icon and text horizontally.
|
|
2788
|
+
* @see https://www.mdui.org/en/docs/2/components/tabs#tab-attributes-inline
|
|
2789
|
+
*/
|
|
2790
|
+
'inline'?: boolean;
|
|
2791
|
+
/**
|
|
2792
|
+
* Determines if the element should be focused when the page loads.
|
|
2793
|
+
* @see https://www.mdui.org/en/docs/2/components/tabs#tab-attributes-autofocus
|
|
2794
|
+
*/
|
|
2795
|
+
'autofocus'?: boolean;
|
|
2796
|
+
/**
|
|
2797
|
+
* Specifies the order in which the element receives focus when navigating with the Tab key.
|
|
2798
|
+
* @see https://www.mdui.org/en/docs/2/components/tabs#tab-attributes-tabindex
|
|
2799
|
+
*/
|
|
2800
|
+
'tabindex'?: number;
|
|
2801
|
+
} & HTMLElementProps;
|
|
2802
|
+
/**
|
|
2803
|
+
* Tab Panel Component It should be used in conjunction with the `<mdui-tabs>` and `<mdui-tab>` components
|
|
2804
|
+
*
|
|
2805
|
+
* ```html
|
|
2806
|
+
* <mdui-tabs value="tab-1">
|
|
2807
|
+
* <mdui-tab value="tab-1">Tab 1</mdui-tab>
|
|
2808
|
+
* <mdui-tab value="tab-2">Tab 2</mdui-tab>
|
|
2809
|
+
* <mdui-tab value="tab-3">Tab 3</mdui-tab>
|
|
2810
|
+
*
|
|
2811
|
+
* <mdui-tab-panel slot="panel" value="tab-1">Panel 1</mdui-tab-panel>
|
|
2812
|
+
* <mdui-tab-panel slot="panel" value="tab-2">Panel 2</mdui-tab-panel>
|
|
2813
|
+
* <mdui-tab-panel slot="panel" value="tab-3">Panel 3</mdui-tab-panel>
|
|
2814
|
+
* </mdui-tabs>
|
|
2815
|
+
* ```
|
|
2816
|
+
* @see https://www.mdui.org/en/docs/2/components/tabs
|
|
2817
|
+
*/
|
|
2818
|
+
'mdui-tab-panel': {
|
|
2819
|
+
/**
|
|
2820
|
+
* Specifies the value of the tab panel.
|
|
2821
|
+
* @see https://www.mdui.org/en/docs/2/components/tabs#tab-panel-attributes-value
|
|
2822
|
+
*/
|
|
2823
|
+
'value'?: string;
|
|
2824
|
+
} & HTMLElementProps;
|
|
2825
|
+
/**
|
|
2826
|
+
* Tabs Component It should be used in conjunction with the `<mdui-tab>` and `<mdui-tab-panel>` components
|
|
2827
|
+
*
|
|
2828
|
+
* ```html
|
|
2829
|
+
* <mdui-tabs value="tab-1">
|
|
2830
|
+
* <mdui-tab value="tab-1">Tab 1</mdui-tab>
|
|
2831
|
+
* <mdui-tab value="tab-2">Tab 2</mdui-tab>
|
|
2832
|
+
* <mdui-tab value="tab-3">Tab 3</mdui-tab>
|
|
2833
|
+
*
|
|
2834
|
+
* <mdui-tab-panel slot="panel" value="tab-1">Panel 1</mdui-tab-panel>
|
|
2835
|
+
* <mdui-tab-panel slot="panel" value="tab-2">Panel 2</mdui-tab-panel>
|
|
2836
|
+
* <mdui-tab-panel slot="panel" value="tab-3">Panel 3</mdui-tab-panel>
|
|
2837
|
+
* </mdui-tabs>
|
|
2838
|
+
* ```
|
|
2839
|
+
* @see https://www.mdui.org/en/docs/2/components/tabs
|
|
2840
|
+
*/
|
|
2841
|
+
'mdui-tabs': {
|
|
2842
|
+
/**
|
|
2843
|
+
* Defines the tab shape. Possible values:
|
|
2844
|
+
*
|
|
2845
|
+
* * `primary`: Located below `<mdui-top-app-bar>`, used for switching between main application pages.
|
|
2846
|
+
* * `secondary`: Located within the page, used for switching between related content groups.
|
|
2847
|
+
* @see https://www.mdui.org/en/docs/2/components/tabs#tabs-attributes-variant
|
|
2848
|
+
*/
|
|
2849
|
+
'variant'?: 'primary' | 'secondary';
|
|
2850
|
+
/**
|
|
2851
|
+
* Specifies the active `<mdui-tab>` value.
|
|
2852
|
+
* @see https://www.mdui.org/en/docs/2/components/tabs#tabs-attributes-value
|
|
2853
|
+
*/
|
|
2854
|
+
'value'?: string;
|
|
2855
|
+
/**
|
|
2856
|
+
* Defines the tab position. Default is `top-start`. Possible values:
|
|
2857
|
+
*
|
|
2858
|
+
* * `top-start`: Top, left-aligned.
|
|
2859
|
+
* * `top`: Top, center-aligned.
|
|
2860
|
+
* * `top-end`: Top, right-aligned.
|
|
2861
|
+
* * `bottom-start`: Bottom, left-aligned.
|
|
2862
|
+
* * `bottom`: Bottom, center-aligned.
|
|
2863
|
+
* * `bottom-end`: Bottom, right-aligned.
|
|
2864
|
+
* * `left-start`: Left, top-aligned.
|
|
2865
|
+
* * `left`: Left, center-aligned.
|
|
2866
|
+
* * `left-end`: Left, bottom-aligned.
|
|
2867
|
+
* * `right-start`: Right, top-aligned.
|
|
2868
|
+
* * `right`: Right, center-aligned.
|
|
2869
|
+
* * `right-end`: Right, bottom-aligned.
|
|
2870
|
+
* @see https://www.mdui.org/en/docs/2/components/tabs#tabs-attributes-placement
|
|
2871
|
+
*/
|
|
2872
|
+
'placement'?: 'top-start' | 'top' | 'top-end' | 'bottom-start' | 'bottom' | 'bottom-end' | 'left-start' | 'left' | 'left-end' | 'right-start' | 'right' | 'right-end';
|
|
2873
|
+
/**
|
|
2874
|
+
* If set, the tabs will fill the width of its parent element.
|
|
2875
|
+
* @see https://www.mdui.org/en/docs/2/components/tabs#tabs-attributes-full-width
|
|
2876
|
+
*/
|
|
2877
|
+
'full-width'?: boolean;
|
|
2878
|
+
} & HTMLElementProps;
|
|
2879
|
+
/**
|
|
2880
|
+
* Text Field Component
|
|
2881
|
+
*
|
|
2882
|
+
* ```html
|
|
2883
|
+
* <mdui-text-field label="Text Field"></mdui-text-field>
|
|
2884
|
+
* ```
|
|
2885
|
+
* @see https://www.mdui.org/en/docs/2/components/text-field
|
|
2886
|
+
*/
|
|
2887
|
+
'mdui-text-field': {
|
|
2888
|
+
/**
|
|
2889
|
+
* Defines the text field style. Default is `filled`. Possible values:
|
|
2890
|
+
*
|
|
2891
|
+
* * `filled`: Text field with background color, providing a stronger visual effect.
|
|
2892
|
+
* * `outlined`: Text field with border, providing a subtler visual effect.
|
|
2893
|
+
* @see https://www.mdui.org/en/docs/2/components/text-field#attributes-variant
|
|
2894
|
+
*/
|
|
2895
|
+
'variant'?: 'filled' | 'outlined';
|
|
2896
|
+
/**
|
|
2897
|
+
* Specifies the text field type. Default is `text`. Possible values:
|
|
2898
|
+
*
|
|
2899
|
+
* * `text`: Standard text field.
|
|
2900
|
+
* * `number`: Allows only numeric input. Devices with dynamic keyboards will display a numeric keyboard.
|
|
2901
|
+
* * `password`: Masks the input for password confidentiality.
|
|
2902
|
+
* * `url`: Validates URL format. Devices with dynamic keyboards will display a URL-specific keyboard.
|
|
2903
|
+
* * `email`: Validates email format. Devices with dynamic keyboards will display an email-specific keyboard.
|
|
2904
|
+
* * `search`: Changes the enter icon to a search icon on devices with dynamic keyboards.
|
|
2905
|
+
* * `tel`: Displays a phone number keyboard on devices with dynamic keyboards.
|
|
2906
|
+
* * `hidden`: Hides the control, but its value will still be submitted to the server.
|
|
2907
|
+
* * `date`: Activates a date picker or a numeric scroll wheel for year, month, and day in supported browsers.
|
|
2908
|
+
* * `datetime-local`: Activates a date and time picker in supported browsers, excluding time zone.
|
|
2909
|
+
* * `month`: Allows input for year and month, excluding time zone.
|
|
2910
|
+
* * `time`: Allows time input, excluding time zone.
|
|
2911
|
+
* * `week`: Allows input for dates consisting of a year and week, excluding time zone.
|
|
2912
|
+
* @see https://www.mdui.org/en/docs/2/components/text-field#attributes-type
|
|
2913
|
+
*/
|
|
2914
|
+
'type'?: 'text' | 'number' | 'password' | 'url' | 'email' | 'search' | 'tel' | 'hidden' | 'date' | 'datetime-local' | 'month' | 'time' | 'week';
|
|
2915
|
+
/**
|
|
2916
|
+
* The name of text field, which is submitted with form data.
|
|
2917
|
+
* @see https://www.mdui.org/en/docs/2/components/text-field#attributes-name
|
|
2918
|
+
*/
|
|
2919
|
+
'name'?: string;
|
|
2920
|
+
/**
|
|
2921
|
+
* The value of text field, which is submitted with form data.
|
|
2922
|
+
* @see https://www.mdui.org/en/docs/2/components/text-field#attributes-value
|
|
2923
|
+
*/
|
|
2924
|
+
'value'?: string;
|
|
2925
|
+
/**
|
|
2926
|
+
* Label text.
|
|
2927
|
+
* @see https://www.mdui.org/en/docs/2/components/text-field#attributes-label
|
|
2928
|
+
*/
|
|
2929
|
+
'label'?: string;
|
|
2930
|
+
/**
|
|
2931
|
+
* Placeholder text.
|
|
2932
|
+
* @see https://www.mdui.org/en/docs/2/components/text-field#attributes-placeholder
|
|
2933
|
+
*/
|
|
2934
|
+
'placeholder'?: string;
|
|
2935
|
+
/**
|
|
2936
|
+
* The helper text displayed at the bottom of the text field. Alternatively, use `slot="helper"`.
|
|
2937
|
+
* @see https://www.mdui.org/en/docs/2/components/text-field#attributes-helper
|
|
2938
|
+
*/
|
|
2939
|
+
'helper'?: string;
|
|
2940
|
+
/**
|
|
2941
|
+
* If set, the helper text is only displayed when the text field is focused.
|
|
2942
|
+
* @see https://www.mdui.org/en/docs/2/components/text-field#attributes-helper-on-focus
|
|
2943
|
+
*/
|
|
2944
|
+
'helper-on-focus'?: boolean;
|
|
2945
|
+
/**
|
|
2946
|
+
* If set, the text field can be cleared.
|
|
2947
|
+
* @see https://www.mdui.org/en/docs/2/components/text-field#attributes-clearable
|
|
2948
|
+
*/
|
|
2949
|
+
'clearable'?: boolean;
|
|
2950
|
+
/**
|
|
2951
|
+
* Material Icons name displayed on the right when the text field is clearable. Alternatively, use `slot="clear-icon"`.
|
|
2952
|
+
* @see https://www.mdui.org/en/docs/2/components/text-field#attributes-clear-icon
|
|
2953
|
+
*/
|
|
2954
|
+
'clear-icon'?: string;
|
|
2955
|
+
/**
|
|
2956
|
+
* Aligns the text to the right.
|
|
2957
|
+
* @see https://www.mdui.org/en/docs/2/components/text-field#attributes-end-aligned
|
|
2958
|
+
*/
|
|
2959
|
+
'end-aligned'?: boolean;
|
|
2960
|
+
/**
|
|
2961
|
+
* The prefix text for the text field. It is only displayed when the text field is focused or has a value. Alternatively, use `slot="prefix"`.
|
|
2962
|
+
* @see https://www.mdui.org/en/docs/2/components/text-field#attributes-prefix
|
|
2963
|
+
*/
|
|
2964
|
+
'prefix'?: string;
|
|
2965
|
+
/**
|
|
2966
|
+
* The suffix text for the text field. It is only displayed when the text field is focused or has a value. Alternatively, use `slot="suffix"`.
|
|
2967
|
+
* @see https://www.mdui.org/en/docs/2/components/text-field#attributes-suffix
|
|
2968
|
+
*/
|
|
2969
|
+
'suffix'?: string;
|
|
2970
|
+
/**
|
|
2971
|
+
* Material Icons name for the prefix icon of the text field. Alternatively, use `slot="icon"`.
|
|
2972
|
+
* @see https://www.mdui.org/en/docs/2/components/text-field#attributes-icon
|
|
2973
|
+
*/
|
|
2974
|
+
'icon'?: string;
|
|
2975
|
+
/**
|
|
2976
|
+
* Material Icons name for the suffix icon of the text field. Alternatively, use `slot="end-icon"`.
|
|
2977
|
+
* @see https://www.mdui.org/en/docs/2/components/text-field#attributes-end-icon
|
|
2978
|
+
*/
|
|
2979
|
+
'end-icon'?: string;
|
|
2980
|
+
/**
|
|
2981
|
+
* Material Icons name displayed on the right side of the text field when the form field validation fails. Alternatively, use `slot="error-icon"`.
|
|
2982
|
+
* @see https://www.mdui.org/en/docs/2/components/text-field#attributes-error-icon
|
|
2983
|
+
*/
|
|
2984
|
+
'error-icon'?: string;
|
|
2985
|
+
/**
|
|
2986
|
+
* Associates the text field with a `<form>` element. The value should be the `id` of a `<form>` in the same document. If not set, the text field is associated with its parent `<form>`, if any.
|
|
2987
|
+
*
|
|
2988
|
+
* This attribute allows text field elements to be associated with `<form>`s anywhere in the document, not just inside a `<form>`.
|
|
2989
|
+
* @see https://www.mdui.org/en/docs/2/components/text-field#attributes-form
|
|
2990
|
+
*/
|
|
2991
|
+
'form'?: string;
|
|
2992
|
+
/**
|
|
2993
|
+
* Makes the text field read-only.
|
|
2994
|
+
* @see https://www.mdui.org/en/docs/2/components/text-field#attributes-readonly
|
|
2995
|
+
*/
|
|
2996
|
+
'readonly'?: boolean;
|
|
2997
|
+
/**
|
|
2998
|
+
* Disables the text field.
|
|
2999
|
+
* @see https://www.mdui.org/en/docs/2/components/text-field#attributes-disabled
|
|
3000
|
+
*/
|
|
3001
|
+
'disabled'?: boolean;
|
|
3002
|
+
/**
|
|
3003
|
+
* The field must be filled in before the form is submitted.
|
|
3004
|
+
* @see https://www.mdui.org/en/docs/2/components/text-field#attributes-required
|
|
3005
|
+
*/
|
|
3006
|
+
'required'?: boolean;
|
|
3007
|
+
/**
|
|
3008
|
+
* The number of rows in the text field.
|
|
3009
|
+
* @see https://www.mdui.org/en/docs/2/components/text-field#attributes-rows
|
|
3010
|
+
*/
|
|
3011
|
+
'rows'?: number;
|
|
3012
|
+
/**
|
|
3013
|
+
* Allows the text field height to adjust automatically based on the input content.
|
|
3014
|
+
* @see https://www.mdui.org/en/docs/2/components/text-field#attributes-autosize
|
|
3015
|
+
*/
|
|
3016
|
+
'autosize'?: boolean;
|
|
3017
|
+
/**
|
|
3018
|
+
* The minimum number of rows when `autosize` is enabled.
|
|
3019
|
+
* @see https://www.mdui.org/en/docs/2/components/text-field#attributes-min-rows
|
|
3020
|
+
*/
|
|
3021
|
+
'min-rows'?: number;
|
|
3022
|
+
/**
|
|
3023
|
+
* The maximum number of rows when `autosize` is enabled.
|
|
3024
|
+
* @see https://www.mdui.org/en/docs/2/components/text-field#attributes-max-rows
|
|
3025
|
+
*/
|
|
3026
|
+
'max-rows'?: number;
|
|
3027
|
+
/**
|
|
3028
|
+
* The minimum number of characters for input.
|
|
3029
|
+
* @see https://www.mdui.org/en/docs/2/components/text-field#attributes-minlength
|
|
3030
|
+
*/
|
|
3031
|
+
'minlength'?: number;
|
|
3032
|
+
/**
|
|
3033
|
+
* The maximum number of characters for input.
|
|
3034
|
+
* @see https://www.mdui.org/en/docs/2/components/text-field#attributes-maxlength
|
|
3035
|
+
*/
|
|
3036
|
+
'maxlength'?: number;
|
|
3037
|
+
/**
|
|
3038
|
+
* Displays the character count when `maxlength` is specified.
|
|
3039
|
+
* @see https://www.mdui.org/en/docs/2/components/text-field#attributes-counter
|
|
3040
|
+
*/
|
|
3041
|
+
'counter'?: boolean;
|
|
3042
|
+
/**
|
|
3043
|
+
* The minimum value when `type` is `number`.
|
|
3044
|
+
* @see https://www.mdui.org/en/docs/2/components/text-field#attributes-min
|
|
3045
|
+
*/
|
|
3046
|
+
'min'?: number;
|
|
3047
|
+
/**
|
|
3048
|
+
* The maximum value when `type` is `number`.
|
|
3049
|
+
* @see https://www.mdui.org/en/docs/2/components/text-field#attributes-max
|
|
3050
|
+
*/
|
|
3051
|
+
'max'?: number;
|
|
3052
|
+
/**
|
|
3053
|
+
* The step interval during increment and decrement when `type` is `number`.
|
|
3054
|
+
* @see https://www.mdui.org/en/docs/2/components/text-field#attributes-step
|
|
3055
|
+
*/
|
|
3056
|
+
'step'?: number;
|
|
3057
|
+
/**
|
|
3058
|
+
* The regular expression for form validation.
|
|
3059
|
+
* @see https://www.mdui.org/en/docs/2/components/text-field#attributes-pattern
|
|
3060
|
+
*/
|
|
3061
|
+
'pattern'?: string;
|
|
3062
|
+
/**
|
|
3063
|
+
* Adds a toggle button for showing and hiding the password when `type` is `password`.
|
|
3064
|
+
* @see https://www.mdui.org/en/docs/2/components/text-field#attributes-toggle-password
|
|
3065
|
+
*/
|
|
3066
|
+
'toggle-password'?: boolean;
|
|
3067
|
+
/**
|
|
3068
|
+
* Material Icons name for the visible password toggle button. Alternatively, use `slot="show-password-icon"`.
|
|
3069
|
+
* @see https://www.mdui.org/en/docs/2/components/text-field#attributes-show-password-icon
|
|
3070
|
+
*/
|
|
3071
|
+
'show-password-icon'?: string;
|
|
3072
|
+
/**
|
|
3073
|
+
* Material Icons name for the hidden password toggle button. Alternatively, use `slot="hide-password-icon"`.
|
|
3074
|
+
* @see https://www.mdui.org/en/docs/2/components/text-field#attributes-hide-password-icon
|
|
3075
|
+
*/
|
|
3076
|
+
'hide-password-icon'?: string;
|
|
3077
|
+
/**
|
|
3078
|
+
* A non-standard iOS attribute for automatic capitalization. Possible values:
|
|
3079
|
+
*
|
|
3080
|
+
* * `none`: Disables automatic capitalization.
|
|
3081
|
+
* * `sentences`: Capitalizes the first letter of each sentence.
|
|
3082
|
+
* * `words`: Capitalizes the first letter of each word.
|
|
3083
|
+
* * `characters`: Capitalizes all letters.
|
|
3084
|
+
* @see https://www.mdui.org/en/docs/2/components/text-field#attributes-autocapitalize
|
|
3085
|
+
*/
|
|
3086
|
+
'autocapitalize'?: 'none' | 'sentences' | 'words' | 'characters';
|
|
3087
|
+
/**
|
|
3088
|
+
* The `autocorrect` attribute of the `input` element.
|
|
3089
|
+
* @see https://www.mdui.org/en/docs/2/components/text-field#attributes-autocorrect
|
|
3090
|
+
*/
|
|
3091
|
+
'autocorrect'?: string;
|
|
3092
|
+
/**
|
|
3093
|
+
* Enables the browser's autocomplete feature for text input. Possible values:
|
|
3094
|
+
*
|
|
3095
|
+
* * `off`: Disables browser autocomplete.
|
|
3096
|
+
* * `on`: Enables browser autocomplete.
|
|
3097
|
+
* @see https://www.mdui.org/en/docs/2/components/text-field#attributes-autocomplete
|
|
3098
|
+
*/
|
|
3099
|
+
'autocomplete'?: 'off' | 'on';
|
|
3100
|
+
/**
|
|
3101
|
+
* Customizes the Enter key text or icon on the virtual keyboard. The effect varies based on the device and language. Possible values:
|
|
3102
|
+
*
|
|
3103
|
+
* * `enter`: Inserts a new line, typically used in a multi-line text field.
|
|
3104
|
+
* * `done`: Indicates input completion, closes the virtual keyboard.
|
|
3105
|
+
* * `go`: Navigates to the target of the entered text.
|
|
3106
|
+
* * `next`: Moves to the next text field.
|
|
3107
|
+
* * `previous`: Moves to the previous text field.
|
|
3108
|
+
* * `search`: Navigates to search results.
|
|
3109
|
+
* * `send`: Sends a text message.
|
|
3110
|
+
* @see https://www.mdui.org/en/docs/2/components/text-field#attributes-enterkeyhint
|
|
3111
|
+
*/
|
|
3112
|
+
'enterkeyhint'?: 'enter' | 'done' | 'go' | 'next' | 'previous' | 'search' | 'send';
|
|
3113
|
+
/**
|
|
3114
|
+
* Enable spell checking.
|
|
3115
|
+
* @see https://www.mdui.org/en/docs/2/components/text-field#attributes-spellcheck
|
|
3116
|
+
*/
|
|
3117
|
+
'spellcheck'?: boolean;
|
|
3118
|
+
/**
|
|
3119
|
+
* Customizes the virtual keyboard. Possible values:
|
|
3120
|
+
*
|
|
3121
|
+
* * `none`: No virtual keyboard. This is useful for custom input controls.
|
|
3122
|
+
* * `text`: Standard text input keyboard.
|
|
3123
|
+
* * `decimal`: Decimal input keyboard. This includes a period `.` or comma `,` and numbers.
|
|
3124
|
+
* * `numeric`: Numeric keyboard. This displays numbers 0-9.
|
|
3125
|
+
* * `tel`: Phone number keyboard. This includes numbers 0-9, asterisk `*`, and hash `#` keys.
|
|
3126
|
+
* * `search`: Search-optimized virtual keyboard. 'Search' is displayed on the submit button.
|
|
3127
|
+
* * `email`: Email-optimized virtual keyboard. This typically includes `@ .`.
|
|
3128
|
+
* * `url`: URL-optimized virtual keyboard. This typically includes `. / #`.
|
|
3129
|
+
* @see https://www.mdui.org/en/docs/2/components/text-field#attributes-inputmode
|
|
3130
|
+
*/
|
|
3131
|
+
'inputmode'?: 'none' | 'text' | 'decimal' | 'numeric' | 'tel' | 'search' | 'email' | 'url';
|
|
3132
|
+
/**
|
|
3133
|
+
* Determines if the element should be focused when the page loads.
|
|
3134
|
+
* @see https://www.mdui.org/en/docs/2/components/text-field#attributes-autofocus
|
|
3135
|
+
*/
|
|
3136
|
+
'autofocus'?: boolean;
|
|
3137
|
+
/**
|
|
3138
|
+
* Specifies the order in which the element receives focus when navigating with the Tab key.
|
|
3139
|
+
* @see https://www.mdui.org/en/docs/2/components/text-field#attributes-tabindex
|
|
3140
|
+
*/
|
|
3141
|
+
'tabindex'?: number;
|
|
3142
|
+
} & HTMLElementProps;
|
|
3143
|
+
/**
|
|
3144
|
+
* Tooltip Component
|
|
3145
|
+
*
|
|
3146
|
+
* ```html
|
|
3147
|
+
* <mdui-tooltip content="tooltip content">
|
|
3148
|
+
* <mdui-button>button</mdui-button>
|
|
3149
|
+
* </mdui-tooltip>
|
|
3150
|
+
* ```
|
|
3151
|
+
* @see https://www.mdui.org/en/docs/2/components/tooltip
|
|
3152
|
+
*/
|
|
3153
|
+
'mdui-tooltip': {
|
|
3154
|
+
/**
|
|
3155
|
+
* Defines the tooltip shape. Default is `plain`. Possible values:
|
|
3156
|
+
*
|
|
3157
|
+
* * `plain`: For simple single-line text.
|
|
3158
|
+
* * `rich`: For text including a title, body text, and action buttons.
|
|
3159
|
+
* @see https://www.mdui.org/en/docs/2/components/tooltip#attributes-variant
|
|
3160
|
+
*/
|
|
3161
|
+
'variant'?: 'plain' | 'rich';
|
|
3162
|
+
/**
|
|
3163
|
+
* Sets the tooltip position. Default is `auto`. Possible values:
|
|
3164
|
+
*
|
|
3165
|
+
* * `auto`: Position is determined automatically.
|
|
3166
|
+
* * `top-left`: Top-left corner.
|
|
3167
|
+
* * `top-start`: Top, left-aligned.
|
|
3168
|
+
* * `top`: Top, centered.
|
|
3169
|
+
* * `top-end`: Top, right-aligned.
|
|
3170
|
+
* * `top-right`: Top-right corner.
|
|
3171
|
+
* * `bottom-left`: Bottom-left corner.
|
|
3172
|
+
* * `bottom-start`: Bottom, left-aligned.
|
|
3173
|
+
* * `bottom`: Bottom, centered.
|
|
3174
|
+
* * `bottom-end`: Bottom, right-aligned.
|
|
3175
|
+
* * `bottom-right`: Bottom-right corner.
|
|
3176
|
+
* * `left-start`: Left, top-aligned.
|
|
3177
|
+
* * `left`: Left, centered.
|
|
3178
|
+
* * `left-end`: Left, bottom-aligned.
|
|
3179
|
+
* * `right-start`: Right, top-aligned.
|
|
3180
|
+
* * `right`: Right, centered.
|
|
3181
|
+
* * `right-end`: Right, bottom-aligned.
|
|
3182
|
+
* @see https://www.mdui.org/en/docs/2/components/tooltip#attributes-placement
|
|
3183
|
+
*/
|
|
3184
|
+
'placement'?: 'auto' | 'top-left' | 'top-start' | 'top' | 'top-end' | 'top-right' | 'bottom-left' | 'bottom-start' | 'bottom' | 'bottom-end' | 'bottom-right' | 'left-start' | 'left' | 'left-end' | 'right-start' | 'right' | 'right-end';
|
|
3185
|
+
/**
|
|
3186
|
+
* Sets the delay in milliseconds before the tooltip appears on hover.
|
|
3187
|
+
* @see https://www.mdui.org/en/docs/2/components/tooltip#attributes-open-delay
|
|
3188
|
+
*/
|
|
3189
|
+
'open-delay'?: number;
|
|
3190
|
+
/**
|
|
3191
|
+
* Sets the delay in milliseconds before the tooltip disappears on hover.
|
|
3192
|
+
* @see https://www.mdui.org/en/docs/2/components/tooltip#attributes-close-delay
|
|
3193
|
+
*/
|
|
3194
|
+
'close-delay'?: number;
|
|
3195
|
+
/**
|
|
3196
|
+
* Sets the tooltip title. Only applicable when `variant="rich"`. Alternatively, use `slot="headline"`.
|
|
3197
|
+
* @see https://www.mdui.org/en/docs/2/components/tooltip#attributes-headline
|
|
3198
|
+
*/
|
|
3199
|
+
'headline'?: string;
|
|
3200
|
+
/**
|
|
3201
|
+
* Sets the tooltip content. Alternatively, use `slot="content"`.
|
|
3202
|
+
* @see https://www.mdui.org/en/docs/2/components/tooltip#attributes-content
|
|
3203
|
+
*/
|
|
3204
|
+
'content'?: string;
|
|
3205
|
+
/**
|
|
3206
|
+
* Defines the trigger method. Supports multiple values separated by spaces. Possible values:
|
|
3207
|
+
*
|
|
3208
|
+
* * `click`: Triggered on click.
|
|
3209
|
+
* * `hover`: Triggered on mouse hover.
|
|
3210
|
+
* * `focus`: Triggered on focus.
|
|
3211
|
+
* * `manual`: Can only open and close the tooltip programmatically, cannot specify other trigger methods.
|
|
3212
|
+
* @see https://www.mdui.org/en/docs/2/components/tooltip#attributes-trigger
|
|
3213
|
+
*/
|
|
3214
|
+
'trigger'?: 'click' | 'hover' | 'focus' | 'manual' | string;
|
|
3215
|
+
/**
|
|
3216
|
+
* Disables the tooltip.
|
|
3217
|
+
* @see https://www.mdui.org/en/docs/2/components/tooltip#attributes-disabled
|
|
3218
|
+
*/
|
|
3219
|
+
'disabled'?: boolean;
|
|
3220
|
+
/**
|
|
3221
|
+
* Opens the tooltip.
|
|
3222
|
+
* @see https://www.mdui.org/en/docs/2/components/tooltip#attributes-open
|
|
3223
|
+
*/
|
|
3224
|
+
'open'?: boolean;
|
|
3225
|
+
} & HTMLElementProps;
|
|
3226
|
+
/**
|
|
3227
|
+
* Top App Bar Component
|
|
3228
|
+
*
|
|
3229
|
+
* ```html
|
|
3230
|
+
* <mdui-top-app-bar>
|
|
3231
|
+
* <mdui-button-icon icon="menu"></mdui-button-icon>
|
|
3232
|
+
* <mdui-top-app-bar-title>Title</mdui-top-app-bar-title>
|
|
3233
|
+
* <div style="flex-grow: 1"></div>
|
|
3234
|
+
* <mdui-button-icon icon="more_vert"></mdui-button-icon>
|
|
3235
|
+
* </mdui-top-app-bar>
|
|
3236
|
+
* ```
|
|
3237
|
+
* @see https://www.mdui.org/en/docs/2/components/top-app-bar
|
|
3238
|
+
*/
|
|
3239
|
+
'mdui-top-app-bar': {
|
|
3240
|
+
/**
|
|
3241
|
+
* Defines the top app bar style. Default is `small`. Possible values:
|
|
3242
|
+
*
|
|
3243
|
+
* * `center-aligned`: Small app bar with a center-aligned title.
|
|
3244
|
+
* * `small`: Small app bar.
|
|
3245
|
+
* * `medium`: Medium-sized app bar.
|
|
3246
|
+
* * `large`: Large-sized app bar.
|
|
3247
|
+
* @see https://www.mdui.org/en/docs/2/components/top-app-bar#top-app-bar-attributes-variant
|
|
3248
|
+
*/
|
|
3249
|
+
'variant'?: 'center-aligned' | 'small' | 'medium' | 'large';
|
|
3250
|
+
/**
|
|
3251
|
+
* Hide the top app bar.
|
|
3252
|
+
* @see https://www.mdui.org/en/docs/2/components/top-app-bar#top-app-bar-attributes-hide
|
|
3253
|
+
*/
|
|
3254
|
+
'hide'?: boolean;
|
|
3255
|
+
/**
|
|
3256
|
+
* Shrinks the app bar to `small` style. Only applicable for `medium` or `large` variants.
|
|
3257
|
+
* @see https://www.mdui.org/en/docs/2/components/top-app-bar#top-app-bar-attributes-shrink
|
|
3258
|
+
*/
|
|
3259
|
+
'shrink'?: boolean;
|
|
3260
|
+
/**
|
|
3261
|
+
* Defines the scroll behavior. Accepts multiple space-separated values. Possible values:
|
|
3262
|
+
*
|
|
3263
|
+
* * `hide`: Hides when scrolling.
|
|
3264
|
+
* * `shrink`: Shrinks when scrolling for medium to large app bars.
|
|
3265
|
+
* * `elevate`: Increases elevation when scrolling.
|
|
3266
|
+
* @see https://www.mdui.org/en/docs/2/components/top-app-bar#top-app-bar-attributes-scroll-behavior
|
|
3267
|
+
*/
|
|
3268
|
+
'scroll-behavior'?: 'hide' | 'shrink' | 'elevate';
|
|
3269
|
+
/**
|
|
3270
|
+
* 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`.
|
|
3271
|
+
* @see https://www.mdui.org/en/docs/2/components/top-app-bar#top-app-bar-attributes-scroll-target
|
|
3272
|
+
*/
|
|
3273
|
+
'scroll-target'?: string | HTMLElement | JQ<HTMLElement>;
|
|
3274
|
+
/**
|
|
3275
|
+
* The scroll distance (in pixels) that triggers the scroll behavior.
|
|
3276
|
+
* @see https://www.mdui.org/en/docs/2/components/top-app-bar#top-app-bar-attributes-scroll-threshold
|
|
3277
|
+
*/
|
|
3278
|
+
'scroll-threshold'?: number;
|
|
3279
|
+
/**
|
|
3280
|
+
* 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`.
|
|
3281
|
+
* @see https://www.mdui.org/en/docs/2/components/top-app-bar#top-app-bar-attributes-order
|
|
3282
|
+
*/
|
|
3283
|
+
'order'?: number;
|
|
3284
|
+
} & HTMLElementProps;
|
|
3285
|
+
/**
|
|
3286
|
+
* Top App Bar Title Component It should be used in conjunction with the `<mdui-top-app-bar>` component
|
|
3287
|
+
*
|
|
3288
|
+
* ```html
|
|
3289
|
+
* <mdui-top-app-bar>
|
|
3290
|
+
* <mdui-button-icon icon="menu"></mdui-button-icon>
|
|
3291
|
+
* <mdui-top-app-bar-title>Title</mdui-top-app-bar-title>
|
|
3292
|
+
* <div style="flex-grow: 1"></div>
|
|
3293
|
+
* <mdui-button-icon icon="more_vert"></mdui-button-icon>
|
|
3294
|
+
* </mdui-top-app-bar>
|
|
3295
|
+
* ```
|
|
3296
|
+
* @see https://www.mdui.org/en/docs/2/components/top-app-bar
|
|
3297
|
+
*/
|
|
3298
|
+
'mdui-top-app-bar-title': {
|
|
3299
|
+
|
|
3300
|
+
} & HTMLElementProps;
|
|
3301
|
+
}
|
|
3302
|
+
}
|
|
3303
|
+
}
|