@emuanalytics/flow-rdf-ui 4.0.3 → 4.0.5
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/dist/custom-elements.json +9785 -9745
- package/dist/index.cjs +155 -59
- package/dist/index.d.cts +42 -26
- package/dist/index.d.mts +42 -26
- package/dist/index.d.ts +42 -26
- package/dist/index.mjs +155 -59
- package/dist/vscode.html-custom-data.json +589 -579
- package/package.json +3 -3
- package/themes/dark.css +41 -0
- package/themes/dark.styles.js +41 -0
- package/themes/light.css +41 -0
- package/themes/light.styles.js +41 -0
|
@@ -1,6 +1,40 @@
|
|
|
1
1
|
{
|
|
2
2
|
"version": 1.1,
|
|
3
3
|
"tags": [
|
|
4
|
+
{
|
|
5
|
+
"name": "flow-ui-alert",
|
|
6
|
+
"description": "Alerts are used to display important messages inline or as toast notifications.\n\n\n---\n\n\n\n\n### **Events:**\n - **flow-ui-show** - Emitted when the alert opens.\n- **flow-ui-after-show** - Emitted after the alert opens and all animations are complete.\n- **flow-ui-hide** - Emitted when the alert closes.\n- **flow-ui-after-hide** - Emitted after the alert closes and all animations are complete.\n\n### **Methods:**\n - **show()** - Shows the alert.\n- **hide()** - Hides the alert\n- **toast(): _Promise<void>_** - Displays the alert as a toast notification. This will move the alert out of its position in the DOM and, when\ndismissed, it will be removed from the DOM completely. By storing a reference to the alert, you can reuse it by\ncalling this method again. The returned promise will resolve after the alert is hidden.\n\n### **Slots:**\n - _default_ - The alert's main content.\n- **icon** - An icon to show in the alert. Works best with `<flow-ui-icon>`.\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.\n- **icon** - The container that wraps the optional icon.\n- **message** - The container that wraps the alert's main content.\n- **close-button** - The close button, an `<flow-ui-icon-button>`.\n- **close-button__base** - The close button's exported `base` part.",
|
|
7
|
+
"attributes": [
|
|
8
|
+
{
|
|
9
|
+
"name": "open",
|
|
10
|
+
"description": "Set to `true` to display the alert. You can also\nuse the `show()` and `hide()` methods.",
|
|
11
|
+
"values": []
|
|
12
|
+
},
|
|
13
|
+
{
|
|
14
|
+
"name": "closable",
|
|
15
|
+
"description": "Enables a close button that allows the user to dismiss the alert.",
|
|
16
|
+
"values": []
|
|
17
|
+
},
|
|
18
|
+
{
|
|
19
|
+
"name": "variant",
|
|
20
|
+
"description": "The alert's theme variant.",
|
|
21
|
+
"values": [
|
|
22
|
+
{ "name": "primary" },
|
|
23
|
+
{ "name": "secondary" },
|
|
24
|
+
{ "name": "success" },
|
|
25
|
+
{ "name": "neutral" },
|
|
26
|
+
{ "name": "warning" },
|
|
27
|
+
{ "name": "danger" }
|
|
28
|
+
]
|
|
29
|
+
},
|
|
30
|
+
{
|
|
31
|
+
"name": "duration",
|
|
32
|
+
"description": "The length of time (in ms) that the alert will show itself before closing. If the user interacts with\nthe alert before it closes (e.g. by moving the mouse over it), the timer will restart.",
|
|
33
|
+
"values": []
|
|
34
|
+
}
|
|
35
|
+
],
|
|
36
|
+
"references": []
|
|
37
|
+
},
|
|
4
38
|
{
|
|
5
39
|
"name": "flow-ui-animation",
|
|
6
40
|
"description": "Animate elements declaratively with over 100 animation presets. Powered by the [Web Animations API](https://developer.mozilla.org/en-US/docs/Web/API/Web_Animations_API).\n\n\n---\n\n\n\n\n### **Events:**\n - **flow-ui-cancel** - Emitted when the animation is canceled.\n- **flow-ui-finish** - Emitted when the animation finishes.\n- **flow-ui-start** - Emitted when the animation starts or restarts.\n\n### **Methods:**\n - **cancel()** - Clears all keyframe effects caused by this animation and aborts its playback.\n- **finish()** - Sets the playback time to the end of the animation corresponding to the current playback direction.\n\n### **Slots:**\n - _default_ - The element to animate. Avoid slotting in more than one element, as subsequent ones will be ignored. To animate multiple elements, either wrap them in a single container or use multiple `<flow-ui-animation>` elements.",
|
|
@@ -64,22 +98,12 @@
|
|
|
64
98
|
"references": []
|
|
65
99
|
},
|
|
66
100
|
{
|
|
67
|
-
"name": "flow-ui-
|
|
68
|
-
"description": "
|
|
101
|
+
"name": "flow-ui-badge",
|
|
102
|
+
"description": "Badges are used to draw attention and display statuses or counts.\n\n\n---\n\n\n\n\n### **Slots:**\n - _default_ - The badge's content.\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.",
|
|
69
103
|
"attributes": [
|
|
70
|
-
{
|
|
71
|
-
"name": "open",
|
|
72
|
-
"description": "Set to `true` to display the alert. You can also\nuse the `show()` and `hide()` methods.",
|
|
73
|
-
"values": []
|
|
74
|
-
},
|
|
75
|
-
{
|
|
76
|
-
"name": "closable",
|
|
77
|
-
"description": "Enables a close button that allows the user to dismiss the alert.",
|
|
78
|
-
"values": []
|
|
79
|
-
},
|
|
80
104
|
{
|
|
81
105
|
"name": "variant",
|
|
82
|
-
"description": "The
|
|
106
|
+
"description": "The badge's theme variant.",
|
|
83
107
|
"values": [
|
|
84
108
|
{ "name": "primary" },
|
|
85
109
|
{ "name": "secondary" },
|
|
@@ -90,8 +114,25 @@
|
|
|
90
114
|
]
|
|
91
115
|
},
|
|
92
116
|
{
|
|
93
|
-
"name": "
|
|
94
|
-
"description": "
|
|
117
|
+
"name": "pill",
|
|
118
|
+
"description": "Draws a pill-style badge with rounded edges.",
|
|
119
|
+
"values": []
|
|
120
|
+
},
|
|
121
|
+
{
|
|
122
|
+
"name": "pulse",
|
|
123
|
+
"description": "Makes the badge pulsate to draw attention.",
|
|
124
|
+
"values": []
|
|
125
|
+
}
|
|
126
|
+
],
|
|
127
|
+
"references": []
|
|
128
|
+
},
|
|
129
|
+
{
|
|
130
|
+
"name": "flow-ui-breadcrumb",
|
|
131
|
+
"description": "Breadcrumbs provide a group of links so users can easily navigate a website's hierarchy.\n\n\n---\n\n\n\n\n### **Slots:**\n - _default_ - One or more breadcrumb items to display.\n- **separator** - The separator to use between breadcrumb items. Works best with `<flow-ui-icon>`.\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.",
|
|
132
|
+
"attributes": [
|
|
133
|
+
{
|
|
134
|
+
"name": "label",
|
|
135
|
+
"description": "The label to use for the breadcrumb control. This will not be shown on the screen, but it will be announced by\nscreen readers and other assistive devices to provide more context for users.",
|
|
95
136
|
"values": []
|
|
96
137
|
}
|
|
97
138
|
],
|
|
@@ -133,45 +174,6 @@
|
|
|
133
174
|
],
|
|
134
175
|
"references": []
|
|
135
176
|
},
|
|
136
|
-
{
|
|
137
|
-
"name": "flow-ui-breadcrumb",
|
|
138
|
-
"description": "Breadcrumbs provide a group of links so users can easily navigate a website's hierarchy.\n\n\n---\n\n\n\n\n### **Slots:**\n - _default_ - One or more breadcrumb items to display.\n- **separator** - The separator to use between breadcrumb items. Works best with `<flow-ui-icon>`.\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.",
|
|
139
|
-
"attributes": [
|
|
140
|
-
{
|
|
141
|
-
"name": "label",
|
|
142
|
-
"description": "The label to use for the breadcrumb control. This will not be shown on the screen, but it will be announced by\nscreen readers and other assistive devices to provide more context for users.",
|
|
143
|
-
"values": []
|
|
144
|
-
}
|
|
145
|
-
],
|
|
146
|
-
"references": []
|
|
147
|
-
},
|
|
148
|
-
{
|
|
149
|
-
"name": "flow-ui-breadcrumb-item",
|
|
150
|
-
"description": "Breadcrumb Items are used inside [breadcrumbs](./flow-ui-breadcrumb) to represent different links.\n\n\n---\n\n\n\n\n### **Slots:**\n - _default_ - The breadcrumb item's label.\n- **prefix** - An optional prefix, usually an icon or icon button.\n- **suffix** - An optional suffix, usually an icon or icon button.\n- **separator** - The separator to use for the breadcrumb item. This will only change the separator for this item. If you want to change it for all items in the group, set the separator on `<flow-ui-breadcrumb>` instead.\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.\n- **label** - The breadcrumb item's label.\n- **prefix** - The container that wraps the prefix.\n- **suffix** - The container that wraps the suffix.\n- **separator** - The container that wraps the separator.",
|
|
151
|
-
"attributes": [
|
|
152
|
-
{
|
|
153
|
-
"name": "href",
|
|
154
|
-
"description": "Optional URL to direct the user to when the breadcrumb item is activated. When set, a link will be rendered\ninternally. When unset, a button will be rendered instead.",
|
|
155
|
-
"values": []
|
|
156
|
-
},
|
|
157
|
-
{
|
|
158
|
-
"name": "target",
|
|
159
|
-
"description": "Tells the browser where to open the link. Only used when `href` is set.",
|
|
160
|
-
"values": [
|
|
161
|
-
{ "name": "_blank" },
|
|
162
|
-
{ "name": "_parent" },
|
|
163
|
-
{ "name": "_self" },
|
|
164
|
-
{ "name": "_top" }
|
|
165
|
-
]
|
|
166
|
-
},
|
|
167
|
-
{
|
|
168
|
-
"name": "rel",
|
|
169
|
-
"description": "The `rel` attribute to use on the link. Only used when `href` is set.",
|
|
170
|
-
"values": []
|
|
171
|
-
}
|
|
172
|
-
],
|
|
173
|
-
"references": []
|
|
174
|
-
},
|
|
175
177
|
{
|
|
176
178
|
"name": "flow-ui-button",
|
|
177
179
|
"description": "Buttons represent actions that are available to the user.\n\n\n---\n\n\n\n\n### **Events:**\n - **flow-ui-blur** - Emitted when the button loses focus.\n- **flow-ui-focus** - Emitted when the button gains focus.\n- **flow-ui-invalid** - Emitted when the form control has been checked for validity and its constraints aren't satisfied.\n\n### **Methods:**\n - **click()** - Simulates a click on the button.\n- **focus(options: _FocusOptions_)** - Sets focus on the button.\n- **blur()** - Removes focus from the button.\n- **checkValidity()** - Checks for validity but does not show a validation message. Returns `true` when valid and `false` when invalid.\n- **getForm(): _HTMLFormElement | null_** - Gets the associated form, if one exists.\n- **reportValidity()** - Checks for validity and shows the browser's validation message if the control is invalid.\n- **setCustomValidity(message: _string_)** - Sets a custom validation message. Pass an empty string to restore validity.\n\n### **Slots:**\n - _default_ - The button's label.\n- **prefix** - A presentational prefix icon or similar element.\n- **suffix** - A presentational suffix icon or similar element.\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.\n- **prefix** - The container that wraps the prefix.\n- **label** - The button's label.\n- **suffix** - The container that wraps the suffix.\n- **caret** - The button's caret icon, an `<flow-ui-icon>` element.",
|
|
@@ -323,29 +325,27 @@
|
|
|
323
325
|
"references": []
|
|
324
326
|
},
|
|
325
327
|
{
|
|
326
|
-
"name": "flow-ui-
|
|
327
|
-
"description": "
|
|
328
|
+
"name": "flow-ui-breadcrumb-item",
|
|
329
|
+
"description": "Breadcrumb Items are used inside [breadcrumbs](./flow-ui-breadcrumb) to represent different links.\n\n\n---\n\n\n\n\n### **Slots:**\n - _default_ - The breadcrumb item's label.\n- **prefix** - An optional prefix, usually an icon or icon button.\n- **suffix** - An optional suffix, usually an icon or icon button.\n- **separator** - The separator to use for the breadcrumb item. This will only change the separator for this item. If you want to change it for all items in the group, set the separator on `<flow-ui-breadcrumb>` instead.\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.\n- **label** - The breadcrumb item's label.\n- **prefix** - The container that wraps the prefix.\n- **suffix** - The container that wraps the suffix.\n- **separator** - The container that wraps the separator.",
|
|
328
330
|
"attributes": [
|
|
329
331
|
{
|
|
330
|
-
"name": "
|
|
331
|
-
"description": "
|
|
332
|
-
"values": [
|
|
333
|
-
{ "name": "primary" },
|
|
334
|
-
{ "name": "secondary" },
|
|
335
|
-
{ "name": "success" },
|
|
336
|
-
{ "name": "neutral" },
|
|
337
|
-
{ "name": "warning" },
|
|
338
|
-
{ "name": "danger" }
|
|
339
|
-
]
|
|
332
|
+
"name": "href",
|
|
333
|
+
"description": "Optional URL to direct the user to when the breadcrumb item is activated. When set, a link will be rendered\ninternally. When unset, a button will be rendered instead.",
|
|
334
|
+
"values": []
|
|
340
335
|
},
|
|
341
336
|
{
|
|
342
|
-
"name": "
|
|
343
|
-
"description": "
|
|
344
|
-
"values": [
|
|
337
|
+
"name": "target",
|
|
338
|
+
"description": "Tells the browser where to open the link. Only used when `href` is set.",
|
|
339
|
+
"values": [
|
|
340
|
+
{ "name": "_blank" },
|
|
341
|
+
{ "name": "_parent" },
|
|
342
|
+
{ "name": "_self" },
|
|
343
|
+
{ "name": "_top" }
|
|
344
|
+
]
|
|
345
345
|
},
|
|
346
346
|
{
|
|
347
|
-
"name": "
|
|
348
|
-
"description": "
|
|
347
|
+
"name": "rel",
|
|
348
|
+
"description": "The `rel` attribute to use on the link. Only used when `href` is set.",
|
|
349
349
|
"values": []
|
|
350
350
|
}
|
|
351
351
|
],
|
|
@@ -368,12 +368,6 @@
|
|
|
368
368
|
],
|
|
369
369
|
"references": []
|
|
370
370
|
},
|
|
371
|
-
{
|
|
372
|
-
"name": "flow-ui-card",
|
|
373
|
-
"description": "Cards can be used to group related subjects in a container.\n\n\n---\n\n\n\n\n### **Slots:**\n - _default_ - The card's main content.\n- **header** - An optional header for the card.\n- **footer** - An optional footer for the card.\n- **image** - An optional image to render at the start of the card.\n\n### **CSS Properties:**\n - **--border-color** - The card's border color, including borders that occur inside the card. _(default: undefined)_\n- **--border-radius** - The border radius for the card's edges. _(default: undefined)_\n- **--border-width** - The width of the card's borders. _(default: undefined)_\n- **--padding** - The padding to use for the card's sections. _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.\n- **image** - The container that wraps the card's image.\n- **header** - The container that wraps the card's header.\n- **body** - The container that wraps the card's main content.\n- **footer** - The container that wraps the card's footer.",
|
|
374
|
-
"attributes": [],
|
|
375
|
-
"references": []
|
|
376
|
-
},
|
|
377
371
|
{
|
|
378
372
|
"name": "flow-ui-calendar",
|
|
379
373
|
"description": "A calendar component for selecting dates and times.\n\n\n---\n\n\n\n\n### **Events:**\n - **flow-ui-input** - Emitted when the calendar value changes.\n- **flow-ui-change** - Emitted when the calendar value changes.\n\n### **CSS Properties:**\n - **--width** - The width of the calendar in CSS units. Set automatically if `size` is set. _(default: undefined)_\n- **--font-size** - The font size of the calendar. Set automatically if `size` is set. _(default: undefined)_\n- **--day-font-size** - The font size of the day labels. Set automatically if `size` is set. _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.",
|
|
@@ -414,6 +408,12 @@
|
|
|
414
408
|
],
|
|
415
409
|
"references": []
|
|
416
410
|
},
|
|
411
|
+
{
|
|
412
|
+
"name": "flow-ui-card",
|
|
413
|
+
"description": "Cards can be used to group related subjects in a container.\n\n\n---\n\n\n\n\n### **Slots:**\n - _default_ - The card's main content.\n- **header** - An optional header for the card.\n- **footer** - An optional footer for the card.\n- **image** - An optional image to render at the start of the card.\n\n### **CSS Properties:**\n - **--border-color** - The card's border color, including borders that occur inside the card. _(default: undefined)_\n- **--border-radius** - The border radius for the card's edges. _(default: undefined)_\n- **--border-width** - The width of the card's borders. _(default: undefined)_\n- **--padding** - The padding to use for the card's sections. _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.\n- **image** - The container that wraps the card's image.\n- **header** - The container that wraps the card's header.\n- **body** - The container that wraps the card's main content.\n- **footer** - The container that wraps the card's footer.",
|
|
414
|
+
"attributes": [],
|
|
415
|
+
"references": []
|
|
416
|
+
},
|
|
417
417
|
{
|
|
418
418
|
"name": "flow-ui-carousel",
|
|
419
419
|
"description": "Carousels display an arbitrary number of content slides along a horizontal or vertical axis.\n\n\n---\n\n\n\n\n### **Events:**\n - **flow-ui-slide-change** - Emitted when the active slide changes.\n\n### **Methods:**\n - **previous(behavior: _ScrollBehavior_)** - Move the carousel backward by `slides-per-move` slides.\n- **next(behavior: _ScrollBehavior_)** - Move the carousel forward by `slides-per-move` slides.\n- **goToSlide(index: _number_, behavior: _ScrollBehavior_)** - Scrolls the carousel to the slide specified by `index`.\n\n### **Slots:**\n - _default_ - The carousel's main content, one or more `<flow-ui-carousel-item>` elements.\n- **next-icon** - Optional next icon to use instead of the default. Works best with `<flow-ui-icon>`.\n- **previous-icon** - Optional previous icon to use instead of the default. Works best with `<flow-ui-icon>`.\n\n### **CSS Properties:**\n - **--slide-gap** - The space between each slide. _(default: undefined)_\n- **--aspect-ratio** - The aspect ratio of each slide. _(default: undefined)_\n- **--scroll-hint** - The amount of padding to apply to the scroll area, allowing adjacent slides to become partially visible as a scroll hint. _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The carousel's internal wrapper.\n- **scroll-container** - The scroll container that wraps the slides.\n- **pagination** - The pagination indicators wrapper.\n- **pagination-item** - The pagination indicator.\n- **pagination-item--active** - Applied when the item is active.\n- **navigation** - The navigation wrapper.\n- **navigation-button** - The navigation button.\n- **navigation-button--previous** - Applied to the previous button.\n- **navigation-button--next** - Applied to the next button.",
|
|
@@ -472,6 +472,23 @@
|
|
|
472
472
|
"attributes": [],
|
|
473
473
|
"references": []
|
|
474
474
|
},
|
|
475
|
+
{
|
|
476
|
+
"name": "flow-ui-chart",
|
|
477
|
+
"description": "The chart component displays Chart.js charts.\n\n\n---\n\n\n\n\n### **Methods:**\n - **repaint()** - Trigger a repaint of the chart.\n\n### **CSS Properties:**\n - **--background-color** - Chart background color (applied as the background color of the base container). _(default: undefined)_\n- **--text-color** - General text color (titles etc.) _(default: undefined)_\n- **--axis-color** - Color of the axis lines. _(default: undefined)_\n- **--x-axis-color** - Color of the x-axis lines. (defaults to `--axis-color`) _(default: undefined)_\n- **--y-axis-color** - Color of the y-axis lines. (defaults to `--axis-color`) _(default: undefined)_\n- **--axis-grid-color** - Color of the axis grid lines. _(default: undefined)_\n- **--x-axis-grid-color** - Color of the x-axis grid lines. (defaults to `--axis-grid-color`) _(default: undefined)_\n- **--y-axis-grid-color** - Color of the y-axis grid lines. (defaults to `--axis-grid-color`) _(default: undefined)_\n- **--axis-label-color** - Color of the axis labels. _(default: undefined)_\n- **--x-axis-label-color** - Color of the x-axis labels. (defaults to `--axis-label-color`) _(default: undefined)_\n- **--y-axis-label-color** - Color of the y-axis labels. (defaults to `--axis-label-color`) _(default: undefined)_\n- **--tick-label-color** - Color of the tick labels. _(default: undefined)_\n- **--x-tick-label-color** - Color of the x-axis tick labels. (defaults to `--tick-label-color`) _(default: undefined)_\n- **--y-tick-label-color** - Color of the y-axis tick labels. (defaults to `--tick-label-color`) _(default: undefined)_\n- **--dataset-stroke-color-n** - Color of the stroke for dataset n (where n = 0-9). _(default: undefined)_\n- **--dataset-fill-color-n** - Color of the fill for dataset n (where n = 0-9). _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The base container of the chart.",
|
|
478
|
+
"attributes": [
|
|
479
|
+
{
|
|
480
|
+
"name": "type",
|
|
481
|
+
"description": "The Chart.js chart type (e.g `line`, `bar` or a custom type).",
|
|
482
|
+
"values": []
|
|
483
|
+
},
|
|
484
|
+
{
|
|
485
|
+
"name": "plugins",
|
|
486
|
+
"description": "List of extra plugins to use for this chart.",
|
|
487
|
+
"values": [{ "name": "Plugin[]" }]
|
|
488
|
+
}
|
|
489
|
+
],
|
|
490
|
+
"references": []
|
|
491
|
+
},
|
|
475
492
|
{
|
|
476
493
|
"name": "flow-ui-checkbox",
|
|
477
494
|
"description": "Checkboxes allow the user to toggle an option on or off.\n\n\n---\n\n\n\n\n### **Events:**\n - **flow-ui-blur** - Emitted when the checkbox loses focus.\n- **flow-ui-change** - Emitted when the checked state changes.\n- **flow-ui-focus** - Emitted when the checkbox gains focus.\n- **flow-ui-input** - Emitted when the checkbox receives input.\n- **flow-ui-invalid** - Emitted when the form control has been checked for validity and its constraints aren't satisfied.\n\n### **Methods:**\n - **click()** - Simulates a click on the checkbox.\n- **focus(options: _FocusOptions_)** - Sets focus on the checkbox.\n- **blur()** - Removes focus from the checkbox.\n- **checkValidity()** - Checks for validity but does not show a validation message. Returns `true` when valid and `false` when invalid.\n- **getForm(): _HTMLFormElement | null_** - Gets the associated form, if one exists.\n- **reportValidity()** - Checks for validity and shows the browser's validation message if the control is invalid.\n- **setCustomValidity(message: _string_)** - Sets a custom validation message. The value provided will be shown to the user when the form is submitted. To clear\nthe custom validation message, call this method with an empty string.\n\n### **Slots:**\n - _default_ - The checkbox's label.\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.\n- **control** - The square container that wraps the checkbox's checked state.\n- **control--checked** - Matches the control part when the checkbox is checked.\n- **control--indeterminate** - Matches the control part when the checkbox is indeterminate.\n- **checked-icon** - The checked icon, an `<flow-ui-icon>` element.\n- **indeterminate-icon** - The indeterminate icon, an `<flow-ui-icon>` element.\n- **label** - The container that wraps the checkbox's label.",
|
|
@@ -530,23 +547,42 @@
|
|
|
530
547
|
{ "name": "danger" },
|
|
531
548
|
{ "name": "neutral" }
|
|
532
549
|
]
|
|
550
|
+
},
|
|
551
|
+
{
|
|
552
|
+
"name": "full-width",
|
|
553
|
+
"description": "Display the radio group using the alternative 'full-width' style with left-aligned label.",
|
|
554
|
+
"values": []
|
|
533
555
|
}
|
|
534
556
|
],
|
|
535
557
|
"references": []
|
|
536
558
|
},
|
|
537
559
|
{
|
|
538
|
-
"name": "flow-ui-
|
|
539
|
-
"description": "
|
|
560
|
+
"name": "flow-ui-color-mapper",
|
|
561
|
+
"description": "A component for defining mappings between data values and colors.\n\n\n---\n\n\n",
|
|
540
562
|
"attributes": [
|
|
541
563
|
{
|
|
542
|
-
"name": "
|
|
543
|
-
"description": "The
|
|
544
|
-
"values": []
|
|
564
|
+
"name": "options",
|
|
565
|
+
"description": "The color mapper configuration specifying available fields.",
|
|
566
|
+
"values": [{ "name": "ColorMapperOptions" }]
|
|
545
567
|
},
|
|
546
568
|
{
|
|
547
|
-
"name": "
|
|
548
|
-
"description": "
|
|
549
|
-
"values": [{ "name": "
|
|
569
|
+
"name": "value",
|
|
570
|
+
"description": "The current value of the color mapper.",
|
|
571
|
+
"values": [{ "name": "ColorMapperValue" }]
|
|
572
|
+
},
|
|
573
|
+
{
|
|
574
|
+
"name": "size",
|
|
575
|
+
"description": "The size of the color mapper component.",
|
|
576
|
+
"values": [
|
|
577
|
+
{ "name": "small" },
|
|
578
|
+
{ "name": "medium" },
|
|
579
|
+
{ "name": "large" }
|
|
580
|
+
]
|
|
581
|
+
},
|
|
582
|
+
{
|
|
583
|
+
"name": "swatches",
|
|
584
|
+
"description": "One or more predefined color swatches to display as presets in the color picker. Can include any format the color\npicker can parse, including HEX(A), RGB(A), HSL(A), HSV(A), and CSS color names. Each color must be separated by a\nsemicolon (`;`). Alternatively, you can pass an array of color values to this property using JavaScript.",
|
|
585
|
+
"values": [{ "name": "string[]" }]
|
|
550
586
|
}
|
|
551
587
|
],
|
|
552
588
|
"references": []
|
|
@@ -666,28 +702,6 @@
|
|
|
666
702
|
],
|
|
667
703
|
"references": []
|
|
668
704
|
},
|
|
669
|
-
{
|
|
670
|
-
"name": "flow-ui-details",
|
|
671
|
-
"description": "Details show a brief summary and expand to show additional content.\n\n\n---\n\n\n\n\n### **Events:**\n - **flow-ui-show** - Emitted when the details opens.\n- **flow-ui-after-show** - Emitted after the details opens and all animations are complete.\n- **flow-ui-hide** - Emitted when the details closes.\n- **flow-ui-after-hide** - Emitted after the details closes and all animations are complete.\n\n### **Methods:**\n - **show()** - Shows the details.\n- **hide()** - Hides the details\n\n### **Slots:**\n - _default_ - The details' main content.\n- **summary** - The details' summary. Alternatively, you can use the `summary` attribute.\n- **expand-icon** - Optional expand icon to use instead of the default. Works best with `<flow-ui-icon>`.\n- **collapse-icon** - Optional collapse icon to use instead of the default. Works best with `<flow-ui-icon>`.\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.\n- **header** - The header that wraps both the summary and the expand/collapse icon.\n- **summary** - The container that wraps the summary.\n- **summary-icon** - The container that wraps the expand/collapse icons.\n- **content** - The details content.",
|
|
672
|
-
"attributes": [
|
|
673
|
-
{
|
|
674
|
-
"name": "open",
|
|
675
|
-
"description": "Indicates whether or not the details is open. You can toggle this attribute to show and hide the details, or you\ncan use the `show()` and `hide()` methods and this attribute will reflect the details' open state.",
|
|
676
|
-
"values": []
|
|
677
|
-
},
|
|
678
|
-
{
|
|
679
|
-
"name": "summary",
|
|
680
|
-
"description": "The summary to show in the header. If you need to display HTML, use the `summary` slot instead.",
|
|
681
|
-
"values": []
|
|
682
|
-
},
|
|
683
|
-
{
|
|
684
|
-
"name": "disabled",
|
|
685
|
-
"description": "Disables the details so it can't be toggled.",
|
|
686
|
-
"values": []
|
|
687
|
-
}
|
|
688
|
-
],
|
|
689
|
-
"references": []
|
|
690
|
-
},
|
|
691
705
|
{
|
|
692
706
|
"name": "flow-ui-color-stop",
|
|
693
707
|
"description": "A single color stop used by the `flow-ui-color-mapper` component.\n\n\n---\n\n\n\n\n### **Methods:**\n - **checkValidity()** - Checks for validity but does not show a validation message. Returns `true` when valid and `false` when invalid.\n- **getForm(): _HTMLFormElement | null_** - Gets the associated form, if one exists.\n- **reportValidity()** - Checks for validity and shows the browser's validation message if the control is invalid.\n- **setCustomValidity(message: _string_)** - Sets a custom validation message. Pass an empty string to restore validity.",
|
|
@@ -745,84 +759,31 @@
|
|
|
745
759
|
"references": []
|
|
746
760
|
},
|
|
747
761
|
{
|
|
748
|
-
"name": "flow-ui-
|
|
749
|
-
"description": "
|
|
762
|
+
"name": "flow-ui-date-time-picker",
|
|
763
|
+
"description": "Date time pickers allow users to select a date and time from a calendar and clock interface.\n\n\n---\n\n\n\n\n### **Events:**\n - **flow-ui-change** - Emitted when the control's value changes.\n- **flow-ui-clear** - Emitted when the control's value is cleared.\n- **flow-ui-input** - Emitted when the control receives input.\n- **flow-ui-focus** - Emitted when the control gains focus.\n- **flow-ui-blur** - Emitted when the control loses focus.\n- **flow-ui-show** - Emitted when calendar opens.\n- **flow-ui-after-show** - Emitted after the calendar opens and all animations are complete.\n- **flow-ui-hide** - Emitted when the calendar closes.\n- **flow-ui-after-hide** - Emitted after the calendar closes and all animations are complete.\n- **flow-ui-invalid** - Emitted when the form control has been checked for validity and its constraints aren't satisfied.\n\n### **Methods:**\n - **show()** - Shows the calendar.\n- **hide()** - Hides the calendar.\n- **checkValidity()** - Checks for validity but does not show a validation message. Returns `true` when valid and `false` when invalid.\n- **getForm(): _HTMLFormElement | null_** - Gets the associated form, if one exists.\n- **reportValidity()** - Checks for validity and shows the browser's validation message if the control is invalid.\n- **setCustomValidity(message: _string_)** - Sets a custom validation message. Pass an empty string to restore validity.\n- **focus(options: _FocusOptions_)** - Sets focus on the control.\n- **blur()** - Removes focus from the control.\n\n### **Slots:**\n - **label** - The input's label. Alternatively, you can use the `label` attribute.\n- **prefix** - Used to prepend a presentational icon or similar element to the picker.\n- **clear-icon** - An icon to use in lieu of the default clear icon.\n- **mode-icon** - An icon to use in lieu of the default mode icon.\n- **help-text** - Text that describes how to use the input. Alternatively, you can use the `help-text` attribute.\n\n### **CSS Parts:**\n - **form-control** - The form control that wraps the label, input, and help text.\n- **form-control-label** - The label's wrapper.\n- **form-control-help-text** - The help text's wrapper.\n- **combobox** - The container the wraps the prefix, mode-icon, combobox, and clear icon.\n- **prefix** - The container that wraps the prefix slot.\n- **display-input** - The element that displays the selected date/time, an `<input>` element.\n- **clear-button** - The clear button.\n- **mode-icon** - The mode icon, a `<flow-ui-icon>` element.",
|
|
750
764
|
"attributes": [
|
|
751
765
|
{
|
|
752
|
-
"name": "
|
|
753
|
-
"description": "
|
|
766
|
+
"name": "name",
|
|
767
|
+
"description": "The name of the date/time picker, submitted as a name/value pair with form data.",
|
|
754
768
|
"values": []
|
|
755
769
|
},
|
|
756
770
|
{
|
|
757
|
-
"name": "
|
|
758
|
-
"description": "The
|
|
771
|
+
"name": "value",
|
|
772
|
+
"description": "The current value of the date/time picker. (ISO8601 date/time string)",
|
|
759
773
|
"values": []
|
|
760
774
|
},
|
|
761
775
|
{
|
|
762
|
-
"name": "
|
|
763
|
-
"description": "
|
|
764
|
-
"values": [
|
|
765
|
-
|
|
766
|
-
|
|
767
|
-
|
|
768
|
-
|
|
769
|
-
|
|
770
|
-
|
|
771
|
-
|
|
772
|
-
|
|
773
|
-
{
|
|
774
|
-
"name": "options",
|
|
775
|
-
"description": "The color mapper configuration specifying available fields.",
|
|
776
|
-
"values": [{ "name": "ColorMapperOptions" }]
|
|
777
|
-
},
|
|
778
|
-
{
|
|
779
|
-
"name": "value",
|
|
780
|
-
"description": "The current value of the color mapper.",
|
|
781
|
-
"values": [{ "name": "ColorMapperValue" }]
|
|
782
|
-
},
|
|
783
|
-
{
|
|
784
|
-
"name": "size",
|
|
785
|
-
"description": "The size of the color mapper component.",
|
|
786
|
-
"values": [
|
|
787
|
-
{ "name": "small" },
|
|
788
|
-
{ "name": "medium" },
|
|
789
|
-
{ "name": "large" }
|
|
790
|
-
]
|
|
791
|
-
},
|
|
792
|
-
{
|
|
793
|
-
"name": "swatches",
|
|
794
|
-
"description": "One or more predefined color swatches to display as presets in the color picker. Can include any format the color\npicker can parse, including HEX(A), RGB(A), HSL(A), HSV(A), and CSS color names. Each color must be separated by a\nsemicolon (`;`). Alternatively, you can pass an array of color values to this property using JavaScript.",
|
|
795
|
-
"values": [{ "name": "string[]" }]
|
|
796
|
-
}
|
|
797
|
-
],
|
|
798
|
-
"references": []
|
|
799
|
-
},
|
|
800
|
-
{
|
|
801
|
-
"name": "flow-ui-date-time-picker",
|
|
802
|
-
"description": "Date time pickers allow users to select a date and time from a calendar and clock interface.\n\n\n---\n\n\n\n\n### **Events:**\n - **flow-ui-change** - Emitted when the control's value changes.\n- **flow-ui-clear** - Emitted when the control's value is cleared.\n- **flow-ui-input** - Emitted when the control receives input.\n- **flow-ui-focus** - Emitted when the control gains focus.\n- **flow-ui-blur** - Emitted when the control loses focus.\n- **flow-ui-show** - Emitted when calendar opens.\n- **flow-ui-after-show** - Emitted after the calendar opens and all animations are complete.\n- **flow-ui-hide** - Emitted when the calendar closes.\n- **flow-ui-after-hide** - Emitted after the calendar closes and all animations are complete.\n- **flow-ui-invalid** - Emitted when the form control has been checked for validity and its constraints aren't satisfied.\n\n### **Methods:**\n - **show()** - Shows the calendar.\n- **hide()** - Hides the calendar.\n- **checkValidity()** - Checks for validity but does not show a validation message. Returns `true` when valid and `false` when invalid.\n- **getForm(): _HTMLFormElement | null_** - Gets the associated form, if one exists.\n- **reportValidity()** - Checks for validity and shows the browser's validation message if the control is invalid.\n- **setCustomValidity(message: _string_)** - Sets a custom validation message. Pass an empty string to restore validity.\n- **focus(options: _FocusOptions_)** - Sets focus on the control.\n- **blur()** - Removes focus from the control.\n\n### **Slots:**\n - **label** - The input's label. Alternatively, you can use the `label` attribute.\n- **prefix** - Used to prepend a presentational icon or similar element to the picker.\n- **clear-icon** - An icon to use in lieu of the default clear icon.\n- **mode-icon** - An icon to use in lieu of the default mode icon.\n- **help-text** - Text that describes how to use the input. Alternatively, you can use the `help-text` attribute.\n\n### **CSS Parts:**\n - **form-control** - The form control that wraps the label, input, and help text.\n- **form-control-label** - The label's wrapper.\n- **form-control-help-text** - The help text's wrapper.\n- **combobox** - The container the wraps the prefix, mode-icon, combobox, and clear icon.\n- **prefix** - The container that wraps the prefix slot.\n- **display-input** - The element that displays the selected date/time, an `<input>` element.\n- **clear-button** - The clear button.\n- **mode-icon** - The mode icon, a `<flow-ui-icon>` element.",
|
|
803
|
-
"attributes": [
|
|
804
|
-
{
|
|
805
|
-
"name": "name",
|
|
806
|
-
"description": "The name of the date/time picker, submitted as a name/value pair with form data.",
|
|
807
|
-
"values": []
|
|
808
|
-
},
|
|
809
|
-
{
|
|
810
|
-
"name": "value",
|
|
811
|
-
"description": "The current value of the date/time picker. (ISO8601 date/time string)",
|
|
812
|
-
"values": []
|
|
813
|
-
},
|
|
814
|
-
{
|
|
815
|
-
"name": "display-mode",
|
|
816
|
-
"description": "Select whether to show date only, time only or both date and time.",
|
|
817
|
-
"values": [
|
|
818
|
-
{ "name": "date" },
|
|
819
|
-
{ "name": "time" },
|
|
820
|
-
{ "name": "datetime" }
|
|
821
|
-
]
|
|
822
|
-
},
|
|
823
|
-
{
|
|
824
|
-
"name": "format",
|
|
825
|
-
"description": "Specify the display format using a [Luxon format string](https://moment.github.io/luxon/#/formatting?id=table-of-tokens).",
|
|
776
|
+
"name": "display-mode",
|
|
777
|
+
"description": "Select whether to show date only, time only or both date and time.",
|
|
778
|
+
"values": [
|
|
779
|
+
{ "name": "date" },
|
|
780
|
+
{ "name": "time" },
|
|
781
|
+
{ "name": "datetime" }
|
|
782
|
+
]
|
|
783
|
+
},
|
|
784
|
+
{
|
|
785
|
+
"name": "format",
|
|
786
|
+
"description": "Specify the display format using a [Luxon format string](https://moment.github.io/luxon/#/formatting?id=table-of-tokens).",
|
|
826
787
|
"values": []
|
|
827
788
|
},
|
|
828
789
|
{
|
|
@@ -914,6 +875,50 @@
|
|
|
914
875
|
],
|
|
915
876
|
"references": []
|
|
916
877
|
},
|
|
878
|
+
{
|
|
879
|
+
"name": "flow-ui-details",
|
|
880
|
+
"description": "Details show a brief summary and expand to show additional content.\n\n\n---\n\n\n\n\n### **Events:**\n - **flow-ui-show** - Emitted when the details opens.\n- **flow-ui-after-show** - Emitted after the details opens and all animations are complete.\n- **flow-ui-hide** - Emitted when the details closes.\n- **flow-ui-after-hide** - Emitted after the details closes and all animations are complete.\n\n### **Methods:**\n - **show()** - Shows the details.\n- **hide()** - Hides the details\n\n### **Slots:**\n - _default_ - The details' main content.\n- **summary** - The details' summary. Alternatively, you can use the `summary` attribute.\n- **expand-icon** - Optional expand icon to use instead of the default. Works best with `<flow-ui-icon>`.\n- **collapse-icon** - Optional collapse icon to use instead of the default. Works best with `<flow-ui-icon>`.\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.\n- **header** - The header that wraps both the summary and the expand/collapse icon.\n- **summary** - The container that wraps the summary.\n- **summary-icon** - The container that wraps the expand/collapse icons.\n- **content** - The details content.",
|
|
881
|
+
"attributes": [
|
|
882
|
+
{
|
|
883
|
+
"name": "open",
|
|
884
|
+
"description": "Indicates whether or not the details is open. You can toggle this attribute to show and hide the details, or you\ncan use the `show()` and `hide()` methods and this attribute will reflect the details' open state.",
|
|
885
|
+
"values": []
|
|
886
|
+
},
|
|
887
|
+
{
|
|
888
|
+
"name": "summary",
|
|
889
|
+
"description": "The summary to show in the header. If you need to display HTML, use the `summary` slot instead.",
|
|
890
|
+
"values": []
|
|
891
|
+
},
|
|
892
|
+
{
|
|
893
|
+
"name": "disabled",
|
|
894
|
+
"description": "Disables the details so it can't be toggled.",
|
|
895
|
+
"values": []
|
|
896
|
+
}
|
|
897
|
+
],
|
|
898
|
+
"references": []
|
|
899
|
+
},
|
|
900
|
+
{
|
|
901
|
+
"name": "flow-ui-dialog",
|
|
902
|
+
"description": "Dialogs, sometimes called \"modals\", appear above the page and require the user's immediate attention.\n\n\n---\n\n\n\n\n### **Events:**\n - **flow-ui-show** - Emitted when the dialog opens.\n- **flow-ui-after-show** - Emitted after the dialog opens and all animations are complete.\n- **flow-ui-hide** - Emitted when the dialog closes.\n- **flow-ui-after-hide** - Emitted after the dialog closes and all animations are complete.\n- **flow-ui-initial-focus** - Emitted when the dialog opens and is ready to receive focus. Calling `event.preventDefault()` will prevent focusing and allow you to set it on a different element, such as an input.\n- **flow-ui-request-close** - Emitted when the user attempts to close the dialog by clicking the close button, clicking the overlay, or pressing escape. Calling `event.preventDefault()` will keep the dialog open. Avoid using this unless closing the dialog will result in destructive behavior such as data loss.\n\n### **Methods:**\n - **show()** - Shows the dialog.\n- **hide()** - Hides the dialog\n\n### **Slots:**\n - _default_ - The dialog's main content.\n- **label** - The dialog's label. Alternatively, you can use the `label` attribute.\n- **header-actions** - Optional actions to add to the header. Works best with `<flow-ui-icon-button>`.\n- **footer** - The dialog's footer, usually one or more buttons representing various options.\n\n### **CSS Properties:**\n - **--width** - The preferred width of the dialog. Note that the dialog will shrink to accommodate smaller screens. _(default: undefined)_\n- **--header-spacing** - The amount of padding to use for the header. _(default: undefined)_\n- **--body-spacing** - The amount of padding to use for the body. _(default: undefined)_\n- **--footer-spacing** - The amount of padding to use for the footer. _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.\n- **overlay** - The overlay that covers the screen behind the dialog.\n- **panel** - The dialog's panel (where the dialog and its content are rendered).\n- **header** - The dialog's header. This element wraps the title and header actions.\n- **header-actions** - Optional actions to add to the header. Works best with `<flow-ui-icon-button>`.\n- **title** - The dialog's title.\n- **close-button** - The close button, an `<flow-ui-icon-button>`.\n- **close-button__base** - The close button's exported `base` part.\n- **body** - The dialog's body.\n- **footer** - The dialog's footer.",
|
|
903
|
+
"attributes": [
|
|
904
|
+
{
|
|
905
|
+
"name": "open",
|
|
906
|
+
"description": "Indicates whether or not the dialog is open. You can toggle this attribute to show and hide the dialog, or you can\nuse the `show()` and `hide()` methods and this attribute will reflect the dialog's open state.",
|
|
907
|
+
"values": []
|
|
908
|
+
},
|
|
909
|
+
{
|
|
910
|
+
"name": "label",
|
|
911
|
+
"description": "The dialog's label as displayed in the header. You should always include a relevant label even when using\n`no-header`, as it is required for proper accessibility. If you need to display HTML, use the `label` slot instead.",
|
|
912
|
+
"values": []
|
|
913
|
+
},
|
|
914
|
+
{
|
|
915
|
+
"name": "no-header",
|
|
916
|
+
"description": "Disables the header. This will also remove the default close button, so please ensure you provide an easy,\naccessible way for users to dismiss the dialog.",
|
|
917
|
+
"values": []
|
|
918
|
+
}
|
|
919
|
+
],
|
|
920
|
+
"references": []
|
|
921
|
+
},
|
|
917
922
|
{
|
|
918
923
|
"name": "flow-ui-divider",
|
|
919
924
|
"description": "Dividers are used to visually separate or group elements.\n\n\n---\n\n\n\n\n### **CSS Properties:**\n - **--color** - The color of the divider. _(default: undefined)_\n- **--width** - The width of the divider. _(default: undefined)_\n- **--spacing** - The spacing of the divider. _(default: undefined)_",
|
|
@@ -1048,6 +1053,43 @@
|
|
|
1048
1053
|
],
|
|
1049
1054
|
"references": []
|
|
1050
1055
|
},
|
|
1056
|
+
{
|
|
1057
|
+
"name": "flow-ui-gauge",
|
|
1058
|
+
"description": "Gauges are used to display a single value with an optional icon and heading.\n\n\n---\n\n\n\n\n### **Slots:**\n - **title** - The gauge's title. Alternatively, you can use the `title` attribute.\n- **value** - The gauge's value. Alternatively, you can use the `value` attribute.\n- **unit** - Alternatively, you can use the `unit` attribute.\n- **info** - The content to display in the gauge's info dialog. If this is set then an info button will be displayed in the gauge's header.\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.\n- **header** - The gauge's header.\n- **header-icon** - The icon in the gauge's header.\n- **title** - The text in the gauge's header.\n- **info-button** - The info button in the gauge's header (if info dialog configured).",
|
|
1059
|
+
"attributes": [
|
|
1060
|
+
{
|
|
1061
|
+
"name": "title",
|
|
1062
|
+
"description": "The title text of the gauge. Alternatively, use the `title` slot to enhance the title with HTML markup.",
|
|
1063
|
+
"values": []
|
|
1064
|
+
},
|
|
1065
|
+
{
|
|
1066
|
+
"name": "units",
|
|
1067
|
+
"description": "The units of the gauge value.",
|
|
1068
|
+
"values": []
|
|
1069
|
+
},
|
|
1070
|
+
{
|
|
1071
|
+
"name": "value",
|
|
1072
|
+
"description": "The value to display in the gauge.",
|
|
1073
|
+
"values": []
|
|
1074
|
+
},
|
|
1075
|
+
{
|
|
1076
|
+
"name": "icon",
|
|
1077
|
+
"description": "The icon to display in the gauge header.",
|
|
1078
|
+
"values": []
|
|
1079
|
+
},
|
|
1080
|
+
{
|
|
1081
|
+
"name": "icon-library",
|
|
1082
|
+
"description": "The icon library to use for the icon. Uses default library if not specified.",
|
|
1083
|
+
"values": []
|
|
1084
|
+
},
|
|
1085
|
+
{
|
|
1086
|
+
"name": "format",
|
|
1087
|
+
"description": "The [D3 format](https://d3js.org/d3-format#locale_format) to use when displaying numeric values.",
|
|
1088
|
+
"values": []
|
|
1089
|
+
}
|
|
1090
|
+
],
|
|
1091
|
+
"references": []
|
|
1092
|
+
},
|
|
1051
1093
|
{
|
|
1052
1094
|
"name": "flow-ui-icon",
|
|
1053
1095
|
"description": "Icons are symbols that can be used to represent various options within an application.\n\n\n---\n\n\n\n\n### **Events:**\n - **flow-ui-load** - Emitted when the icon has loaded.\n- **flow-ui-error** - Emitted when the icon fails to load due to an error.\n\n### **CSS Parts:**\n - **svg** - The internal SVG element.",
|
|
@@ -1368,12 +1410,6 @@
|
|
|
1368
1410
|
],
|
|
1369
1411
|
"references": []
|
|
1370
1412
|
},
|
|
1371
|
-
{
|
|
1372
|
-
"name": "flow-ui-menu",
|
|
1373
|
-
"description": "Menus provide a list of options for the user to choose from.\n\n\n---\n\n\n\n\n### **Events:**\n - **flow-ui-select** - Emitted when a menu item is selected.\n\n### **Slots:**\n - _default_ - The menu's content, including menu items, menu labels, and dividers.",
|
|
1374
|
-
"attributes": [],
|
|
1375
|
-
"references": []
|
|
1376
|
-
},
|
|
1377
1413
|
{
|
|
1378
1414
|
"name": "flow-ui-map",
|
|
1379
1415
|
"description": "Display a Flo.w map.\n\n\n---\n\n\n\n\n### **Events:**\n - **flow-ui-map-load** - Dispatched when the map is first initialized and has completed loading. The Flo.w Core map instance can be retrieved from the event `detail` property.\n\n### **CSS Parts:**\n - **base** - The base element of the component.\n- **busy-indicator** - The busy indicator flow-ui-progress-bar.\n- **control-container** - The map control containers.\n- **control-container--top-left** - The top left control container element.\n- **control-container--top-right** - The top right control container element.\n- **control-container--bottom-left** - The bottom left control container element.\n- **control-container--bottom-right** - The bottom right control container element.",
|
|
@@ -1426,6 +1462,12 @@
|
|
|
1426
1462
|
],
|
|
1427
1463
|
"references": []
|
|
1428
1464
|
},
|
|
1465
|
+
{
|
|
1466
|
+
"name": "flow-ui-menu",
|
|
1467
|
+
"description": "Menus provide a list of options for the user to choose from.\n\n\n---\n\n\n\n\n### **Events:**\n - **flow-ui-select** - Emitted when a menu item is selected.\n\n### **Slots:**\n - _default_ - The menu's content, including menu items, menu labels, and dividers.",
|
|
1468
|
+
"attributes": [],
|
|
1469
|
+
"references": []
|
|
1470
|
+
},
|
|
1429
1471
|
{
|
|
1430
1472
|
"name": "flow-ui-menu-item",
|
|
1431
1473
|
"description": "Menu items provide options for the user to pick from in a menu.\n\n\n---\n\n\n\n\n### **Slots:**\n - _default_ - The menu item's label.\n- **prefix** - Used to prepend an icon or similar element to the menu item.\n- **suffix** - Used to append an icon or similar element to the menu item.\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.\n- **checked-icon** - The checked icon, which is only visible when the menu item is checked.\n- **prefix** - The prefix container.\n- **label** - The menu item label.\n- **suffix** - The suffix container.\n- **submenu-icon** - The submenu icon, visible only when the menu item has a submenu (not yet implemented).",
|
|
@@ -1453,43 +1495,6 @@
|
|
|
1453
1495
|
],
|
|
1454
1496
|
"references": []
|
|
1455
1497
|
},
|
|
1456
|
-
{
|
|
1457
|
-
"name": "flow-ui-gauge",
|
|
1458
|
-
"description": "Gauges are used to display a single value with an optional icon and heading.\n\n\n---\n\n\n\n\n### **Slots:**\n - **title** - The gauge's title. Alternatively, you can use the `title` attribute.\n- **value** - The gauge's value. Alternatively, you can use the `value` attribute.\n- **unit** - Alternatively, you can use the `unit` attribute.\n- **info** - The content to display in the gauge's info dialog. If this is set then an info button will be displayed in the gauge's header.\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.\n- **header** - The gauge's header.\n- **header-icon** - The icon in the gauge's header.\n- **title** - The text in the gauge's header.\n- **info-button** - The info button in the gauge's header (if info dialog configured).",
|
|
1459
|
-
"attributes": [
|
|
1460
|
-
{
|
|
1461
|
-
"name": "title",
|
|
1462
|
-
"description": "The title text of the gauge. Alternatively, use the `title` slot to enhance the title with HTML markup.",
|
|
1463
|
-
"values": []
|
|
1464
|
-
},
|
|
1465
|
-
{
|
|
1466
|
-
"name": "units",
|
|
1467
|
-
"description": "The units of the gauge value.",
|
|
1468
|
-
"values": []
|
|
1469
|
-
},
|
|
1470
|
-
{
|
|
1471
|
-
"name": "value",
|
|
1472
|
-
"description": "The value to display in the gauge.",
|
|
1473
|
-
"values": []
|
|
1474
|
-
},
|
|
1475
|
-
{
|
|
1476
|
-
"name": "icon",
|
|
1477
|
-
"description": "The icon to display in the gauge header.",
|
|
1478
|
-
"values": []
|
|
1479
|
-
},
|
|
1480
|
-
{
|
|
1481
|
-
"name": "icon-library",
|
|
1482
|
-
"description": "The icon library to use for the icon. Uses default library if not specified.",
|
|
1483
|
-
"values": []
|
|
1484
|
-
},
|
|
1485
|
-
{
|
|
1486
|
-
"name": "format",
|
|
1487
|
-
"description": "The [D3 format](https://d3js.org/d3-format#locale_format) to use when displaying numeric values.",
|
|
1488
|
-
"values": []
|
|
1489
|
-
}
|
|
1490
|
-
],
|
|
1491
|
-
"references": []
|
|
1492
|
-
},
|
|
1493
1498
|
{
|
|
1494
1499
|
"name": "flow-ui-menu-label",
|
|
1495
1500
|
"description": "Menu labels are used to describe a group of menu items.\n\n\n---\n\n\n\n\n### **Slots:**\n - _default_ - The menu label's content.\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.",
|
|
@@ -1559,6 +1564,50 @@
|
|
|
1559
1564
|
],
|
|
1560
1565
|
"references": []
|
|
1561
1566
|
},
|
|
1567
|
+
{
|
|
1568
|
+
"name": "flow-ui-panel",
|
|
1569
|
+
"description": "Panels are use with split-views to create resizable areas.\n\n\n---\n\n\n\n\n### **Methods:**\n - **expand(emitEvent: _boolean_)** - Open the panel\n- **collapse(emitEvent: _boolean_)** - Close the panel\n\n### **CSS Properties:**\n - **--padding** - Padding to add to the panel when the `padding` attribute is set. Defaults to `--flow-ui-spacing-small`. _(default: undefined)_",
|
|
1570
|
+
"attributes": [
|
|
1571
|
+
{
|
|
1572
|
+
"name": "closed",
|
|
1573
|
+
"description": "Indicates whether the panel is open or closed.",
|
|
1574
|
+
"values": []
|
|
1575
|
+
},
|
|
1576
|
+
{
|
|
1577
|
+
"name": "scrollable",
|
|
1578
|
+
"description": "Indicates whether the panel is scrollable. By default overflow is hidden.",
|
|
1579
|
+
"values": []
|
|
1580
|
+
},
|
|
1581
|
+
{
|
|
1582
|
+
"name": "padding",
|
|
1583
|
+
"description": "Indicates whether the panel body has padding.",
|
|
1584
|
+
"values": []
|
|
1585
|
+
}
|
|
1586
|
+
],
|
|
1587
|
+
"references": []
|
|
1588
|
+
},
|
|
1589
|
+
{
|
|
1590
|
+
"name": "flow-ui-panel-header",
|
|
1591
|
+
"description": "A panel header provides a title, optional accessory controls and expand/collapse behavior for panels.\n\n\n---\n\n\n\n\n### **Events:**\n - **flow-ui-collapse** - Emitted when the header is collapsed by UI interaction.\n- **flow-ui-expand** - Emitted when the header is expanded by UI interaction.\n\n### **Slots:**\n - **title** - The panel header's title content. Alternatively, use the `title` attribute for plain text.\n- **prefix** - The panel header's prefix content.\n- **suffix** - The panel header's suffix content.\n- **expand-icon** - Specify an alternative `<flow-ui-icon>` to use for the expand icon.\n- **collapse-icon** - Specify an alternative `<flow-ui-icon>` to use for the collapse icon.\n\n### **CSS Properties:**\n - **padding** - The padding around the header. Defaults to `--flow-ui-panel-header-padding`. _(default: undefined)_\n- **header-height** - The height of the header. Defaults to `--flow-ui-panel-header-height`. _(default: undefined)_\n- **background-color** - The background color of the header. Defaults to `--flow-ui-panel-header-background-color`. _(default: undefined)_\n- **color** - The text color of the header. Defaults to `--flow-ui-panel-header-color`. _(default: undefined)_\n- **accessory-color** - The color of the accessory controls. Defaults to `--flow-ui-panel-header-accessory-color`. _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.\n- **title** - The container that wraps the title.\n- **prefix** - The container that wraps the prefix.\n- **suffix** - The container that wraps the suffix.\n- **toggle-icon** - The container that wraps the expand/collapse icon.",
|
|
1592
|
+
"attributes": [
|
|
1593
|
+
{
|
|
1594
|
+
"name": "closed",
|
|
1595
|
+
"description": "Indicates whether or not the header is open or closed. Toggle this attribute to expand or collapse the header.\nAlternatively, call the `expand()` and `collapse()` methods.",
|
|
1596
|
+
"values": []
|
|
1597
|
+
},
|
|
1598
|
+
{
|
|
1599
|
+
"name": "title",
|
|
1600
|
+
"description": "The header title text. Use the `title` slot instead to display HTML.",
|
|
1601
|
+
"values": []
|
|
1602
|
+
},
|
|
1603
|
+
{
|
|
1604
|
+
"name": "fixed",
|
|
1605
|
+
"description": "Set to `true` to hide the panel expand/collapse button.",
|
|
1606
|
+
"values": []
|
|
1607
|
+
}
|
|
1608
|
+
],
|
|
1609
|
+
"references": []
|
|
1610
|
+
},
|
|
1562
1611
|
{
|
|
1563
1612
|
"name": "flow-ui-popup",
|
|
1564
1613
|
"description": "Popup is a utility that lets you declaratively anchor \"popup\" containers to another element.\n\n\n---\n\n\n\n\n### **Events:**\n - **flow-ui-reposition** - Emitted when the popup is repositioned. This event can fire a lot, so avoid putting expensive operations in your listener or consider debouncing it.\n\n### **Methods:**\n - **reposition()** - Forces the popup to recalculate and reposition itself.\n\n### **Slots:**\n - _default_ - The popup's content.\n- **anchor** - The element the popup will be anchored to. If the anchor lives outside of the popup, you can use the `anchor` attribute or property instead.\n\n### **CSS Properties:**\n - **--arrow-size** - The size of the arrow. Note that an arrow won't be shown unless the `arrow` attribute is used. _(default: 6px)_\n- **--arrow-color** - The color of the arrow. _(default: var(--flow-ui-color-neutral-0))_\n- **--auto-size-available-width** - A read-only custom property that determines the amount of width the popup can be before overflowing. Useful for positioning child elements that need to overflow. This property is only available when using `auto-size`. _(default: undefined)_\n- **--auto-size-available-height** - A read-only custom property that determines the amount of height the popup can be before overflowing. Useful for positioning child elements that need to overflow. This property is only available when using `auto-size`. _(default: undefined)_\n\n### **CSS Parts:**\n - **arrow** - The arrow's container. Avoid setting `top|bottom|left|right` properties, as these values are assigned dynamically as the popup moves. This is most useful for applying a background color to match the popup, and maybe a border or box shadow.\n- **popup** - The popup's container. Useful for setting a background color, box shadow, etc.\n- **hover-bridge** - The hover bridge element. Only available when the `hover-bridge` option is enabled.",
|
|
@@ -1743,38 +1792,79 @@
|
|
|
1743
1792
|
"references": []
|
|
1744
1793
|
},
|
|
1745
1794
|
{
|
|
1746
|
-
"name": "flow-ui-
|
|
1747
|
-
"description": "
|
|
1795
|
+
"name": "flow-ui-query-builder",
|
|
1796
|
+
"description": "Query builder component\n\n\n---\n\n\n\n\n### **Events:**\n - **flow-ui-change** - Emitted when the control's value changes.\n\n### **Methods:**\n - **registerFieldDefinition(type: _T_, fieldDefinition: _FlowQueryBuilderFieldDefinition<NoUnion<T>>_)** - Register a custom field definition.\n\nA field definition is used to add support for a custom field type. A field type comprises:\n\n- a field `type` string\n- a `template` function that returns the template for the field's value control\n- an array of `operators` that are valid for the field\n\n### **Slots:**\n - **label** - The component's label. Alternatively, you can use the `label` attribute.\n- **help-text** - Text that describes how to use the component. Alternatively, you can use the `help-text` attribute.",
|
|
1748
1797
|
"attributes": [
|
|
1749
|
-
{
|
|
1750
|
-
"name": "value",
|
|
1751
|
-
"description": "The radio's value. When selected, the radio group will receive this value.",
|
|
1752
|
-
"values": []
|
|
1753
|
-
},
|
|
1754
1798
|
{
|
|
1755
1799
|
"name": "size",
|
|
1756
|
-
"description": "The
|
|
1800
|
+
"description": "The query builder's size.",
|
|
1757
1801
|
"values": [
|
|
1758
1802
|
{ "name": "small" },
|
|
1759
1803
|
{ "name": "medium" },
|
|
1760
1804
|
{ "name": "large" }
|
|
1761
1805
|
]
|
|
1762
1806
|
},
|
|
1763
|
-
{
|
|
1764
|
-
"name": "variant",
|
|
1765
|
-
"description": "The radio's variant color.",
|
|
1766
|
-
"values": [
|
|
1767
|
-
{ "name": "primary" },
|
|
1768
|
-
{ "name": "secondary" },
|
|
1769
|
-
{ "name": "success" },
|
|
1770
|
-
{ "name": "warning" },
|
|
1771
|
-
{ "name": "danger" },
|
|
1772
|
-
{ "name": "neutral" }
|
|
1773
|
-
]
|
|
1774
|
-
},
|
|
1775
1807
|
{
|
|
1776
1808
|
"name": "disabled",
|
|
1777
|
-
"description": "Disables the
|
|
1809
|
+
"description": "Disables the select control.",
|
|
1810
|
+
"values": []
|
|
1811
|
+
},
|
|
1812
|
+
{
|
|
1813
|
+
"name": "label",
|
|
1814
|
+
"description": "The query builders's label. If you need to display HTML, use the `label` slot instead.",
|
|
1815
|
+
"values": []
|
|
1816
|
+
},
|
|
1817
|
+
{
|
|
1818
|
+
"name": "help-text",
|
|
1819
|
+
"description": "The query builders's help text. If you need to display HTML, use the `help-text` slot instead.",
|
|
1820
|
+
"values": []
|
|
1821
|
+
},
|
|
1822
|
+
{
|
|
1823
|
+
"name": "tree-lines",
|
|
1824
|
+
"description": "Display tree connector lines between query rules",
|
|
1825
|
+
"values": []
|
|
1826
|
+
}
|
|
1827
|
+
],
|
|
1828
|
+
"references": []
|
|
1829
|
+
},
|
|
1830
|
+
{
|
|
1831
|
+
"name": "flow-ui-radio",
|
|
1832
|
+
"description": "Radios allow the user to select a single option from a group.\n\n\n---\n\n\n\n\n### **Events:**\n - **flow-ui-blur** - Emitted when the control loses focus.\n- **flow-ui-focus** - Emitted when the control gains focus.\n\n### **Slots:**\n - _default_ - The radio's label.\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.\n- **control** - The circular container that wraps the radio's checked state.\n- **control--checked** - The radio control when the radio is checked.\n- **checked-icon** - The checked icon, an `<flow-ui-icon>` element.\n- **label** - The container that wraps the radio's label.",
|
|
1833
|
+
"attributes": [
|
|
1834
|
+
{
|
|
1835
|
+
"name": "value",
|
|
1836
|
+
"description": "The radio's value. When selected, the radio group will receive this value.",
|
|
1837
|
+
"values": []
|
|
1838
|
+
},
|
|
1839
|
+
{
|
|
1840
|
+
"name": "size",
|
|
1841
|
+
"description": "The radio's size. When used inside a radio group, the size will be determined by the radio group's size so this\nattribute can typically be omitted.",
|
|
1842
|
+
"values": [
|
|
1843
|
+
{ "name": "small" },
|
|
1844
|
+
{ "name": "medium" },
|
|
1845
|
+
{ "name": "large" }
|
|
1846
|
+
]
|
|
1847
|
+
},
|
|
1848
|
+
{
|
|
1849
|
+
"name": "variant",
|
|
1850
|
+
"description": "The radio's variant color.",
|
|
1851
|
+
"values": [
|
|
1852
|
+
{ "name": "primary" },
|
|
1853
|
+
{ "name": "secondary" },
|
|
1854
|
+
{ "name": "success" },
|
|
1855
|
+
{ "name": "warning" },
|
|
1856
|
+
{ "name": "danger" },
|
|
1857
|
+
{ "name": "neutral" }
|
|
1858
|
+
]
|
|
1859
|
+
},
|
|
1860
|
+
{
|
|
1861
|
+
"name": "disabled",
|
|
1862
|
+
"description": "Disables the radio.",
|
|
1863
|
+
"values": []
|
|
1864
|
+
},
|
|
1865
|
+
{
|
|
1866
|
+
"name": "full-width",
|
|
1867
|
+
"description": "Display the radio using the alternative 'full-width' style with left-aligned label.",
|
|
1778
1868
|
"values": []
|
|
1779
1869
|
}
|
|
1780
1870
|
],
|
|
@@ -1835,8 +1925,8 @@
|
|
|
1835
1925
|
"values": []
|
|
1836
1926
|
},
|
|
1837
1927
|
{
|
|
1838
|
-
"name": "
|
|
1839
|
-
"description": "
|
|
1928
|
+
"name": "full-width",
|
|
1929
|
+
"description": "Display the radio group using the alternative 'full-width' style with left-aligned label.",
|
|
1840
1930
|
"values": []
|
|
1841
1931
|
}
|
|
1842
1932
|
],
|
|
@@ -1915,92 +2005,6 @@
|
|
|
1915
2005
|
],
|
|
1916
2006
|
"references": []
|
|
1917
2007
|
},
|
|
1918
|
-
{
|
|
1919
|
-
"name": "flow-ui-panel",
|
|
1920
|
-
"description": "Panels are use with split-views to create resizable areas.\n\n\n---\n\n\n\n\n### **Methods:**\n - **expand(emitEvent: _boolean_)** - Open the panel\n- **collapse(emitEvent: _boolean_)** - Close the panel\n\n### **CSS Properties:**\n - **--padding** - Padding to add to the panel when the `padding` attribute is set. Defaults to `--flow-ui-spacing-small`. _(default: undefined)_",
|
|
1921
|
-
"attributes": [
|
|
1922
|
-
{
|
|
1923
|
-
"name": "closed",
|
|
1924
|
-
"description": "Indicates whether the panel is open or closed.",
|
|
1925
|
-
"values": []
|
|
1926
|
-
},
|
|
1927
|
-
{
|
|
1928
|
-
"name": "scrollable",
|
|
1929
|
-
"description": "Indicates whether the panel is scrollable. By default overflow is hidden.",
|
|
1930
|
-
"values": []
|
|
1931
|
-
},
|
|
1932
|
-
{
|
|
1933
|
-
"name": "padding",
|
|
1934
|
-
"description": "Indicates whether the panel body has padding.",
|
|
1935
|
-
"values": []
|
|
1936
|
-
}
|
|
1937
|
-
],
|
|
1938
|
-
"references": []
|
|
1939
|
-
},
|
|
1940
|
-
{
|
|
1941
|
-
"name": "flow-ui-panel-header",
|
|
1942
|
-
"description": "A panel header provides a title, optional accessory controls and expand/collapse behavior for panels.\n\n\n---\n\n\n\n\n### **Events:**\n - **flow-ui-collapse** - Emitted when the header is collapsed by UI interaction.\n- **flow-ui-expand** - Emitted when the header is expanded by UI interaction.\n\n### **Slots:**\n - **title** - The panel header's title content. Alternatively, use the `title` attribute for plain text.\n- **prefix** - The panel header's prefix content.\n- **suffix** - The panel header's suffix content.\n- **expand-icon** - Specify an alternative `<flow-ui-icon>` to use for the expand icon.\n- **collapse-icon** - Specify an alternative `<flow-ui-icon>` to use for the collapse icon.\n\n### **CSS Properties:**\n - **padding** - The padding around the header. Defaults to `--flow-ui-panel-header-padding`. _(default: undefined)_\n- **header-height** - The height of the header. Defaults to `--flow-ui-panel-header-height`. _(default: undefined)_\n- **background-color** - The background color of the header. Defaults to `--flow-ui-panel-header-background-color`. _(default: undefined)_\n- **color** - The text color of the header. Defaults to `--flow-ui-panel-header-color`. _(default: undefined)_\n- **accessory-color** - The color of the accessory controls. Defaults to `--flow-ui-panel-header-accessory-color`. _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.\n- **title** - The container that wraps the title.\n- **prefix** - The container that wraps the prefix.\n- **suffix** - The container that wraps the suffix.\n- **toggle-icon** - The container that wraps the expand/collapse icon.",
|
|
1943
|
-
"attributes": [
|
|
1944
|
-
{
|
|
1945
|
-
"name": "closed",
|
|
1946
|
-
"description": "Indicates whether or not the header is open or closed. Toggle this attribute to expand or collapse the header.\nAlternatively, call the `expand()` and `collapse()` methods.",
|
|
1947
|
-
"values": []
|
|
1948
|
-
},
|
|
1949
|
-
{
|
|
1950
|
-
"name": "title",
|
|
1951
|
-
"description": "The header title text. Use the `title` slot instead to display HTML.",
|
|
1952
|
-
"values": []
|
|
1953
|
-
},
|
|
1954
|
-
{
|
|
1955
|
-
"name": "fixed",
|
|
1956
|
-
"description": "Set to `true` to hide the panel expand/collapse button.",
|
|
1957
|
-
"values": []
|
|
1958
|
-
}
|
|
1959
|
-
],
|
|
1960
|
-
"references": []
|
|
1961
|
-
},
|
|
1962
|
-
{
|
|
1963
|
-
"name": "flow-ui-query-builder",
|
|
1964
|
-
"description": "Query builder component\n\n\n---\n\n\n\n\n### **Events:**\n - **flow-ui-change** - Emitted when the control's value changes.\n\n### **Methods:**\n - **registerFieldDefinition(type: _T_, fieldDefinition: _FlowQueryBuilderFieldDefinition<NoUnion<T>>_)** - Register a custom field definition.\n\nA field definition is used to add support for a custom field type. A field type comprises:\n\n- a field `type` string\n- a `template` function that returns the template for the field's value control\n- an array of `operators` that are valid for the field\n\n### **Slots:**\n - **label** - The component's label. Alternatively, you can use the `label` attribute.\n- **help-text** - Text that describes how to use the component. Alternatively, you can use the `help-text` attribute.",
|
|
1965
|
-
"attributes": [
|
|
1966
|
-
{
|
|
1967
|
-
"name": "size",
|
|
1968
|
-
"description": "The query builder's size.",
|
|
1969
|
-
"values": [
|
|
1970
|
-
{ "name": "small" },
|
|
1971
|
-
{ "name": "medium" },
|
|
1972
|
-
{ "name": "large" }
|
|
1973
|
-
]
|
|
1974
|
-
},
|
|
1975
|
-
{
|
|
1976
|
-
"name": "disabled",
|
|
1977
|
-
"description": "Disables the select control.",
|
|
1978
|
-
"values": []
|
|
1979
|
-
},
|
|
1980
|
-
{
|
|
1981
|
-
"name": "label",
|
|
1982
|
-
"description": "The query builders's label. If you need to display HTML, use the `label` slot instead.",
|
|
1983
|
-
"values": []
|
|
1984
|
-
},
|
|
1985
|
-
{
|
|
1986
|
-
"name": "help-text",
|
|
1987
|
-
"description": "The query builders's help text. If you need to display HTML, use the `help-text` slot instead.",
|
|
1988
|
-
"values": []
|
|
1989
|
-
},
|
|
1990
|
-
{
|
|
1991
|
-
"name": "tree-lines",
|
|
1992
|
-
"description": "Display tree connector lines between query rules",
|
|
1993
|
-
"values": []
|
|
1994
|
-
}
|
|
1995
|
-
],
|
|
1996
|
-
"references": []
|
|
1997
|
-
},
|
|
1998
|
-
{
|
|
1999
|
-
"name": "flow-ui-spinner",
|
|
2000
|
-
"description": "Spinners are used to show the progress of an indeterminate operation.\n\n\n---\n\n\n\n\n### **CSS Properties:**\n - **--track-width** - The width of the track. _(default: undefined)_\n- **--track-color** - The color of the track. _(default: undefined)_\n- **--indicator-color** - The color of the spinner's indicator. _(default: undefined)_\n- **--speed** - The time it takes for the spinner to complete one animation cycle. _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.",
|
|
2001
|
-
"attributes": [],
|
|
2002
|
-
"references": []
|
|
2003
|
-
},
|
|
2004
2008
|
{
|
|
2005
2009
|
"name": "flow-ui-select",
|
|
2006
2010
|
"description": "Selects allow you to choose items from a menu of predefined options.\n\n\n---\n\n\n\n\n### **Events:**\n - **flow-ui-change** - Emitted when the control's value changes.\n- **flow-ui-clear** - Emitted when the control's value is cleared.\n- **flow-ui-input** - Emitted when the control receives input.\n- **flow-ui-focus** - Emitted when the control gains focus.\n- **flow-ui-blur** - Emitted when the control loses focus.\n- **flow-ui-show** - Emitted when the select's menu opens.\n- **flow-ui-after-show** - Emitted after the select's menu opens and all animations are complete.\n- **flow-ui-hide** - Emitted when the select's menu closes.\n- **flow-ui-after-hide** - Emitted after the select's menu closes and all animations are complete.\n- **flow-ui-invalid** - Emitted when the form control has been checked for validity and its constraints aren't satisfied.\n\n### **Methods:**\n - **show()** - Shows the listbox.\n- **hide()** - Hides the listbox.\n- **checkValidity()** - Checks for validity but does not show a validation message. Returns `true` when valid and `false` when invalid.\n- **getForm(): _HTMLFormElement | null_** - Gets the associated form, if one exists.\n- **reportValidity()** - Checks for validity and shows the browser's validation message if the control is invalid.\n- **setCustomValidity(message: _string_)** - Sets a custom validation message. Pass an empty string to restore validity.\n- **focus(options: _FocusOptions_)** - Sets focus on the control.\n- **blur()** - Removes focus from the control.\n\n### **Slots:**\n - _default_ - The listbox options. Must be `<flow-option>` elements. You can use `<flow-divider>` to group items visually.\n- **label** - The input's label. Alternatively, you can use the `label` attribute.\n- **prefix** - Used to prepend a presentational icon or similar element to the combobox.\n- **suffix** - Used to append a presentational icon or similar element to the combobox.\n- **clear-icon** - An icon to use in lieu of the default clear icon.\n- **expand-icon** - The icon to show when the control is expanded and collapsed. Rotates on open and close.\n- **help-text** - Text that describes how to use the input. Alternatively, you can use the `help-text` attribute.\n\n### **CSS Parts:**\n - **form-control** - The form control that wraps the label, input, and help text.\n- **form-control-label** - The label's wrapper.\n- **form-control-input** - The select's wrapper.\n- **form-control-help-text** - The help text's wrapper.\n- **combobox** - The container the wraps the prefix, suffix, combobox, clear icon, and expand button.\n- **prefix** - The container that wraps the prefix slot.\n- **suffix** - The container that wraps the suffix slot.\n- **display-input** - The element that displays the selected option's label, an `<input>` element.\n- **listbox** - The listbox container where options are slotted.\n- **tags** - The container that houses option tags when `multiselect` is used.\n- **tag** - The individual tags that represent each multiselect option.\n- **tag__base** - The tag's base part.\n- **tag__content** - The tag's content part.\n- **tag__remove-button** - The tag's remove button.\n- **tag__remove-button__base** - The tag's remove button base part.\n- **clear-button** - The clear button.\n- **expand-icon** - The container that wraps the expand icon.",
|
|
@@ -2106,6 +2110,12 @@
|
|
|
2106
2110
|
],
|
|
2107
2111
|
"references": []
|
|
2108
2112
|
},
|
|
2113
|
+
{
|
|
2114
|
+
"name": "flow-ui-spinner",
|
|
2115
|
+
"description": "Spinners are used to show the progress of an indeterminate operation.\n\n\n---\n\n\n\n\n### **CSS Properties:**\n - **--track-width** - The width of the track. _(default: undefined)_\n- **--track-color** - The color of the track. _(default: undefined)_\n- **--indicator-color** - The color of the spinner's indicator. _(default: undefined)_\n- **--speed** - The time it takes for the spinner to complete one animation cycle. _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.",
|
|
2116
|
+
"attributes": [],
|
|
2117
|
+
"references": []
|
|
2118
|
+
},
|
|
2109
2119
|
{
|
|
2110
2120
|
"name": "flow-ui-split-view",
|
|
2111
2121
|
"description": "Split-views contain two or more split-view panes to create resizable areas.\n\n\n---\n\n\n",
|
|
@@ -2145,6 +2155,53 @@
|
|
|
2145
2155
|
],
|
|
2146
2156
|
"references": []
|
|
2147
2157
|
},
|
|
2158
|
+
{
|
|
2159
|
+
"name": "flow-ui-split-view-pane",
|
|
2160
|
+
"description": "Split-view panes are used with split-views to create resizable areas.\n\n\n---\n\n\n\n\n### **Methods:**\n - **expand(emitEvent)** - Open the split pane.\n- **collapse(emitEvent)** - Close the split pane.",
|
|
2161
|
+
"attributes": [
|
|
2162
|
+
{
|
|
2163
|
+
"name": "vertical",
|
|
2164
|
+
"description": "Set to `true` for vertically-arranged panes.",
|
|
2165
|
+
"values": []
|
|
2166
|
+
},
|
|
2167
|
+
{
|
|
2168
|
+
"name": "size",
|
|
2169
|
+
"description": "Set the initial size of the split pane in CSS px or % units",
|
|
2170
|
+
"values": []
|
|
2171
|
+
},
|
|
2172
|
+
{
|
|
2173
|
+
"name": "min-size",
|
|
2174
|
+
"description": "Set the minimum size of the split pane in CSS px or % units",
|
|
2175
|
+
"values": []
|
|
2176
|
+
},
|
|
2177
|
+
{
|
|
2178
|
+
"name": "max-size",
|
|
2179
|
+
"description": "Set the maximum size of the split pane in CSS px or % units",
|
|
2180
|
+
"values": []
|
|
2181
|
+
},
|
|
2182
|
+
{
|
|
2183
|
+
"name": "closed-size",
|
|
2184
|
+
"description": "Set the closed size split pane in CSS px or % units",
|
|
2185
|
+
"values": []
|
|
2186
|
+
},
|
|
2187
|
+
{
|
|
2188
|
+
"name": "closed",
|
|
2189
|
+
"description": "Indicates if the split-view pane is open or closed.",
|
|
2190
|
+
"values": []
|
|
2191
|
+
},
|
|
2192
|
+
{
|
|
2193
|
+
"name": "divider",
|
|
2194
|
+
"description": "Indicates if the split-view pane has a divider.",
|
|
2195
|
+
"values": []
|
|
2196
|
+
},
|
|
2197
|
+
{
|
|
2198
|
+
"name": "hidden",
|
|
2199
|
+
"description": "Indicates if the split-view pane is hidden.",
|
|
2200
|
+
"values": []
|
|
2201
|
+
}
|
|
2202
|
+
],
|
|
2203
|
+
"references": []
|
|
2204
|
+
},
|
|
2148
2205
|
{
|
|
2149
2206
|
"name": "flow-ui-split-view-toggle-button",
|
|
2150
2207
|
"description": "Use a split panel toggle button to control a parent panel's open/closed state\n\n\n---\n\n\n",
|
|
@@ -2167,6 +2224,44 @@
|
|
|
2167
2224
|
],
|
|
2168
2225
|
"references": []
|
|
2169
2226
|
},
|
|
2227
|
+
{
|
|
2228
|
+
"name": "flow-ui-stepper",
|
|
2229
|
+
"description": "Steppers are used to guide users through a series of steps in a wizard-like UI.\n\n\n---\n\n\n\n\n### **Methods:**\n - **setComplete(panelName: _string_, complete: _boolean_)** - Mark the specified panel as `complete`",
|
|
2230
|
+
"attributes": [],
|
|
2231
|
+
"references": []
|
|
2232
|
+
},
|
|
2233
|
+
{
|
|
2234
|
+
"name": "flow-ui-stepper-panel",
|
|
2235
|
+
"description": "Stepper panels provide a single page in a stepper to guide users through a series of steps.\n\n\n---\n\n\n",
|
|
2236
|
+
"attributes": [
|
|
2237
|
+
{
|
|
2238
|
+
"name": "name",
|
|
2239
|
+
"description": "The tab panel's name.",
|
|
2240
|
+
"values": []
|
|
2241
|
+
},
|
|
2242
|
+
{
|
|
2243
|
+
"name": "title",
|
|
2244
|
+
"description": "The stepper panel's title.",
|
|
2245
|
+
"values": []
|
|
2246
|
+
},
|
|
2247
|
+
{
|
|
2248
|
+
"name": "sub-title",
|
|
2249
|
+
"description": "The stepper panel's sub-title.",
|
|
2250
|
+
"values": []
|
|
2251
|
+
},
|
|
2252
|
+
{
|
|
2253
|
+
"name": "active",
|
|
2254
|
+
"description": "When true, the stepper panel will be shown.",
|
|
2255
|
+
"values": []
|
|
2256
|
+
},
|
|
2257
|
+
{
|
|
2258
|
+
"name": "complete",
|
|
2259
|
+
"description": "When true, the stepper panel is marked as complete",
|
|
2260
|
+
"values": []
|
|
2261
|
+
}
|
|
2262
|
+
],
|
|
2263
|
+
"references": []
|
|
2264
|
+
},
|
|
2170
2265
|
{
|
|
2171
2266
|
"name": "flow-ui-switch",
|
|
2172
2267
|
"description": "Switches allow the user to toggle an option on or off.\n\n\n---\n\n\n\n\n### **Events:**\n - **flow-ui-blur** - Emitted when the control loses focus.\n- **flow-ui-change** - Emitted when the control's checked state changes.\n- **flow-ui-input** - Emitted when the control receives input.\n- **flow-ui-focus** - Emitted when the control gains focus.\n- **flow-ui-invalid** - Emitted when the form control has been checked for validity and its constraints aren't satisfied.\n\n### **Methods:**\n - **click()** - Simulates a click on the switch.\n- **focus(options: _FocusOptions_)** - Sets focus on the switch.\n- **blur()** - Removes focus from the switch.\n- **checkValidity()** - Checks for validity but does not show a validation message. Returns `true` when valid and `false` when invalid.\n- **getForm(): _HTMLFormElement | null_** - Gets the associated form, if one exists.\n- **reportValidity()** - Checks for validity and shows the browser's validation message if the control is invalid.\n- **setCustomValidity(message: _string_)** - Sets a custom validation message. Pass an empty string to restore validity.\n\n### **Slots:**\n - _default_ - The switch's label.\n\n### **CSS Properties:**\n - **--width** - The width of the switch. _(default: undefined)_\n- **--height** - The height of the switch. _(default: undefined)_\n- **--thumb-size** - The size of the thumb. _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.\n- **control** - The control that houses the switch's thumb.\n- **thumb** - The switch's thumb.\n- **label** - The switch's label.",
|
|
@@ -2214,47 +2309,61 @@
|
|
|
2214
2309
|
"references": []
|
|
2215
2310
|
},
|
|
2216
2311
|
{
|
|
2217
|
-
"name": "flow-ui-
|
|
2218
|
-
"description": "
|
|
2312
|
+
"name": "flow-ui-tab",
|
|
2313
|
+
"description": "Tabs are used inside [tab groups](/components/tab-group) to represent and activate [tab panels](/components/tab-panel).\n\n\n---\n\n\n\n\n### **Events:**\n - **flow-ui-close** - Emitted when the tab is closable and the close button is activated.\n\n### **Methods:**\n - **focus(options: _FocusOptions_)** - Sets focus to the tab.\n- **blur()** - Removes focus from the tab.\n\n### **Slots:**\n - _default_ - The tab's label.\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.\n- **close-button** - The close button, an `<flow-ui-icon-button>`.\n- **close-button__base** - The close button's exported `base` part.",
|
|
2219
2314
|
"attributes": [
|
|
2220
2315
|
{
|
|
2221
|
-
"name": "
|
|
2222
|
-
"description": "
|
|
2316
|
+
"name": "panel",
|
|
2317
|
+
"description": "The name of the tab panel this tab is associated with. The panel must be located in the same tab group.",
|
|
2223
2318
|
"values": []
|
|
2224
2319
|
},
|
|
2225
2320
|
{
|
|
2226
|
-
"name": "
|
|
2227
|
-
"description": "
|
|
2321
|
+
"name": "active",
|
|
2322
|
+
"description": "Draws the tab in an active state.",
|
|
2228
2323
|
"values": []
|
|
2229
2324
|
},
|
|
2230
2325
|
{
|
|
2231
|
-
"name": "
|
|
2232
|
-
"description": "
|
|
2326
|
+
"name": "icon-only",
|
|
2327
|
+
"description": "Display tab icon only. Label text is displayed as a tooltip",
|
|
2233
2328
|
"values": []
|
|
2234
2329
|
},
|
|
2235
2330
|
{
|
|
2236
|
-
"name": "
|
|
2237
|
-
"description": "
|
|
2331
|
+
"name": "closable",
|
|
2332
|
+
"description": "Makes the tab closable and shows a close button.",
|
|
2238
2333
|
"values": []
|
|
2239
2334
|
},
|
|
2240
2335
|
{
|
|
2241
|
-
"name": "
|
|
2242
|
-
"description": "
|
|
2336
|
+
"name": "disabled",
|
|
2337
|
+
"description": "Disables the tab and prevents selection.",
|
|
2243
2338
|
"values": []
|
|
2244
2339
|
},
|
|
2245
2340
|
{
|
|
2246
|
-
"name": "
|
|
2247
|
-
"description": "
|
|
2248
|
-
"values": [
|
|
2341
|
+
"name": "tooltip-placement",
|
|
2342
|
+
"description": "The preferred placement of the tooltip. Note that the actual placement may vary as needed to keep the tooltip\ninside of the viewport.",
|
|
2343
|
+
"values": [
|
|
2344
|
+
{ "name": "" },
|
|
2345
|
+
{ "name": "top" },
|
|
2346
|
+
{ "name": "top-start" },
|
|
2347
|
+
{ "name": "top-end" },
|
|
2348
|
+
{ "name": "right" },
|
|
2349
|
+
{ "name": "right-start" },
|
|
2350
|
+
{ "name": "right-end" },
|
|
2351
|
+
{ "name": "bottom" },
|
|
2352
|
+
{ "name": "bottom-start" },
|
|
2353
|
+
{ "name": "bottom-end" },
|
|
2354
|
+
{ "name": "left" },
|
|
2355
|
+
{ "name": "left-start" },
|
|
2356
|
+
{ "name": "left-end" }
|
|
2357
|
+
]
|
|
2249
2358
|
},
|
|
2250
2359
|
{
|
|
2251
|
-
"name": "
|
|
2252
|
-
"description": "
|
|
2360
|
+
"name": "tooltip-distance",
|
|
2361
|
+
"description": "The distance in pixels from which to offset the tooltip away from the icon button.",
|
|
2253
2362
|
"values": []
|
|
2254
2363
|
},
|
|
2255
2364
|
{
|
|
2256
|
-
"name": "
|
|
2257
|
-
"description": "
|
|
2365
|
+
"name": "tooltip-skidding",
|
|
2366
|
+
"description": "The distance in pixels from which to offset the tooltip along the icon button.",
|
|
2258
2367
|
"values": []
|
|
2259
2368
|
}
|
|
2260
2369
|
],
|
|
@@ -2292,67 +2401,6 @@
|
|
|
2292
2401
|
],
|
|
2293
2402
|
"references": []
|
|
2294
2403
|
},
|
|
2295
|
-
{
|
|
2296
|
-
"name": "flow-ui-tab",
|
|
2297
|
-
"description": "Tabs are used inside [tab groups](/components/tab-group) to represent and activate [tab panels](/components/tab-panel).\n\n\n---\n\n\n\n\n### **Events:**\n - **flow-ui-close** - Emitted when the tab is closable and the close button is activated.\n\n### **Methods:**\n - **focus(options: _FocusOptions_)** - Sets focus to the tab.\n- **blur()** - Removes focus from the tab.\n\n### **Slots:**\n - _default_ - The tab's label.\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.\n- **close-button** - The close button, an `<flow-ui-icon-button>`.\n- **close-button__base** - The close button's exported `base` part.",
|
|
2298
|
-
"attributes": [
|
|
2299
|
-
{
|
|
2300
|
-
"name": "panel",
|
|
2301
|
-
"description": "The name of the tab panel this tab is associated with. The panel must be located in the same tab group.",
|
|
2302
|
-
"values": []
|
|
2303
|
-
},
|
|
2304
|
-
{
|
|
2305
|
-
"name": "active",
|
|
2306
|
-
"description": "Draws the tab in an active state.",
|
|
2307
|
-
"values": []
|
|
2308
|
-
},
|
|
2309
|
-
{
|
|
2310
|
-
"name": "icon-only",
|
|
2311
|
-
"description": "Display tab icon only. Label text is displayed as a tooltip",
|
|
2312
|
-
"values": []
|
|
2313
|
-
},
|
|
2314
|
-
{
|
|
2315
|
-
"name": "closable",
|
|
2316
|
-
"description": "Makes the tab closable and shows a close button.",
|
|
2317
|
-
"values": []
|
|
2318
|
-
},
|
|
2319
|
-
{
|
|
2320
|
-
"name": "disabled",
|
|
2321
|
-
"description": "Disables the tab and prevents selection.",
|
|
2322
|
-
"values": []
|
|
2323
|
-
},
|
|
2324
|
-
{
|
|
2325
|
-
"name": "tooltip-placement",
|
|
2326
|
-
"description": "The preferred placement of the tooltip. Note that the actual placement may vary as needed to keep the tooltip\ninside of the viewport.",
|
|
2327
|
-
"values": [
|
|
2328
|
-
{ "name": "" },
|
|
2329
|
-
{ "name": "top" },
|
|
2330
|
-
{ "name": "top-start" },
|
|
2331
|
-
{ "name": "top-end" },
|
|
2332
|
-
{ "name": "right" },
|
|
2333
|
-
{ "name": "right-start" },
|
|
2334
|
-
{ "name": "right-end" },
|
|
2335
|
-
{ "name": "bottom" },
|
|
2336
|
-
{ "name": "bottom-start" },
|
|
2337
|
-
{ "name": "bottom-end" },
|
|
2338
|
-
{ "name": "left" },
|
|
2339
|
-
{ "name": "left-start" },
|
|
2340
|
-
{ "name": "left-end" }
|
|
2341
|
-
]
|
|
2342
|
-
},
|
|
2343
|
-
{
|
|
2344
|
-
"name": "tooltip-distance",
|
|
2345
|
-
"description": "The distance in pixels from which to offset the tooltip away from the icon button.",
|
|
2346
|
-
"values": []
|
|
2347
|
-
},
|
|
2348
|
-
{
|
|
2349
|
-
"name": "tooltip-skidding",
|
|
2350
|
-
"description": "The distance in pixels from which to offset the tooltip along the icon button.",
|
|
2351
|
-
"values": []
|
|
2352
|
-
}
|
|
2353
|
-
],
|
|
2354
|
-
"references": []
|
|
2355
|
-
},
|
|
2356
2404
|
{
|
|
2357
2405
|
"name": "flow-ui-tab-panel",
|
|
2358
2406
|
"description": "Tab panels are used inside [tab groups](/components/tab-group) to display tabbed content.\n\n\n---\n\n\n\n\n### **Slots:**\n - _default_ - The tab panel's content.\n\n### **CSS Properties:**\n - **--padding** - The tab panel's padding. _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.",
|
|
@@ -2564,111 +2612,6 @@
|
|
|
2564
2612
|
],
|
|
2565
2613
|
"references": []
|
|
2566
2614
|
},
|
|
2567
|
-
{
|
|
2568
|
-
"name": "flow-ui-stepper",
|
|
2569
|
-
"description": "Steppers are used to guide users through a series of steps in a wizard-like UI.\n\n\n---\n\n\n\n\n### **Methods:**\n - **setComplete(panelName: _string_, complete: _boolean_)** - Mark the specified panel as `complete`",
|
|
2570
|
-
"attributes": [],
|
|
2571
|
-
"references": []
|
|
2572
|
-
},
|
|
2573
|
-
{
|
|
2574
|
-
"name": "flow-ui-stepper-panel",
|
|
2575
|
-
"description": "Stepper panels provide a single page in a stepper to guide users through a series of steps.\n\n\n---\n\n\n",
|
|
2576
|
-
"attributes": [
|
|
2577
|
-
{
|
|
2578
|
-
"name": "name",
|
|
2579
|
-
"description": "The tab panel's name.",
|
|
2580
|
-
"values": []
|
|
2581
|
-
},
|
|
2582
|
-
{
|
|
2583
|
-
"name": "title",
|
|
2584
|
-
"description": "The stepper panel's title.",
|
|
2585
|
-
"values": []
|
|
2586
|
-
},
|
|
2587
|
-
{
|
|
2588
|
-
"name": "sub-title",
|
|
2589
|
-
"description": "The stepper panel's sub-title.",
|
|
2590
|
-
"values": []
|
|
2591
|
-
},
|
|
2592
|
-
{
|
|
2593
|
-
"name": "active",
|
|
2594
|
-
"description": "When true, the stepper panel will be shown.",
|
|
2595
|
-
"values": []
|
|
2596
|
-
},
|
|
2597
|
-
{
|
|
2598
|
-
"name": "complete",
|
|
2599
|
-
"description": "When true, the stepper panel is marked as complete",
|
|
2600
|
-
"values": []
|
|
2601
|
-
}
|
|
2602
|
-
],
|
|
2603
|
-
"references": []
|
|
2604
|
-
},
|
|
2605
|
-
{
|
|
2606
|
-
"name": "flow-ui-tool-button-group",
|
|
2607
|
-
"description": "Tool buttons groups are used to build toolbars from [tool buttons](./flow-ui-tool-button).\n\n\n---\n\n\n\n\n### **Events:**\n - **flow-ui-change** - Emitted when the control's value changes.\n- **flow-ui-input** - Emitted when the control receives input.\n\n### **Methods:**\n - **checkValidity()** - Checks for validity but does not show a validation message. Returns `true` when valid and `false` when invalid.\n- **getForm(): _HTMLFormElement | null_** - Gets the associated form, if one exists.\n- **reportValidity(): _boolean_** - Checks for validity and shows the browser's validation message if the control is invalid.\n- **setCustomValidity(message)** - Sets a custom validation message. Pass an empty string to restore validity.",
|
|
2608
|
-
"attributes": [
|
|
2609
|
-
{
|
|
2610
|
-
"name": "label",
|
|
2611
|
-
"description": "The radio group's label. Required for proper accessibility. If you need to display HTML, use the `label` slot\ninstead.",
|
|
2612
|
-
"values": []
|
|
2613
|
-
},
|
|
2614
|
-
{
|
|
2615
|
-
"name": "name",
|
|
2616
|
-
"description": "The name of the tool button group, submitted as a name/value pair with form data.",
|
|
2617
|
-
"values": []
|
|
2618
|
-
},
|
|
2619
|
-
{
|
|
2620
|
-
"name": "value",
|
|
2621
|
-
"description": "The current value of the tool button group, submitted as a name/value pair with form data. When `checkbox` mode is enabled, the\nvalue will be a space-delimited list of values based on the checked tool buttons.",
|
|
2622
|
-
"values": [{ "name": "string[]" }]
|
|
2623
|
-
},
|
|
2624
|
-
{
|
|
2625
|
-
"name": "size",
|
|
2626
|
-
"description": "The radio group's size. This size will be applied to all child radios and radio buttons.",
|
|
2627
|
-
"values": [
|
|
2628
|
-
{ "name": "x-small" },
|
|
2629
|
-
{ "name": "small" },
|
|
2630
|
-
{ "name": "medium" },
|
|
2631
|
-
{ "name": "large" }
|
|
2632
|
-
]
|
|
2633
|
-
},
|
|
2634
|
-
{
|
|
2635
|
-
"name": "pill",
|
|
2636
|
-
"description": "Draws pill-style tool buttons. This style will be applied to all child tool buttons.",
|
|
2637
|
-
"values": []
|
|
2638
|
-
},
|
|
2639
|
-
{
|
|
2640
|
-
"name": "outline",
|
|
2641
|
-
"description": "Draws outline-style tool buttons. This style will be applied to all child tool buttons.",
|
|
2642
|
-
"values": []
|
|
2643
|
-
},
|
|
2644
|
-
{
|
|
2645
|
-
"name": "variant",
|
|
2646
|
-
"values": [
|
|
2647
|
-
{ "name": "primary" },
|
|
2648
|
-
{ "name": "secondary" },
|
|
2649
|
-
{ "name": "success" },
|
|
2650
|
-
{ "name": "warning" },
|
|
2651
|
-
{ "name": "danger" },
|
|
2652
|
-
{ "name": "neutral" }
|
|
2653
|
-
]
|
|
2654
|
-
},
|
|
2655
|
-
{
|
|
2656
|
-
"name": "form",
|
|
2657
|
-
"description": "By default, form controls are associated with the nearest containing `<form>` element. This attribute allows you\nto place the form control outside of a form and associate it with the form that has this `id`. The form must be in\nthe same document or shadow root for this to work.",
|
|
2658
|
-
"values": []
|
|
2659
|
-
},
|
|
2660
|
-
{
|
|
2661
|
-
"name": "vertical",
|
|
2662
|
-
"description": "Use vertical layout for the radio group.",
|
|
2663
|
-
"values": []
|
|
2664
|
-
},
|
|
2665
|
-
{
|
|
2666
|
-
"name": "mode",
|
|
2667
|
-
"values": [{ "name": "radio" }, { "name": "checkbox" }]
|
|
2668
|
-
}
|
|
2669
|
-
],
|
|
2670
|
-
"references": []
|
|
2671
|
-
},
|
|
2672
2615
|
{
|
|
2673
2616
|
"name": "flow-ui-timer",
|
|
2674
2617
|
"description": "The timer component is the primary time control for Flo.w time-based visualizations.\n\n\n---\n\n\n\n\n### **Events:**\n - **flow-ui-change** - Emitted when the control's value changes.\n- **flow-ui-input** - Emitted when the control receives input.",
|
|
@@ -2732,46 +2675,46 @@
|
|
|
2732
2675
|
"references": []
|
|
2733
2676
|
},
|
|
2734
2677
|
{
|
|
2735
|
-
"name": "flow-ui-
|
|
2736
|
-
"description": "
|
|
2678
|
+
"name": "flow-ui-tool-button",
|
|
2679
|
+
"description": "Tool buttons are used to build [toolbars](./flow-ui-tool-button-group). They can be used to toggle a state or perform an action.\n\n\n---\n\n\n\n\n### **Methods:**\n - **focus(options: _FocusOptions_)** - Sets focus on the radio button.\n- **blur()** - Removes focus from the radio button.\n\n### **Slots:**\n - **prefix** - A presentational prefix icon or similar element.\n- **suffix** - A presentational suffix icon or similar element.\n- **icon** - The tool button's icon.\n- **tooltip** - The tool button's tooltip content.\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.\n- **button** - The button element.\n- **button--checked** - The button element when checked.\n- **tooltip** - The tooltip element.\n- **prefix** - The prefix slot.\n- **suffix** - The suffix slot.\n- **label-wrapper** - The wrapper that contains the icon and label.\n- **icon** - The icon slot. Alternatively, you can use the `icon` attribute.\n- **label** - The button label.",
|
|
2737
2680
|
"attributes": [
|
|
2738
2681
|
{
|
|
2739
2682
|
"name": "value",
|
|
2740
|
-
"description": "The
|
|
2741
|
-
"values": [
|
|
2683
|
+
"description": "The radio's value. When selected, the radio group will receive this value.",
|
|
2684
|
+
"values": []
|
|
2742
2685
|
},
|
|
2743
2686
|
{
|
|
2744
|
-
"name": "
|
|
2745
|
-
"description": "
|
|
2746
|
-
"values": [
|
|
2747
|
-
{ "name": "single" },
|
|
2748
|
-
{ "name": "multiple" },
|
|
2749
|
-
{ "name": "leaf" }
|
|
2750
|
-
]
|
|
2687
|
+
"name": "disabled",
|
|
2688
|
+
"description": "Disables the radio button.",
|
|
2689
|
+
"values": []
|
|
2751
2690
|
},
|
|
2752
2691
|
{
|
|
2753
2692
|
"name": "size",
|
|
2754
|
-
"description": "The
|
|
2693
|
+
"description": "The radio button's size. When used inside a radio group, the size will be determined by the radio group's size so\nthis attribute can typically be omitted.",
|
|
2755
2694
|
"values": [
|
|
2695
|
+
{ "name": "x-small" },
|
|
2756
2696
|
{ "name": "small" },
|
|
2757
2697
|
{ "name": "medium" },
|
|
2758
2698
|
{ "name": "large" }
|
|
2759
2699
|
]
|
|
2760
|
-
}
|
|
2761
|
-
],
|
|
2762
|
-
"references": []
|
|
2763
|
-
},
|
|
2764
|
-
{
|
|
2765
|
-
"name": "flow-ui-tooltip",
|
|
2766
|
-
"description": "Tooltips display additional information based on a specific action.\n\n\n---\n\n\n\n\n### **Events:**\n - **flow-ui-show** - Emitted when the tooltip begins to show.\n- **flow-ui-after-show** - Emitted after the tooltip has shown and all animations are complete.\n- **flow-ui-hide** - Emitted when the tooltip begins to hide.\n- **flow-ui-after-hide** - Emitted after the tooltip has hidden and all animations are complete.\n\n### **Methods:**\n - **show()** - Shows the tooltip.\n- **hide()** - Hides the tooltip\n\n### **Slots:**\n - _default_ - The tooltip's target element. Avoid slotting in more than one element, as subsequent ones will be ignored.\n- **content** - The content to render in the tooltip. Alternatively, you can use the `content` attribute.\n\n### **CSS Properties:**\n - **--max-width** - The maximum width of the tooltip before its content will wrap. _(default: undefined)_\n- **--hide-delay** - The amount of time to wait before hiding the tooltip when hovering. _(default: undefined)_\n- **--show-delay** - The amount of time to wait before showing the tooltip when hovering. _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The component's base wrapper, an `<flow-ui-popup>` element.\n- **base__popup** - The popup's exported `popup` part. Use this to target the tooltip's popup container.\n- **base__arrow** - The popup's exported `arrow` part. Use this to target the tooltip's arrow.\n- **body** - The tooltip's body where its content is rendered.",
|
|
2767
|
-
"attributes": [
|
|
2700
|
+
},
|
|
2768
2701
|
{
|
|
2769
|
-
"name": "
|
|
2770
|
-
"description": "
|
|
2702
|
+
"name": "pill",
|
|
2703
|
+
"description": "Draws a pill-style radio button with rounded edges.",
|
|
2771
2704
|
"values": []
|
|
2772
2705
|
},
|
|
2773
2706
|
{
|
|
2774
|
-
"name": "
|
|
2707
|
+
"name": "outline",
|
|
2708
|
+
"description": "Draws an tool button with with an outline.",
|
|
2709
|
+
"values": []
|
|
2710
|
+
},
|
|
2711
|
+
{
|
|
2712
|
+
"name": "tooltip",
|
|
2713
|
+
"description": "Tooltip text that gets displayed when the user hovers over the button. If you need to display HTML, use the\n`tooltip` slot instead.",
|
|
2714
|
+
"values": []
|
|
2715
|
+
},
|
|
2716
|
+
{
|
|
2717
|
+
"name": "tooltip-placement",
|
|
2775
2718
|
"description": "The preferred placement of the tooltip. Note that the actual placement may vary as needed to keep the tooltip\ninside of the viewport.",
|
|
2776
2719
|
"values": [
|
|
2777
2720
|
{ "name": "" },
|
|
@@ -2790,55 +2733,66 @@
|
|
|
2790
2733
|
]
|
|
2791
2734
|
},
|
|
2792
2735
|
{
|
|
2793
|
-
"name": "
|
|
2794
|
-
"description": "
|
|
2736
|
+
"name": "tooltip-distance",
|
|
2737
|
+
"description": "The distance in pixels from which to offset the tooltip away from the button.",
|
|
2795
2738
|
"values": []
|
|
2796
2739
|
},
|
|
2797
2740
|
{
|
|
2798
|
-
"name": "
|
|
2799
|
-
"description": "The distance in pixels from which to offset the tooltip
|
|
2741
|
+
"name": "tooltip-skidding",
|
|
2742
|
+
"description": "The distance in pixels from which to offset the tooltip along the button.",
|
|
2800
2743
|
"values": []
|
|
2801
2744
|
},
|
|
2802
2745
|
{
|
|
2803
|
-
"name": "
|
|
2804
|
-
"description": "
|
|
2746
|
+
"name": "icon",
|
|
2747
|
+
"description": "Specify an icon by name to display above the tool button label. Available names depend on the icon library being used.",
|
|
2805
2748
|
"values": []
|
|
2806
2749
|
},
|
|
2807
2750
|
{
|
|
2808
|
-
"name": "
|
|
2809
|
-
"description": "
|
|
2751
|
+
"name": "icon-src",
|
|
2752
|
+
"description": "Specify an external SVG file to display as an icon above the tool button label.",
|
|
2810
2753
|
"values": []
|
|
2811
2754
|
},
|
|
2812
2755
|
{
|
|
2813
|
-
"name": "
|
|
2814
|
-
"description": "
|
|
2756
|
+
"name": "icon-library",
|
|
2757
|
+
"description": "The name of a registered custom icon library.",
|
|
2815
2758
|
"values": []
|
|
2816
2759
|
},
|
|
2817
2760
|
{
|
|
2818
|
-
"name": "
|
|
2819
|
-
"
|
|
2820
|
-
|
|
2761
|
+
"name": "variant",
|
|
2762
|
+
"values": [
|
|
2763
|
+
{ "name": "primary" },
|
|
2764
|
+
{ "name": "secondary" },
|
|
2765
|
+
{ "name": "success" },
|
|
2766
|
+
{ "name": "warning" },
|
|
2767
|
+
{ "name": "danger" },
|
|
2768
|
+
{ "name": "neutral" }
|
|
2769
|
+
]
|
|
2821
2770
|
}
|
|
2822
2771
|
],
|
|
2823
2772
|
"references": []
|
|
2824
2773
|
},
|
|
2825
2774
|
{
|
|
2826
|
-
"name": "flow-ui-tool-button",
|
|
2827
|
-
"description": "Tool buttons are used to build [
|
|
2775
|
+
"name": "flow-ui-tool-button-group",
|
|
2776
|
+
"description": "Tool buttons groups are used to build toolbars from [tool buttons](./flow-ui-tool-button).\n\n\n---\n\n\n\n\n### **Events:**\n - **flow-ui-change** - Emitted when the control's value changes.\n- **flow-ui-input** - Emitted when the control receives input.\n\n### **Methods:**\n - **checkValidity()** - Checks for validity but does not show a validation message. Returns `true` when valid and `false` when invalid.\n- **getForm(): _HTMLFormElement | null_** - Gets the associated form, if one exists.\n- **reportValidity(): _boolean_** - Checks for validity and shows the browser's validation message if the control is invalid.\n- **setCustomValidity(message)** - Sets a custom validation message. Pass an empty string to restore validity.",
|
|
2828
2777
|
"attributes": [
|
|
2829
2778
|
{
|
|
2830
|
-
"name": "
|
|
2831
|
-
"description": "The radio's
|
|
2779
|
+
"name": "label",
|
|
2780
|
+
"description": "The radio group's label. Required for proper accessibility. If you need to display HTML, use the `label` slot\ninstead.",
|
|
2832
2781
|
"values": []
|
|
2833
2782
|
},
|
|
2834
2783
|
{
|
|
2835
|
-
"name": "
|
|
2836
|
-
"description": "
|
|
2784
|
+
"name": "name",
|
|
2785
|
+
"description": "The name of the tool button group, submitted as a name/value pair with form data.",
|
|
2837
2786
|
"values": []
|
|
2838
2787
|
},
|
|
2788
|
+
{
|
|
2789
|
+
"name": "value",
|
|
2790
|
+
"description": "The current value of the tool button group, submitted as a name/value pair with form data. When `checkbox` mode is enabled, the\nvalue will be a space-delimited list of values based on the checked tool buttons.",
|
|
2791
|
+
"values": [{ "name": "string[]" }]
|
|
2792
|
+
},
|
|
2839
2793
|
{
|
|
2840
2794
|
"name": "size",
|
|
2841
|
-
"description": "The radio
|
|
2795
|
+
"description": "The radio group's size. This size will be applied to all child radios and radio buttons.",
|
|
2842
2796
|
"values": [
|
|
2843
2797
|
{ "name": "x-small" },
|
|
2844
2798
|
{ "name": "small" },
|
|
@@ -2848,21 +2802,53 @@
|
|
|
2848
2802
|
},
|
|
2849
2803
|
{
|
|
2850
2804
|
"name": "pill",
|
|
2851
|
-
"description": "Draws
|
|
2805
|
+
"description": "Draws pill-style tool buttons. This style will be applied to all child tool buttons.",
|
|
2852
2806
|
"values": []
|
|
2853
2807
|
},
|
|
2854
2808
|
{
|
|
2855
2809
|
"name": "outline",
|
|
2856
|
-
"description": "Draws
|
|
2810
|
+
"description": "Draws outline-style tool buttons. This style will be applied to all child tool buttons.",
|
|
2857
2811
|
"values": []
|
|
2858
2812
|
},
|
|
2859
2813
|
{
|
|
2860
|
-
"name": "
|
|
2861
|
-
"
|
|
2814
|
+
"name": "variant",
|
|
2815
|
+
"values": [
|
|
2816
|
+
{ "name": "primary" },
|
|
2817
|
+
{ "name": "secondary" },
|
|
2818
|
+
{ "name": "success" },
|
|
2819
|
+
{ "name": "warning" },
|
|
2820
|
+
{ "name": "danger" },
|
|
2821
|
+
{ "name": "neutral" }
|
|
2822
|
+
]
|
|
2823
|
+
},
|
|
2824
|
+
{
|
|
2825
|
+
"name": "form",
|
|
2826
|
+
"description": "By default, form controls are associated with the nearest containing `<form>` element. This attribute allows you\nto place the form control outside of a form and associate it with the form that has this `id`. The form must be in\nthe same document or shadow root for this to work.",
|
|
2862
2827
|
"values": []
|
|
2863
2828
|
},
|
|
2864
2829
|
{
|
|
2865
|
-
"name": "
|
|
2830
|
+
"name": "vertical",
|
|
2831
|
+
"description": "Use vertical layout for the radio group.",
|
|
2832
|
+
"values": []
|
|
2833
|
+
},
|
|
2834
|
+
{
|
|
2835
|
+
"name": "mode",
|
|
2836
|
+
"values": [{ "name": "radio" }, { "name": "checkbox" }]
|
|
2837
|
+
}
|
|
2838
|
+
],
|
|
2839
|
+
"references": []
|
|
2840
|
+
},
|
|
2841
|
+
{
|
|
2842
|
+
"name": "flow-ui-tooltip",
|
|
2843
|
+
"description": "Tooltips display additional information based on a specific action.\n\n\n---\n\n\n\n\n### **Events:**\n - **flow-ui-show** - Emitted when the tooltip begins to show.\n- **flow-ui-after-show** - Emitted after the tooltip has shown and all animations are complete.\n- **flow-ui-hide** - Emitted when the tooltip begins to hide.\n- **flow-ui-after-hide** - Emitted after the tooltip has hidden and all animations are complete.\n\n### **Methods:**\n - **show()** - Shows the tooltip.\n- **hide()** - Hides the tooltip\n\n### **Slots:**\n - _default_ - The tooltip's target element. Avoid slotting in more than one element, as subsequent ones will be ignored.\n- **content** - The content to render in the tooltip. Alternatively, you can use the `content` attribute.\n\n### **CSS Properties:**\n - **--max-width** - The maximum width of the tooltip before its content will wrap. _(default: undefined)_\n- **--hide-delay** - The amount of time to wait before hiding the tooltip when hovering. _(default: undefined)_\n- **--show-delay** - The amount of time to wait before showing the tooltip when hovering. _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The component's base wrapper, an `<flow-ui-popup>` element.\n- **base__popup** - The popup's exported `popup` part. Use this to target the tooltip's popup container.\n- **base__arrow** - The popup's exported `arrow` part. Use this to target the tooltip's arrow.\n- **body** - The tooltip's body where its content is rendered.",
|
|
2844
|
+
"attributes": [
|
|
2845
|
+
{
|
|
2846
|
+
"name": "content",
|
|
2847
|
+
"description": "The tooltip's content. If you need to display HTML, use the `content` slot instead.",
|
|
2848
|
+
"values": []
|
|
2849
|
+
},
|
|
2850
|
+
{
|
|
2851
|
+
"name": "placement",
|
|
2866
2852
|
"description": "The preferred placement of the tooltip. Note that the actual placement may vary as needed to keep the tooltip\ninside of the viewport.",
|
|
2867
2853
|
"values": [
|
|
2868
2854
|
{ "name": "" },
|
|
@@ -2881,39 +2867,63 @@
|
|
|
2881
2867
|
]
|
|
2882
2868
|
},
|
|
2883
2869
|
{
|
|
2884
|
-
"name": "
|
|
2885
|
-
"description": "
|
|
2870
|
+
"name": "disabled",
|
|
2871
|
+
"description": "Disables the tooltip so it won't show when triggered.",
|
|
2886
2872
|
"values": []
|
|
2887
2873
|
},
|
|
2888
2874
|
{
|
|
2889
|
-
"name": "
|
|
2890
|
-
"description": "The distance in pixels from which to offset the tooltip
|
|
2875
|
+
"name": "distance",
|
|
2876
|
+
"description": "The distance in pixels from which to offset the tooltip away from its target.",
|
|
2891
2877
|
"values": []
|
|
2892
2878
|
},
|
|
2893
2879
|
{
|
|
2894
|
-
"name": "
|
|
2895
|
-
"description": "
|
|
2880
|
+
"name": "open",
|
|
2881
|
+
"description": "Indicates whether or not the tooltip is open. You can use this in lieu of the show/hide methods.",
|
|
2896
2882
|
"values": []
|
|
2897
2883
|
},
|
|
2898
2884
|
{
|
|
2899
|
-
"name": "
|
|
2900
|
-
"description": "
|
|
2885
|
+
"name": "skidding",
|
|
2886
|
+
"description": "The distance in pixels from which to offset the tooltip along its target.",
|
|
2901
2887
|
"values": []
|
|
2902
2888
|
},
|
|
2903
2889
|
{
|
|
2904
|
-
"name": "
|
|
2905
|
-
"description": "
|
|
2890
|
+
"name": "trigger",
|
|
2891
|
+
"description": "Controls how the tooltip is activated. Possible options include `click`, `hover`, `focus`, and `manual`. Multiple\noptions can be passed by separating them with a space. When manual is used, the tooltip must be activated\nprogrammatically.",
|
|
2906
2892
|
"values": []
|
|
2907
2893
|
},
|
|
2908
2894
|
{
|
|
2909
|
-
"name": "
|
|
2895
|
+
"name": "hoist",
|
|
2896
|
+
"description": "Enable this option to prevent the tooltip from being clipped when the component is placed inside a container with\n`overflow: auto|hidden|scroll`. Hoisting uses a fixed positioning strategy that works in many, but not all,\nscenarios.",
|
|
2897
|
+
"values": []
|
|
2898
|
+
}
|
|
2899
|
+
],
|
|
2900
|
+
"references": []
|
|
2901
|
+
},
|
|
2902
|
+
{
|
|
2903
|
+
"name": "flow-ui-tree",
|
|
2904
|
+
"description": "Trees allow you to display a hierarchical list of selectable [tree items](./flow-ui-tree-item). Items with children can be expanded and collapsed as desired by the user.\n\n\n---\n\n\n\n\n### **Events:**\n - **flow-ui-change** - Emitted when a tree item is selected or deselected.\n\n### **Slots:**\n - _default_ - The default slot.\n- **expand-icon** - The icon to show when the tree item is expanded. Works best with `<flow-ui-icon>`.\n- **collapse-icon** - The icon to show when the tree item is collapsed. Works best with `<flow-ui-icon>`.\n\n### **CSS Properties:**\n - **--indent-size** - The size of the indentation for nested items. _(default: var(--flow-ui-spacing-medium))_\n- **--indent-guide-color** - The color of the indentation line. _(default: var(--flow-ui-color-neutral-200))_\n- **--indent-guide-offset** - The amount of vertical spacing to leave between the top and bottom of the indentation line's starting position. _(default: 0)_\n- **--indent-guide-style** - The style of the indentation line, e.g. solid, dotted, dashed. _(default: solid)_\n- **--indent-guide-width** - The width of the indentation line. _(default: 0)_\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.",
|
|
2905
|
+
"attributes": [
|
|
2906
|
+
{
|
|
2907
|
+
"name": "value",
|
|
2908
|
+
"description": "The current value of the select, submitted as a name/value pair with form data. When `multiple` is enabled, the\nvalue attribute will be a space-delimited list of values based on the options selected, and the value property will\nbe an array. **For this reason, values must not contain spaces.**",
|
|
2909
|
+
"values": [{ "name": "string[]" }]
|
|
2910
|
+
},
|
|
2911
|
+
{
|
|
2912
|
+
"name": "selection-mode",
|
|
2913
|
+
"description": "The selection behavior of the tree. Single selection allows only one node to be selected at a time. Multiple\ndisplays checkboxes and allows more than one node to be selected. Leaf allows only leaf nodes to be selected.",
|
|
2910
2914
|
"values": [
|
|
2911
|
-
{ "name": "
|
|
2912
|
-
{ "name": "
|
|
2913
|
-
{ "name": "
|
|
2914
|
-
|
|
2915
|
-
|
|
2916
|
-
|
|
2915
|
+
{ "name": "single" },
|
|
2916
|
+
{ "name": "multiple" },
|
|
2917
|
+
{ "name": "leaf" }
|
|
2918
|
+
]
|
|
2919
|
+
},
|
|
2920
|
+
{
|
|
2921
|
+
"name": "size",
|
|
2922
|
+
"description": "The select's size.",
|
|
2923
|
+
"values": [
|
|
2924
|
+
{ "name": "small" },
|
|
2925
|
+
{ "name": "medium" },
|
|
2926
|
+
{ "name": "large" }
|
|
2917
2927
|
]
|
|
2918
2928
|
}
|
|
2919
2929
|
],
|