@tylertech/forge 3.8.2-dev.0 → 3.9.0-dev.0
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/custom-elements.json +10454 -10067
- package/dist/lib.js +18 -18
- package/dist/lib.js.map +3 -3
- package/dist/toolbar/forge-toolbar.css +1 -0
- package/dist/vscode.css-custom-data.json +946 -946
- package/dist/vscode.html-custom-data.json +618 -558
- package/esm/calendar/calendar-adapter.d.ts +24 -0
- package/esm/calendar/calendar-adapter.js +67 -1
- package/esm/calendar/calendar-constants.d.ts +34 -0
- package/esm/calendar/calendar-constants.js +33 -0
- package/esm/calendar/calendar-core.d.ts +60 -0
- package/esm/calendar/calendar-core.js +220 -2
- package/esm/calendar/calendar-dom-utils.d.ts +6 -0
- package/esm/calendar/calendar-dom-utils.js +36 -0
- package/esm/calendar/calendar.d.ts +40 -1
- package/esm/calendar/calendar.js +80 -2
- package/esm/calendar/core/calendar-base.d.ts +3 -0
- package/esm/calendar/core/date-range.d.ts +2 -0
- package/esm/calendar/core/date-range.js +1 -0
- package/esm/date-picker/base/base-date-picker-adapter.js +0 -3
- package/esm/date-picker/base/base-date-picker-constants.d.ts +3 -0
- package/esm/date-picker/base/base-date-picker-constants.js +3 -0
- package/esm/date-picker/base/base-date-picker-core.d.ts +15 -0
- package/esm/date-picker/base/base-date-picker-core.js +30 -0
- package/esm/date-picker/base/base-date-picker.d.ts +12 -0
- package/esm/date-picker/base/base-date-picker.js +24 -0
- package/esm/date-picker/date-picker-core.d.ts +3 -0
- package/esm/date-picker/date-picker-core.js +20 -0
- package/esm/date-range-picker/date-range-picker-constants.d.ts +3 -0
- package/esm/date-range-picker/date-range-picker-constants.js +1 -0
- package/esm/date-range-picker/date-range-picker-core.d.ts +3 -0
- package/esm/date-range-picker/date-range-picker-core.js +62 -2
- package/esm/date-range-picker/date-range-picker.d.ts +3 -0
- package/esm/date-range-picker/date-range-picker.js +3 -0
- package/esm/split-view/split-view-panel/split-view-panel.js +1 -1
- package/esm/tabs/tab-bar/tab-bar-core.d.ts +1 -0
- package/esm/tabs/tab-bar/tab-bar-core.js +27 -30
- package/esm/toolbar/toolbar.js +1 -1
- package/package.json +1 -1
- package/sass/calendar/_mixins.scss +3 -2
- package/sass/toolbar/_core.scss +5 -0
- package/sass/toolbar/toolbar.scss +4 -0
|
@@ -14,6 +14,29 @@
|
|
|
14
14
|
],
|
|
15
15
|
"references": []
|
|
16
16
|
},
|
|
17
|
+
{
|
|
18
|
+
"name": "forge-backdrop",
|
|
19
|
+
"description": "\n---\n\n\n### **Methods:**\n - **show(): _void_** - Immediately shows the backdrop by setting the `visibility` to `true` without animations.\n- **hide(): _void_** - Immediately hides the backdrop by setting the `visibility` to `false` without animations.\n- **fadeIn(): _Promise<void>_** - Sets the `visibility` to `true` and animates in.\n- **fadeOut(): _Promise<void>_** - Sets the `visibility` to `false` and animates out.\n\n### **CSS Properties:**\n - **--forge-backdrop-background** - The backdrop background color. _(default: undefined)_\n- **--forge-backdrop-opacity** - The backdrop opacity. _(default: undefined)_\n- **--forge-backdrop-z-index** - The backdrop z-index. _(default: undefined)_\n- **--forge-backdrop-enter-animation-duration** - The animation duration for the enter animation. _(default: undefined)_\n- **--forge-backdrop-enter-animation-easing** - The animation easing for the enter animation. _(default: undefined)_\n- **--forge-backdrop-exit-animation-duration** - The animation duration for the exit animation. _(default: undefined)_\n- **--forge-backdrop-exit-animation-easing** - The animation easing for the exit animation. _(default: undefined)_\n\n### **CSS Parts:**\n - **root** - The root element of the backdrop.",
|
|
20
|
+
"attributes": [
|
|
21
|
+
{
|
|
22
|
+
"name": "visible",
|
|
23
|
+
"description": "Whether the backdrop is visible.",
|
|
24
|
+
"values": []
|
|
25
|
+
},
|
|
26
|
+
{
|
|
27
|
+
"name": "fixed",
|
|
28
|
+
"description": "Whether the backdrop uses \"fixed\" or \"relative\" positioning.",
|
|
29
|
+
"values": []
|
|
30
|
+
}
|
|
31
|
+
],
|
|
32
|
+
"references": []
|
|
33
|
+
},
|
|
34
|
+
{
|
|
35
|
+
"name": "forge-badge",
|
|
36
|
+
"description": "\n---\n\n\n### **Slots:**\n - _default_ - Default content placed inside the badge.\n- **start** - Content placed before the default content.\n- **end** - Content placed after the default content.\n\n### **CSS Properties:**\n - **--forge-badge-background** - The background color. _(default: undefined)_\n- **--forge-badge-color** - The text color. _(default: undefined)_\n- **--forge-badge-shape** - The shape radius. _(default: undefined)_\n- **--forge-badge-padding-inline** - The inline padding. _(default: undefined)_\n- **--forge-badge-padding-block** - The block padding. _(default: undefined)_\n- **--forge-badge-border-width** - The border width. _(default: undefined)_\n- **--forge-badge-border-color** - The border color. _(default: undefined)_\n- **--forge-badge-border-style** - The border style. _(default: undefined)_\n- **--forge-badge-gap** - The spacing between the content within the badge. _(default: undefined)_",
|
|
37
|
+
"attributes": [],
|
|
38
|
+
"references": []
|
|
39
|
+
},
|
|
17
40
|
{
|
|
18
41
|
"name": "forge-autocomplete",
|
|
19
42
|
"description": "\n---\n\n\n### **Events:**\n - **forge-autocomplete-change** - Fired when the value changes.\n- **forge-autocomplete-select** - Fired when an option is selected. Only applies when in \"stateless\" `mode`.\n- **forge-autocomplete-scrolled-bottom** - Fired when the dropdown is scrolled to the bottom. Only applies when `observe-scroll` is enabled.\n\n### **Methods:**\n - **appendOptions(options: _IAutocompleteOption[] | IAutocompleteOptionGroup[]_): _void_** - Adds options to the dropdown while it is open. Has no effect if the dropdown is closed.\n- **openDropdown(): _void_** - Opens the dropdown.\n- **closeDropdown(): _void_** - Closes the dropdown.\n- **forceFilter(opts: _IAutocompleteForceFilterOptions_): _void_** - Forces the filter callback to be executed to update the current selection state with new options.",
|
|
@@ -149,28 +172,27 @@
|
|
|
149
172
|
"references": []
|
|
150
173
|
},
|
|
151
174
|
{
|
|
152
|
-
"name": "forge-
|
|
153
|
-
"description": "
|
|
175
|
+
"name": "forge-banner",
|
|
176
|
+
"description": "Banners are used to inform users of important information, such as errors, warnings, or success messages.\n---\n\n\n### **Events:**\n - **forge-banner-before-dismiss** - Dispatched before the banner is dismissed. Cancelable to prevent dismissal.\n- **forge-banner-dismissed** - Dispatched when the banner is dismissed.\n\n### **Slots:**\n - _default_ - The content of the banner.\n- **icon** - The icon to display.\n- **button** - The optional button to display.\n\n### **CSS Properties:**\n - **--forge-banner-background** - The background color of the banner. _(default: undefined)_\n- **--forge-banner-color** - The text color of the banner. _(default: undefined)_\n- **--forge-banner-icon-color** - The color of the icon. _(default: undefined)_\n- **--forge-banner-gap** - The gap between the contents. _(default: undefined)_\n- **--forge-banner-padding-inline** - The inline padding. _(default: undefined)_\n- **--forge-banner-padding-block** - The block padding. _(default: undefined)_\n- **--forge-banner-transition-duration** - The transition duration. _(default: undefined)_\n- **--forge-banner-transition-easing** - The transition easing function. _(default: undefined)_",
|
|
154
177
|
"attributes": [
|
|
155
178
|
{
|
|
156
|
-
"name": "
|
|
157
|
-
"description": "
|
|
179
|
+
"name": "dismissed",
|
|
180
|
+
"description": "Controls the visibility of the banner.",
|
|
158
181
|
"values": []
|
|
159
182
|
},
|
|
160
183
|
{
|
|
161
|
-
"name": "
|
|
162
|
-
"description": "
|
|
184
|
+
"name": "persistent",
|
|
185
|
+
"description": "Controls the visibility of the built-in dismiss button.",
|
|
163
186
|
"values": []
|
|
187
|
+
},
|
|
188
|
+
{
|
|
189
|
+
"name": "theme",
|
|
190
|
+
"description": "The theme of the banner.",
|
|
191
|
+
"values": [{ "name": "BannerTheme" }]
|
|
164
192
|
}
|
|
165
193
|
],
|
|
166
194
|
"references": []
|
|
167
195
|
},
|
|
168
|
-
{
|
|
169
|
-
"name": "forge-badge",
|
|
170
|
-
"description": "\n---\n\n\n### **Slots:**\n - _default_ - Default content placed inside the badge.\n- **start** - Content placed before the default content.\n- **end** - Content placed after the default content.\n\n### **CSS Properties:**\n - **--forge-badge-background** - The background color. _(default: undefined)_\n- **--forge-badge-color** - The text color. _(default: undefined)_\n- **--forge-badge-shape** - The shape radius. _(default: undefined)_\n- **--forge-badge-padding-inline** - The inline padding. _(default: undefined)_\n- **--forge-badge-padding-block** - The block padding. _(default: undefined)_\n- **--forge-badge-border-width** - The border width. _(default: undefined)_\n- **--forge-badge-border-color** - The border color. _(default: undefined)_\n- **--forge-badge-border-style** - The border style. _(default: undefined)_\n- **--forge-badge-gap** - The spacing between the content within the badge. _(default: undefined)_",
|
|
171
|
-
"attributes": [],
|
|
172
|
-
"references": []
|
|
173
|
-
},
|
|
174
196
|
{
|
|
175
197
|
"name": "forge-bottom-sheet",
|
|
176
198
|
"description": "Bottom sheets slide up from the bottom of the screen to reveal more content and/or actions that the user can take.\n---\n\n\n### **Events:**\n - **forge-bottom-sheet-before-close** - Fires before the bottom sheet closes.\n- **forge-bottom-sheet-close** - Fires after the bottom sheet closes.\n- **forge-bottom-sheet-open** - Fires after the bottom sheet opens.\n- **forge-bottom-sheet-drag-start** - Fires when the bottom sheet starts to be dragged.\n- **forge-bottom-sheet-dragged** - Fires when the bottom sheet is dragged.\n- **forge-bottom-sheet-drag-end** - Fires when the bottom sheet drag ends.\n- **forge-bottom-sheet-drag-cancel** - Fires when the bottom sheet drag is cancelled.\n- **forge-bottom-sheet-fullscreen** - Fires when the bottom sheet is toggled to fullscreen.\n\n### **Slots:**\n - _default_ - The content of the bottom sheet. This is a passthrough slot to the dialog surface.\n\n### **CSS Properties:**\n - **--forge-bottom-sheet-desktop-max-width** - The maximum width of the bottom sheet on desktop. _(default: undefined)_\n- **--forge-bottom-sheet-desktop-min-width** - The minimum width of the bottom sheet on desktop. _(default: undefined)_\n- **--forge-bottom-sheet-animation-duration** - The duration of the bottom sheet animation to fullscreen. _(default: undefined)_\n- **--forge-bottom-sheet-animation-timing** - The timing function of the bottom sheet animation to fullscreen. _(default: undefined)_\n\n### **CSS Parts:**\n - **root** - The root element of the bottom sheet.\n- **surface** - The surface element of the bottom sheet within th dialog.",
|
|
@@ -198,28 +220,6 @@
|
|
|
198
220
|
],
|
|
199
221
|
"references": []
|
|
200
222
|
},
|
|
201
|
-
{
|
|
202
|
-
"name": "forge-banner",
|
|
203
|
-
"description": "Banners are used to inform users of important information, such as errors, warnings, or success messages.\n---\n\n\n### **Events:**\n - **forge-banner-before-dismiss** - Dispatched before the banner is dismissed. Cancelable to prevent dismissal.\n- **forge-banner-dismissed** - Dispatched when the banner is dismissed.\n\n### **Slots:**\n - _default_ - The content of the banner.\n- **icon** - The icon to display.\n- **button** - The optional button to display.\n\n### **CSS Properties:**\n - **--forge-banner-background** - The background color of the banner. _(default: undefined)_\n- **--forge-banner-color** - The text color of the banner. _(default: undefined)_\n- **--forge-banner-icon-color** - The color of the icon. _(default: undefined)_\n- **--forge-banner-gap** - The gap between the contents. _(default: undefined)_\n- **--forge-banner-padding-inline** - The inline padding. _(default: undefined)_\n- **--forge-banner-padding-block** - The block padding. _(default: undefined)_\n- **--forge-banner-transition-duration** - The transition duration. _(default: undefined)_\n- **--forge-banner-transition-easing** - The transition easing function. _(default: undefined)_",
|
|
204
|
-
"attributes": [
|
|
205
|
-
{
|
|
206
|
-
"name": "dismissed",
|
|
207
|
-
"description": "Controls the visibility of the banner.",
|
|
208
|
-
"values": []
|
|
209
|
-
},
|
|
210
|
-
{
|
|
211
|
-
"name": "persistent",
|
|
212
|
-
"description": "Controls the visibility of the built-in dismiss button.",
|
|
213
|
-
"values": []
|
|
214
|
-
},
|
|
215
|
-
{
|
|
216
|
-
"name": "theme",
|
|
217
|
-
"description": "The theme of the banner.",
|
|
218
|
-
"values": [{ "name": "BannerTheme" }]
|
|
219
|
-
}
|
|
220
|
-
],
|
|
221
|
-
"references": []
|
|
222
|
-
},
|
|
223
223
|
{
|
|
224
224
|
"name": "forge-button",
|
|
225
225
|
"description": "Buttons represent actions that a user can take.\n---\n\n\n### **Events:**\n - **click** - Fires when the button is clicked.\n\n### **Methods:**\n - **click(): _void_** - Clicks the button.\n- **focus(options: _ExperimentalFocusOptions_): _void_** - Focuses the button.\n\n### **Slots:**\n - _default_ - This is a default/unnamed slot for the label text.\n- **start** - Elements to logically render before the label text.\n- **end** - Elements to logically render after the label text.\n\n### **CSS Properties:**\n - **--forge-button-primary-color** - The primary color of the button. _(default: undefined)_\n- **--forge-button-text-color** - The text color of the button. Inherits from primary color. _(default: undefined)_\n- **--forge-button-disabled-color** - The disabled color of the button. _(default: undefined)_\n- **--forge-button-padding** - The padding of the button. _(default: undefined)_\n- **--forge-button-display** - The display of the button. _(default: undefined)_\n- **--forge-button-justify** - The flex justify of the button. _(default: undefined)_\n- **--forge-button-shape** - The shape of the button. _(default: undefined)_\n- **--forge-button-height** - The height of the button. _(default: undefined)_\n- **--forge-button-min-width** - The min-width of the button. _(default: undefined)_\n- **--forge-button-spacing** - The spacing of the button. _(default: undefined)_\n- **--forge-button-border-width** - The border-width of the button. _(default: undefined)_\n- **--forge-button-border-style** - The border style of the button. _(default: undefined)_\n- **--forge-button-border-color** - The border color of the button. _(default: undefined)_\n- **--forge-button-shape-start-start-radius** - The shape start start radius of the button. _(default: undefined)_\n- **--forge-button-shape-start-end-radius** - The shape start end radius of the button. _(default: undefined)_\n- **--forge-button-shape-end-start-radius** - The shape end start radius of the button. _(default: undefined)_\n- **--forge-button-shape-end-end-radius** - The shape end end radius of the button. _(default: undefined)_\n- **--forge-button-padding-block** - The padding block of the button. _(default: undefined)_\n- **--forge-button-padding-inline** - The padding inline of the button. _(default: undefined)_\n- **--forge-button-background** - The background color of the button. _(default: undefined)_\n- **--forge-button-hover-background** - The background color of the button on hover. _(default: undefined)_\n- **--forge-button-active-background** - The background color of the button on active state. _(default: undefined)_\n- **--forge-button-color** - The text color of the button. _(default: undefined)_\n- **--forge-button-icon-size** - The size of the icon in the button. _(default: undefined)_\n- **--forge-button-shadow** - The shadow of the button. _(default: undefined)_\n- **--forge-button-hover-shadow** - The shadow of the button on hover. _(default: undefined)_\n- **--forge-button-active-shadow** - The shadow of the button on active state. _(default: undefined)_\n- **--forge-button-cursor** - The cursor type of the button. _(default: undefined)_\n- **--forge-button-transition-duration** - The transition duration of the button. _(default: undefined)_\n- **--forge-button-transition-timing** - The transition timing of the button. _(default: undefined)_\n- **--forge-button-text-padding-inline** - The inline padding of the button when using the text variant. _(default: undefined)_\n- **--forge-button-filled-background** - The background color of the filled button. _(default: undefined)_\n- **--forge-button-filled-disabled-background** - The background color of the disabled filled button. _(default: undefined)_\n- **--forge-button-filled-color** - The text color of the filled button. _(default: undefined)_\n- **--forge-button-filled-disabled-color** - The text color of the disabled filled button. _(default: undefined)_\n- **--forge-button-raised-background** - The background color of the raised button. _(default: undefined)_\n- **--forge-button-raised-disabled-background** - The background color of the disabled raised button. _(default: undefined)_\n- **--forge-button-raised-color** - The text color of the raised button. _(default: undefined)_\n- **--forge-button-raised-disabled-color** - The text color of the disabled raised button. _(default: undefined)_\n- **--forge-button-raised-shadow** - The shadow of the raised button. _(default: undefined)_\n- **--forge-button-raised-hover-shadow** - The shadow of the raised button on hover. _(default: undefined)_\n- **--forge-button-raised-active-shadow** - The shadow of the raised button on active state. _(default: undefined)_\n- **--forge-button-raised-disabled-shadow** - The shadow of the disabled raised button. _(default: undefined)_\n- **--forge-button-flat-background** - The background color of the flat button. _(default: undefined)_\n- **--forge-button-flat-disabled-background** - The background color of the disabled flat button. _(default: undefined)_\n- **--forge-button-flat-color** - The text color of the flat button. _(default: undefined)_\n- **--forge-button-flat-disabled-color** - The text color of the disabled flat button. _(default: undefined)_\n- **--forge-button-outlined-background** - The background color of the outlined button. _(default: undefined)_\n- **--forge-button-outlined-color** - The text color of the outlined button. _(default: undefined)_\n- **--forge-button-outlined-border-width** - The border width of the outlined button. _(default: undefined)_\n- **--forge-button-outlined-border-style** - The border style of the outlined button. _(default: undefined)_\n- **--forge-button-outlined-border-color** - The border color of the outlined button. _(default: undefined)_\n- **--forge-button-link-color** - The text color of the link button. _(default: undefined)_\n- **--forge-button-link-text-decoration** - The text decoration of the link button. _(default: undefined)_\n- **--forge-button-link-height** - The height of the link button. _(default: undefined)_\n- **--forge-button-link-padding** - The padding of the link button. _(default: undefined)_\n- **--forge-button-link-line-height** - The line height of the link button. _(default: undefined)_\n- **--forge-button-link-width** - The width of the link button. _(default: undefined)_\n- **--forge-button-link-hover-text-decoration** - The text decoration of the link button on hover. _(default: undefined)_\n- **--forge-button-link-active-opacity** - The opacity of the link button on active state. _(default: undefined)_\n- **--forge-button-link-transition-duration** - The transition duration of the link button. _(default: undefined)_\n- **--forge-button-link-transition-timing** - The transition timing of the link button. _(default: undefined)_\n- **--forge-button-disabled-cursor** - The cursor type of the disabled button. _(default: undefined)_\n- **--forge-button-disabled-text-color** - The text color of the disabled button. _(default: undefined)_\n- **--forge-button-disabled-background** - The background color of the disabled button. _(default: undefined)_\n- **--forge-button-disabled-border-color** - The border color of the disabled button. _(default: undefined)_\n- **--forge-button-disabled-shadow** - The shadow of the disabled button. _(default: undefined)_\n- **--forge-button-dense-height** - The height of the dense button. _(default: undefined)_\n- **--forge-button-pill-shape** - The shape of the pill button. _(default: undefined)_\n- **--forge-button-pill-padding-inline** - The inline padding of the pill button. _(default: undefined)_\n\n### **CSS Parts:**\n - **root** - The root container element.\n- **focus-indicator** - The focus-indicator indicator element.\n- **state-layer** - The state-layer surface element.",
|
|
@@ -291,7 +291,7 @@
|
|
|
291
291
|
},
|
|
292
292
|
{
|
|
293
293
|
"name": "forge-calendar",
|
|
294
|
-
"description": "\n---\n\n\n### **Events:**\n - **forge-calendar-date-select** - Event fired when a date is selected.\n- **forge-calendar-focus-change** - Event fired when the focus changes.\n- **forge-calendar-month-change** - Event fired when the month changes.\n- **forge-calendar-view-change** - Event fired when the view changes.\n\n### **Methods:**\n - **clear(): _void_** - Clears the selected date(s).\n- **deselectDate(date: _Date_): _void_** - Deselects a date.\n- **goToDate(date: _Date_, setFocus: _boolean_): _void_** - Navigates to a specific date.\n- **handleKey(evt: _KeyboardEvent_): _void_** - Handles a keyboard event.\n- **layout(): _void_** - Lays out the calendar.\n- **selectDate(date: _Date_): _void_** - Selects a date.\n- **setActiveDate(date: _Date_, setFocus: _boolean_): _boolean_** - Sets the active date.\n- **today(): _void_** - Sets the calendar to today.\n- **toggleDate(date: _Date_, force: _boolean_): _void_** - Toggles a date selection.\n\n### **Slots:**\n - **today-button-text** - Text to display in the today button.\n- **clear-button-text** - Text to display in the clear button.\n- **next-month-button-text** - Text to display in the next month button's tooltip.\n- **previous-month-button-text** - Text to display in the previous month button's tooltip.\n- **next-year-button-text** - Text to display in the next year button's tooltip.\n- **previous-year-button-text** - Text to display in the previous year button's tooltip.\n- **next-years-button-text** - Text to display in the next years button's tooltip.\n- **previous-years-button-text** - Text to display in the previous years button's tooltip.",
|
|
294
|
+
"description": "\n---\n\n\n### **Events:**\n - **forge-calendar-date-select** - Event fired when a date is selected.\n- **forge-calendar-focus-change** - Event fired when the focus changes.\n- **forge-calendar-month-change** - Event fired when the month changes.\n- **forge-calendar-view-change** - Event fired when the view changes.\n\n### **Methods:**\n - **clear(): _void_** - Clears the selected date(s).\n- **deselectDate(date: _Date_): _void_** - Deselects a date.\n- **goToDate(date: _Date_, setFocus: _boolean_): _void_** - Navigates to a specific date.\n- **handleKey(evt: _KeyboardEvent_): _void_** - Handles a keyboard event.\n- **layout(): _void_** - Lays out the calendar.\n- **selectDate(date: _Date_): _void_** - Selects a date.\n- **setActiveDate(date: _Date_, setFocus: _boolean_): _boolean_** - Sets the active date.\n- **today(): _void_** - Sets the calendar to today.\n- **toggleDate(date: _Date_, force: _boolean_): _void_** - Toggles a date selection.\n\n### **Slots:**\n - **today-button-text** - Text to display in the today button.\n- **yesterday-button-text** - Text to display in the yesterday button.\n- **last-seven-days-button-text** - Text to display in the last seven days button.\n- **last-thirty-days-button-text** - Text to display in the last thirty days button.\n- **clear-button-text** - Text to display in the clear button.\n- **next-month-button-text** - Text to display in the next month button's tooltip.\n- **previous-month-button-text** - Text to display in the previous month button's tooltip.\n- **next-year-button-text** - Text to display in the next year button's tooltip.\n- **previous-year-button-text** - Text to display in the previous year button's tooltip.\n- **next-years-button-text** - Text to display in the next years button's tooltip.\n- **previous-years-button-text** - Text to display in the previous years button's tooltip.",
|
|
295
295
|
"attributes": [
|
|
296
296
|
{
|
|
297
297
|
"name": "allow-single-date-range",
|
|
@@ -388,6 +388,36 @@
|
|
|
388
388
|
"description": "Whether to show a button to select today.",
|
|
389
389
|
"values": []
|
|
390
390
|
},
|
|
391
|
+
{
|
|
392
|
+
"name": "show-yesterday",
|
|
393
|
+
"description": "Whether to show the yesterday button.",
|
|
394
|
+
"values": []
|
|
395
|
+
},
|
|
396
|
+
{
|
|
397
|
+
"name": "yesterday-button",
|
|
398
|
+
"description": "Whether to show a button to select yesterday.",
|
|
399
|
+
"values": []
|
|
400
|
+
},
|
|
401
|
+
{
|
|
402
|
+
"name": "show-last-seven-days",
|
|
403
|
+
"description": "Whether to show the last seven days button.",
|
|
404
|
+
"values": []
|
|
405
|
+
},
|
|
406
|
+
{
|
|
407
|
+
"name": "last-seven-days-button",
|
|
408
|
+
"description": "Whether to show a button to select last seven days.",
|
|
409
|
+
"values": []
|
|
410
|
+
},
|
|
411
|
+
{
|
|
412
|
+
"name": "show-last-thirty-days",
|
|
413
|
+
"description": "Whether to show the last thirty days button.",
|
|
414
|
+
"values": []
|
|
415
|
+
},
|
|
416
|
+
{
|
|
417
|
+
"name": "last-thirty-days-button",
|
|
418
|
+
"description": "Whether to show a button to select last thirty days.",
|
|
419
|
+
"values": []
|
|
420
|
+
},
|
|
391
421
|
{
|
|
392
422
|
"name": "view",
|
|
393
423
|
"description": "The view of the calendar.",
|
|
@@ -677,6 +707,21 @@
|
|
|
677
707
|
"description": "Whether the today button is visible in the popup.",
|
|
678
708
|
"values": []
|
|
679
709
|
},
|
|
710
|
+
{
|
|
711
|
+
"name": "show-yesterday",
|
|
712
|
+
"description": "Whether the yesterday button is visible in the popup.",
|
|
713
|
+
"values": []
|
|
714
|
+
},
|
|
715
|
+
{
|
|
716
|
+
"name": "show-last-seven-days",
|
|
717
|
+
"description": "Whether the last seven days button is visible in the popup.",
|
|
718
|
+
"values": []
|
|
719
|
+
},
|
|
720
|
+
{
|
|
721
|
+
"name": "show-last-thirty-days",
|
|
722
|
+
"description": "Whether the last thirty days button is visible in the popup.",
|
|
723
|
+
"values": []
|
|
724
|
+
},
|
|
680
725
|
{
|
|
681
726
|
"name": "value-mode",
|
|
682
727
|
"description": "The type for the `value` property and `forge-date-picker-change` event.",
|
|
@@ -756,6 +801,21 @@
|
|
|
756
801
|
"description": "Whether the today button is visible in the popup.",
|
|
757
802
|
"values": []
|
|
758
803
|
},
|
|
804
|
+
{
|
|
805
|
+
"name": "show-yesterday",
|
|
806
|
+
"description": "Whether the yesterday button is visible in the popup.",
|
|
807
|
+
"values": []
|
|
808
|
+
},
|
|
809
|
+
{
|
|
810
|
+
"name": "show-last-seven-days",
|
|
811
|
+
"description": "Whether the last seven days button is visible in the popup.",
|
|
812
|
+
"values": []
|
|
813
|
+
},
|
|
814
|
+
{
|
|
815
|
+
"name": "show-last-thirty-days",
|
|
816
|
+
"description": "Whether the last thirty days button is visible in the popup.",
|
|
817
|
+
"values": []
|
|
818
|
+
},
|
|
759
819
|
{
|
|
760
820
|
"name": "value-mode",
|
|
761
821
|
"description": "The type for the `value` property and `forge-date-picker-change` event.",
|
|
@@ -765,18 +825,6 @@
|
|
|
765
825
|
],
|
|
766
826
|
"references": []
|
|
767
827
|
},
|
|
768
|
-
{
|
|
769
|
-
"name": "forge-divider",
|
|
770
|
-
"description": "Divider is used to separate elements.\n---\n\n\n### **CSS Properties:**\n - **--forge-divider-color** - The color of the divider. _(default: undefined)_\n- **--forge-divider-width** - The width of the divider. _(default: undefined)_\n- **--forge-divider-border-style** - The border-style (dashed, solid) of the divider. _(default: undefined)_\n- **--forge-divider-margin** - The margin of divider. _(default: undefined)_\n\n### **CSS Parts:**\n - **root** - The root container element.",
|
|
771
|
-
"attributes": [
|
|
772
|
-
{
|
|
773
|
-
"name": "vertical",
|
|
774
|
-
"description": "Controls if the divider is displayed vertically or horizontally.",
|
|
775
|
-
"values": []
|
|
776
|
-
}
|
|
777
|
-
],
|
|
778
|
-
"references": []
|
|
779
|
-
},
|
|
780
828
|
{
|
|
781
829
|
"name": "forge-dialog",
|
|
782
830
|
"description": "Dialogs are temporary UI elements that are used to display information, ask for input, or confirm actions.\n---\n\n\n### **Events:**\n - **forge-dialog-open** - Dispatched when the dialog is opened.\n- **forge-dialog-close** - Dispatched when the dialog is closed.\n- **forge-dialog-before-close** - Dispatched before the dialog is closed. This event is cancelable.\n- **forge-dialog-move-start** - Dispatched when the dialog is first moved.\n- **forge-dialog-move** - Dispatched when the dialog is being moved.\n- **forge-dialog-move-end** - Dispatched when the dialog is done being moved.\n- **forge-dialog-fullscreen-change** - Dispatched when the dialog's fullscreen state changes.\n\n### **Methods:**\n - **show(): _void_** - Shows the dialog.\n- **hide(): _void_** - Hides the dialog.\n\n### **Slots:**\n - _default_ - The content of the dialog.\n- **move-handle** - The move handle content.\n\n### **CSS Properties:**\n - **--forge-dialog-background** - The background color of the dialog. _(default: undefined)_\n- **--forge-dialog-shape** - The shape of the dialog. _(default: undefined)_\n- **--forge-dialog-elevation** - The elevation of the dialog. _(default: undefined)_\n- **--forge-dialog-spacing** - The spacing between elements inside the dialog. _(default: undefined)_\n- **--forge-dialog-block-start-spacing** - The spacing at the start of the dialog block. _(default: undefined)_\n- **--forge-dialog-block-end-spacing** - The spacing at the end of the dialog block. _(default: undefined)_\n- **--forge-dialog-inline-start-spacing** - The spacing at the start of the dialog inline. _(default: undefined)_\n- **--forge-dialog-inline-end-spacing** - The spacing at the end of the dialog inline. _(default: undefined)_\n- **--forge-dialog-padding** - The padding of the dialog. _(default: undefined)_\n- **--forge-dialog-width** - The width of the dialog. _(default: undefined)_\n- **--forge-dialog-height** - The height of the dialog. _(default: undefined)_\n- **--forge-dialog-min-width** - The minimum width of the dialog. _(default: undefined)_\n- **--forge-dialog-max-width** - The maximum width of the dialog. _(default: undefined)_\n- **--forge-dialog-min-height** - The minimum height of the dialog. _(default: undefined)_\n- **--forge-dialog-max-height** - The maximum height of the dialog. _(default: undefined)_\n- **--forge-dialog-z-index** - The z-index of the dialog. _(default: undefined)_\n- **--forge-dialog-move-handle-color** - The color of the move handle. _(default: undefined)_\n- **--forge-dialog-move-handle-size** - The size of the move handle. _(default: undefined)_\n- **--forge-dialog-move-handle-hover-cursor** - The cursor style when hovering over the move handle. _(default: undefined)_\n- **--forge-dialog-move-handle-active-cursor** - The cursor style when the move handle is active. _(default: undefined)_\n- **--forge-dialog-move-handle-spacing** - The spacing around the move handle. _(default: undefined)_\n- **--forge-dialog-move-transition-duration** - The duration of the move transition. _(default: undefined)_\n- **--forge-dialog-move-transition-easing** - The easing function of the move transition. _(default: undefined)_\n- **--forge-dialog-moving-opacity** - The opacity of the dialog when it is being moved. _(default: undefined)_\n- **--forge-dialog-enter-animation-duration** - The duration of the enter animation. _(default: undefined)_\n- **--forge-dialog-enter-animation-easing** - The easing function of the enter animation. _(default: undefined)_\n- **--forge-dialog-exit-animation-duration** - The duration of the exit animation. _(default: undefined)_\n- **--forge-dialog-exit-animation-easing** - The easing function of the exit animation. _(default: undefined)_\n- **--forge-dialog-zoom-opacity** - The opacity of the dialog during zoom animation. _(default: undefined)_\n- **--forge-dialog-zoom-scale** - The scale of the dialog during zoom animation. _(default: undefined)_\n- **--forge-dialog-fade-opacity** - The opacity of the dialog during fade animation. _(default: undefined)_\n- **--forge-dialog-slide-opacity** - The opacity of the dialog during slide animation. _(default: undefined)_\n- **--forge-dialog-slide-translate** - The translation distance of the dialog during slide animation. _(default: undefined)_\n- **--forge-dialog-backdrop-opacity** - The opacity of the dialog backdrop. _(default: undefined)_\n- **--forge-dialog-nonmodal-elevation** - The elevation of non-modal dialogs. _(default: undefined)_\n- **--forge-dialog-fullscreen-enter-animation-duration** - The duration of the enter animation for fullscreen dialogs. _(default: undefined)_\n- **--forge-dialog-fullscreen-exit-animation-duration** - The duration of the exit animation for fullscreen dialogs. _(default: undefined)_\n- **--forge-dialog-position-x** - The x-axis position of the dialog. _(default: undefined)_\n- **--forge-dialog-position-y** - The y-axis position of the dialog. _(default: undefined)_\n- **--forge-dialog-preset-sheet-enter-animation-duration** - The duration of the enter animation for preset sheet dialogs. _(default: undefined)_\n- **--forge-dialog-preset-sheet-exit-animation-duration** - The duration of the exit animation for preset sheet dialogs. _(default: undefined)_\n\n### **CSS Parts:**\n - **root** - The dialog container element.\n- **backdrop** - The backdrop element.\n- **surface** - The dialog surface element.\n- **move-handle-container** - The alignment container for the move handle.\n- **move-handle** - The move handle element.\n- **move-handle-icon** - The move handle icon element.",
|
|
@@ -859,6 +907,18 @@
|
|
|
859
907
|
],
|
|
860
908
|
"references": []
|
|
861
909
|
},
|
|
910
|
+
{
|
|
911
|
+
"name": "forge-divider",
|
|
912
|
+
"description": "Divider is used to separate elements.\n---\n\n\n### **CSS Properties:**\n - **--forge-divider-color** - The color of the divider. _(default: undefined)_\n- **--forge-divider-width** - The width of the divider. _(default: undefined)_\n- **--forge-divider-border-style** - The border-style (dashed, solid) of the divider. _(default: undefined)_\n- **--forge-divider-margin** - The margin of divider. _(default: undefined)_\n\n### **CSS Parts:**\n - **root** - The root container element.",
|
|
913
|
+
"attributes": [
|
|
914
|
+
{
|
|
915
|
+
"name": "vertical",
|
|
916
|
+
"description": "Controls if the divider is displayed vertically or horizontally.",
|
|
917
|
+
"values": []
|
|
918
|
+
}
|
|
919
|
+
],
|
|
920
|
+
"references": []
|
|
921
|
+
},
|
|
862
922
|
{
|
|
863
923
|
"name": "forge-expansion-panel",
|
|
864
924
|
"description": "Expansion panels provide progressive disclosure of content.\n---\n\n\n### **Events:**\n - **forge-expansion-panel-toggle** - Event fired when the panel is toggled open or closed.\n- **forge-expansion-panel-animation-complete** - Event fired when the panel has finished animating when toggling.\n\n### **Methods:**\n - **toggle(): _void_** - Toggles the open state of the panel.\n\n### **Slots:**\n - _default_ - The content of the panel.\n- **header** - The header of the panel.\n\n### **CSS Properties:**\n - **--forge-expansion-panel-animation-duration** - The duration of the open/close animation. _(default: undefined)_\n- **--forge-expansion-panel-animation-easing** - The easing function of the open/close animation. _(default: undefined)_\n\n### **CSS Parts:**\n - **root** - The root element of the panel.\n- **header** - The header of the panel.\n- **content** - The content of the panel.",
|
|
@@ -1030,6 +1090,58 @@
|
|
|
1030
1090
|
],
|
|
1031
1091
|
"references": []
|
|
1032
1092
|
},
|
|
1093
|
+
{
|
|
1094
|
+
"name": "forge-fab",
|
|
1095
|
+
"description": "Floating action buttons are used to represent the most important action on a page.\n---\n\n\n### **Events:**\n - **click** - Fires when the button is clicked.\n\n### **Methods:**\n - **click(): _void_** - Clicks the button.\n- **focus(options: _ExperimentalFocusOptions_): _void_** - Focuses the button.\n\n### **Slots:**\n - _default_ - This is a default/unnamed slot. Typically used for icon-only or label-only FABs. If the content forces the width to be large than the height, then the FAB will be in extended mode.\n- **start** - An element to logically render at the start of the button content.\n- **label** - Reserved specifically for label text. This forces the button into extended mode.\n- **end** - An element to logically render at the end of the button content.\n\n### **CSS Properties:**\n - **--forge-fab-background-display** - The display property. _(default: undefined)_\n- **--forge-fab-gap** - The gap between the icon and the label. _(default: undefined)_\n- **--forge-fab-background** - The background color. _(default: undefined)_\n- **--forge-fab-color** - The text color. _(default: undefined)_\n- **--forge-fab-size** - The height and min-width of the button. _(default: undefined)_\n- **--forge-fab-padding** - The inline padding of the button. _(default: undefined)_\n- **--forge-fab-shadow** - The box shadow of the button. _(default: undefined)_\n- **--forge-fab-hover-shadow** - The box shadow of the button when hovered. _(default: undefined)_\n- **--forge-fab-active-shadow** - The box shadow of the button when active. _(default: undefined)_\n- **--forge-fab-lowered-shadow** - The box shadow of the button when lowered. _(default: undefined)_\n- **--forge-fab-lowered-hover-shadow** - The box shadow of the button when lowered and hovered. _(default: undefined)_\n- **--forge-fab-lowered-active-shadow** - The box shadow of the button when lowered and active. _(default: undefined)_\n- **--forge-fab-transition-duration** - The transition duration. _(default: undefined)_\n- **--forge-fab-transition-timing** - The transition timing function. _(default: undefined)_\n- **--forge-fab-shape** - The border radius of the button. _(default: undefined)_\n- **--forge-fab-shape-start-start** - The start-start border radius. _(default: undefined)_\n- **--forge-fab-shape-start-end** - The start-end border radius. _(default: undefined)_\n- **--forge-fab-shape-end-start** - The end-start border radius. _(default: undefined)_\n- **--forge-fab-shape-end-end** - The end-end border radius. _(default: undefined)_\n- **--forge-fab-extended-padding** - The inline padding of the extended button. _(default: undefined)_\n- **--forge-fab-extended-min-width** - The min-width of the extended button. _(default: undefined)_\n- **--forge-fab-density-small-size** - The height and min-width of the small density button. _(default: undefined)_\n- **--forge-fab-density-medium-size** - The height and min-width of the medium density (default) button. _(default: undefined)_\n- **--forge-fab-density-large-size** - The height and min-width of the large density button. _(default: undefined)_\n- **--forge-fab-disabled-cursor** - The cursor when disabled. _(default: undefined)_\n- **--forge-fab-disabled-background** - The background color when disabled. _(default: undefined)_\n- **--forge-fab-disabled-color** - The text color when disabled. _(default: undefined)_\n- **--forge-fab-disabled-opacity** - The opacity when disabled. _(default: undefined)_\n\n### **CSS Parts:**\n - **root** - The root container element.\n- **focus-indicator** - The focus-indicator indicator element.\n- **state-layer** - The state-layer surface element.",
|
|
1096
|
+
"attributes": [
|
|
1097
|
+
{
|
|
1098
|
+
"name": "theme",
|
|
1099
|
+
"description": "Sets the theme of the button.",
|
|
1100
|
+
"values": []
|
|
1101
|
+
},
|
|
1102
|
+
{
|
|
1103
|
+
"name": "density",
|
|
1104
|
+
"description": "Sets the density of the button.",
|
|
1105
|
+
"values": []
|
|
1106
|
+
},
|
|
1107
|
+
{
|
|
1108
|
+
"name": "elevation",
|
|
1109
|
+
"description": "Sets the elevation of the button.",
|
|
1110
|
+
"values": []
|
|
1111
|
+
},
|
|
1112
|
+
{
|
|
1113
|
+
"name": "type",
|
|
1114
|
+
"description": "Sets the type of the button. Possible values are `button`, `submit`, and `reset`.",
|
|
1115
|
+
"values": [{ "name": "ButtonType" }]
|
|
1116
|
+
},
|
|
1117
|
+
{
|
|
1118
|
+
"name": "disabled",
|
|
1119
|
+
"description": "Disables the button.",
|
|
1120
|
+
"values": []
|
|
1121
|
+
},
|
|
1122
|
+
{
|
|
1123
|
+
"name": "popover-icon",
|
|
1124
|
+
"description": "Shows a popover icon on the button.",
|
|
1125
|
+
"values": []
|
|
1126
|
+
},
|
|
1127
|
+
{
|
|
1128
|
+
"name": "dense",
|
|
1129
|
+
"description": "Sets the density of the button.",
|
|
1130
|
+
"values": []
|
|
1131
|
+
},
|
|
1132
|
+
{
|
|
1133
|
+
"name": "name",
|
|
1134
|
+
"description": "The name of the button.",
|
|
1135
|
+
"values": []
|
|
1136
|
+
},
|
|
1137
|
+
{
|
|
1138
|
+
"name": "value",
|
|
1139
|
+
"description": "The value of the button.",
|
|
1140
|
+
"values": []
|
|
1141
|
+
}
|
|
1142
|
+
],
|
|
1143
|
+
"references": []
|
|
1144
|
+
},
|
|
1033
1145
|
{
|
|
1034
1146
|
"name": "forge-focus-indicator",
|
|
1035
1147
|
"description": "Renders a focus indicator when an attached element matches `:focus-visible`.\n---\n\n\n### **CSS Properties:**\n - **--forge-focus-indicator-display** - The `display` style. Defaults to `flex`. _(default: undefined)_\n- **--forge-focus-indicator-width** - The width of the focus indicator when resting. _(default: undefined)_\n- **--forge-focus-indicator-active-width** - The width of the focus indicator when active. When animating this is the max extent. _(default: undefined)_\n- **--forge-focus-indicator-color** - The color of the focus indicator. _(default: undefined)_\n- **--forge-focus-indicator-shape** - The shape of the focus indicator. _(default: undefined)_\n- **--forge-focus-indicator-duration** - The animation duration. _(default: undefined)_\n- **--forge-focus-indicator-easing** - The animation easing function. _(default: undefined)_\n- **--forge-focus-indicator-shape-start-start** - The start start shape. _(default: undefined)_\n- **--forge-focus-indicator-shape-start-end** - The start end shape. _(default: undefined)_\n- **--forge-focus-indicator-shape-end-start** - The end start shape. _(default: undefined)_\n- **--forge-focus-indicator-shape-end-end** - The end end shape. _(default: undefined)_\n- **--forge-focus-indicator-outward-offset** - The offset of the focus indicator when outward. _(default: undefined)_\n- **--forge-focus-indicator-inward-offset** - The offset of the focus indicator when inward. _(default: undefined)_\n- **--forge-focus-indicator-offset-block** - The block offset. _(default: undefined)_\n- **--forge-focus-indicator-offset-inline** - The inline offset. _(default: undefined)_\n\n### **CSS Parts:**\n - **indicator** - The focus indicator element.",
|
|
@@ -1068,36 +1180,56 @@
|
|
|
1068
1180
|
"references": []
|
|
1069
1181
|
},
|
|
1070
1182
|
{
|
|
1071
|
-
"name": "forge-
|
|
1072
|
-
"description": "
|
|
1183
|
+
"name": "forge-icon",
|
|
1184
|
+
"description": "Icons are used to represent information visually\n---\n\n\n### **Methods:**\n - **layout(): _void_** - Forces a reload of the icon.\n\n### **CSS Properties:**\n - **--forge-icon-color** - The color of the icon. _(default: undefined)_\n- **--forge-icon-size** - The size of the icon. Defaults to the font-size of the context it is placed in. _(default: undefined)_\n- **--forge-icon-width** - The width of the icon. _(default: undefined)_\n- **--forge-icon-height** - The height of the icon. _(default: undefined)_\n- **--forge-icon-font-size** - The font size of the icon. _(default: undefined)_\n\n### **CSS Parts:**\n - **svg** - The internal SVG element.",
|
|
1073
1185
|
"attributes": [
|
|
1074
1186
|
{
|
|
1075
|
-
"name": "
|
|
1076
|
-
"description": "The
|
|
1077
|
-
"values": [{ "name": "
|
|
1078
|
-
}
|
|
1079
|
-
],
|
|
1080
|
-
"references": []
|
|
1081
|
-
},
|
|
1082
|
-
{
|
|
1083
|
-
"name": "forge-fab",
|
|
1084
|
-
"description": "Floating action buttons are used to represent the most important action on a page.\n---\n\n\n### **Events:**\n - **click** - Fires when the button is clicked.\n\n### **Methods:**\n - **click(): _void_** - Clicks the button.\n- **focus(options: _ExperimentalFocusOptions_): _void_** - Focuses the button.\n\n### **Slots:**\n - _default_ - This is a default/unnamed slot. Typically used for icon-only or label-only FABs. If the content forces the width to be large than the height, then the FAB will be in extended mode.\n- **start** - An element to logically render at the start of the button content.\n- **label** - Reserved specifically for label text. This forces the button into extended mode.\n- **end** - An element to logically render at the end of the button content.\n\n### **CSS Properties:**\n - **--forge-fab-background-display** - The display property. _(default: undefined)_\n- **--forge-fab-gap** - The gap between the icon and the label. _(default: undefined)_\n- **--forge-fab-background** - The background color. _(default: undefined)_\n- **--forge-fab-color** - The text color. _(default: undefined)_\n- **--forge-fab-size** - The height and min-width of the button. _(default: undefined)_\n- **--forge-fab-padding** - The inline padding of the button. _(default: undefined)_\n- **--forge-fab-shadow** - The box shadow of the button. _(default: undefined)_\n- **--forge-fab-hover-shadow** - The box shadow of the button when hovered. _(default: undefined)_\n- **--forge-fab-active-shadow** - The box shadow of the button when active. _(default: undefined)_\n- **--forge-fab-lowered-shadow** - The box shadow of the button when lowered. _(default: undefined)_\n- **--forge-fab-lowered-hover-shadow** - The box shadow of the button when lowered and hovered. _(default: undefined)_\n- **--forge-fab-lowered-active-shadow** - The box shadow of the button when lowered and active. _(default: undefined)_\n- **--forge-fab-transition-duration** - The transition duration. _(default: undefined)_\n- **--forge-fab-transition-timing** - The transition timing function. _(default: undefined)_\n- **--forge-fab-shape** - The border radius of the button. _(default: undefined)_\n- **--forge-fab-shape-start-start** - The start-start border radius. _(default: undefined)_\n- **--forge-fab-shape-start-end** - The start-end border radius. _(default: undefined)_\n- **--forge-fab-shape-end-start** - The end-start border radius. _(default: undefined)_\n- **--forge-fab-shape-end-end** - The end-end border radius. _(default: undefined)_\n- **--forge-fab-extended-padding** - The inline padding of the extended button. _(default: undefined)_\n- **--forge-fab-extended-min-width** - The min-width of the extended button. _(default: undefined)_\n- **--forge-fab-density-small-size** - The height and min-width of the small density button. _(default: undefined)_\n- **--forge-fab-density-medium-size** - The height and min-width of the medium density (default) button. _(default: undefined)_\n- **--forge-fab-density-large-size** - The height and min-width of the large density button. _(default: undefined)_\n- **--forge-fab-disabled-cursor** - The cursor when disabled. _(default: undefined)_\n- **--forge-fab-disabled-background** - The background color when disabled. _(default: undefined)_\n- **--forge-fab-disabled-color** - The text color when disabled. _(default: undefined)_\n- **--forge-fab-disabled-opacity** - The opacity when disabled. _(default: undefined)_\n\n### **CSS Parts:**\n - **root** - The root container element.\n- **focus-indicator** - The focus-indicator indicator element.\n- **state-layer** - The state-layer surface element.",
|
|
1085
|
-
"attributes": [
|
|
1187
|
+
"name": "external-type",
|
|
1188
|
+
"description": "The type of icon to load externally. Possible values: \"standard\", \"extended\", \"custom\".",
|
|
1189
|
+
"values": [{ "name": "IconExternalType" }]
|
|
1190
|
+
},
|
|
1086
1191
|
{
|
|
1087
|
-
"name": "
|
|
1088
|
-
"description": "
|
|
1192
|
+
"name": "external-url-builder",
|
|
1193
|
+
"description": "A callback that can be provided to generate a URL that will be used to fetch an SVG icon.",
|
|
1194
|
+
"values": [{ "name": "IconUrlBuilder" }]
|
|
1195
|
+
},
|
|
1196
|
+
{
|
|
1197
|
+
"name": "name",
|
|
1198
|
+
"description": "The name of the icon to render.",
|
|
1089
1199
|
"values": []
|
|
1090
1200
|
},
|
|
1091
1201
|
{
|
|
1092
|
-
"name": "
|
|
1093
|
-
"description": "
|
|
1202
|
+
"name": "src",
|
|
1203
|
+
"description": "Provides the ability to set the SVG string content directly.",
|
|
1094
1204
|
"values": []
|
|
1095
1205
|
},
|
|
1096
1206
|
{
|
|
1097
|
-
"name": "
|
|
1098
|
-
"description": "
|
|
1207
|
+
"name": "lazy",
|
|
1208
|
+
"description": "Controls whether the icon will be loaded dynamically when it comes into view. False by default.",
|
|
1209
|
+
"values": []
|
|
1210
|
+
},
|
|
1211
|
+
{
|
|
1212
|
+
"name": "external",
|
|
1213
|
+
"description": "Controls whether external network requests are allowed for this icon. Only pertains for icons that aren't already defined in the registry.",
|
|
1214
|
+
"values": []
|
|
1215
|
+
},
|
|
1216
|
+
{
|
|
1217
|
+
"name": "viewbox",
|
|
1218
|
+
"description": "A custom value to apply to the `viewBox` attribute on the internal `<svg>` element.",
|
|
1099
1219
|
"values": []
|
|
1100
1220
|
},
|
|
1221
|
+
{
|
|
1222
|
+
"name": "theme",
|
|
1223
|
+
"description": "The theme to apply to the icon.",
|
|
1224
|
+
"values": [{ "name": "IconTheme" }]
|
|
1225
|
+
}
|
|
1226
|
+
],
|
|
1227
|
+
"references": []
|
|
1228
|
+
},
|
|
1229
|
+
{
|
|
1230
|
+
"name": "forge-icon-button",
|
|
1231
|
+
"description": "\n---\n\n\n### **Events:**\n - **click** - Fires when the button is clicked.\n- **forge-icon-button-toggle** - Fires when the icon button is toggled. Only applies in `toggle` mode.\n\n### **Methods:**\n - **click(): _void_** - Clicks the button.\n- **focus(options: _ExperimentalFocusOptions_): _void_** - Focuses the button.\n\n### **Slots:**\n - _default_ - This is a default/unnamed slot for the icon.\n- **on** - The icon to show when in `toggle` mode when toggled \"on\".\n- **start** - Elements to logically render before the icon.\n- **end** - Elements to logically render after the icon.\n- **badge** - Absolutely positions the element in the top-end corner of the button (typically reserved for badge-like content).\n\n### **CSS Properties:**\n - **--forge-icon-button-display** - The display property of the button. _(default: undefined)_\n- **--forge-icon-button-size** - The height and min-width of the button. _(default: undefined)_\n- **--forge-icon-button-gap** - The gap between the icon content. _(default: undefined)_\n- **--forge-icon-button-icon-color** - The color of the icon. _(default: undefined)_\n- **--forge-icon-button-background-color** - The background color of the button. _(default: undefined)_\n- **--forge-icon-button-icon-size** - The size of the icon. _(default: undefined)_\n- **--forge-icon-button-cursor** - The cursor of the button. _(default: undefined)_\n- **--forge-icon-button-padding** - The inline padding of the button. _(default: undefined)_\n- **--forge-icon-button-border** - The border of the button. _(default: undefined)_\n- **--forge-icon-button-shadow** - The shadow of the button. _(default: undefined)_\n- **--forge-icon-button-transition-duration** - The transition duration of the button. _(default: undefined)_\n- **--forge-icon-button-transition-timing** - The transition timing of the button. _(default: undefined)_\n- **--forge-icon-button-shape** - The shape of the button. _(default: undefined)_\n- **--forge-icon-button-shape-start-start** - The start-start border-radius of the button. _(default: undefined)_\n- **--forge-icon-button-shape-start-end** - The start-end border-radius of the button. _(default: undefined)_\n- **--forge-icon-button-shape-end-start** - The end-start border-radius of the button. _(default: undefined)_\n- **--forge-icon-button-shape-end-end** - The end-end border-radius of the button. _(default: undefined)_\n- **--forge-icon-button-shape-squared** - The squared border-radius of the button. _(default: undefined)_\n- **--forge-icon-button-outlined-border-width** - The border width when in the outlined variant. _(default: undefined)_\n- **--forge-icon-button-outlined-border-style** - The border style when in the outlined variant. _(default: undefined)_\n- **--forge-icon-button-outlined-border-color** - The border color when in the outlined variant. _(default: undefined)_\n- **--forge-icon-button-tonal-icon-color** - The icon color when in the tonal variant. _(default: undefined)_\n- **--forge-icon-button-tonal-background-color** - The background color when in the tonal variant. _(default: undefined)_\n- **--forge-icon-button-filled-icon-color** - The icon color when in the filled variant. _(default: undefined)_\n- **--forge-icon-button-filled-background-color** - The background color when in the filled variant. _(default: undefined)_\n- **--forge-icon-button-raised-shadow** - The shadow when in the raised variant. _(default: undefined)_\n- **--forge-icon-button-raised-hover-shadow** - The shadow when in the raised variant and hovered. _(default: undefined)_\n- **--forge-icon-button-raised-active-shadow** - The shadow when in the raised variant and active. _(default: undefined)_\n- **--forge-icon-button-raised-disabled-shadow** - The shadow when in the raised variant and disabled. _(default: undefined)_\n- **--forge-icon-button-density-small-size** - The size of the button when in the small density. _(default: undefined)_\n- **--forge-icon-button-density-small-padding** - The padding of the button when in the small density. _(default: undefined)_\n- **--forge-icon-button-density-small-icon-size** - The size of the icon when in the small density. _(default: undefined)_\n- **--forge-icon-button-density-medium-size** - The size of the button when in the medium density. _(default: undefined)_\n- **--forge-icon-button-density-medium-padding** - The padding of the button when in the medium density. _(default: undefined)_\n- **--forge-icon-button-density-large-size** - The size of the button when in the large density. _(default: undefined)_\n- **--forge-icon-button-toggle-on-background-color** - The background color of the when in toggle mode and toggled on. _(default: undefined)_\n- **--forge-icon-button-toggle-on-icon-color** - The color of the icon when in toggle mode and toggled on. _(default: undefined)_\n- **--forge-icon-button-outlined-toggle-on-background-color** - The background color when in the outlined variant and toggled on. _(default: undefined)_\n- **--forge-icon-button-outlined-toggle-on-icon-color** - The icon color when in the outlined variant and toggled on. _(default: undefined)_\n- **--forge-icon-button-tonal-toggle-background-color** - The background color when in the tonal variant and toggled. _(default: undefined)_\n- **--forge-icon-button-tonal-toggle-on-background-color** - The background color when in the tonal variant and toggled on. _(default: undefined)_\n- **--forge-icon-button-tonal-toggle-on-icon-color** - The icon color when in the tonal variant and toggled on. _(default: undefined)_\n- **--forge-icon-button-filled-toggle-background-color** - The background color when in the filled variant and toggled. _(default: undefined)_\n- **--forge-icon-button-filled-toggle-icon-color** - The icon color when in the filled variant and toggled. _(default: undefined)_\n- **--forge-icon-button-filled-toggle-on-background-color** - The background color when in the filled variant and toggled on. _(default: undefined)_\n- **--forge-icon-button-filled-toggle-on-icon-color** - The icon color when in the filled variant and toggled on. _(default: undefined)_\n- **--forge-icon-button-disabled-cursor** - The cursor when the button is disabled. _(default: undefined)_\n- **--forge-icon-button-disabled-opacity** - The opacity when the button is disabled. _(default: undefined)_\n- **--forge-icon-button-popover-icon-padding** - The padding of the popover icon. _(default: undefined)_\n- **--forge-icon-button-focus-indicator-color** - The color of the focus indicator. _(default: undefined)_\n\n### **CSS Parts:**\n - **root** - The root container element.\n- **focus-indicator** - The focus-indicator indicator element.\n- **state-layer** - The state-layer surface element.",
|
|
1232
|
+
"attributes": [
|
|
1101
1233
|
{
|
|
1102
1234
|
"name": "type",
|
|
1103
1235
|
"description": "Sets the type of the button. Possible values are `button`, `submit`, and `reset`.",
|
|
@@ -1131,6 +1263,18 @@
|
|
|
1131
1263
|
],
|
|
1132
1264
|
"references": []
|
|
1133
1265
|
},
|
|
1266
|
+
{
|
|
1267
|
+
"name": "forge-inline-message",
|
|
1268
|
+
"description": "Inline messages are used to provide feedback to the user about a specific action or state.\n---\n\n\n### **Slots:**\n - _default_ - The message text.\n- **title** - The title of the inline message.\n- **icon** - The icon to display.\n\n### **CSS Properties:**\n - **--forge-inline-message-background** - The background color. _(default: undefined)_\n- **--forge-inline-message-color** - The text color. _(default: undefined)_\n- **--forge-inline-message-shape** - The shape (border) radius. _(default: undefined)_\n- **--forge-inline-message-padding** - The padding around the content. _(default: undefined)_\n- **--forge-inline-message-padding-inline** - The inline padding around the content. _(default: undefined)_\n- **--forge-inline-message-padding-block** - The block padding around the content. _(default: undefined)_\n- **--forge-inline-message-border-width** - The border width. _(default: undefined)_\n- **--forge-inline-message-border-style** - The border style. Defaults to `none`. _(default: undefined)_\n- **--forge-inline-message-border-color** - The border color. _(default: undefined)_\n- **--forge-inline-message-gap** - The gap/space between the content elements. _(default: undefined)_\n- **--forge-inline-message-icon-gap** - The gap/space between the icon and the content. _(default: undefined)_\n- **--forge-inline-message-content-gap** - The gap/space between the title and the message. _(default: undefined)_\n- **--forge-inline-message-icon-color** - The icon color. _(default: undefined)_\n\n### **CSS Parts:**\n - **root** - The root layout element.\n- **container** - The container element for the title and message content.",
|
|
1269
|
+
"attributes": [
|
|
1270
|
+
{
|
|
1271
|
+
"name": "theme",
|
|
1272
|
+
"description": "The theme to apply.",
|
|
1273
|
+
"values": [{ "name": "InlineMessageTheme" }]
|
|
1274
|
+
}
|
|
1275
|
+
],
|
|
1276
|
+
"references": []
|
|
1277
|
+
},
|
|
1134
1278
|
{
|
|
1135
1279
|
"name": "forge-keyboard-shortcut",
|
|
1136
1280
|
"description": "\n---\n\n\n### **Events:**\n - **forge-keyboard-shortcut-activate** - Event fired when the keyboard shortcut is activated.",
|
|
@@ -1256,92 +1400,8 @@
|
|
|
1256
1400
|
"references": []
|
|
1257
1401
|
},
|
|
1258
1402
|
{
|
|
1259
|
-
"name": "forge-
|
|
1260
|
-
"description": "
|
|
1261
|
-
"attributes": [
|
|
1262
|
-
{
|
|
1263
|
-
"name": "external-type",
|
|
1264
|
-
"description": "The type of icon to load externally. Possible values: \"standard\", \"extended\", \"custom\".",
|
|
1265
|
-
"values": [{ "name": "IconExternalType" }]
|
|
1266
|
-
},
|
|
1267
|
-
{
|
|
1268
|
-
"name": "external-url-builder",
|
|
1269
|
-
"description": "A callback that can be provided to generate a URL that will be used to fetch an SVG icon.",
|
|
1270
|
-
"values": [{ "name": "IconUrlBuilder" }]
|
|
1271
|
-
},
|
|
1272
|
-
{
|
|
1273
|
-
"name": "name",
|
|
1274
|
-
"description": "The name of the icon to render.",
|
|
1275
|
-
"values": []
|
|
1276
|
-
},
|
|
1277
|
-
{
|
|
1278
|
-
"name": "src",
|
|
1279
|
-
"description": "Provides the ability to set the SVG string content directly.",
|
|
1280
|
-
"values": []
|
|
1281
|
-
},
|
|
1282
|
-
{
|
|
1283
|
-
"name": "lazy",
|
|
1284
|
-
"description": "Controls whether the icon will be loaded dynamically when it comes into view. False by default.",
|
|
1285
|
-
"values": []
|
|
1286
|
-
},
|
|
1287
|
-
{
|
|
1288
|
-
"name": "external",
|
|
1289
|
-
"description": "Controls whether external network requests are allowed for this icon. Only pertains for icons that aren't already defined in the registry.",
|
|
1290
|
-
"values": []
|
|
1291
|
-
},
|
|
1292
|
-
{
|
|
1293
|
-
"name": "viewbox",
|
|
1294
|
-
"description": "A custom value to apply to the `viewBox` attribute on the internal `<svg>` element.",
|
|
1295
|
-
"values": []
|
|
1296
|
-
},
|
|
1297
|
-
{
|
|
1298
|
-
"name": "theme",
|
|
1299
|
-
"description": "The theme to apply to the icon.",
|
|
1300
|
-
"values": [{ "name": "IconTheme" }]
|
|
1301
|
-
}
|
|
1302
|
-
],
|
|
1303
|
-
"references": []
|
|
1304
|
-
},
|
|
1305
|
-
{
|
|
1306
|
-
"name": "forge-icon-button",
|
|
1307
|
-
"description": "\n---\n\n\n### **Events:**\n - **click** - Fires when the button is clicked.\n- **forge-icon-button-toggle** - Fires when the icon button is toggled. Only applies in `toggle` mode.\n\n### **Methods:**\n - **click(): _void_** - Clicks the button.\n- **focus(options: _ExperimentalFocusOptions_): _void_** - Focuses the button.\n\n### **Slots:**\n - _default_ - This is a default/unnamed slot for the icon.\n- **on** - The icon to show when in `toggle` mode when toggled \"on\".\n- **start** - Elements to logically render before the icon.\n- **end** - Elements to logically render after the icon.\n- **badge** - Absolutely positions the element in the top-end corner of the button (typically reserved for badge-like content).\n\n### **CSS Properties:**\n - **--forge-icon-button-display** - The display property of the button. _(default: undefined)_\n- **--forge-icon-button-size** - The height and min-width of the button. _(default: undefined)_\n- **--forge-icon-button-gap** - The gap between the icon content. _(default: undefined)_\n- **--forge-icon-button-icon-color** - The color of the icon. _(default: undefined)_\n- **--forge-icon-button-background-color** - The background color of the button. _(default: undefined)_\n- **--forge-icon-button-icon-size** - The size of the icon. _(default: undefined)_\n- **--forge-icon-button-cursor** - The cursor of the button. _(default: undefined)_\n- **--forge-icon-button-padding** - The inline padding of the button. _(default: undefined)_\n- **--forge-icon-button-border** - The border of the button. _(default: undefined)_\n- **--forge-icon-button-shadow** - The shadow of the button. _(default: undefined)_\n- **--forge-icon-button-transition-duration** - The transition duration of the button. _(default: undefined)_\n- **--forge-icon-button-transition-timing** - The transition timing of the button. _(default: undefined)_\n- **--forge-icon-button-shape** - The shape of the button. _(default: undefined)_\n- **--forge-icon-button-shape-start-start** - The start-start border-radius of the button. _(default: undefined)_\n- **--forge-icon-button-shape-start-end** - The start-end border-radius of the button. _(default: undefined)_\n- **--forge-icon-button-shape-end-start** - The end-start border-radius of the button. _(default: undefined)_\n- **--forge-icon-button-shape-end-end** - The end-end border-radius of the button. _(default: undefined)_\n- **--forge-icon-button-shape-squared** - The squared border-radius of the button. _(default: undefined)_\n- **--forge-icon-button-outlined-border-width** - The border width when in the outlined variant. _(default: undefined)_\n- **--forge-icon-button-outlined-border-style** - The border style when in the outlined variant. _(default: undefined)_\n- **--forge-icon-button-outlined-border-color** - The border color when in the outlined variant. _(default: undefined)_\n- **--forge-icon-button-tonal-icon-color** - The icon color when in the tonal variant. _(default: undefined)_\n- **--forge-icon-button-tonal-background-color** - The background color when in the tonal variant. _(default: undefined)_\n- **--forge-icon-button-filled-icon-color** - The icon color when in the filled variant. _(default: undefined)_\n- **--forge-icon-button-filled-background-color** - The background color when in the filled variant. _(default: undefined)_\n- **--forge-icon-button-raised-shadow** - The shadow when in the raised variant. _(default: undefined)_\n- **--forge-icon-button-raised-hover-shadow** - The shadow when in the raised variant and hovered. _(default: undefined)_\n- **--forge-icon-button-raised-active-shadow** - The shadow when in the raised variant and active. _(default: undefined)_\n- **--forge-icon-button-raised-disabled-shadow** - The shadow when in the raised variant and disabled. _(default: undefined)_\n- **--forge-icon-button-density-small-size** - The size of the button when in the small density. _(default: undefined)_\n- **--forge-icon-button-density-small-padding** - The padding of the button when in the small density. _(default: undefined)_\n- **--forge-icon-button-density-small-icon-size** - The size of the icon when in the small density. _(default: undefined)_\n- **--forge-icon-button-density-medium-size** - The size of the button when in the medium density. _(default: undefined)_\n- **--forge-icon-button-density-medium-padding** - The padding of the button when in the medium density. _(default: undefined)_\n- **--forge-icon-button-density-large-size** - The size of the button when in the large density. _(default: undefined)_\n- **--forge-icon-button-toggle-on-background-color** - The background color of the when in toggle mode and toggled on. _(default: undefined)_\n- **--forge-icon-button-toggle-on-icon-color** - The color of the icon when in toggle mode and toggled on. _(default: undefined)_\n- **--forge-icon-button-outlined-toggle-on-background-color** - The background color when in the outlined variant and toggled on. _(default: undefined)_\n- **--forge-icon-button-outlined-toggle-on-icon-color** - The icon color when in the outlined variant and toggled on. _(default: undefined)_\n- **--forge-icon-button-tonal-toggle-background-color** - The background color when in the tonal variant and toggled. _(default: undefined)_\n- **--forge-icon-button-tonal-toggle-on-background-color** - The background color when in the tonal variant and toggled on. _(default: undefined)_\n- **--forge-icon-button-tonal-toggle-on-icon-color** - The icon color when in the tonal variant and toggled on. _(default: undefined)_\n- **--forge-icon-button-filled-toggle-background-color** - The background color when in the filled variant and toggled. _(default: undefined)_\n- **--forge-icon-button-filled-toggle-icon-color** - The icon color when in the filled variant and toggled. _(default: undefined)_\n- **--forge-icon-button-filled-toggle-on-background-color** - The background color when in the filled variant and toggled on. _(default: undefined)_\n- **--forge-icon-button-filled-toggle-on-icon-color** - The icon color when in the filled variant and toggled on. _(default: undefined)_\n- **--forge-icon-button-disabled-cursor** - The cursor when the button is disabled. _(default: undefined)_\n- **--forge-icon-button-disabled-opacity** - The opacity when the button is disabled. _(default: undefined)_\n- **--forge-icon-button-popover-icon-padding** - The padding of the popover icon. _(default: undefined)_\n- **--forge-icon-button-focus-indicator-color** - The color of the focus indicator. _(default: undefined)_\n\n### **CSS Parts:**\n - **root** - The root container element.\n- **focus-indicator** - The focus-indicator indicator element.\n- **state-layer** - The state-layer surface element.",
|
|
1308
|
-
"attributes": [
|
|
1309
|
-
{
|
|
1310
|
-
"name": "type",
|
|
1311
|
-
"description": "Sets the type of the button. Possible values are `button`, `submit`, and `reset`.",
|
|
1312
|
-
"values": [{ "name": "ButtonType" }]
|
|
1313
|
-
},
|
|
1314
|
-
{
|
|
1315
|
-
"name": "disabled",
|
|
1316
|
-
"description": "Disables the button.",
|
|
1317
|
-
"values": []
|
|
1318
|
-
},
|
|
1319
|
-
{
|
|
1320
|
-
"name": "popover-icon",
|
|
1321
|
-
"description": "Shows a popover icon on the button.",
|
|
1322
|
-
"values": []
|
|
1323
|
-
},
|
|
1324
|
-
{
|
|
1325
|
-
"name": "dense",
|
|
1326
|
-
"description": "Sets the density of the button.",
|
|
1327
|
-
"values": []
|
|
1328
|
-
},
|
|
1329
|
-
{
|
|
1330
|
-
"name": "name",
|
|
1331
|
-
"description": "The name of the button.",
|
|
1332
|
-
"values": []
|
|
1333
|
-
},
|
|
1334
|
-
{
|
|
1335
|
-
"name": "value",
|
|
1336
|
-
"description": "The value of the button.",
|
|
1337
|
-
"values": []
|
|
1338
|
-
}
|
|
1339
|
-
],
|
|
1340
|
-
"references": []
|
|
1341
|
-
},
|
|
1342
|
-
{
|
|
1343
|
-
"name": "forge-menu",
|
|
1344
|
-
"description": "\n---\n\n\n### **Methods:**\n - **propagateKeyEvent(evt: _KeyboardEvent_): _void_** - Force propagates the key event from another element to this component.\n- **activateFirstOption(): _void_** - Activates the first option in the menu when open.",
|
|
1403
|
+
"name": "forge-menu",
|
|
1404
|
+
"description": "\n---\n\n\n### **Methods:**\n - **propagateKeyEvent(evt: _KeyboardEvent_): _void_** - Force propagates the key event from another element to this component.\n- **activateFirstOption(): _void_** - Activates the first option in the menu when open.",
|
|
1345
1405
|
"attributes": [
|
|
1346
1406
|
{
|
|
1347
1407
|
"name": "open",
|
|
@@ -1468,69 +1528,6 @@
|
|
|
1468
1528
|
],
|
|
1469
1529
|
"references": []
|
|
1470
1530
|
},
|
|
1471
|
-
{
|
|
1472
|
-
"name": "forge-page-state",
|
|
1473
|
-
"description": "\n---\n\n\n### **Slots:**\n - **graphic** - The slot where the graphic will be rendered.\n- **title** - The slot where the title will be rendered.\n- **message** - The slot where the message will be rendered.\n- **actions** - The slot where the actions will be rendered.\n\n### **CSS Properties:**\n - **--forge-page-state-width** - The width of the page state. _(default: undefined)_\n- **--forge-page-state-height** - The height of the page state. _(default: undefined)_\n- **--forge-page-state-spacing** - The spacing of the page state. _(default: undefined)_\n- **--forge-page-state-mobile-width** - The mobile width of the page state. _(default: undefined)_\n- **--forge-page-state-graphic-height** - The graphic height of the page state. _(default: undefined)_\n- **--forge-page-state-graphic-spacing** - The graphic spacing of the page state. _(default: undefined)_\n- **--forge-page-state-mobile-graphic-height** - The mobile graphic height of the page state. _(default: undefined)_\n- **--forge-page-state-title-color** - The title color of the page state. _(default: undefined)_\n- **--forge-page-state-title-spacing** - The title spacing of the page state. _(default: undefined)_\n- **--forge-page-state-message-color** - The message color of the page state. _(default: undefined)_\n- **--forge-page-state-message-spacing** - The message spacing of the page state. _(default: undefined)_\n- **--forge-page-state-actions-spacing** - The actions spacing of the page state. _(default: undefined)_\n\n### **CSS Parts:**\n - **root** - The root container element.\n- **graphic-container** - The graphic container element.\n- **title-container** - The title container element.\n- **message-container** - The message container element.\n- **actions-container** - The actions container element.",
|
|
1474
|
-
"attributes": [],
|
|
1475
|
-
"references": []
|
|
1476
|
-
},
|
|
1477
|
-
{
|
|
1478
|
-
"name": "forge-paginator",
|
|
1479
|
-
"description": "\n---\n\n\n### **Events:**\n - **forge-paginator-change** - Dispatched when the paginator state changes.\n\n### **Methods:**\n - **focus(options: _FocusOptions_): _void_** - Sets focus to the first focusable element within the paginator.\n\n### **Slots:**\n - **label** - Overrides the label text when in the default variant.\n- **range-label** - Overrides the default range label with a custom label when in the default variant.\n- **alternative-range-label** - Overrides the default range label with a custom label when in the `alternative` variant.\n- **first-page-tooltip** - Overrides the default tooltip for the first page button.\n- **last-page-tooltip** - Overrides the default tooltip for the last page button.\n- **previous-page-tooltip** - Overrides the default tooltip for the previous page button.\n- **next-page-tooltip** - Overrides the default tooltip for the next page button.",
|
|
1480
|
-
"attributes": [
|
|
1481
|
-
{
|
|
1482
|
-
"name": "page-index",
|
|
1483
|
-
"description": "The zero-based page index.",
|
|
1484
|
-
"values": []
|
|
1485
|
-
},
|
|
1486
|
-
{
|
|
1487
|
-
"name": "page-size",
|
|
1488
|
-
"description": "Number of items to display on a page.",
|
|
1489
|
-
"values": []
|
|
1490
|
-
},
|
|
1491
|
-
{
|
|
1492
|
-
"name": "offset",
|
|
1493
|
-
"description": "Sets page index by providing the number of items to skip. The getter for this property returns the number of items to skip.",
|
|
1494
|
-
"values": []
|
|
1495
|
-
},
|
|
1496
|
-
{
|
|
1497
|
-
"name": "total",
|
|
1498
|
-
"description": "The total number of items to be paginated.",
|
|
1499
|
-
"values": []
|
|
1500
|
-
},
|
|
1501
|
-
{
|
|
1502
|
-
"name": "page-size-options",
|
|
1503
|
-
"description": "The set of provided page size options to display to the user.",
|
|
1504
|
-
"values": [{ "name": "number[]" }]
|
|
1505
|
-
},
|
|
1506
|
-
{
|
|
1507
|
-
"name": "label",
|
|
1508
|
-
"description": "A label for the paginator.",
|
|
1509
|
-
"values": []
|
|
1510
|
-
},
|
|
1511
|
-
{
|
|
1512
|
-
"name": "first-last",
|
|
1513
|
-
"description": "Whether to show the first page and last page buttons.",
|
|
1514
|
-
"values": []
|
|
1515
|
-
},
|
|
1516
|
-
{
|
|
1517
|
-
"name": "first",
|
|
1518
|
-
"description": "Whether to show the first page button. Default is false.",
|
|
1519
|
-
"values": []
|
|
1520
|
-
},
|
|
1521
|
-
{
|
|
1522
|
-
"name": "disabled",
|
|
1523
|
-
"description": "Whether the paginator is disabled.",
|
|
1524
|
-
"values": []
|
|
1525
|
-
},
|
|
1526
|
-
{
|
|
1527
|
-
"name": "alternative",
|
|
1528
|
-
"description": "Whether to use the alternative range label slot.",
|
|
1529
|
-
"values": []
|
|
1530
|
-
}
|
|
1531
|
-
],
|
|
1532
|
-
"references": []
|
|
1533
|
-
},
|
|
1534
1531
|
{
|
|
1535
1532
|
"name": "forge-overlay",
|
|
1536
1533
|
"description": "Overlays are used to render content in an element that rendered above all content on the page,\nand positioned around a specified anchor element.\n---\n\n\n### **Events:**\n - **forge-overlay-light-dismiss** - Dispatches when the overlay is light dismissed via the escape key or clicking outside the overlay.\n\n### **Slots:**\n - _default_ - The content to render inside the positioned overlay container.\n\n### **CSS Properties:**\n - **--forge-overlay-position** - The `position` of the overlay. _(default: undefined)_\n- **--forge-overlay-z-index** - The `z-index` of the overlay. Defaults to the `popup` range. _(default: undefined)_\n- **--forge-overlay-height** - The `height` of the overlay. Defaults to `min-content`. _(default: undefined)_\n- **--forge-overlay-width** - The `width` of the overlay. Defaults to `min-content`. _(default: undefined)_\n- **--forge-overlay-position-block-start** - The `block-start` position of the overlay. _(default: undefined)_\n- **--forge-overlay-position-block-end** - The `block-end` position of the overlay. _(default: undefined)_\n- **--forge-overlay-position-inline-start** - The `inline-start` position of the overlay. _(default: undefined)_\n- **--forge-overlay-position-inline-end** - The `inline-end` position of the overlay. _(default: undefined)_\n\n### **CSS Parts:**\n - **root** - The component's root element.",
|
|
@@ -1603,6 +1600,69 @@
|
|
|
1603
1600
|
],
|
|
1604
1601
|
"references": []
|
|
1605
1602
|
},
|
|
1603
|
+
{
|
|
1604
|
+
"name": "forge-page-state",
|
|
1605
|
+
"description": "\n---\n\n\n### **Slots:**\n - **graphic** - The slot where the graphic will be rendered.\n- **title** - The slot where the title will be rendered.\n- **message** - The slot where the message will be rendered.\n- **actions** - The slot where the actions will be rendered.\n\n### **CSS Properties:**\n - **--forge-page-state-width** - The width of the page state. _(default: undefined)_\n- **--forge-page-state-height** - The height of the page state. _(default: undefined)_\n- **--forge-page-state-spacing** - The spacing of the page state. _(default: undefined)_\n- **--forge-page-state-mobile-width** - The mobile width of the page state. _(default: undefined)_\n- **--forge-page-state-graphic-height** - The graphic height of the page state. _(default: undefined)_\n- **--forge-page-state-graphic-spacing** - The graphic spacing of the page state. _(default: undefined)_\n- **--forge-page-state-mobile-graphic-height** - The mobile graphic height of the page state. _(default: undefined)_\n- **--forge-page-state-title-color** - The title color of the page state. _(default: undefined)_\n- **--forge-page-state-title-spacing** - The title spacing of the page state. _(default: undefined)_\n- **--forge-page-state-message-color** - The message color of the page state. _(default: undefined)_\n- **--forge-page-state-message-spacing** - The message spacing of the page state. _(default: undefined)_\n- **--forge-page-state-actions-spacing** - The actions spacing of the page state. _(default: undefined)_\n\n### **CSS Parts:**\n - **root** - The root container element.\n- **graphic-container** - The graphic container element.\n- **title-container** - The title container element.\n- **message-container** - The message container element.\n- **actions-container** - The actions container element.",
|
|
1606
|
+
"attributes": [],
|
|
1607
|
+
"references": []
|
|
1608
|
+
},
|
|
1609
|
+
{
|
|
1610
|
+
"name": "forge-paginator",
|
|
1611
|
+
"description": "\n---\n\n\n### **Events:**\n - **forge-paginator-change** - Dispatched when the paginator state changes.\n\n### **Methods:**\n - **focus(options: _FocusOptions_): _void_** - Sets focus to the first focusable element within the paginator.\n\n### **Slots:**\n - **label** - Overrides the label text when in the default variant.\n- **range-label** - Overrides the default range label with a custom label when in the default variant.\n- **alternative-range-label** - Overrides the default range label with a custom label when in the `alternative` variant.\n- **first-page-tooltip** - Overrides the default tooltip for the first page button.\n- **last-page-tooltip** - Overrides the default tooltip for the last page button.\n- **previous-page-tooltip** - Overrides the default tooltip for the previous page button.\n- **next-page-tooltip** - Overrides the default tooltip for the next page button.",
|
|
1612
|
+
"attributes": [
|
|
1613
|
+
{
|
|
1614
|
+
"name": "page-index",
|
|
1615
|
+
"description": "The zero-based page index.",
|
|
1616
|
+
"values": []
|
|
1617
|
+
},
|
|
1618
|
+
{
|
|
1619
|
+
"name": "page-size",
|
|
1620
|
+
"description": "Number of items to display on a page.",
|
|
1621
|
+
"values": []
|
|
1622
|
+
},
|
|
1623
|
+
{
|
|
1624
|
+
"name": "offset",
|
|
1625
|
+
"description": "Sets page index by providing the number of items to skip. The getter for this property returns the number of items to skip.",
|
|
1626
|
+
"values": []
|
|
1627
|
+
},
|
|
1628
|
+
{
|
|
1629
|
+
"name": "total",
|
|
1630
|
+
"description": "The total number of items to be paginated.",
|
|
1631
|
+
"values": []
|
|
1632
|
+
},
|
|
1633
|
+
{
|
|
1634
|
+
"name": "page-size-options",
|
|
1635
|
+
"description": "The set of provided page size options to display to the user.",
|
|
1636
|
+
"values": [{ "name": "number[]" }]
|
|
1637
|
+
},
|
|
1638
|
+
{
|
|
1639
|
+
"name": "label",
|
|
1640
|
+
"description": "A label for the paginator.",
|
|
1641
|
+
"values": []
|
|
1642
|
+
},
|
|
1643
|
+
{
|
|
1644
|
+
"name": "first-last",
|
|
1645
|
+
"description": "Whether to show the first page and last page buttons.",
|
|
1646
|
+
"values": []
|
|
1647
|
+
},
|
|
1648
|
+
{
|
|
1649
|
+
"name": "first",
|
|
1650
|
+
"description": "Whether to show the first page button. Default is false.",
|
|
1651
|
+
"values": []
|
|
1652
|
+
},
|
|
1653
|
+
{
|
|
1654
|
+
"name": "disabled",
|
|
1655
|
+
"description": "Whether the paginator is disabled.",
|
|
1656
|
+
"values": []
|
|
1657
|
+
},
|
|
1658
|
+
{
|
|
1659
|
+
"name": "alternative",
|
|
1660
|
+
"description": "Whether to use the alternative range label slot.",
|
|
1661
|
+
"values": []
|
|
1662
|
+
}
|
|
1663
|
+
],
|
|
1664
|
+
"references": []
|
|
1665
|
+
},
|
|
1606
1666
|
{
|
|
1607
1667
|
"name": "forge-popover",
|
|
1608
1668
|
"description": "Popovers are used to render content in an element that is above all other content on the page.\n---\n\n\n### **Events:**\n - **forge-popover-beforetoggle** - Dispatches before the popover is toggled, and is cancelable.\n- **forge-popover-toggle** - Dispatches after the popover is toggled.\n\n### **Methods:**\n - **hideAsync(): _Promise<void>_** - Hides the popover, and returns a `Promise` that resolves when the hide animation is complete.\n- **position(): _void_** - Forces the overlay to reposition itself.\n\n### **Slots:**\n - _default_ - The content to render inside the popover.\n\n### **CSS Properties:**\n - **--forge-popover-background** - The background color of the popover surface. _(default: undefined)_\n- **--forge-popover-border-radius** - The border radius of the popover surface. _(default: undefined)_\n- **--forge-popover-box-shadow** - The box shadow of the popover surface. _(default: undefined)_\n- **--forge-popover-border-width** - The border width of the popover surface. _(default: undefined)_\n- **--forge-popover-border-style** - The border style of the popover surface. _(default: undefined)_\n- **--forge-popover-border-color** - The border color of the popover surface. _(default: undefined)_\n- **--forge-popover-width** - The width of the popover surface. Defaults to `auto`. _(default: undefined)_\n- **--forge-popover-height** - The height of the popover surface. Defaults to `auto`. _(default: undefined)_\n- **--forge-popover-min-width** - The minimum width of the popover surface. Defaults to `none`. _(default: undefined)_\n- **--forge-popover-max-width** - The maximum width of the popover surface. Defaults to `none`. _(default: undefined)_\n- **--forge-popover-min-height** - The minimum height of the popover surface. Defaults to `none`. _(default: undefined)_\n- **--forge-popover-max-height** - The maximum height of the popover surface. Defaults to `none`. _(default: undefined)_\n- **--forge-popover-arrow-size** - The size of the arrow. _(default: undefined)_\n- **--forge-popover-arrow-height** - The height of the arrow. _(default: undefined)_\n- **--forge-popover-arrow-width** - The width of the arrow. _(default: undefined)_\n- **--forge-popover-arrow-background-color** - The background color of the arrow. Defaults to the background color of the popover surface. _(default: undefined)_\n- **--forge-popover-arrow-top-rotation** - The rotation of the arrow when the popover is placed on the top. _(default: undefined)_\n- **--forge-popover-arrow-right-rotation** - The rotation of the arrow when the popover is placed on the right. _(default: undefined)_\n- **--forge-popover-arrow-bottom-rotation** - The rotation of the arrow when the popover is placed on the bottom. _(default: undefined)_\n- **--forge-popover-arrow-left-rotation** - The rotation of the arrow when the popover is placed on the left. _(default: undefined)_\n- **--forge-popover-arrow-border-width** - The border width of the popover surface and arrow when an arrow is applied. _(default: undefined)_\n- **--forge-popover-arrow-clip-path** - The clip path to use for the arrow element. _(default: undefined)_\n- **--forge-popover-animation-timing** - The animation timing function to use for the popover animation. _(default: undefined)_\n- **--forge-popover-zoom-duration** - The duration of the zoom animation. _(default: undefined)_\n- **--forge-popover-zoom-timing** - The timing function to use for the zoom animation. _(default: undefined)_\n- **--forge-popover-slide-duration** - The duration of the slide animation. _(default: undefined)_\n- **--forge-popover-slide-timing** - The timing function to use for the slide animation. _(default: undefined)_\n- **--forge-popover-slide-offset** - The start offset to use for the slide animation. _(default: undefined)_\n- **--forge-popover-fade-duration** - The duration of the fade animation. _(default: undefined)_\n- **--forge-popover-fade-timing** - The timing function to use for the fade animation. _(default: undefined)_\n- **--forge-popover-position-block-start** - The `block-start` position of the popover. _(default: undefined)_\n- **--forge-popover-position-block-end** - The `block-end` position of the popover. _(default: undefined)_\n- **--forge-popover-position-inline-start** - The `inline-start` position of the popover. _(default: undefined)_\n- **--forge-popover-position-inline-end** - The `inline-end` position of the popover. _(default: undefined)_\n- **--forge-popover-preset-dropdown-max-height** - The maximum height of the popover when using `preset=\"dropdown\"`. Defaults to `256px`. _(default: undefined)_\n- **--forge-popover-preset-dropdown-overflow** - The overflow behavior of the popover when using `preset=\"dropdown\"`. Defaults to `auto visible` (vertical scrolling only). _(default: undefined)_\n\n### **CSS Parts:**\n - **overlay** - The overlay root element.\n- **surface** - The surface container element for the slotted content.",
|
|
@@ -1729,79 +1789,79 @@
|
|
|
1729
1789
|
"references": []
|
|
1730
1790
|
},
|
|
1731
1791
|
{
|
|
1732
|
-
"name": "forge-
|
|
1733
|
-
"description": "
|
|
1792
|
+
"name": "forge-skeleton",
|
|
1793
|
+
"description": "Skeleton is used to provide a placeholder for content that is loading.\n---\n\n\n### **CSS Properties:**\n - **--forge-skeleton-animation-duration** - The duration of the skeleton animation. _(default: undefined)_\n- **--forge-skeleton-width** - The width of the skeleton. _(default: undefined)_\n- **--forge-skeleton-height** - The height of the skeleton. _(default: undefined)_\n- **--forge-skeleton-background** - The background color of the skeleton. _(default: undefined)_\n- **--forge-skeleton-shape** - The shape of the skeleton. _(default: undefined)_\n- **--forge-skeleton-margin** - The margin of the skeleton. _(default: undefined)_\n- **--forge-skeleton-button-height** - The height of the button skeleton. _(default: undefined)_\n- **--forge-skeleton-button-width** - The width of the button skeleton. _(default: undefined)_\n- **--forge-skeleton-form-field-height** - The height of the form field skeleton. _(default: undefined)_\n- **--forge-skeleton-form-field-width** - The width of the form field skeleton. _(default: undefined)_\n- **--forge-skeleton-chip-height** - The height of the chip skeleton. _(default: undefined)_\n- **--forge-skeleton-chip-width** - The width of the chip skeleton. _(default: undefined)_\n- **--forge-skeleton-chip-shape** - The shape of the chip skeleton. _(default: undefined)_\n- **--forge-skeleton-list-item-height** - The height of the list item skeleton. _(default: undefined)_\n- **--forge-skeleton-list-item-margin** - The margin of the list item skeleton. _(default: undefined)_\n- **--forge-skeleton-text-height** - The height of the text skeleton. _(default: undefined)_\n- **--forge-skeleton-gradient-color** - The color of the gradient skeleton. _(default: undefined)_\n- **--forge-skeleton-avatar-size** - The size of the avatar skeleton. _(default: undefined)_\n- **--forge-skeleton-avatar-shape** - The shape of the avatar skeleton. _(default: undefined)_\n\n### **CSS Parts:**\n - **root** - The root element of the skeleton.",
|
|
1734
1794
|
"attributes": [
|
|
1735
1795
|
{
|
|
1736
|
-
"name": "
|
|
1737
|
-
"description": "
|
|
1796
|
+
"name": "form-field",
|
|
1797
|
+
"description": "Apply form field styles to the skeleton.",
|
|
1738
1798
|
"values": []
|
|
1739
1799
|
},
|
|
1740
1800
|
{
|
|
1741
|
-
"name": "
|
|
1742
|
-
"description": "
|
|
1743
|
-
"values": [
|
|
1801
|
+
"name": "button",
|
|
1802
|
+
"description": "Apply button styles to the skeleton.",
|
|
1803
|
+
"values": []
|
|
1744
1804
|
},
|
|
1745
1805
|
{
|
|
1746
|
-
"name": "
|
|
1747
|
-
"description": "
|
|
1806
|
+
"name": "chip",
|
|
1807
|
+
"description": "Apply chip styles to the skeleton.",
|
|
1748
1808
|
"values": []
|
|
1749
1809
|
},
|
|
1750
1810
|
{
|
|
1751
|
-
"name": "
|
|
1752
|
-
"description": "
|
|
1811
|
+
"name": "list-item",
|
|
1812
|
+
"description": "Apply list item styles to the skeleton.",
|
|
1753
1813
|
"values": []
|
|
1754
1814
|
},
|
|
1755
1815
|
{
|
|
1756
|
-
"name": "
|
|
1757
|
-
"description": "
|
|
1816
|
+
"name": "text",
|
|
1817
|
+
"description": "Apply text styles to the skeleton.",
|
|
1758
1818
|
"values": []
|
|
1759
1819
|
},
|
|
1760
1820
|
{
|
|
1761
|
-
"name": "
|
|
1762
|
-
"description": "
|
|
1821
|
+
"name": "avatar",
|
|
1822
|
+
"description": "Apply avatar styles to the skeleton.",
|
|
1823
|
+
"values": []
|
|
1824
|
+
},
|
|
1825
|
+
{
|
|
1826
|
+
"name": "stretch",
|
|
1827
|
+
"description": "Apply stretch styles to the skeleton.",
|
|
1763
1828
|
"values": []
|
|
1764
1829
|
}
|
|
1765
1830
|
],
|
|
1766
1831
|
"references": []
|
|
1767
1832
|
},
|
|
1768
1833
|
{
|
|
1769
|
-
"name": "forge-
|
|
1770
|
-
"description": "
|
|
1834
|
+
"name": "forge-skip-link",
|
|
1835
|
+
"description": "The Forge Skip Link component is used to provide a way for users to skip repetitive content and navigate directly to a section of the page.\n---\n\n\n### **Slots:**\n - _default_ - The default/unnamed slot for link text.\n\n### **CSS Properties:**\n - **--forge-skip-link-background** - The background color of the skip link. _(default: undefined)_\n- **--forge-skip-link-color** - The text color of the skip link. _(default: undefined)_\n- **--forge-skip-link-shape** - The border radius of the skip link. _(default: undefined)_\n- **--forge-skip-link-inset** - The skip link's inset from the edge of the viewport. _(default: undefined)_\n- **--forge-skip-link-z-index** - The z-index of the skip link. _(default: undefined)_\n- **--forge-skip-link-elevation** - The box shadow of the skip link. _(default: undefined)_\n- **--forge-skip-link-padding-block** - The interior padding of the skip link along the block axis. _(default: undefined)_\n- **--forge-skip-link-padding-inline** - The interior padding of the skip link along the inline axis. _(default: undefined)_\n- **--forge-skip-link-focus-indicator-color** - The color of the focus indicator. _(default: undefined)_\n- **--forge-skip-link-transition-duration** - The duration of the skip link's animations. _(default: undefined)_\n- **--forge-skip-link-transition-timing-function** - The timing function of the skip link's animations. _(default: undefined)_\n\n### **CSS Parts:**\n - **anchor** - The root anchor element.\n- **focus-indicator** - The focus indicator element.\n- **state-layer** - The state layer element.",
|
|
1771
1836
|
"attributes": [
|
|
1772
1837
|
{
|
|
1773
|
-
"name": "
|
|
1774
|
-
"description": "
|
|
1775
|
-
"values": []
|
|
1776
|
-
},
|
|
1777
|
-
{
|
|
1778
|
-
"name": "button",
|
|
1779
|
-
"description": "Apply button styles to the skeleton.",
|
|
1838
|
+
"name": "target",
|
|
1839
|
+
"description": "The IDREF of the element to which the skip link should navigate.",
|
|
1780
1840
|
"values": []
|
|
1781
1841
|
},
|
|
1782
1842
|
{
|
|
1783
|
-
"name": "
|
|
1784
|
-
"description": "
|
|
1785
|
-
"values": []
|
|
1843
|
+
"name": "theme",
|
|
1844
|
+
"description": "The theme applied to the skip link.",
|
|
1845
|
+
"values": [{ "name": "SkipLinkTheme" }]
|
|
1786
1846
|
},
|
|
1787
1847
|
{
|
|
1788
|
-
"name": "
|
|
1789
|
-
"description": "
|
|
1848
|
+
"name": "muted",
|
|
1849
|
+
"description": "Whether or not the skip link uses a muted color scheme.",
|
|
1790
1850
|
"values": []
|
|
1791
1851
|
},
|
|
1792
1852
|
{
|
|
1793
|
-
"name": "
|
|
1794
|
-
"description": "
|
|
1853
|
+
"name": "persistent",
|
|
1854
|
+
"description": "Whether or not the skip link should remain visible when not focused.",
|
|
1795
1855
|
"values": []
|
|
1796
1856
|
},
|
|
1797
1857
|
{
|
|
1798
|
-
"name": "
|
|
1799
|
-
"description": "
|
|
1858
|
+
"name": "inline",
|
|
1859
|
+
"description": "Whether or not the skip link renders within its container.",
|
|
1800
1860
|
"values": []
|
|
1801
1861
|
},
|
|
1802
1862
|
{
|
|
1803
|
-
"name": "
|
|
1804
|
-
"description": "
|
|
1863
|
+
"name": "skip-url-change",
|
|
1864
|
+
"description": "Sets the skip link to skip browser navigation and scroll to the target element.",
|
|
1805
1865
|
"values": []
|
|
1806
1866
|
}
|
|
1807
1867
|
],
|
|
@@ -1983,6 +2043,23 @@
|
|
|
1983
2043
|
],
|
|
1984
2044
|
"references": []
|
|
1985
2045
|
},
|
|
2046
|
+
{
|
|
2047
|
+
"name": "forge-state-layer",
|
|
2048
|
+
"description": "State layers show the interaction status of an element.\n---\n\n\n### **Methods:**\n - **playAnimation(coords: _StateLayerCoords_): _void_** - Triggers the animation to run.\n\nNote: If coordinates are not provided, the transition will originate from the center of the target element.\n\n### **CSS Properties:**\n - **--forge-state-layer-color** - The color of the state layer. Defaults to the on-surface theme. _(default: undefined)_\n- **--forge-state-layer-hover-color** - The color of the state layer when hovered. _(default: undefined)_\n- **--forge-state-layer-hover-opacity** - The opacity of the state layer when hovered. _(default: undefined)_\n- **--forge-state-layer-pressed-color** - The color of the state layer when pressed. _(default: undefined)_\n- **--forge-state-layer-pressed-opacity** - The opacity of the state layer when pressed. _(default: undefined)_\n- **--forge-state-layer-hover-duration** - The duration of the hover animation. _(default: undefined)_\n- **--forge-state-layer-animation-duration** - The duration of the animation. _(default: undefined)_\n- **--forge-state-layer-pressed-duration** - The duration of the pressed animation. _(default: undefined)_\n\n### **CSS Parts:**\n - **surface** - The surface element.",
|
|
2049
|
+
"attributes": [
|
|
2050
|
+
{
|
|
2051
|
+
"name": "target",
|
|
2052
|
+
"description": "The id of the element to attach the state layer to.",
|
|
2053
|
+
"values": []
|
|
2054
|
+
},
|
|
2055
|
+
{
|
|
2056
|
+
"name": "disabled",
|
|
2057
|
+
"description": "Controls whether the state layer is disabled.",
|
|
2058
|
+
"values": []
|
|
2059
|
+
}
|
|
2060
|
+
],
|
|
2061
|
+
"references": []
|
|
2062
|
+
},
|
|
1986
2063
|
{
|
|
1987
2064
|
"name": "forge-switch",
|
|
1988
2065
|
"description": "Switches toggle the state of a single setting on or off.\n---\n\n\n### **Events:**\n - **change** - Dispatches when the switch's value changes.\n- **forge-switch-change** - Dispatches when the switch's value changes.\n\n### **Methods:**\n - **toggle(force: _boolean_): _void_** - Toggles the switch on or off.\n\n### **CSS Properties:**\n - **--forge-theme-primary** - The primary color of the switch. _(default: undefined)_\n- **--forge-theme-on-primary** - The color of elements placed on top of the primary color (the handle icons for example). _(default: undefined)_\n- **--forge-switch-handle-on-color** - The color of the handle in the switch's on state. _(default: undefined)_\n- **--forge-switch-handle-off-color** - The color of the handle in the switch's off state. _(default: undefined)_\n- **--forge-switch-handle-active-on-color** - The color of the handle when the switch is active (pressed) in its on state. _(default: undefined)_\n- **--forge-switch-handle-active-off-color** - The color of the handle when the switch is active (pressed) in its off state. _(default: undefined)_\n- **--forge-switch-handle-size** - The inline and block size of the handle. _(default: undefined)_\n- **--forge-switch-handle-width** - The inline size of the handle. _(default: undefined)_\n- **--forge-switch-handle-height** - The block size of the handle. _(default: undefined)_\n- **--forge-switch-handle-scale** - The scale transformation applied to the handle. _(default: undefined)_\n- **--forge-switch-handle-on-scale** - The scale transformation applied to the handle in the switch's on state. _(default: undefined)_\n- **--forge-switch-handle-off-scale** - The scale transformation applied to the handle in the switch's off state. _(default: undefined)_\n- **--forge-switch-handle-active-scale** - The scale transformation applied to the handle when the switch is active (pressed). _(default: undefined)_\n- **--forge-switch-handle-active-on-scale** - The scale transformation applied to the handle when the switch is active (pressed) in its on state. _(default: undefined)_\n- **--forge-switch-handle-active-off-scale** - The scale transformation applied to the handle when the switch is active (pressed) in its off state. _(default: undefined)_\n- **--forge-switch-handle-shape** - The shape of the handle. _(default: undefined)_\n- **--forge-switch-handle-elevation** - The handle's shadow. _(default: undefined)_\n- **--forge-switch-handle-on-elevation** - The handle's shadow in the switch's on state. _(default: undefined)_\n- **--forge-switch-handle-off-elevation** - The handle's shadow in the switch's off state. _(default: undefined)_\n- **--forge-switch-handle-active-elevation** - The handle's shadow when the switch is active (pressed). _(default: undefined)_\n- **--forge-switch-handle-active-on-elevation** - The handle's shadow when the switch is active (pressed) in its on state. _(default: undefined)_\n- **--forge-switch-handle-active-off-elevation** - The handle's shadow when the switch is active (pressed) in its off state. _(default: undefined)_\n- **--forge-switch-track-on-color** - The color of the track in the switch's on state. _(default: undefined)_\n- **--forge-switch-track-off-color** - The color fo the track in the switch's off state. _(default: undefined)_\n- **--forge-switch-track-active-on-color** - The color of the track when the switch is active (pressed) in its on state. _(default: undefined)_\n- **--forge-switch-track-active-off-color** - The color fo the track when the switch is active (pressed) in its off state. _(default: undefined)_\n- **--forge-switch-track-width** - The inline size of the track. _(default: undefined)_\n- **--forge-switch-track-height** - The block size of the track. _(default: undefined)_\n- **--forge-switch-track-shape** - The shape of the track. _(default: undefined)_\n- **--forge-switch-track-border-width** - The width of the track border. _(default: undefined)_\n- **--forge-switch-track-on-border-width** - The width of the track border in the switch's on state. _(default: undefined)_\n- **--forge-switch-track-off-border-width** - The width of the track border in the switch's off state. _(default: undefined)_\n- **--forge-switch-track-active-on-border-width** - The width of the track border when the switch is active (pressed) in its on state. _(default: undefined)_\n- **--forge-switch-track-active-off-border-width** - The width of the track border when the switch is active (pressed) in its off state. _(default: undefined)_\n- **--forge-switch-track-border-color** - The color of the track border. _(default: undefined)_\n- **--forge-switch-track-on-border-color** - The color of the track border in the switch's on state. _(default: undefined)_\n- **--forge-switch-track-off-border-color** - The color of the track border in the switch's off state. _(default: undefined)_\n- **--forge-switch-track-active-on-border-color** - The color of the track border when the switch is active (pressed) in its on state. _(default: undefined)_\n- **--forge-switch-track-active-off-border-color** - The color of the track border when the switch is active (pressed) in its off state. _(default: undefined)_\n- **--forge-switch-icon-color** - The color of the handle icons. _(default: undefined)_\n- **--forge-switch-icon-on-color** - The color of the handle icon in the switch's on state. _(default: undefined)_\n- **--forge-switch-icon-off-color** - The color of the handle icon in the switch's off state. _(default: undefined)_\n- **--forge-switch-icon-active-on-color** - The color of the handle icon when the switch is active (pressed) in its on state. _(default: undefined)_\n- **--forge-switch-icon-active-off-color** - The color of the handle icon when the switch is active (pressed) in its off state. _(default: undefined)_\n- **--forge-switch-icon-size** - The size of the handle icon. _(default: undefined)_\n- **--forge-switch-icon-on-size** - The size of the handle icon in the switch's on state. _(default: undefined)_\n- **--forge-switch-icon-off-size** - The size of the handle icon in the switch's off state. _(default: undefined)_\n- **--forge-switch-icon-scale** - The scale transformation applied to the handle icons. _(default: undefined)_\n- **--forge-switch-icon-on-scale** - The scale transformation applied to the handle icons in the switch's on state. _(default: undefined)_\n- **--forge-switch-icon-off-scale** - The scale transformation applied to the handle icons in the switch's off state. _(default: undefined)_\n- **--forge-switch-icon-active-on-scale** - The scale transformation applied to the handle icons when the switch is active (pressed) in its on state. _(default: undefined)_\n- **--forge-switch-icon-active-off-scale** - The scale transformation applied to the handle icons when the switch is active (pressed) in its off state. _(default: undefined)_\n- **--forge-switch-gap** - The space between the switch and label. _(default: undefined)_\n- **--forge-switch-justify** - How the switch and label are distributed along their main axis. _(default: undefined)_\n- **--forge-switch-align** - How the switch and label are distributed along their cross axis. _(default: undefined)_\n- **--forge-switch-direction** - Whether the switch and label are arranged along the inline or block axis. _(default: undefined)_\n- **--forge-switch-state-layer-size** - The inline and block size of the handle's state layer. _(default: undefined)_\n- **--forge-switch-state-layer-width** - The inline size of the handle's state layer. _(default: undefined)_\n- **--forge-switch-state-layer-height** - The block size of the handle's state layer. _(default: undefined)_\n- **--forge-switch-state-layer-on-color** - The color of the handle's state layer when the switch is in its on state. _(default: undefined)_\n- **--forge-switch-state-layer-off-color** - The color of the handle's state layer when the switch is in its off state. _(default: undefined)_\n- **--forge-switch-state-layer-dense-size** - The inline and block size of the handle's state layer when the dense switch is used. _(default: undefined)_\n- **--forge-switch-state-layer-dense-width** - The inline size of the handle's state layer when the dense switch is used. _(default: undefined)_\n- **--forge-switch-state-layer-dense-height** - The block size of the handle's state layer when the dense switch is used. _(default: undefined)_\n- **--forge-switch-disabled-opacity** - The opacity of the switch when disabled. _(default: undefined)_\n- **--forge-switch-animation-duration** - The duration of animations. _(default: undefined)_\n- **--forge-switch-animation-timing** - The timing function used in most animations. _(default: undefined)_\n- **--forge-switch-active-animation-timing** - The timing function used in active state animations. _(default: undefined)_\n\n### **CSS Parts:**\n - **switch** - Styles the switch container element.\n- **track** - Styles the track element.\n- **handle** - Styles the handle element.\n- **icon-on** - Styles the on icon element.\n- **icon-off** - Styles the off icon element.\n- **label** - Styles the label element.\n- **state-layer** - Styles the state layer root element.\n- **focus-indicator** - Styles the focus indicator root element.",
|
|
@@ -2033,19 +2110,106 @@
|
|
|
2033
2110
|
"values": []
|
|
2034
2111
|
},
|
|
2035
2112
|
{
|
|
2036
|
-
"name": "readonly",
|
|
2037
|
-
"description": "Controls whether the switch is readonly.",
|
|
2113
|
+
"name": "readonly",
|
|
2114
|
+
"description": "Controls whether the switch is readonly.",
|
|
2115
|
+
"values": []
|
|
2116
|
+
},
|
|
2117
|
+
{
|
|
2118
|
+
"name": "icon",
|
|
2119
|
+
"description": "Controls the presence of the off and on icons.",
|
|
2120
|
+
"values": [{ "name": "SwitchIconVisibility" }]
|
|
2121
|
+
},
|
|
2122
|
+
{
|
|
2123
|
+
"name": "label-position",
|
|
2124
|
+
"description": "Controls whether the label appears before or after the switch.",
|
|
2125
|
+
"values": [{ "name": "SwitchLabelPosition" }]
|
|
2126
|
+
}
|
|
2127
|
+
],
|
|
2128
|
+
"references": []
|
|
2129
|
+
},
|
|
2130
|
+
{
|
|
2131
|
+
"name": "forge-table",
|
|
2132
|
+
"description": "\n---\n\n\n### **Events:**\n - **forge-table-row-click** - Dispatched when a row is clicked. Only applies when `allow-row-click` is specified.\n- **forge-table-select** - Dispatched when a row is selected. Only applies when `select` is specified.\n- **forge-table-select-double** - Dispatched when a row is double-clicked. Only applies when `select` is specified.\n- **forge-table-select-all** - Dispatched when the select all checkbox is toggled. Only applies when `select` and `multiselect` is specified.\n- **forge-table-sort** - Dispatched when a column is sorted.\n- **forge-table-filter** - Dispatched when a column is filtered. Only applies when `filter` is specified.\n- **forge-table-initialized** - Dispatched when the table is initialized in the DOM for the first time.\n- **forge-table-column-resize** - Dispatched when a column is resized.\n\n### **Methods:**\n - **hideColumn(columnIndex: _number_): _void_** - Hides a column from the table.\n- **showColumn(columnIndex: _number_): _void_** - Shows a hidden column in th table.\n- **isColumnHidden(columnIndex: _number_): _boolean_** - Determines if a column at the given index is hidden or not.\n- **getSelectedRows(): _any[]_** - Returns the selected row instances.\n- **selectRow(data: _any_): _void_** - Selects a row in the table. Only applicable if `select` is true.\n- **selectRows(data: _any[]_, preserveExisting: _boolean_): _void_** - Selects one or more rows in the table. Only applicable if `select` is true.\n- **deselectRow(data: _any_): _void_** - Deselects a single row in the table.\n- **deselectRows(data: _any[]_): _void_** - Deselects one or more rows in the table.\n- **clearSelections(): _void_** - Clears all selected table rows.\n- **render(): _void_** - Forces the table to re-render based on its current configuration.\n- **expandRow(rowIndex: _any_, template: _TableViewTemplate_): _Promise<void>_** - Expands a collapsed row.\n- **collapseRow(rowIndex: _number_): _Promise<void>_** - Collapses an expanded row.\n- **isRowExpanded(rowIndex: _number_): _boolean_** - Checks if a row is expanded or not.\n- **selectRowsByIndex(indexes: _number | number[]_, preserveExisting: _boolean_): _void_** - Selects a rows by an index or array of indexes.\n- **deselectRowsByIndex(indexes: _number | number[]_): _void_** - Deselects a rows by an index or array of indexes.\n- **isRowSelected(rowData: _{ [key: string]: any }_): _boolean_** - Checks if a row is selected or not.",
|
|
2133
|
+
"attributes": [
|
|
2134
|
+
{
|
|
2135
|
+
"name": "select",
|
|
2136
|
+
"description": "Controls the visibility of the select column.",
|
|
2137
|
+
"values": []
|
|
2138
|
+
},
|
|
2139
|
+
{
|
|
2140
|
+
"name": "multiselect",
|
|
2141
|
+
"description": "Controls the visibility of the select all checkbox (only applied when `select` is `true`).",
|
|
2142
|
+
"values": []
|
|
2143
|
+
},
|
|
2144
|
+
{
|
|
2145
|
+
"name": "select-key",
|
|
2146
|
+
"description": "The row key for matching data to selections.",
|
|
2147
|
+
"values": [{ "name": "string[]" }]
|
|
2148
|
+
},
|
|
2149
|
+
{
|
|
2150
|
+
"name": "tooltip-select",
|
|
2151
|
+
"description": "The tooltip to display when hovering over the select column.",
|
|
2152
|
+
"values": [{ "name": "TableSelectTooltipCallback" }]
|
|
2153
|
+
},
|
|
2154
|
+
{
|
|
2155
|
+
"name": "tooltip-select-all",
|
|
2156
|
+
"description": "The tooltip to display when hovering over the select all checkbox.",
|
|
2157
|
+
"values": []
|
|
2158
|
+
},
|
|
2159
|
+
{
|
|
2160
|
+
"name": "dense",
|
|
2161
|
+
"description": "Controls whether the table is dense or not.",
|
|
2162
|
+
"values": []
|
|
2163
|
+
},
|
|
2164
|
+
{
|
|
2165
|
+
"name": "roomy",
|
|
2166
|
+
"description": "Controls whether the table is roomy or not.",
|
|
2167
|
+
"values": []
|
|
2168
|
+
},
|
|
2169
|
+
{
|
|
2170
|
+
"name": "filter",
|
|
2171
|
+
"description": "Controls whether the table shows its column filter row.",
|
|
2172
|
+
"values": []
|
|
2173
|
+
},
|
|
2174
|
+
{
|
|
2175
|
+
"name": "fixed-headers",
|
|
2176
|
+
"description": "Controls whether the table applies fixed headers when in scroll containers.",
|
|
2177
|
+
"values": []
|
|
2178
|
+
},
|
|
2179
|
+
{
|
|
2180
|
+
"name": "layout-type",
|
|
2181
|
+
"description": "Controls the table layout algorithm.",
|
|
2182
|
+
"values": [{ "name": "TableLayoutType" }]
|
|
2183
|
+
},
|
|
2184
|
+
{
|
|
2185
|
+
"name": "wrap-content",
|
|
2186
|
+
"description": "Controls whether the content in each cell wraps or not (true by default).",
|
|
2187
|
+
"values": []
|
|
2188
|
+
},
|
|
2189
|
+
{
|
|
2190
|
+
"name": "resizable",
|
|
2191
|
+
"description": "Controls whether the columns are resizable or not.",
|
|
2192
|
+
"values": []
|
|
2193
|
+
},
|
|
2194
|
+
{
|
|
2195
|
+
"name": "min-resize-width",
|
|
2196
|
+
"description": "Gets/sets the minimum width that a column can be resized to by the user dragging the resize handle.",
|
|
2197
|
+
"values": []
|
|
2198
|
+
},
|
|
2199
|
+
{
|
|
2200
|
+
"name": "allow-row-click",
|
|
2201
|
+
"description": "Gets/sets whether the rows respond to (and emit) row click events.",
|
|
2038
2202
|
"values": []
|
|
2039
2203
|
},
|
|
2040
2204
|
{
|
|
2041
|
-
"name": "
|
|
2042
|
-
"description": "
|
|
2043
|
-
"values": [
|
|
2205
|
+
"name": "multi-column-sort",
|
|
2206
|
+
"description": "Gets/sets whether the table supports multi-column sorting.",
|
|
2207
|
+
"values": []
|
|
2044
2208
|
},
|
|
2045
2209
|
{
|
|
2046
|
-
"name": "
|
|
2047
|
-
"description": "Controls
|
|
2048
|
-
"values": [{ "name": "
|
|
2210
|
+
"name": "select-checkbox-alignment",
|
|
2211
|
+
"description": "Controls the alignment of the select checkbox.",
|
|
2212
|
+
"values": [{ "name": "`${CellAlign}`" }]
|
|
2049
2213
|
}
|
|
2050
2214
|
],
|
|
2051
2215
|
"references": []
|
|
@@ -2269,110 +2433,6 @@
|
|
|
2269
2433
|
],
|
|
2270
2434
|
"references": []
|
|
2271
2435
|
},
|
|
2272
|
-
{
|
|
2273
|
-
"name": "forge-table",
|
|
2274
|
-
"description": "\n---\n\n\n### **Events:**\n - **forge-table-row-click** - Dispatched when a row is clicked. Only applies when `allow-row-click` is specified.\n- **forge-table-select** - Dispatched when a row is selected. Only applies when `select` is specified.\n- **forge-table-select-double** - Dispatched when a row is double-clicked. Only applies when `select` is specified.\n- **forge-table-select-all** - Dispatched when the select all checkbox is toggled. Only applies when `select` and `multiselect` is specified.\n- **forge-table-sort** - Dispatched when a column is sorted.\n- **forge-table-filter** - Dispatched when a column is filtered. Only applies when `filter` is specified.\n- **forge-table-initialized** - Dispatched when the table is initialized in the DOM for the first time.\n- **forge-table-column-resize** - Dispatched when a column is resized.\n\n### **Methods:**\n - **hideColumn(columnIndex: _number_): _void_** - Hides a column from the table.\n- **showColumn(columnIndex: _number_): _void_** - Shows a hidden column in th table.\n- **isColumnHidden(columnIndex: _number_): _boolean_** - Determines if a column at the given index is hidden or not.\n- **getSelectedRows(): _any[]_** - Returns the selected row instances.\n- **selectRow(data: _any_): _void_** - Selects a row in the table. Only applicable if `select` is true.\n- **selectRows(data: _any[]_, preserveExisting: _boolean_): _void_** - Selects one or more rows in the table. Only applicable if `select` is true.\n- **deselectRow(data: _any_): _void_** - Deselects a single row in the table.\n- **deselectRows(data: _any[]_): _void_** - Deselects one or more rows in the table.\n- **clearSelections(): _void_** - Clears all selected table rows.\n- **render(): _void_** - Forces the table to re-render based on its current configuration.\n- **expandRow(rowIndex: _any_, template: _TableViewTemplate_): _Promise<void>_** - Expands a collapsed row.\n- **collapseRow(rowIndex: _number_): _Promise<void>_** - Collapses an expanded row.\n- **isRowExpanded(rowIndex: _number_): _boolean_** - Checks if a row is expanded or not.\n- **selectRowsByIndex(indexes: _number | number[]_, preserveExisting: _boolean_): _void_** - Selects a rows by an index or array of indexes.\n- **deselectRowsByIndex(indexes: _number | number[]_): _void_** - Deselects a rows by an index or array of indexes.\n- **isRowSelected(rowData: _{ [key: string]: any }_): _boolean_** - Checks if a row is selected or not.",
|
|
2275
|
-
"attributes": [
|
|
2276
|
-
{
|
|
2277
|
-
"name": "select",
|
|
2278
|
-
"description": "Controls the visibility of the select column.",
|
|
2279
|
-
"values": []
|
|
2280
|
-
},
|
|
2281
|
-
{
|
|
2282
|
-
"name": "multiselect",
|
|
2283
|
-
"description": "Controls the visibility of the select all checkbox (only applied when `select` is `true`).",
|
|
2284
|
-
"values": []
|
|
2285
|
-
},
|
|
2286
|
-
{
|
|
2287
|
-
"name": "select-key",
|
|
2288
|
-
"description": "The row key for matching data to selections.",
|
|
2289
|
-
"values": [{ "name": "string[]" }]
|
|
2290
|
-
},
|
|
2291
|
-
{
|
|
2292
|
-
"name": "tooltip-select",
|
|
2293
|
-
"description": "The tooltip to display when hovering over the select column.",
|
|
2294
|
-
"values": [{ "name": "TableSelectTooltipCallback" }]
|
|
2295
|
-
},
|
|
2296
|
-
{
|
|
2297
|
-
"name": "tooltip-select-all",
|
|
2298
|
-
"description": "The tooltip to display when hovering over the select all checkbox.",
|
|
2299
|
-
"values": []
|
|
2300
|
-
},
|
|
2301
|
-
{
|
|
2302
|
-
"name": "dense",
|
|
2303
|
-
"description": "Controls whether the table is dense or not.",
|
|
2304
|
-
"values": []
|
|
2305
|
-
},
|
|
2306
|
-
{
|
|
2307
|
-
"name": "roomy",
|
|
2308
|
-
"description": "Controls whether the table is roomy or not.",
|
|
2309
|
-
"values": []
|
|
2310
|
-
},
|
|
2311
|
-
{
|
|
2312
|
-
"name": "filter",
|
|
2313
|
-
"description": "Controls whether the table shows its column filter row.",
|
|
2314
|
-
"values": []
|
|
2315
|
-
},
|
|
2316
|
-
{
|
|
2317
|
-
"name": "fixed-headers",
|
|
2318
|
-
"description": "Controls whether the table applies fixed headers when in scroll containers.",
|
|
2319
|
-
"values": []
|
|
2320
|
-
},
|
|
2321
|
-
{
|
|
2322
|
-
"name": "layout-type",
|
|
2323
|
-
"description": "Controls the table layout algorithm.",
|
|
2324
|
-
"values": [{ "name": "TableLayoutType" }]
|
|
2325
|
-
},
|
|
2326
|
-
{
|
|
2327
|
-
"name": "wrap-content",
|
|
2328
|
-
"description": "Controls whether the content in each cell wraps or not (true by default).",
|
|
2329
|
-
"values": []
|
|
2330
|
-
},
|
|
2331
|
-
{
|
|
2332
|
-
"name": "resizable",
|
|
2333
|
-
"description": "Controls whether the columns are resizable or not.",
|
|
2334
|
-
"values": []
|
|
2335
|
-
},
|
|
2336
|
-
{
|
|
2337
|
-
"name": "min-resize-width",
|
|
2338
|
-
"description": "Gets/sets the minimum width that a column can be resized to by the user dragging the resize handle.",
|
|
2339
|
-
"values": []
|
|
2340
|
-
},
|
|
2341
|
-
{
|
|
2342
|
-
"name": "allow-row-click",
|
|
2343
|
-
"description": "Gets/sets whether the rows respond to (and emit) row click events.",
|
|
2344
|
-
"values": []
|
|
2345
|
-
},
|
|
2346
|
-
{
|
|
2347
|
-
"name": "multi-column-sort",
|
|
2348
|
-
"description": "Gets/sets whether the table supports multi-column sorting.",
|
|
2349
|
-
"values": []
|
|
2350
|
-
},
|
|
2351
|
-
{
|
|
2352
|
-
"name": "select-checkbox-alignment",
|
|
2353
|
-
"description": "Controls the alignment of the select checkbox.",
|
|
2354
|
-
"values": [{ "name": "`${CellAlign}`" }]
|
|
2355
|
-
}
|
|
2356
|
-
],
|
|
2357
|
-
"references": []
|
|
2358
|
-
},
|
|
2359
|
-
{
|
|
2360
|
-
"name": "forge-state-layer",
|
|
2361
|
-
"description": "State layers show the interaction status of an element.\n---\n\n\n### **Methods:**\n - **playAnimation(coords: _StateLayerCoords_): _void_** - Triggers the animation to run.\n\nNote: If coordinates are not provided, the transition will originate from the center of the target element.\n\n### **CSS Properties:**\n - **--forge-state-layer-color** - The color of the state layer. Defaults to the on-surface theme. _(default: undefined)_\n- **--forge-state-layer-hover-color** - The color of the state layer when hovered. _(default: undefined)_\n- **--forge-state-layer-hover-opacity** - The opacity of the state layer when hovered. _(default: undefined)_\n- **--forge-state-layer-pressed-color** - The color of the state layer when pressed. _(default: undefined)_\n- **--forge-state-layer-pressed-opacity** - The opacity of the state layer when pressed. _(default: undefined)_\n- **--forge-state-layer-hover-duration** - The duration of the hover animation. _(default: undefined)_\n- **--forge-state-layer-animation-duration** - The duration of the animation. _(default: undefined)_\n- **--forge-state-layer-pressed-duration** - The duration of the pressed animation. _(default: undefined)_\n\n### **CSS Parts:**\n - **surface** - The surface element.",
|
|
2362
|
-
"attributes": [
|
|
2363
|
-
{
|
|
2364
|
-
"name": "target",
|
|
2365
|
-
"description": "The id of the element to attach the state layer to.",
|
|
2366
|
-
"values": []
|
|
2367
|
-
},
|
|
2368
|
-
{
|
|
2369
|
-
"name": "disabled",
|
|
2370
|
-
"description": "Controls whether the state layer is disabled.",
|
|
2371
|
-
"values": []
|
|
2372
|
-
}
|
|
2373
|
-
],
|
|
2374
|
-
"references": []
|
|
2375
|
-
},
|
|
2376
2436
|
{
|
|
2377
2437
|
"name": "forge-toast",
|
|
2378
2438
|
"description": "Toasts are non-modal notifications that appear in response to user interactions.\n---\n\n\n### **Events:**\n - **forge-toast-action** - Dispatched when the action button is clicked.\n- **forge-toast-close** - Dispatched when the toast is closed.\n\n### **Methods:**\n - **show(): _void_** - Shows the toast.\n- **hide(): __** - Hides the toast.\n\n### **CSS Properties:**\n - **--forge-toast-background** - The background color of the toast. _(default: undefined)_\n- **--forge-toast-color** - The text color of the toast. _(default: undefined)_\n- **--forge-toast-offset** - The offset of the toast from the edge of the viewport. _(default: undefined)_\n- **--forge-toast-shape** - The shape of the toast. _(default: undefined)_\n- **--forge-toast-elevation** - The elevation of the toast. _(default: undefined)_\n- **--forge-toast-action-color** - The text color of the action button. _(default: undefined)_\n- **--forge-toast-min-width** - The minimum width of the toast. _(default: undefined)_\n- **--forge-toast-max-width** - The maximum width of the toast. _(default: undefined)_\n- **--forge-toast-min-height** - The minimum height of the toast. _(default: undefined)_\n- **--forge-toast-inline-padding** - The padding of the toast when inline. _(default: undefined)_\n- **--forge-toast-spacing** - The spacing between toasts. _(default: undefined)_\n- **--forge-toast-message-padding** - The padding of the toast message. _(default: undefined)_\n- **--forge-toast-enter-duration** - The duration of the enter animation. _(default: undefined)_\n- **--forge-toast-enter-timing** - The timing function of the enter animation. _(default: undefined)_\n- **--forge-toast-exit-duration** - The duration of the exit animation. _(default: undefined)_\n- **--forge-toast-exit-timing** - The timing function of the exit animation. _(default: undefined)_\n- **--forge-toast-slide-origin** - The origin of the slide animation. _(default: undefined)_\n\n### **CSS Parts:**\n - **surface** - The surface container.\n- **message** - The message container.\n- **action-button** - The action button.\n- **close-button** - The close button.\n- **overlay** - The `<forge-overlay>` element.",
|
|
@@ -2503,6 +2563,26 @@
|
|
|
2503
2563
|
],
|
|
2504
2564
|
"references": []
|
|
2505
2565
|
},
|
|
2566
|
+
{
|
|
2567
|
+
"name": "forge-view-switcher",
|
|
2568
|
+
"description": "\n---\n\n\n### **Methods:**\n - **next(): _void_** - Transitions to the next view.\n- **previous(): _void_** - Transitions to the previous view.\n- **goToStart(): _void_** - Transitions to the first view.\n- **goToEnd(): _void_** - Transitions to the last view.",
|
|
2569
|
+
"attributes": [
|
|
2570
|
+
{
|
|
2571
|
+
"name": "index",
|
|
2572
|
+
"description": "Gets/sets the currently visible view index.",
|
|
2573
|
+
"values": []
|
|
2574
|
+
},
|
|
2575
|
+
{
|
|
2576
|
+
"name": "animation-type",
|
|
2577
|
+
"description": "Gets/sets the animation type.",
|
|
2578
|
+
"values": [
|
|
2579
|
+
{ "name": "`${ViewSwitcherAnimationType}`" },
|
|
2580
|
+
{ "name": "ViewSwitcherAnimation" }
|
|
2581
|
+
]
|
|
2582
|
+
}
|
|
2583
|
+
],
|
|
2584
|
+
"references": []
|
|
2585
|
+
},
|
|
2506
2586
|
{
|
|
2507
2587
|
"name": "forge-app-bar",
|
|
2508
2588
|
"description": "\n---\n\n\n### **Events:**\n - **forge-app-bar-navigate** - Fires when the app bar is clicked.\n\n### **Slots:**\n - **logo** - Reserved for the brand logo.\n- **title** - Reserved for the application title. This will overwrite the `titleText` property/attribute.\n- **start** - Places content at the beginning of the app bar.\n- **center** - Places content in the center of the app bar.\n- **end** - Places content at the end of the app bar.\n\n### **CSS Properties:**\n - **--forge-app-bar-background** - The background color of the app bar. _(default: undefined)_\n- **--forge-app-bar-foreground** - The text color of the app bar. _(default: undefined)_\n- **--forge-app-bar-theme-foreground** - The text color of the app bar when using the **scoped theme mode**. _(default: undefined)_\n- **--forge-app-bar-theme-foreground-muted** - The muted text color of the app bar when using the **scoped theme mode**. _(default: undefined)_\n- **--forge-app-bar-z-index** - The `z-index` of the app bar. _(default: undefined)_\n- **--forge-app-bar-elevation** - The elevation of the app bar. _(default: undefined)_\n- **--forge-app-bar-height** - The height of the app bar. _(default: undefined)_\n- **--forge-app-bar-row-padding** - The inline padding of the app bar. _(default: undefined)_\n- **--forge-app-bar-logo-gap** - The space between the logo and title. _(default: undefined)_\n- **--forge-app-bar-title-padding** - The padding around the title element. _(default: undefined)_\n- **--forge-app-bar-columns** - The grid column track sizes. _(default: undefined)_\n- **--forge-app-bar-transition-duration** - The transition duration for animations. _(default: undefined)_\n- **--forge-app-bar-transition-timing** - The transition timing function for animations. _(default: undefined)_\n\n### **CSS Parts:**\n - **root** - The root container element.\n- **title** - The title element.",
|
|
@@ -2541,21 +2621,23 @@
|
|
|
2541
2621
|
"references": []
|
|
2542
2622
|
},
|
|
2543
2623
|
{
|
|
2544
|
-
"name": "forge-
|
|
2545
|
-
"description": "\n---\n\n\n### **
|
|
2624
|
+
"name": "forge-app-bar-help-button",
|
|
2625
|
+
"description": "\n---\n\n\n### **Events:**\n - **forge-menu-select** - Bubbles up the menu select from the internal menu component.",
|
|
2546
2626
|
"attributes": [
|
|
2547
2627
|
{
|
|
2548
|
-
"name": "
|
|
2549
|
-
"description": "
|
|
2628
|
+
"name": "icon",
|
|
2629
|
+
"description": "The name of an alternative icon to display.",
|
|
2550
2630
|
"values": []
|
|
2551
2631
|
},
|
|
2552
2632
|
{
|
|
2553
|
-
"name": "
|
|
2554
|
-
"description": "
|
|
2555
|
-
"values": [
|
|
2556
|
-
|
|
2557
|
-
|
|
2558
|
-
|
|
2633
|
+
"name": "aria-label",
|
|
2634
|
+
"description": "The aria-label to apply to the button.",
|
|
2635
|
+
"values": []
|
|
2636
|
+
},
|
|
2637
|
+
{
|
|
2638
|
+
"name": "aria-labelledby",
|
|
2639
|
+
"description": "The id of an element to use as the aria-labelledby attribute.",
|
|
2640
|
+
"values": []
|
|
2559
2641
|
}
|
|
2560
2642
|
],
|
|
2561
2643
|
"references": []
|
|
@@ -2624,28 +2706,6 @@
|
|
|
2624
2706
|
],
|
|
2625
2707
|
"references": []
|
|
2626
2708
|
},
|
|
2627
|
-
{
|
|
2628
|
-
"name": "forge-app-bar-search",
|
|
2629
|
-
"description": "\n---\n\n\n### **Events:**\n - **forge-app-bar-search-input** - Emits when the users executes the search via pressing the Enter key while the `<input>` has focus.\n\n### **Slots:**\n - _default_ - The default (unnamed) slot is where child `<input>` elements will be placed.\n- **action** - Places actions at the end of the input.\n\n### **CSS Properties:**\n - **--forge-theme-on-primary** - Controls the border-color of the container outline, the font-color, and icon color. _(default: undefined)_\n- **--forge-theme-on-surface** - Controls the font color of the buttons. _(default: undefined)_\n- **--forge-theme-text-medium** - Controls the placeholder font color. _(default: undefined)_\n- **--forge-app-bar-search-theme-background** - Controls the background-color of the container. _(default: undefined)_\n- **--forge-app-bar-search-theme-background-focused** - Controls the focused background-color of the container. _(default: undefined)_\n- **--forge-app-bar-search-theme-hover-opacity** - Controls the hover opacity of the outline. _(default: undefined)_\n- **--forge-app-bar-search-theme-disabled-opacity** - Controls the disabled opacity of the component. _(default: undefined)_\n\n### **CSS Parts:**\n - **root** - The root element\n- **container** - The input container element.\n- **icon-container** - The icon container element.\n- **icon** - The <forge-icon> element.\n- **context** - The context container element.\n- **context-divider** - The context divider element.\n- **context-button** - The context button element.\n- **context-button-text** - The context button text element.\n- **context-button-icon** - The context button icon element.\n- **global-icon-container** - The global icon container element.\n- **global-icon** - The global icon <forge-icon> element.\n- **actions-container** - The action container element around the slot.",
|
|
2630
|
-
"attributes": [
|
|
2631
|
-
{
|
|
2632
|
-
"name": "disabled",
|
|
2633
|
-
"description": "A boolean attribute that, if present, indicates that the input should be disabled.",
|
|
2634
|
-
"values": []
|
|
2635
|
-
},
|
|
2636
|
-
{
|
|
2637
|
-
"name": "value",
|
|
2638
|
-
"description": "The value of the input.",
|
|
2639
|
-
"values": []
|
|
2640
|
-
},
|
|
2641
|
-
{
|
|
2642
|
-
"name": "placeholder",
|
|
2643
|
-
"description": "The placeholder text of the input.",
|
|
2644
|
-
"values": []
|
|
2645
|
-
}
|
|
2646
|
-
],
|
|
2647
|
-
"references": []
|
|
2648
|
-
},
|
|
2649
2709
|
{
|
|
2650
2710
|
"name": "forge-app-bar-profile-button",
|
|
2651
2711
|
"description": "\n---\n\n\n### **Events:**\n - **forge-profile-card-sign-out** - Fires when the sign out button is clicked.\n- **forge-profile-card-profile** - Fires when the profile button is clicked.",
|
|
@@ -2711,82 +2771,108 @@
|
|
|
2711
2771
|
"references": []
|
|
2712
2772
|
},
|
|
2713
2773
|
{
|
|
2714
|
-
"name": "forge-app-bar-
|
|
2715
|
-
"description": "\n---\n\n\n### **Events:**\n - **forge-
|
|
2774
|
+
"name": "forge-app-bar-search",
|
|
2775
|
+
"description": "\n---\n\n\n### **Events:**\n - **forge-app-bar-search-input** - Emits when the users executes the search via pressing the Enter key while the `<input>` has focus.\n\n### **Slots:**\n - _default_ - The default (unnamed) slot is where child `<input>` elements will be placed.\n- **action** - Places actions at the end of the input.\n\n### **CSS Properties:**\n - **--forge-theme-on-primary** - Controls the border-color of the container outline, the font-color, and icon color. _(default: undefined)_\n- **--forge-theme-on-surface** - Controls the font color of the buttons. _(default: undefined)_\n- **--forge-theme-text-medium** - Controls the placeholder font color. _(default: undefined)_\n- **--forge-app-bar-search-theme-background** - Controls the background-color of the container. _(default: undefined)_\n- **--forge-app-bar-search-theme-background-focused** - Controls the focused background-color of the container. _(default: undefined)_\n- **--forge-app-bar-search-theme-hover-opacity** - Controls the hover opacity of the outline. _(default: undefined)_\n- **--forge-app-bar-search-theme-disabled-opacity** - Controls the disabled opacity of the component. _(default: undefined)_\n\n### **CSS Parts:**\n - **root** - The root element\n- **container** - The input container element.\n- **icon-container** - The icon container element.\n- **icon** - The <forge-icon> element.\n- **context** - The context container element.\n- **context-divider** - The context divider element.\n- **context-button** - The context button element.\n- **context-button-text** - The context button text element.\n- **context-button-icon** - The context button icon element.\n- **global-icon-container** - The global icon container element.\n- **global-icon** - The global icon <forge-icon> element.\n- **actions-container** - The action container element around the slot.",
|
|
2716
2776
|
"attributes": [
|
|
2717
2777
|
{
|
|
2718
|
-
"name": "
|
|
2719
|
-
"description": "
|
|
2778
|
+
"name": "disabled",
|
|
2779
|
+
"description": "A boolean attribute that, if present, indicates that the input should be disabled.",
|
|
2720
2780
|
"values": []
|
|
2721
2781
|
},
|
|
2722
2782
|
{
|
|
2723
|
-
"name": "
|
|
2724
|
-
"description": "The
|
|
2783
|
+
"name": "value",
|
|
2784
|
+
"description": "The value of the input.",
|
|
2725
2785
|
"values": []
|
|
2726
2786
|
},
|
|
2727
2787
|
{
|
|
2728
|
-
"name": "
|
|
2729
|
-
"description": "The
|
|
2788
|
+
"name": "placeholder",
|
|
2789
|
+
"description": "The placeholder text of the input.",
|
|
2730
2790
|
"values": []
|
|
2731
2791
|
}
|
|
2732
2792
|
],
|
|
2733
2793
|
"references": []
|
|
2734
2794
|
},
|
|
2735
2795
|
{
|
|
2736
|
-
"name": "forge-
|
|
2737
|
-
"description": "\n---\n\n\n### **Events:**\n - **forge-
|
|
2796
|
+
"name": "forge-button-toggle",
|
|
2797
|
+
"description": "\n---\n\n\n### **Events:**\n - **forge-button-toggle-select** - Dispatches when the user toggles the button.\n\n### **Slots:**\n - _default_ - The default/unnamed slot for the button toggle's content.\n- **start** - Typically reserved for content/icons that render logically before the default slot content.\n- **end** - Typically reserved content/icons that render logically after the default slot content.\n\n### **CSS Properties:**\n - **--forge-button-toggle-display** - The `display` style for the button toggle container element. _(default: undefined)_\n- **--forge-button-toggle-min-width** - The minimum width. _(default: undefined)_\n- **--forge-button-toggle-spacing** - The spacing between the button toggle and its content. _(default: undefined)_\n- **--forge-button-toggle-padding-block** - The padding on the block axis. _(default: undefined)_\n- **--forge-button-toggle-padding-inline** - The padding on the inline axis. _(default: undefined)_\n- **--forge-button-toggle-color** - The color of the button toggle content. _(default: undefined)_\n- **--forge-button-toggle-background** - The background of the button toggle. _(default: undefined)_\n- **--forge-button-toggle-cursor** - The cursor of the button toggle. _(default: undefined)_\n- **--forge-button-toggle-border-width** - The border-width of the button toggle. _(default: undefined)_\n- **--forge-button-toggle-border-style** - The border-style of the button toggle. _(default: undefined)_\n- **--forge-button-toggle-border-color** - The border-color of the button toggle. _(default: undefined)_\n- **--forge-button-toggle-shape** - The shape radius of the button toggle. _(default: undefined)_\n- **--forge-button-toggle-shape-start-start** - The start-start shape radius of the button toggle. _(default: undefined)_\n- **--forge-button-toggle-shape-start-end** - The start-end shape radius of the button toggle. _(default: undefined)_\n- **--forge-button-toggle-shape-end-start** - The end-start shape radius of the button toggle. _(default: undefined)_\n- **--forge-button-toggle-shape-end-end** - The end-end shape radius of the button toggle. _(default: undefined)_\n- **--forge-button-toggle-selected-background** - The background of the button toggle when selected. _(default: undefined)_\n- **--forge-button-toggle-selected-color** - The color of the button toggle content when selected. _(default: undefined)_\n- **--forge-button-toggle-selected-disabled-background** - The background of the button toggle when selected and disabled. _(default: undefined)_\n- **--forge-button-toggle-disabled-opacity** - The opacity of the button toggle when disabled. _(default: undefined)_\n- **--forge-button-toggle-disabled-cursor** - The cursor of the button toggle when disabled. _(default: undefined)_\n- **--forge-button-toggle-disabled-color** - The color of the button toggle content when disabled. _(default: undefined)_\n- **--forge-button-toggle-disabled-background** - The background of the button toggle when disabled. _(default: undefined)_\n- **--forge-button-toggle-transition-duration** - The transition-duration of various properties. _(default: undefined)_\n- **--forge-button-toggle-transition-timing** - The transition-timing of various properties. _(default: undefined)_\n\n### **CSS Parts:**\n - **root** - The root container element.\n- **focus-indicator** - The focus indicator element.\n- **state-layer** - The state layer surface element.",
|
|
2738
2798
|
"attributes": [
|
|
2739
2799
|
{
|
|
2740
|
-
"name": "
|
|
2741
|
-
"description": "The
|
|
2742
|
-
"values": [
|
|
2800
|
+
"name": "value",
|
|
2801
|
+
"description": "The value of the button toggle.",
|
|
2802
|
+
"values": []
|
|
2803
|
+
},
|
|
2804
|
+
{
|
|
2805
|
+
"name": "selected",
|
|
2806
|
+
"description": "Whether or not the button is selected.",
|
|
2807
|
+
"values": []
|
|
2808
|
+
},
|
|
2809
|
+
{
|
|
2810
|
+
"name": "disabled",
|
|
2811
|
+
"description": "Whether or not the button is disabled.",
|
|
2812
|
+
"values": []
|
|
2743
2813
|
},
|
|
2814
|
+
{
|
|
2815
|
+
"name": "readonly",
|
|
2816
|
+
"description": "Whether or not the button is readonly.",
|
|
2817
|
+
"values": []
|
|
2818
|
+
}
|
|
2819
|
+
],
|
|
2820
|
+
"references": []
|
|
2821
|
+
},
|
|
2822
|
+
{
|
|
2823
|
+
"name": "forge-button-toggle-group",
|
|
2824
|
+
"description": "\n---\n\n\n### **Events:**\n - **forge-button-toggle-group-change** - Dispatches when the value of the group changes.\n\n### **Slots:**\n - _default_ - The is a default/unnamed slot for child button toggle elements.\n\n### **CSS Properties:**\n - **--forge-button-toggle-group-display** - The `display` of the group container elements. _(default: undefined)_\n- **--forge-button-toggle-group-gap** - The space between button toggle elements. _(default: undefined)_\n- **--forge-button-toggle-group-padding** - The padding around the button toggle elements when outlined. _(default: undefined)_\n- **--forge-button-toggle-group-padding-block** - The block padding around the button toggle elements when outlined. _(default: undefined)_\n- **--forge-button-toggle-group-padding-inline** - The inline padding around the button toggle elements when outlined. _(default: undefined)_\n- **--forge-button-toggle-group-height** - The height of the group element. _(default: undefined)_\n- **--forge-button-toggle-group-dense-height** - The height of the group element when dense. _(default: undefined)_\n- **--forge-button-toggle-group-outline-width** - The width of the outline around the group element. _(default: undefined)_\n- **--forge-button-toggle-group-outline-style** - The style of the outline around the group element. _(default: undefined)_\n- **--forge-button-toggle-group-outline-color** - The color of the outline around the group element. _(default: undefined)_\n- **--forge-button-toggle-group-outline-color-active** - The color of the outline around the group element when hovered or focused. _(default: undefined)_\n- **--forge-button-toggle-group-shape** - The shape radius of the group container element. _(default: undefined)_\n- **--forge-button-toggle-group-shape-start-start** - The start-start shape radius. _(default: undefined)_\n- **--forge-button-toggle-group-shape-start-end** - The start-end shape radius. _(default: undefined)_\n- **--forge-button-toggle-group-shape-end-start** - The end-start shape radius. _(default: undefined)_\n- **--forge-button-toggle-group-shape-end-end** - The end-end shape radius. _(default: undefined)_\n- **--forge-button-toggle-group-transition-duration** - The transition duration for all animations on the group. _(default: undefined)_\n- **--forge-button-toggle-group-transition-timing** - The transition timing for all animations on the group. _(default: undefined)_\n\n### **CSS Parts:**\n - **root** - The root container element for the group.",
|
|
2825
|
+
"attributes": [
|
|
2744
2826
|
{
|
|
2745
2827
|
"name": "value",
|
|
2746
|
-
"description": "The value of the
|
|
2828
|
+
"description": "The value of the selected button toggle(s).",
|
|
2747
2829
|
"values": []
|
|
2748
2830
|
},
|
|
2749
2831
|
{
|
|
2750
|
-
"name": "
|
|
2751
|
-
"description": "Whether the
|
|
2832
|
+
"name": "outlined",
|
|
2833
|
+
"description": "Whether or not the group should be outlined.",
|
|
2752
2834
|
"values": []
|
|
2753
2835
|
},
|
|
2754
2836
|
{
|
|
2755
|
-
"name": "
|
|
2756
|
-
"description": "Whether the
|
|
2837
|
+
"name": "multiple",
|
|
2838
|
+
"description": "Whether or not the group should allow multiple selections.",
|
|
2757
2839
|
"values": []
|
|
2758
2840
|
},
|
|
2759
2841
|
{
|
|
2760
|
-
"name": "
|
|
2761
|
-
"description": "Whether the
|
|
2842
|
+
"name": "stretch",
|
|
2843
|
+
"description": "Whether or not the group should stretch to fill the available width.",
|
|
2762
2844
|
"values": []
|
|
2763
2845
|
},
|
|
2764
2846
|
{
|
|
2765
|
-
"name": "
|
|
2766
|
-
"description": "Whether the
|
|
2847
|
+
"name": "mandatory",
|
|
2848
|
+
"description": "Whether or not the group should require a selection once a button has been toggled on.",
|
|
2767
2849
|
"values": []
|
|
2768
2850
|
},
|
|
2769
2851
|
{
|
|
2770
|
-
"name": "
|
|
2771
|
-
"description": "
|
|
2772
|
-
"values": [
|
|
2852
|
+
"name": "vertical",
|
|
2853
|
+
"description": "Whether or not the group should be displayed vertically.",
|
|
2854
|
+
"values": []
|
|
2773
2855
|
},
|
|
2774
2856
|
{
|
|
2775
|
-
"name": "
|
|
2776
|
-
"description": "
|
|
2857
|
+
"name": "disabled",
|
|
2858
|
+
"description": "Whether or not the group should be disabled.",
|
|
2777
2859
|
"values": []
|
|
2778
2860
|
},
|
|
2779
2861
|
{
|
|
2780
|
-
"name": "
|
|
2781
|
-
"description": "
|
|
2862
|
+
"name": "readonly",
|
|
2863
|
+
"description": "Whether or not the group should be readonly.",
|
|
2782
2864
|
"values": []
|
|
2783
2865
|
},
|
|
2784
2866
|
{
|
|
2785
|
-
"name": "
|
|
2786
|
-
"description": "
|
|
2867
|
+
"name": "dense",
|
|
2868
|
+
"description": "Whether or not the group should be dense.",
|
|
2787
2869
|
"values": []
|
|
2788
2870
|
},
|
|
2789
|
-
{
|
|
2871
|
+
{
|
|
2872
|
+
"name": "theme",
|
|
2873
|
+
"description": "The theme to use for the group.",
|
|
2874
|
+
"values": [{ "name": "ButtonToggleGroupTheme" }]
|
|
2875
|
+
}
|
|
2790
2876
|
],
|
|
2791
2877
|
"references": []
|
|
2792
2878
|
},
|
|
@@ -2828,59 +2914,60 @@
|
|
|
2828
2914
|
"references": []
|
|
2829
2915
|
},
|
|
2830
2916
|
{
|
|
2831
|
-
"name": "forge-
|
|
2832
|
-
"description": "\n---\n\n\n### **Events:**\n - **forge-
|
|
2917
|
+
"name": "forge-chip",
|
|
2918
|
+
"description": "\n---\n\n\n### **Events:**\n - **forge-chip-delete** - Event fired when the chip is deleted.\n- **forge-chip-select** - Event fired when the chip is selected.\n\n### **Slots:**\n - _default_ - The content of the chip.\n- **start** - The start content of the chip.\n- **end** - The end content of the chip.\n\n### **CSS Properties:**\n - **--forge-chip-background** - The background color of the chip. _(default: undefined)_\n- **--forge-chip-color** - The background color of the chip. _(default: undefined)_\n- **--forge-chip-shape** - The shape of the chip. _(default: undefined)_\n- **--forge-chip-spacing** - The spacing between chips. _(default: undefined)_\n- **--forge-chip-height** - The height of the chip. _(default: undefined)_\n- **--forge-chip-padding-inline** - The inline padding of the chip. _(default: undefined)_\n- **--forge-chip-padding-block** - The block padding of the chip. _(default: undefined)_\n- **--forge-chip-cursor** - The cursor style of the chip. _(default: undefined)_\n- **--forge-chip-icon-font-size** - The font size of the chip icon. _(default: undefined)_\n- **--forge-chip-focus-indicator-color** - The color of the focus indicator. _(default: undefined)_\n- **--forge-chip-disabled-opacity** - The opacity of the disabled chip. _(default: undefined)_\n- **--forge-chip-disabled-cursor** - The cursor style of the disabled chip. _(default: undefined)_\n- **--forge-chip-dense-height** - The height of the dense chip. _(default: undefined)_\n- **--forge-chip-dense-padding-inline** - The inline padding of the dense chip. _(default: undefined)_\n- **--forge-chip-dense-spacing** - The spacing between dense chips. _(default: undefined)_\n- **--forge-chip-dense-font-size** - The font size of the dense chip. _(default: undefined)_\n- **--forge-chip-dense-font-weight** - The font weight of the dense chip. _(default: undefined)_\n- **--forge-chip-dense-focus-indicator-offset** - The offset of the focus indicator for dense chips. _(default: undefined)_\n- **--forge-chip-dense-icon-font-size** - The font size of the icon in dense chips. _(default: undefined)_\n- **--forge-chip-remove-button-spacing** - The spacing of the remove button in chips. _(default: undefined)_\n- **--forge-chip-remove-button-height-dense** - The height of the remove button in dense chips. _(default: undefined)_\n- **--forge-chip-remove-button-icon-size-dense** - The icon size of the remove button in dense chips. _(default: undefined)_\n- **--forge-chip-remove-button-spacing-dense** - The spacing of the remove button in dense chips. _(default: undefined)_\n- **--forge-chip-selected-background** - The background color of the selected chip. _(default: undefined)_\n- **--forge-chip-selected-color** - The text color of the selected chip. _(default: undefined)_\n- **--forge-chip-invalid-color** - The text color of the invalid chip. _(default: undefined)_\n- **--forge-chip-invalid-selected-background** - The background color of the invalid selected chip. _(default: undefined)_\n- **--forge-chip-invalid-selected-color** - The text color of the invalid selected chip. _(default: undefined)_\n- **--forge-chip-border-width** - The width of the chip border. _(default: undefined)_\n- **--forge-chip-border-style** - The style of the chip border. _(default: undefined)_\n- **--forge-chip-border-color** - The color of the chip border. _(default: undefined)_\n- **--forge-chip-field-background** - The background color of the chip field. _(default: undefined)_\n- **--forge-chip-field-color** - The text color of the chip field. _(default: undefined)_\n- **--forge-chip-field-shape** - The shape of the chip field. _(default: undefined)_\n- **--forge-chip-field-border-color** - The color of the chip field border. _(default: undefined)_\n- **--forge-chip-field-cursor** - The cursor style of the chip field. _(default: undefined)_\n- **--forge-chip-checkmark-size** - The size of the checkmark in chips. _(default: undefined)_\n- **--forge-chip-checkmark-color** - The color of the checkmark in chips. _(default: undefined)_\n- **--forge-chip-checkmark-spacing** - The spacing of the checkmark in chips. _(default: undefined)_\n- **--forge-chip-avatar-size** - The size of the avatar in chips. _(default: undefined)_\n- **--forge-chip-avatar-size-dense** - The size of the avatar in dense chips. _(default: undefined)_\n- **--forge-chip-avatar-font-size** - The font size of the avatar in chips. _(default: undefined)_\n- **--forge-chip-avatar-font-size-dense** - The font size of the avatar in dense chips. _(default: undefined)_\n- **--forge-chip-avatar-spacing** - The spacing of the avatar in chips. _(default: undefined)_\n- **--forge-chip-avatar-spacing-dense** - The spacing of the avatar in dense chips. _(default: undefined)_\n- **--forge-chip-transition-duration** - The duration of the chip transition. _(default: undefined)_\n- **--forge-chip-transition-easing** - The easing function of the chip transition. _(default: undefined)_\n- **--forge-chip-checkmark-transition-delay** - The delay of the checkmark transition in chips. _(default: undefined)_\n\n### **CSS Parts:**\n - **root** - The component's root element.\n- **trigger** - The trigger element of the chip.\n- **focus-indicator** - The focus indicator of the chip.\n- **state-layer** - The state layer surface.",
|
|
2833
2919
|
"attributes": [
|
|
2920
|
+
{
|
|
2921
|
+
"name": "type",
|
|
2922
|
+
"description": "The type of chip.",
|
|
2923
|
+
"values": [{ "name": "ChipType" }]
|
|
2924
|
+
},
|
|
2834
2925
|
{
|
|
2835
2926
|
"name": "value",
|
|
2836
|
-
"description": "The value of the
|
|
2927
|
+
"description": "The value of the chip.",
|
|
2837
2928
|
"values": []
|
|
2838
2929
|
},
|
|
2839
2930
|
{
|
|
2840
|
-
"name": "
|
|
2841
|
-
"description": "Whether
|
|
2931
|
+
"name": "selected",
|
|
2932
|
+
"description": "Whether the chip is selected.",
|
|
2842
2933
|
"values": []
|
|
2843
2934
|
},
|
|
2844
2935
|
{
|
|
2845
|
-
"name": "
|
|
2846
|
-
"description": "Whether
|
|
2936
|
+
"name": "invalid",
|
|
2937
|
+
"description": "Whether the chip is invalid.",
|
|
2847
2938
|
"values": []
|
|
2848
2939
|
},
|
|
2849
2940
|
{
|
|
2850
|
-
"name": "
|
|
2851
|
-
"description": "Whether
|
|
2941
|
+
"name": "disabled",
|
|
2942
|
+
"description": "Whether the chip is disabled.",
|
|
2852
2943
|
"values": []
|
|
2853
2944
|
},
|
|
2854
2945
|
{
|
|
2855
|
-
"name": "
|
|
2856
|
-
"description": "Whether
|
|
2946
|
+
"name": "dense",
|
|
2947
|
+
"description": "Whether the chip is dense.",
|
|
2857
2948
|
"values": []
|
|
2858
2949
|
},
|
|
2859
2950
|
{
|
|
2860
|
-
"name": "
|
|
2861
|
-
"description": "
|
|
2862
|
-
"values": []
|
|
2951
|
+
"name": "theme",
|
|
2952
|
+
"description": "The theme of the chip.",
|
|
2953
|
+
"values": [{ "name": "ChipTheme" }]
|
|
2863
2954
|
},
|
|
2864
2955
|
{
|
|
2865
|
-
"name": "
|
|
2866
|
-
"description": "
|
|
2956
|
+
"name": "href",
|
|
2957
|
+
"description": "The href of the chip.",
|
|
2867
2958
|
"values": []
|
|
2868
2959
|
},
|
|
2869
2960
|
{
|
|
2870
|
-
"name": "
|
|
2871
|
-
"description": "
|
|
2961
|
+
"name": "target",
|
|
2962
|
+
"description": "The target of the chip.",
|
|
2872
2963
|
"values": []
|
|
2873
2964
|
},
|
|
2874
2965
|
{
|
|
2875
|
-
"name": "
|
|
2876
|
-
"description": "
|
|
2966
|
+
"name": "download",
|
|
2967
|
+
"description": "The download of the chip.",
|
|
2877
2968
|
"values": []
|
|
2878
2969
|
},
|
|
2879
|
-
{
|
|
2880
|
-
"name": "theme",
|
|
2881
|
-
"description": "The theme to use for the group.",
|
|
2882
|
-
"values": [{ "name": "ButtonToggleGroupTheme" }]
|
|
2883
|
-
}
|
|
2970
|
+
{ "name": "rel", "description": "The rel of the chip.", "values": [] }
|
|
2884
2971
|
],
|
|
2885
2972
|
"references": []
|
|
2886
2973
|
},
|
|
@@ -2935,33 +3022,6 @@
|
|
|
2935
3022
|
],
|
|
2936
3023
|
"references": []
|
|
2937
3024
|
},
|
|
2938
|
-
{
|
|
2939
|
-
"name": "forge-button-toggle",
|
|
2940
|
-
"description": "\n---\n\n\n### **Events:**\n - **forge-button-toggle-select** - Dispatches when the user toggles the button.\n\n### **Slots:**\n - _default_ - The default/unnamed slot for the button toggle's content.\n- **start** - Typically reserved for content/icons that render logically before the default slot content.\n- **end** - Typically reserved content/icons that render logically after the default slot content.\n\n### **CSS Properties:**\n - **--forge-button-toggle-display** - The `display` style for the button toggle container element. _(default: undefined)_\n- **--forge-button-toggle-min-width** - The minimum width. _(default: undefined)_\n- **--forge-button-toggle-spacing** - The spacing between the button toggle and its content. _(default: undefined)_\n- **--forge-button-toggle-padding-block** - The padding on the block axis. _(default: undefined)_\n- **--forge-button-toggle-padding-inline** - The padding on the inline axis. _(default: undefined)_\n- **--forge-button-toggle-color** - The color of the button toggle content. _(default: undefined)_\n- **--forge-button-toggle-background** - The background of the button toggle. _(default: undefined)_\n- **--forge-button-toggle-cursor** - The cursor of the button toggle. _(default: undefined)_\n- **--forge-button-toggle-border-width** - The border-width of the button toggle. _(default: undefined)_\n- **--forge-button-toggle-border-style** - The border-style of the button toggle. _(default: undefined)_\n- **--forge-button-toggle-border-color** - The border-color of the button toggle. _(default: undefined)_\n- **--forge-button-toggle-shape** - The shape radius of the button toggle. _(default: undefined)_\n- **--forge-button-toggle-shape-start-start** - The start-start shape radius of the button toggle. _(default: undefined)_\n- **--forge-button-toggle-shape-start-end** - The start-end shape radius of the button toggle. _(default: undefined)_\n- **--forge-button-toggle-shape-end-start** - The end-start shape radius of the button toggle. _(default: undefined)_\n- **--forge-button-toggle-shape-end-end** - The end-end shape radius of the button toggle. _(default: undefined)_\n- **--forge-button-toggle-selected-background** - The background of the button toggle when selected. _(default: undefined)_\n- **--forge-button-toggle-selected-color** - The color of the button toggle content when selected. _(default: undefined)_\n- **--forge-button-toggle-selected-disabled-background** - The background of the button toggle when selected and disabled. _(default: undefined)_\n- **--forge-button-toggle-disabled-opacity** - The opacity of the button toggle when disabled. _(default: undefined)_\n- **--forge-button-toggle-disabled-cursor** - The cursor of the button toggle when disabled. _(default: undefined)_\n- **--forge-button-toggle-disabled-color** - The color of the button toggle content when disabled. _(default: undefined)_\n- **--forge-button-toggle-disabled-background** - The background of the button toggle when disabled. _(default: undefined)_\n- **--forge-button-toggle-transition-duration** - The transition-duration of various properties. _(default: undefined)_\n- **--forge-button-toggle-transition-timing** - The transition-timing of various properties. _(default: undefined)_\n\n### **CSS Parts:**\n - **root** - The root container element.\n- **focus-indicator** - The focus indicator element.\n- **state-layer** - The state layer surface element.",
|
|
2941
|
-
"attributes": [
|
|
2942
|
-
{
|
|
2943
|
-
"name": "value",
|
|
2944
|
-
"description": "The value of the button toggle.",
|
|
2945
|
-
"values": []
|
|
2946
|
-
},
|
|
2947
|
-
{
|
|
2948
|
-
"name": "selected",
|
|
2949
|
-
"description": "Whether or not the button is selected.",
|
|
2950
|
-
"values": []
|
|
2951
|
-
},
|
|
2952
|
-
{
|
|
2953
|
-
"name": "disabled",
|
|
2954
|
-
"description": "Whether or not the button is disabled.",
|
|
2955
|
-
"values": []
|
|
2956
|
-
},
|
|
2957
|
-
{
|
|
2958
|
-
"name": "readonly",
|
|
2959
|
-
"description": "Whether or not the button is readonly.",
|
|
2960
|
-
"values": []
|
|
2961
|
-
}
|
|
2962
|
-
],
|
|
2963
|
-
"references": []
|
|
2964
|
-
},
|
|
2965
3025
|
{
|
|
2966
3026
|
"name": "forge-modal-drawer",
|
|
2967
3027
|
"description": "\n---\n\n\n### **Events:**\n - **forge-modal-drawer-close** - Dispatched when the modal drawer is closed by clicking the backdrop.\n- **forge-drawer-after-open** - Dispatched after the drawer has opened.\n- **forge-drawer-after-close** - Dispatched after the drawer has closed.\n\n### **Slots:**\n - _default_ - The content to display in the scrollable content container.\n- **header** - The header content above the main content.\n- **footer** - The footer content below the main content.\n\n### **CSS Properties:**\n - **--forge-drawer-width** - The width of the drawer. _(default: undefined)_\n- **--forge-drawer-background** - The background color of the drawer. _(default: undefined)_\n- **--forge-drawer-border-color** - The border of the drawer. _(default: undefined)_\n- **--forge-drawer-border-width** - The border width of the drawer. _(default: undefined)_\n- **--forge-drawer-transition-duration** - The transition duration of the drawer. _(default: undefined)_\n- **--forge-drawer-transition-easing** - The transition timing function of the drawer. _(default: undefined)_\n- **--forge-drawer-duration-close** - The duration of the drawer closing animation. _(default: undefined)_\n\n### **CSS Parts:**\n - **root** - The component's root element.\n- **content** - The content container element.\n- **backdrop** - The backdrop root element.",
|
|
@@ -3351,23 +3411,6 @@
|
|
|
3351
3411
|
],
|
|
3352
3412
|
"references": []
|
|
3353
3413
|
},
|
|
3354
|
-
{
|
|
3355
|
-
"name": "forge-option-group",
|
|
3356
|
-
"description": "\n---\n",
|
|
3357
|
-
"attributes": [
|
|
3358
|
-
{
|
|
3359
|
-
"name": "value",
|
|
3360
|
-
"description": "Gets/sets the optional group value.",
|
|
3361
|
-
"values": []
|
|
3362
|
-
},
|
|
3363
|
-
{
|
|
3364
|
-
"name": "text",
|
|
3365
|
-
"description": "The text content for the group.",
|
|
3366
|
-
"values": []
|
|
3367
|
-
}
|
|
3368
|
-
],
|
|
3369
|
-
"references": []
|
|
3370
|
-
},
|
|
3371
3414
|
{
|
|
3372
3415
|
"name": "forge-select",
|
|
3373
3416
|
"description": "\n---\n\n\n### **Events:**\n - **forge-select-scrolled-bottom** - Dispatched when the dropdown list has scrolled to the bottom.\n- **change** - Dispatched when the user selects a value.\n\n### **Methods:**\n - **floatLabelWithoutAnimation(value: _boolean_): _void_** - Floats the label without an animation. Only applies when the label is inset.\n\n### **Slots:**\n - **value** - The selected text to display\n- **start** - Typically reserved for content/icons that render logically before the default slot content.\n- **end** - Typically reserved content/icons that render logically after the default slot content.\n- **accessory** - Used for content such as a button that is logically connected to the field but should appear distinct from the input.\n- **support-text** - Used for content that provides additional information about the field. Aligns to the inline start of the field.\n- **support-text-end** - Used for content that provides additional information about the field. Aligns to the inline end of the field.\n\n### **CSS Properties:**\n - **--forge-select-placeholder-color** - The color of the placeholder text. _(default: undefined)_\n- **--forge-field-background** - The background of the field surface. _(default: undefined)_\n- **--forge-field-tonal-background** - The background of the field surface in the tonal variant. _(default: undefined)_\n- **--forge-field-tonal-background-hover** - The background of the field surface in the tonal variant on hover. _(default: undefined)_\n- **--forge-field-filled-background** - The background of the field surface in the filled and raised variants. _(default: undefined)_\n- **--forge-field-outline-style** - The style of the field outline. _(default: undefined)_\n- **--forge-field-outline-width** - The width of the field outline. _(default: undefined)_\n- **--forge-field-shape** - The border radius of the field's corners. _(default: undefined)_\n- **--forge-field-height** - The height of the field in its default density. _(default: undefined)_\n- **--forge-field-inset-height** - The height of the field in its default density when the label is inset. _(default: undefined)_\n- **--forge-field-padding-inline** - The inline padding of the field. _(default: undefined)_\n- **--forge-field-padding-inline-start** - The inline start padding of the field. _(default: undefined)_\n- **--forge-field-padding-inline-end** - The inline end padding of the field. _(default: undefined)_\n- **--forge-field-inner-padding-inline** - The padding between elements slotted into the field. _(default: undefined)_\n- **--forge-field-support-text-margin-block** - The margin between the support text and the field. _(default: undefined)_\n- **--forge-field-support-text-gap** - The minimum gap between the support text and the support text end. _(default: undefined)_\n- **--forge-field-support-text-padding-inline** - The inline padding of the support text. _(default: undefined)_\n- **--forge-field-support-text-padding-inline-start** - The inline start padding of the support text. _(default: undefined)_\n- **--forge-field-support-text-padding-inline-end** - The inline end padding of the support text. _(default: undefined)_\n- **--forge-field-label-margin-inline** - The margin between the label and the field when the label is in an inline position. _(default: undefined)_\n- **--forge-field-label-margin-block** - The margin between the label and the field when the label is in the block start position. _(default: undefined)_\n- **--forge-field-required-padding** - The padding between the required indicator and the label. _(default: undefined)_\n- **--forge-field-required-content** - The content of the required indicator. _(default: undefined)_\n- **--forge-field-optional-padding** - The padding between the optional indicator and the label. _(default: undefined)_\n- **--forge-field-optional-content** - The content of the optional indicator. _(default: undefined)_\n- **--forge-field-multiline-resize** - The direction the field can be resized when multiline. _(default: undefined)_\n- **--forge-field-multiline-min-inline-size** - The minimum inline size the field can be resized to when multiline. _(default: undefined)_\n- **--forge-field-multiline-max-inline-size** - The maximum inline size the field can be resized to when multiline. _(default: undefined)_\n- **--forge-field-multiline-min-block-size** - The minimum block size the field can be resized to when multiline. _(default: undefined)_\n- **--forge-field-multiline-max-block-size** - The maximum block size the field can be resized to when multiline. _(default: undefined)_\n- **--forge-field-popover-icon-transition-duration** - The duration of the popover icon animation. _(default: undefined)_\n- **--forge-field-popover-icon-transition-timing** - The timing function of the popover icon animation. _(default: undefined)_\n- **--forge-field-popover-icon-open-rotation** - The rotation of the popover icon when open. _(default: undefined)_\n- **--forge-field-surface-animation-duration** - The duration of background and outline animations. _(default: undefined)_\n- **--forge-field-surface-animation-timing** - The timing function of background and outline animations. _(default: undefined)_\n- **--forge-field-surface-floating-animation-duration** - The duration of the floating label animation. _(default: undefined)_\n- **--forge-field-surface-floating-animation-timing** - The timing function of the floating label animation. _(default: undefined)_\n- **--forge-field-focus-indicator-width** - The width of the focus indicator. _(default: undefined)_\n- **--forge-field-disabled-opacity** - The opacity of the field when disabled. _(default: undefined)_\n- **--forge-field-disabled-background** - The background of the field when disabled. _(default: undefined)_\n\n### **CSS Parts:**\n - **root** - The root container element.\n- **label** - The label element.\n- **text-container** - The element container for the selected text.\n- **text** - The element containing the selected text.\n- **container** - The container element surrounding the input.\n- **input** - The element containing te input slot.\n- **start** - The element containing the start slot.\n- **end** - The element containing the end slot.\n- **popover-icon** - The popover icon element.\n- **accessory** - The element containing the accessory slot.\n- **support-text** - The support text element.\n- **support-text** - The element containing the support text slot.\n- **support-text-end** - The element containing the support text end slot.\n- **outline** - The element containing the forge-focus-indicator element.\n- **focus-indicator** - The focus indicator element.",
|
|
@@ -3520,6 +3563,23 @@
|
|
|
3520
3563
|
],
|
|
3521
3564
|
"references": []
|
|
3522
3565
|
},
|
|
3566
|
+
{
|
|
3567
|
+
"name": "forge-option-group",
|
|
3568
|
+
"description": "\n---\n",
|
|
3569
|
+
"attributes": [
|
|
3570
|
+
{
|
|
3571
|
+
"name": "value",
|
|
3572
|
+
"description": "Gets/sets the optional group value.",
|
|
3573
|
+
"values": []
|
|
3574
|
+
},
|
|
3575
|
+
{
|
|
3576
|
+
"name": "text",
|
|
3577
|
+
"description": "The text content for the group.",
|
|
3578
|
+
"values": []
|
|
3579
|
+
}
|
|
3580
|
+
],
|
|
3581
|
+
"references": []
|
|
3582
|
+
},
|
|
3523
3583
|
{
|
|
3524
3584
|
"name": "forge-select-dropdown",
|
|
3525
3585
|
"description": "\n---\n\n\n### **Methods:**\n - **appendOptions(options: _ISelectOption[] | ISelectOptionGroup[]_): _void_** - Dynamically appends options to the dropdown while it's open.\n- **selectAll(): _void_** - Selects all options.\n- **deselectAll(): _void_** - Deselects all options.",
|
|
@@ -3696,6 +3756,63 @@
|
|
|
3696
3756
|
],
|
|
3697
3757
|
"references": []
|
|
3698
3758
|
},
|
|
3759
|
+
{
|
|
3760
|
+
"name": "forge-step",
|
|
3761
|
+
"description": "\n---\n\n\n### **Slots:**\n - _default_ - The content of the step.\n- **optional** - The optional content of the step.\n- **expansion-content** - The content of the step expansion.\n\n### **CSS Properties:**\n - **--forge-step-primary-color** - The primary color of the step. Defaults to the primary theme. _(default: undefined)_\n- **--forge-step-text-color** - The text color of the step. Defaults to the on-primary theme. _(default: undefined)_\n- **--forge-step-border-radius** - The border radius of the step. Defaults to the extra-large shape. _(default: undefined)_\n- **--forge-step-border-radius-vertical** - The border radius of the step in vertical mode. Defaults to the medium shape. _(default: undefined)_\n- **--forge-step-disabled-text-color** - The text color of the step when disabled. Defaults to the text-low theme. _(default: undefined)_\n- **--forge-step-disabled-color** - The color of the step when disabled. Defaults to the surface-container-minimum theme. _(default: undefined)_\n- **--forge-step-icon-fill** - The fill color of the step icon. Defaults to unset. _(default: undefined)_\n- **--forge-step-icon-fill-active** - The fill color of the step icon when active. Defaults to the primary color. _(default: undefined)_\n- **--forge-step-icon-text-color** - The text color of the step icon. Defaults to the primary theme. _(default: undefined)_\n- **--forge-step-icon-text-color-active** - The text color of the step icon when active. Defaults to the on-primary theme. _(default: undefined)_\n- **--forge-step-icon-content-size** - The size of the step icon content. Defaults to 24px. _(default: undefined)_\n- **--forge-step-icon-size** - The size of the step icon. Defaults to 0.875em. _(default: undefined)_\n- **--forge-step-icon-transition-duration** - The duration of the step icon transition. Defaults to the medium4 animation duration. _(default: undefined)_\n- **--forge-step-icon-transition-easing** - The easing of the step icon transition. Defaults to the standard animation easing. _(default: undefined)_\n- **--forge-step-line-color** - The color of the step line. Defaults to the outline theme. _(default: undefined)_\n- **--forge-step-line-min-width** - The minimum width of the step line. Defaults to 10px. _(default: undefined)_\n- **--forge-step-line-min-width-clustered** - The minimum width of the step line when clustered. Defaults to 25px. _(default: undefined)_\n- **--forge-step-label-color** - The color of the step label. Defaults to the text-high theme. _(default: undefined)_\n- **--forge-step-sub-label-color** - The color of the step sub-label. Defaults to the text-medium theme. _(default: undefined)_\n- **--forge-step-error-color** - The color of the step error. Defaults to the error theme. _(default: undefined)_\n- **--forge-step-error-text-color** - The text color of the step error. Defaults to the on-error theme. _(default: undefined)_\n- **--forge-step-expansion-panel-border-left-width** - The border left width of the step expansion panel. Defaults to 1px. _(default: undefined)_\n- **--forge-step-expansion-panel-margin-bottom** - The margin bottom of the step expansion panel. Defaults to 4px. _(default: undefined)_\n- **--forge-step-expansion-panel-margin-left** - The margin left of the step expansion panel. Defaults to 60px. _(default: undefined)_\n- **--forge-step-expansion-panel-margin-top** - The margin top of the step expansion panel. Defaults to 4px. _(default: undefined)_\n- **--forge-step-expansion-panel-icon-color** - The color of the step expansion panel icon. Defaults to the text-medium theme. _(default: undefined)_\n\n### **CSS Parts:**\n - **root** - The root element.\n- **step** - The step container element.\n- **before** - The line before the step.\n- **after** - The line after the step.\n- **icon-container** - The icon container element.\n- **icon-content** - The icon content element.\n- **icon** - The icon element.\n- **index** - The index content container.\n- **text-container** - The text container element.\n- **title-container** - The title container element.\n- **subtitle-container** - The subtitle container element.\n- **state-layer** - The state layer surface element.\n- **focus-indicator** - The focus indicator element.",
|
|
3762
|
+
"attributes": [
|
|
3763
|
+
{
|
|
3764
|
+
"name": "alternative",
|
|
3765
|
+
"description": "Whether the step is in alternative mode.",
|
|
3766
|
+
"values": []
|
|
3767
|
+
},
|
|
3768
|
+
{
|
|
3769
|
+
"name": "completed",
|
|
3770
|
+
"description": "Whether the step is completed.",
|
|
3771
|
+
"values": []
|
|
3772
|
+
},
|
|
3773
|
+
{
|
|
3774
|
+
"name": "editable",
|
|
3775
|
+
"description": "Whether the step is editable.",
|
|
3776
|
+
"values": []
|
|
3777
|
+
},
|
|
3778
|
+
{
|
|
3779
|
+
"name": "error",
|
|
3780
|
+
"description": "Whether the step has an error.",
|
|
3781
|
+
"values": []
|
|
3782
|
+
},
|
|
3783
|
+
{
|
|
3784
|
+
"name": "selected",
|
|
3785
|
+
"description": "Whether the step is selected.",
|
|
3786
|
+
"values": []
|
|
3787
|
+
},
|
|
3788
|
+
{
|
|
3789
|
+
"name": "disabled",
|
|
3790
|
+
"description": "Whether the step is disabled.",
|
|
3791
|
+
"values": []
|
|
3792
|
+
},
|
|
3793
|
+
{
|
|
3794
|
+
"name": "vertical",
|
|
3795
|
+
"description": "Whether the step is in vertical mode.",
|
|
3796
|
+
"values": []
|
|
3797
|
+
},
|
|
3798
|
+
{
|
|
3799
|
+
"name": "expanded",
|
|
3800
|
+
"description": "Whether the step is expanded.",
|
|
3801
|
+
"values": []
|
|
3802
|
+
},
|
|
3803
|
+
{
|
|
3804
|
+
"name": "ignore-user-expansion",
|
|
3805
|
+
"description": "Whether the step should ignore user expansion.",
|
|
3806
|
+
"values": []
|
|
3807
|
+
},
|
|
3808
|
+
{
|
|
3809
|
+
"name": "index",
|
|
3810
|
+
"description": "The index of the step.",
|
|
3811
|
+
"values": []
|
|
3812
|
+
}
|
|
3813
|
+
],
|
|
3814
|
+
"references": []
|
|
3815
|
+
},
|
|
3699
3816
|
{
|
|
3700
3817
|
"name": "forge-stepper",
|
|
3701
3818
|
"description": "\n---\n\n\n### **Events:**\n - **forge-step-select** - Emits the index when a step is selected.\n- **forge-step-expanded-content-focusin** - Emits the step component when the expanded content is focused.\n- **forge-step-expanded-content-focusout** - Emits the step component when the expanded content is blurred.",
|
|
@@ -3775,69 +3892,6 @@
|
|
|
3775
3892
|
],
|
|
3776
3893
|
"references": []
|
|
3777
3894
|
},
|
|
3778
|
-
{
|
|
3779
|
-
"name": "forge-step",
|
|
3780
|
-
"description": "\n---\n\n\n### **Slots:**\n - _default_ - The content of the step.\n- **optional** - The optional content of the step.\n- **expansion-content** - The content of the step expansion.\n\n### **CSS Properties:**\n - **--forge-step-primary-color** - The primary color of the step. Defaults to the primary theme. _(default: undefined)_\n- **--forge-step-text-color** - The text color of the step. Defaults to the on-primary theme. _(default: undefined)_\n- **--forge-step-border-radius** - The border radius of the step. Defaults to the extra-large shape. _(default: undefined)_\n- **--forge-step-border-radius-vertical** - The border radius of the step in vertical mode. Defaults to the medium shape. _(default: undefined)_\n- **--forge-step-disabled-text-color** - The text color of the step when disabled. Defaults to the text-low theme. _(default: undefined)_\n- **--forge-step-disabled-color** - The color of the step when disabled. Defaults to the surface-container-minimum theme. _(default: undefined)_\n- **--forge-step-icon-fill** - The fill color of the step icon. Defaults to unset. _(default: undefined)_\n- **--forge-step-icon-fill-active** - The fill color of the step icon when active. Defaults to the primary color. _(default: undefined)_\n- **--forge-step-icon-text-color** - The text color of the step icon. Defaults to the primary theme. _(default: undefined)_\n- **--forge-step-icon-text-color-active** - The text color of the step icon when active. Defaults to the on-primary theme. _(default: undefined)_\n- **--forge-step-icon-content-size** - The size of the step icon content. Defaults to 24px. _(default: undefined)_\n- **--forge-step-icon-size** - The size of the step icon. Defaults to 0.875em. _(default: undefined)_\n- **--forge-step-icon-transition-duration** - The duration of the step icon transition. Defaults to the medium4 animation duration. _(default: undefined)_\n- **--forge-step-icon-transition-easing** - The easing of the step icon transition. Defaults to the standard animation easing. _(default: undefined)_\n- **--forge-step-line-color** - The color of the step line. Defaults to the outline theme. _(default: undefined)_\n- **--forge-step-line-min-width** - The minimum width of the step line. Defaults to 10px. _(default: undefined)_\n- **--forge-step-line-min-width-clustered** - The minimum width of the step line when clustered. Defaults to 25px. _(default: undefined)_\n- **--forge-step-label-color** - The color of the step label. Defaults to the text-high theme. _(default: undefined)_\n- **--forge-step-sub-label-color** - The color of the step sub-label. Defaults to the text-medium theme. _(default: undefined)_\n- **--forge-step-error-color** - The color of the step error. Defaults to the error theme. _(default: undefined)_\n- **--forge-step-error-text-color** - The text color of the step error. Defaults to the on-error theme. _(default: undefined)_\n- **--forge-step-expansion-panel-border-left-width** - The border left width of the step expansion panel. Defaults to 1px. _(default: undefined)_\n- **--forge-step-expansion-panel-margin-bottom** - The margin bottom of the step expansion panel. Defaults to 4px. _(default: undefined)_\n- **--forge-step-expansion-panel-margin-left** - The margin left of the step expansion panel. Defaults to 60px. _(default: undefined)_\n- **--forge-step-expansion-panel-margin-top** - The margin top of the step expansion panel. Defaults to 4px. _(default: undefined)_\n- **--forge-step-expansion-panel-icon-color** - The color of the step expansion panel icon. Defaults to the text-medium theme. _(default: undefined)_\n\n### **CSS Parts:**\n - **root** - The root element.\n- **step** - The step container element.\n- **before** - The line before the step.\n- **after** - The line after the step.\n- **icon-container** - The icon container element.\n- **icon-content** - The icon content element.\n- **icon** - The icon element.\n- **index** - The index content container.\n- **text-container** - The text container element.\n- **title-container** - The title container element.\n- **subtitle-container** - The subtitle container element.\n- **state-layer** - The state layer surface element.\n- **focus-indicator** - The focus indicator element.",
|
|
3781
|
-
"attributes": [
|
|
3782
|
-
{
|
|
3783
|
-
"name": "alternative",
|
|
3784
|
-
"description": "Whether the step is in alternative mode.",
|
|
3785
|
-
"values": []
|
|
3786
|
-
},
|
|
3787
|
-
{
|
|
3788
|
-
"name": "completed",
|
|
3789
|
-
"description": "Whether the step is completed.",
|
|
3790
|
-
"values": []
|
|
3791
|
-
},
|
|
3792
|
-
{
|
|
3793
|
-
"name": "editable",
|
|
3794
|
-
"description": "Whether the step is editable.",
|
|
3795
|
-
"values": []
|
|
3796
|
-
},
|
|
3797
|
-
{
|
|
3798
|
-
"name": "error",
|
|
3799
|
-
"description": "Whether the step has an error.",
|
|
3800
|
-
"values": []
|
|
3801
|
-
},
|
|
3802
|
-
{
|
|
3803
|
-
"name": "selected",
|
|
3804
|
-
"description": "Whether the step is selected.",
|
|
3805
|
-
"values": []
|
|
3806
|
-
},
|
|
3807
|
-
{
|
|
3808
|
-
"name": "disabled",
|
|
3809
|
-
"description": "Whether the step is disabled.",
|
|
3810
|
-
"values": []
|
|
3811
|
-
},
|
|
3812
|
-
{
|
|
3813
|
-
"name": "vertical",
|
|
3814
|
-
"description": "Whether the step is in vertical mode.",
|
|
3815
|
-
"values": []
|
|
3816
|
-
},
|
|
3817
|
-
{
|
|
3818
|
-
"name": "expanded",
|
|
3819
|
-
"description": "Whether the step is expanded.",
|
|
3820
|
-
"values": []
|
|
3821
|
-
},
|
|
3822
|
-
{
|
|
3823
|
-
"name": "ignore-user-expansion",
|
|
3824
|
-
"description": "Whether the step should ignore user expansion.",
|
|
3825
|
-
"values": []
|
|
3826
|
-
},
|
|
3827
|
-
{
|
|
3828
|
-
"name": "index",
|
|
3829
|
-
"description": "The index of the step.",
|
|
3830
|
-
"values": []
|
|
3831
|
-
}
|
|
3832
|
-
],
|
|
3833
|
-
"references": []
|
|
3834
|
-
},
|
|
3835
|
-
{
|
|
3836
|
-
"name": "forge-view",
|
|
3837
|
-
"description": "\n---\n",
|
|
3838
|
-
"attributes": [],
|
|
3839
|
-
"references": []
|
|
3840
|
-
},
|
|
3841
3895
|
{
|
|
3842
3896
|
"name": "forge-tab-bar",
|
|
3843
3897
|
"description": "Tabs organize content across different screens and views.\n---\n\n\n### **Events:**\n - **forge-tab-bar-change** - Dispatches when the active tab changes.\n\n### **CSS Properties:**\n - **--forge-tab-bar-justify** - The `justify-content` value for the tab bar flex container. _(default: undefined)_\n- **--forge-tab-bar-stretch** - The `flex` value for the child `<forge-tab>` elements. _(default: undefined)_\n- **--forge-tab-bar-divider-color** - The color of the divider. _(default: undefined)_\n- **--forge-tab-bar-divider-thickness** - The thickness of the divider. _(default: undefined)_\n\n### **CSS Parts:**\n - **container** - The container element.\n- **scroll-container** - The scroll container element.",
|
|
@@ -3884,6 +3938,12 @@
|
|
|
3884
3938
|
}
|
|
3885
3939
|
],
|
|
3886
3940
|
"references": []
|
|
3941
|
+
},
|
|
3942
|
+
{
|
|
3943
|
+
"name": "forge-view",
|
|
3944
|
+
"description": "\n---\n",
|
|
3945
|
+
"attributes": [],
|
|
3946
|
+
"references": []
|
|
3887
3947
|
}
|
|
3888
3948
|
]
|
|
3889
3949
|
}
|