@emuanalytics/flow-rdf-ui 4.0.3 → 4.0.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/custom-elements.json +11993 -11953
- 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 +673 -663
- package/package.json +1 -1
- 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,68 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"version": 1.1,
|
|
3
3
|
"tags": [
|
|
4
|
-
{
|
|
5
|
-
"name": "flow-ui-animation",
|
|
6
|
-
"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.",
|
|
7
|
-
"attributes": [
|
|
8
|
-
{
|
|
9
|
-
"name": "name",
|
|
10
|
-
"description": "The name of the built-in animation to use. For custom animations, use the `keyframes` prop.\nUse `getAnimationNames()` to retrieve a list of available animations.",
|
|
11
|
-
"values": []
|
|
12
|
-
},
|
|
13
|
-
{
|
|
14
|
-
"name": "play",
|
|
15
|
-
"description": "Plays the animation. When omitted, the animation will be paused. This attribute will be automatically removed when\nthe animation finishes or gets canceled.",
|
|
16
|
-
"values": []
|
|
17
|
-
},
|
|
18
|
-
{
|
|
19
|
-
"name": "delay",
|
|
20
|
-
"description": "The number of milliseconds to delay the start of the animation.",
|
|
21
|
-
"values": []
|
|
22
|
-
},
|
|
23
|
-
{
|
|
24
|
-
"name": "direction",
|
|
25
|
-
"description": "Determines the direction of playback as well as the behavior when reaching the end of an iteration.\n[Learn more](https://developer.mozilla.org/en-US/docs/Web/CSS/animation-direction)",
|
|
26
|
-
"values": [{ "name": "PlaybackDirection" }]
|
|
27
|
-
},
|
|
28
|
-
{
|
|
29
|
-
"name": "duration",
|
|
30
|
-
"description": "The number of milliseconds each iteration of the animation takes to complete.",
|
|
31
|
-
"values": []
|
|
32
|
-
},
|
|
33
|
-
{
|
|
34
|
-
"name": "easing",
|
|
35
|
-
"description": "The easing function to use for the animation. This can be a Shoelace easing function or a custom easing function\nsuch as `cubic-bezier(0, 1, .76, 1.14)`.",
|
|
36
|
-
"values": []
|
|
37
|
-
},
|
|
38
|
-
{
|
|
39
|
-
"name": "end-delay",
|
|
40
|
-
"description": "The number of milliseconds to delay after the active period of an animation sequence.",
|
|
41
|
-
"values": []
|
|
42
|
-
},
|
|
43
|
-
{
|
|
44
|
-
"name": "fill",
|
|
45
|
-
"description": "Sets how the animation applies styles to its target before and after its execution.",
|
|
46
|
-
"values": [{ "name": "FillMode" }]
|
|
47
|
-
},
|
|
48
|
-
{
|
|
49
|
-
"name": "iterations",
|
|
50
|
-
"description": "The number of iterations to run before the animation completes. Defaults to `Infinity`, which loops.",
|
|
51
|
-
"values": []
|
|
52
|
-
},
|
|
53
|
-
{
|
|
54
|
-
"name": "iteration-start",
|
|
55
|
-
"description": "The offset at which to start the animation, usually between 0 (start) and 1 (end).",
|
|
56
|
-
"values": []
|
|
57
|
-
},
|
|
58
|
-
{
|
|
59
|
-
"name": "playback-rate",
|
|
60
|
-
"description": "Sets the animation's playback rate. The default is `1`, which plays the animation at a normal speed. Setting this\nto `2`, for example, will double the animation's speed. A negative value can be used to reverse the animation. This\nvalue can be changed without causing the animation to restart.",
|
|
61
|
-
"values": []
|
|
62
|
-
}
|
|
63
|
-
],
|
|
64
|
-
"references": []
|
|
65
|
-
},
|
|
66
4
|
{
|
|
67
5
|
"name": "flow-ui-alert",
|
|
68
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.",
|
|
@@ -145,6 +83,35 @@
|
|
|
145
83
|
],
|
|
146
84
|
"references": []
|
|
147
85
|
},
|
|
86
|
+
{
|
|
87
|
+
"name": "flow-ui-badge",
|
|
88
|
+
"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.",
|
|
89
|
+
"attributes": [
|
|
90
|
+
{
|
|
91
|
+
"name": "variant",
|
|
92
|
+
"description": "The badge's theme variant.",
|
|
93
|
+
"values": [
|
|
94
|
+
{ "name": "primary" },
|
|
95
|
+
{ "name": "secondary" },
|
|
96
|
+
{ "name": "success" },
|
|
97
|
+
{ "name": "neutral" },
|
|
98
|
+
{ "name": "warning" },
|
|
99
|
+
{ "name": "danger" }
|
|
100
|
+
]
|
|
101
|
+
},
|
|
102
|
+
{
|
|
103
|
+
"name": "pill",
|
|
104
|
+
"description": "Draws a pill-style badge with rounded edges.",
|
|
105
|
+
"values": []
|
|
106
|
+
},
|
|
107
|
+
{
|
|
108
|
+
"name": "pulse",
|
|
109
|
+
"description": "Makes the badge pulsate to draw attention.",
|
|
110
|
+
"values": []
|
|
111
|
+
}
|
|
112
|
+
],
|
|
113
|
+
"references": []
|
|
114
|
+
},
|
|
148
115
|
{
|
|
149
116
|
"name": "flow-ui-breadcrumb-item",
|
|
150
117
|
"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.",
|
|
@@ -323,57 +290,84 @@
|
|
|
323
290
|
"references": []
|
|
324
291
|
},
|
|
325
292
|
{
|
|
326
|
-
"name": "flow-ui-
|
|
327
|
-
"description": "
|
|
293
|
+
"name": "flow-ui-button-group",
|
|
294
|
+
"description": "Button groups can be used to group related buttons into sections.\n\n\n---\n\n\n\n\n### **Slots:**\n - _default_ - One or more `<flow-ui-button>` elements to display in the button group.\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.",
|
|
328
295
|
"attributes": [
|
|
329
296
|
{
|
|
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
|
-
]
|
|
340
|
-
},
|
|
341
|
-
{
|
|
342
|
-
"name": "pill",
|
|
343
|
-
"description": "Draws a pill-style badge with rounded edges.",
|
|
297
|
+
"name": "label",
|
|
298
|
+
"description": "Text label for assistive devices.",
|
|
344
299
|
"values": []
|
|
345
300
|
},
|
|
346
301
|
{
|
|
347
|
-
"name": "
|
|
348
|
-
"description": "
|
|
302
|
+
"name": "vertical",
|
|
303
|
+
"description": "Use vertical layout for the button group.",
|
|
349
304
|
"values": []
|
|
350
305
|
}
|
|
351
306
|
],
|
|
352
307
|
"references": []
|
|
353
308
|
},
|
|
354
309
|
{
|
|
355
|
-
"name": "flow-ui-
|
|
356
|
-
"description": "
|
|
310
|
+
"name": "flow-ui-animation",
|
|
311
|
+
"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.",
|
|
357
312
|
"attributes": [
|
|
358
313
|
{
|
|
359
|
-
"name": "
|
|
360
|
-
"description": "
|
|
314
|
+
"name": "name",
|
|
315
|
+
"description": "The name of the built-in animation to use. For custom animations, use the `keyframes` prop.\nUse `getAnimationNames()` to retrieve a list of available animations.",
|
|
361
316
|
"values": []
|
|
362
317
|
},
|
|
363
318
|
{
|
|
364
|
-
"name": "
|
|
365
|
-
"description": "
|
|
319
|
+
"name": "play",
|
|
320
|
+
"description": "Plays the animation. When omitted, the animation will be paused. This attribute will be automatically removed when\nthe animation finishes or gets canceled.",
|
|
321
|
+
"values": []
|
|
322
|
+
},
|
|
323
|
+
{
|
|
324
|
+
"name": "delay",
|
|
325
|
+
"description": "The number of milliseconds to delay the start of the animation.",
|
|
326
|
+
"values": []
|
|
327
|
+
},
|
|
328
|
+
{
|
|
329
|
+
"name": "direction",
|
|
330
|
+
"description": "Determines the direction of playback as well as the behavior when reaching the end of an iteration.\n[Learn more](https://developer.mozilla.org/en-US/docs/Web/CSS/animation-direction)",
|
|
331
|
+
"values": [{ "name": "PlaybackDirection" }]
|
|
332
|
+
},
|
|
333
|
+
{
|
|
334
|
+
"name": "duration",
|
|
335
|
+
"description": "The number of milliseconds each iteration of the animation takes to complete.",
|
|
336
|
+
"values": []
|
|
337
|
+
},
|
|
338
|
+
{
|
|
339
|
+
"name": "easing",
|
|
340
|
+
"description": "The easing function to use for the animation. This can be a Shoelace easing function or a custom easing function\nsuch as `cubic-bezier(0, 1, .76, 1.14)`.",
|
|
341
|
+
"values": []
|
|
342
|
+
},
|
|
343
|
+
{
|
|
344
|
+
"name": "end-delay",
|
|
345
|
+
"description": "The number of milliseconds to delay after the active period of an animation sequence.",
|
|
346
|
+
"values": []
|
|
347
|
+
},
|
|
348
|
+
{
|
|
349
|
+
"name": "fill",
|
|
350
|
+
"description": "Sets how the animation applies styles to its target before and after its execution.",
|
|
351
|
+
"values": [{ "name": "FillMode" }]
|
|
352
|
+
},
|
|
353
|
+
{
|
|
354
|
+
"name": "iterations",
|
|
355
|
+
"description": "The number of iterations to run before the animation completes. Defaults to `Infinity`, which loops.",
|
|
356
|
+
"values": []
|
|
357
|
+
},
|
|
358
|
+
{
|
|
359
|
+
"name": "iteration-start",
|
|
360
|
+
"description": "The offset at which to start the animation, usually between 0 (start) and 1 (end).",
|
|
361
|
+
"values": []
|
|
362
|
+
},
|
|
363
|
+
{
|
|
364
|
+
"name": "playback-rate",
|
|
365
|
+
"description": "Sets the animation's playback rate. The default is `1`, which plays the animation at a normal speed. Setting this\nto `2`, for example, will double the animation's speed. A negative value can be used to reverse the animation. This\nvalue can be changed without causing the animation to restart.",
|
|
366
366
|
"values": []
|
|
367
367
|
}
|
|
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.",
|
|
@@ -744,59 +758,6 @@
|
|
|
744
758
|
],
|
|
745
759
|
"references": []
|
|
746
760
|
},
|
|
747
|
-
{
|
|
748
|
-
"name": "flow-ui-dialog",
|
|
749
|
-
"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.",
|
|
750
|
-
"attributes": [
|
|
751
|
-
{
|
|
752
|
-
"name": "open",
|
|
753
|
-
"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.",
|
|
754
|
-
"values": []
|
|
755
|
-
},
|
|
756
|
-
{
|
|
757
|
-
"name": "label",
|
|
758
|
-
"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.",
|
|
759
|
-
"values": []
|
|
760
|
-
},
|
|
761
|
-
{
|
|
762
|
-
"name": "no-header",
|
|
763
|
-
"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.",
|
|
764
|
-
"values": []
|
|
765
|
-
}
|
|
766
|
-
],
|
|
767
|
-
"references": []
|
|
768
|
-
},
|
|
769
|
-
{
|
|
770
|
-
"name": "flow-ui-color-mapper",
|
|
771
|
-
"description": "A component for defining mappings between data values and colors.\n\n\n---\n\n\n",
|
|
772
|
-
"attributes": [
|
|
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
761
|
{
|
|
801
762
|
"name": "flow-ui-date-time-picker",
|
|
802
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.",
|
|
@@ -914,6 +875,28 @@
|
|
|
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
|
+
},
|
|
917
900
|
{
|
|
918
901
|
"name": "flow-ui-divider",
|
|
919
902
|
"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)_",
|
|
@@ -926,6 +909,28 @@
|
|
|
926
909
|
],
|
|
927
910
|
"references": []
|
|
928
911
|
},
|
|
912
|
+
{
|
|
913
|
+
"name": "flow-ui-dialog",
|
|
914
|
+
"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.",
|
|
915
|
+
"attributes": [
|
|
916
|
+
{
|
|
917
|
+
"name": "open",
|
|
918
|
+
"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.",
|
|
919
|
+
"values": []
|
|
920
|
+
},
|
|
921
|
+
{
|
|
922
|
+
"name": "label",
|
|
923
|
+
"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.",
|
|
924
|
+
"values": []
|
|
925
|
+
},
|
|
926
|
+
{
|
|
927
|
+
"name": "no-header",
|
|
928
|
+
"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.",
|
|
929
|
+
"values": []
|
|
930
|
+
}
|
|
931
|
+
],
|
|
932
|
+
"references": []
|
|
933
|
+
},
|
|
929
934
|
{
|
|
930
935
|
"name": "flow-ui-drawer",
|
|
931
936
|
"description": "Drawers slide in from a container to expose additional options and information.\n\n\n---\n\n\n\n\n### **Events:**\n - **flow-ui-show** - Emitted when the drawer opens.\n- **flow-ui-after-show** - Emitted after the drawer opens and all animations are complete.\n- **flow-ui-hide** - Emitted when the drawer closes.\n- **flow-ui-after-hide** - Emitted after the drawer closes and all animations are complete.\n- **flow-ui-initial-focus** - Emitted when the drawer 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 drawer by clicking the close button, clicking the overlay, or pressing escape. Calling `event.preventDefault()` will keep the drawer open. Avoid using this unless closing the drawer will result in destructive behavior such as data loss.\n\n### **Methods:**\n - **show()** - Shows the drawer.\n- **hide()** - Hides the drawer\n\n### **Slots:**\n - _default_ - The drawer's main content.\n- **label** - The drawer'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 drawer's footer, usually one or more buttons representing various options.\n\n### **CSS Properties:**\n - **--size** - The preferred size of the drawer. This will be applied to the drawer's width or height depending on its `placement`. Note that the drawer 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 drawer.\n- **panel** - The drawer's panel (where the drawer and its content are rendered).\n- **header** - The drawer'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 drawer'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 drawer's body.\n- **footer** - The drawer's footer.",
|
|
@@ -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,49 +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
|
-
{
|
|
1494
|
-
"name": "flow-ui-menu-label",
|
|
1495
|
-
"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.",
|
|
1496
|
-
"attributes": [],
|
|
1497
|
-
"references": []
|
|
1498
|
-
},
|
|
1499
1498
|
{
|
|
1500
1499
|
"name": "flow-ui-mutation-observer",
|
|
1501
1500
|
"description": "The Mutation Observer component offers a thin, declarative interface to the [`MutationObserver API`](https://developer.mozilla.org/en-US/docs/Web/API/MutationObserver).\n\n\n---\n\n\n\n\n### **Events:**\n - **flow-ui-mutation** - Emitted when a mutation occurs.\n\n### **Slots:**\n - _default_ - The content to watch for mutations.",
|
|
@@ -1559,6 +1558,56 @@
|
|
|
1559
1558
|
],
|
|
1560
1559
|
"references": []
|
|
1561
1560
|
},
|
|
1561
|
+
{
|
|
1562
|
+
"name": "flow-ui-panel",
|
|
1563
|
+
"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)_",
|
|
1564
|
+
"attributes": [
|
|
1565
|
+
{
|
|
1566
|
+
"name": "closed",
|
|
1567
|
+
"description": "Indicates whether the panel is open or closed.",
|
|
1568
|
+
"values": []
|
|
1569
|
+
},
|
|
1570
|
+
{
|
|
1571
|
+
"name": "scrollable",
|
|
1572
|
+
"description": "Indicates whether the panel is scrollable. By default overflow is hidden.",
|
|
1573
|
+
"values": []
|
|
1574
|
+
},
|
|
1575
|
+
{
|
|
1576
|
+
"name": "padding",
|
|
1577
|
+
"description": "Indicates whether the panel body has padding.",
|
|
1578
|
+
"values": []
|
|
1579
|
+
}
|
|
1580
|
+
],
|
|
1581
|
+
"references": []
|
|
1582
|
+
},
|
|
1583
|
+
{
|
|
1584
|
+
"name": "flow-ui-panel-header",
|
|
1585
|
+
"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.",
|
|
1586
|
+
"attributes": [
|
|
1587
|
+
{
|
|
1588
|
+
"name": "closed",
|
|
1589
|
+
"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.",
|
|
1590
|
+
"values": []
|
|
1591
|
+
},
|
|
1592
|
+
{
|
|
1593
|
+
"name": "title",
|
|
1594
|
+
"description": "The header title text. Use the `title` slot instead to display HTML.",
|
|
1595
|
+
"values": []
|
|
1596
|
+
},
|
|
1597
|
+
{
|
|
1598
|
+
"name": "fixed",
|
|
1599
|
+
"description": "Set to `true` to hide the panel expand/collapse button.",
|
|
1600
|
+
"values": []
|
|
1601
|
+
}
|
|
1602
|
+
],
|
|
1603
|
+
"references": []
|
|
1604
|
+
},
|
|
1605
|
+
{
|
|
1606
|
+
"name": "flow-ui-menu-label",
|
|
1607
|
+
"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.",
|
|
1608
|
+
"attributes": [],
|
|
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.",
|
|
@@ -1776,84 +1825,27 @@
|
|
|
1776
1825
|
"name": "disabled",
|
|
1777
1826
|
"description": "Disables the radio.",
|
|
1778
1827
|
"values": []
|
|
1828
|
+
},
|
|
1829
|
+
{
|
|
1830
|
+
"name": "full-width",
|
|
1831
|
+
"description": "Display the radio using the alternative 'full-width' style with left-aligned label.",
|
|
1832
|
+
"values": []
|
|
1779
1833
|
}
|
|
1780
1834
|
],
|
|
1781
1835
|
"references": []
|
|
1782
1836
|
},
|
|
1783
1837
|
{
|
|
1784
|
-
"name": "flow-ui-
|
|
1785
|
-
"description": "
|
|
1838
|
+
"name": "flow-ui-range",
|
|
1839
|
+
"description": "Ranges allow the user to select a single value within a given range using a slider.\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 an alteration to the control's value is committed by the user.\n- **flow-ui-focus** - Emitted when the control gains focus.\n- **flow-ui-input** - Emitted when the control 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 - **focus(options: _FocusOptions_)** - Sets focus on the range.\n- **blur()** - Removes focus from the range.\n- **stepUp()** - Increments the value of the range by the value of the step attribute.\n- **stepDown()** - Decrements the value of the range by the value of the step attribute.\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 - **label** - The range's label. Alternatively, you can use the `label` attribute.\n- **help-text** - Text that describes how to use the input. Alternatively, you can use the `help-text` attribute.\n\n### **CSS Properties:**\n - **--thumb-size** - The size of the thumb. _(default: undefined)_\n- **--tooltip-offset** - The vertical distance the tooltip is offset from the track. _(default: undefined)_\n- **--track-color-active** - The color of the portion of the track that represents the current value. _(default: undefined)_\n- **--track-color-inactive** - The of the portion of the track that represents the remaining value. _(default: undefined)_\n- **--track-height** - The height of the track. _(default: undefined)_\n- **--track-active-offset** - The point of origin of the active track. _(default: undefined)_\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 range's wrapper.\n- **form-control-help-text** - The help text's wrapper.\n- **base** - The component's base wrapper.\n- **input** - The internal `<input>` element.\n- **tooltip** - The range's tooltip.",
|
|
1786
1840
|
"attributes": [
|
|
1787
1841
|
{
|
|
1788
|
-
"name": "
|
|
1789
|
-
"description": "The
|
|
1842
|
+
"name": "name",
|
|
1843
|
+
"description": "The name of the range, submitted as a name/value pair with form data.",
|
|
1790
1844
|
"values": []
|
|
1791
1845
|
},
|
|
1792
1846
|
{
|
|
1793
|
-
"name": "
|
|
1794
|
-
"description": "The
|
|
1795
|
-
"values": []
|
|
1796
|
-
},
|
|
1797
|
-
{
|
|
1798
|
-
"name": "name",
|
|
1799
|
-
"description": "The name of the radio group, submitted as a name/value pair with form data.",
|
|
1800
|
-
"values": []
|
|
1801
|
-
},
|
|
1802
|
-
{
|
|
1803
|
-
"name": "value",
|
|
1804
|
-
"description": "The current value of the radio group, submitted as a name/value pair with form data.",
|
|
1805
|
-
"values": []
|
|
1806
|
-
},
|
|
1807
|
-
{
|
|
1808
|
-
"name": "size",
|
|
1809
|
-
"description": "The radio group's size. This size will be applied to all child radios and radio buttons.",
|
|
1810
|
-
"values": [
|
|
1811
|
-
{ "name": "small" },
|
|
1812
|
-
{ "name": "medium" },
|
|
1813
|
-
{ "name": "large" }
|
|
1814
|
-
]
|
|
1815
|
-
},
|
|
1816
|
-
{
|
|
1817
|
-
"name": "variant",
|
|
1818
|
-
"values": [
|
|
1819
|
-
{ "name": "primary" },
|
|
1820
|
-
{ "name": "secondary" },
|
|
1821
|
-
{ "name": "success" },
|
|
1822
|
-
{ "name": "warning" },
|
|
1823
|
-
{ "name": "danger" },
|
|
1824
|
-
{ "name": "neutral" }
|
|
1825
|
-
]
|
|
1826
|
-
},
|
|
1827
|
-
{
|
|
1828
|
-
"name": "form",
|
|
1829
|
-
"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.",
|
|
1830
|
-
"values": []
|
|
1831
|
-
},
|
|
1832
|
-
{
|
|
1833
|
-
"name": "required",
|
|
1834
|
-
"description": "Ensures a child radio is checked before allowing the containing form to submit.",
|
|
1835
|
-
"values": []
|
|
1836
|
-
},
|
|
1837
|
-
{
|
|
1838
|
-
"name": "vertical",
|
|
1839
|
-
"description": "Use vertical layout for the radio group.",
|
|
1840
|
-
"values": []
|
|
1841
|
-
}
|
|
1842
|
-
],
|
|
1843
|
-
"references": []
|
|
1844
|
-
},
|
|
1845
|
-
{
|
|
1846
|
-
"name": "flow-ui-range",
|
|
1847
|
-
"description": "Ranges allow the user to select a single value within a given range using a slider.\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 an alteration to the control's value is committed by the user.\n- **flow-ui-focus** - Emitted when the control gains focus.\n- **flow-ui-input** - Emitted when the control 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 - **focus(options: _FocusOptions_)** - Sets focus on the range.\n- **blur()** - Removes focus from the range.\n- **stepUp()** - Increments the value of the range by the value of the step attribute.\n- **stepDown()** - Decrements the value of the range by the value of the step attribute.\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 - **label** - The range's label. Alternatively, you can use the `label` attribute.\n- **help-text** - Text that describes how to use the input. Alternatively, you can use the `help-text` attribute.\n\n### **CSS Properties:**\n - **--thumb-size** - The size of the thumb. _(default: undefined)_\n- **--tooltip-offset** - The vertical distance the tooltip is offset from the track. _(default: undefined)_\n- **--track-color-active** - The color of the portion of the track that represents the current value. _(default: undefined)_\n- **--track-color-inactive** - The of the portion of the track that represents the remaining value. _(default: undefined)_\n- **--track-height** - The height of the track. _(default: undefined)_\n- **--track-active-offset** - The point of origin of the active track. _(default: undefined)_\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 range's wrapper.\n- **form-control-help-text** - The help text's wrapper.\n- **base** - The component's base wrapper.\n- **input** - The internal `<input>` element.\n- **tooltip** - The range's tooltip.",
|
|
1848
|
-
"attributes": [
|
|
1849
|
-
{
|
|
1850
|
-
"name": "name",
|
|
1851
|
-
"description": "The name of the range, submitted as a name/value pair with form data.",
|
|
1852
|
-
"values": []
|
|
1853
|
-
},
|
|
1854
|
-
{
|
|
1855
|
-
"name": "value",
|
|
1856
|
-
"description": "The current value of the range, submitted as a name/value pair with form data.",
|
|
1847
|
+
"name": "value",
|
|
1848
|
+
"description": "The current value of the range, submitted as a name/value pair with form data.",
|
|
1857
1849
|
"values": []
|
|
1858
1850
|
},
|
|
1859
1851
|
{
|
|
@@ -1915,50 +1907,6 @@
|
|
|
1915
1907
|
],
|
|
1916
1908
|
"references": []
|
|
1917
1909
|
},
|
|
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
1910
|
{
|
|
1963
1911
|
"name": "flow-ui-query-builder",
|
|
1964
1912
|
"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.",
|
|
@@ -1995,12 +1943,6 @@
|
|
|
1995
1943
|
],
|
|
1996
1944
|
"references": []
|
|
1997
1945
|
},
|
|
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
1946
|
{
|
|
2005
1947
|
"name": "flow-ui-select",
|
|
2006
1948
|
"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.",
|
|
@@ -2107,22 +2049,68 @@
|
|
|
2107
2049
|
"references": []
|
|
2108
2050
|
},
|
|
2109
2051
|
{
|
|
2110
|
-
"name": "flow-ui-
|
|
2111
|
-
"description": "
|
|
2052
|
+
"name": "flow-ui-spinner",
|
|
2053
|
+
"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.",
|
|
2054
|
+
"attributes": [],
|
|
2055
|
+
"references": []
|
|
2056
|
+
},
|
|
2057
|
+
{
|
|
2058
|
+
"name": "flow-ui-radio-group",
|
|
2059
|
+
"description": "Radio groups are used to group multiple [radios](/components/radio) or [radio buttons](/components/radio-button) so they function as a single form control.\n\n\n---\n\n\n\n\n### **Events:**\n - **flow-ui-change** - Emitted when the radio group's selected value changes.\n- **flow-ui-input** - Emitted when the radio group receives user 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 - **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.\n\n### **Slots:**\n - _default_ - The default slot where `<flow-ui-radio>` or `<flow-ui-tool-button>` elements are placed.\n- **label** - The radio group's label. Required for proper accessibility. Alternatively, you can use the `label` 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 input's wrapper.\n- **form-control-help-text** - The help text's wrapper.\n- **button-group** - The button group that wraps radio buttons.\n- **button-group__base** - The button group's `base` part.",
|
|
2112
2060
|
"attributes": [
|
|
2113
2061
|
{
|
|
2114
|
-
"name": "
|
|
2115
|
-
"description": "
|
|
2062
|
+
"name": "label",
|
|
2063
|
+
"description": "The radio group's label. Required for proper accessibility. If you need to display HTML, use the `label` slot\ninstead.",
|
|
2116
2064
|
"values": []
|
|
2117
2065
|
},
|
|
2118
2066
|
{
|
|
2119
|
-
"name": "
|
|
2120
|
-
"description": "The
|
|
2121
|
-
"values": [
|
|
2067
|
+
"name": "help-text",
|
|
2068
|
+
"description": "The radio groups's help text. If you need to display HTML, use the `help-text` slot instead.",
|
|
2069
|
+
"values": []
|
|
2122
2070
|
},
|
|
2123
2071
|
{
|
|
2124
|
-
"name": "
|
|
2125
|
-
"description": "
|
|
2072
|
+
"name": "name",
|
|
2073
|
+
"description": "The name of the radio group, submitted as a name/value pair with form data.",
|
|
2074
|
+
"values": []
|
|
2075
|
+
},
|
|
2076
|
+
{
|
|
2077
|
+
"name": "value",
|
|
2078
|
+
"description": "The current value of the radio group, submitted as a name/value pair with form data.",
|
|
2079
|
+
"values": []
|
|
2080
|
+
},
|
|
2081
|
+
{
|
|
2082
|
+
"name": "size",
|
|
2083
|
+
"description": "The radio group's size. This size will be applied to all child radios and radio buttons.",
|
|
2084
|
+
"values": [
|
|
2085
|
+
{ "name": "small" },
|
|
2086
|
+
{ "name": "medium" },
|
|
2087
|
+
{ "name": "large" }
|
|
2088
|
+
]
|
|
2089
|
+
},
|
|
2090
|
+
{
|
|
2091
|
+
"name": "variant",
|
|
2092
|
+
"values": [
|
|
2093
|
+
{ "name": "primary" },
|
|
2094
|
+
{ "name": "secondary" },
|
|
2095
|
+
{ "name": "success" },
|
|
2096
|
+
{ "name": "warning" },
|
|
2097
|
+
{ "name": "danger" },
|
|
2098
|
+
{ "name": "neutral" }
|
|
2099
|
+
]
|
|
2100
|
+
},
|
|
2101
|
+
{
|
|
2102
|
+
"name": "form",
|
|
2103
|
+
"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.",
|
|
2104
|
+
"values": []
|
|
2105
|
+
},
|
|
2106
|
+
{
|
|
2107
|
+
"name": "required",
|
|
2108
|
+
"description": "Ensures a child radio is checked before allowing the containing form to submit.",
|
|
2109
|
+
"values": []
|
|
2110
|
+
},
|
|
2111
|
+
{
|
|
2112
|
+
"name": "full-width",
|
|
2113
|
+
"description": "Display the radio group using the alternative 'full-width' style with left-aligned label.",
|
|
2126
2114
|
"values": []
|
|
2127
2115
|
}
|
|
2128
2116
|
],
|
|
@@ -2146,27 +2134,80 @@
|
|
|
2146
2134
|
"references": []
|
|
2147
2135
|
},
|
|
2148
2136
|
{
|
|
2149
|
-
"name": "flow-ui-split-view
|
|
2150
|
-
"description": "
|
|
2137
|
+
"name": "flow-ui-split-view",
|
|
2138
|
+
"description": "Split-views contain two or more split-view panes to create resizable areas.\n\n\n---\n\n\n",
|
|
2151
2139
|
"attributes": [
|
|
2152
2140
|
{
|
|
2153
|
-
"name": "
|
|
2154
|
-
"description": "
|
|
2141
|
+
"name": "no-drag-close",
|
|
2142
|
+
"description": "Disable drag-to-close behaviour.",
|
|
2155
2143
|
"values": []
|
|
2156
2144
|
},
|
|
2157
2145
|
{
|
|
2158
|
-
"name": "
|
|
2159
|
-
"description": "The
|
|
2146
|
+
"name": "positions",
|
|
2147
|
+
"description": "The pane positions in CSS size units",
|
|
2148
|
+
"values": [{ "name": "string[]" }]
|
|
2149
|
+
},
|
|
2150
|
+
{
|
|
2151
|
+
"name": "vertical",
|
|
2152
|
+
"description": "Set to `true` for vertically-arranged panes. By default, panes are layed out horizontally.",
|
|
2153
|
+
"values": []
|
|
2154
|
+
}
|
|
2155
|
+
],
|
|
2156
|
+
"references": []
|
|
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",
|
|
2160
2185
|
"values": []
|
|
2161
2186
|
},
|
|
2162
2187
|
{
|
|
2163
2188
|
"name": "closed",
|
|
2164
|
-
"description": "
|
|
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.",
|
|
2165
2200
|
"values": []
|
|
2166
2201
|
}
|
|
2167
2202
|
],
|
|
2168
2203
|
"references": []
|
|
2169
2204
|
},
|
|
2205
|
+
{
|
|
2206
|
+
"name": "flow-ui-stepper",
|
|
2207
|
+
"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`",
|
|
2208
|
+
"attributes": [],
|
|
2209
|
+
"references": []
|
|
2210
|
+
},
|
|
2170
2211
|
{
|
|
2171
2212
|
"name": "flow-ui-switch",
|
|
2172
2213
|
"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 +2255,83 @@
|
|
|
2214
2255
|
"references": []
|
|
2215
2256
|
},
|
|
2216
2257
|
{
|
|
2217
|
-
"name": "flow-ui-
|
|
2218
|
-
"description": "
|
|
2258
|
+
"name": "flow-ui-tab",
|
|
2259
|
+
"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
2260
|
"attributes": [
|
|
2220
2261
|
{
|
|
2221
|
-
"name": "
|
|
2222
|
-
"description": "
|
|
2262
|
+
"name": "panel",
|
|
2263
|
+
"description": "The name of the tab panel this tab is associated with. The panel must be located in the same tab group.",
|
|
2223
2264
|
"values": []
|
|
2224
2265
|
},
|
|
2225
2266
|
{
|
|
2226
|
-
"name": "
|
|
2227
|
-
"description": "
|
|
2267
|
+
"name": "active",
|
|
2268
|
+
"description": "Draws the tab in an active state.",
|
|
2228
2269
|
"values": []
|
|
2229
2270
|
},
|
|
2230
2271
|
{
|
|
2231
|
-
"name": "
|
|
2232
|
-
"description": "
|
|
2272
|
+
"name": "icon-only",
|
|
2273
|
+
"description": "Display tab icon only. Label text is displayed as a tooltip",
|
|
2233
2274
|
"values": []
|
|
2234
2275
|
},
|
|
2235
2276
|
{
|
|
2236
|
-
"name": "
|
|
2237
|
-
"description": "
|
|
2277
|
+
"name": "closable",
|
|
2278
|
+
"description": "Makes the tab closable and shows a close button.",
|
|
2238
2279
|
"values": []
|
|
2239
2280
|
},
|
|
2240
2281
|
{
|
|
2241
|
-
"name": "
|
|
2242
|
-
"description": "
|
|
2282
|
+
"name": "disabled",
|
|
2283
|
+
"description": "Disables the tab and prevents selection.",
|
|
2243
2284
|
"values": []
|
|
2244
2285
|
},
|
|
2245
2286
|
{
|
|
2246
|
-
"name": "
|
|
2247
|
-
"description": "
|
|
2287
|
+
"name": "tooltip-placement",
|
|
2288
|
+
"description": "The preferred placement of the tooltip. Note that the actual placement may vary as needed to keep the tooltip\ninside of the viewport.",
|
|
2289
|
+
"values": [
|
|
2290
|
+
{ "name": "" },
|
|
2291
|
+
{ "name": "top" },
|
|
2292
|
+
{ "name": "top-start" },
|
|
2293
|
+
{ "name": "top-end" },
|
|
2294
|
+
{ "name": "right" },
|
|
2295
|
+
{ "name": "right-start" },
|
|
2296
|
+
{ "name": "right-end" },
|
|
2297
|
+
{ "name": "bottom" },
|
|
2298
|
+
{ "name": "bottom-start" },
|
|
2299
|
+
{ "name": "bottom-end" },
|
|
2300
|
+
{ "name": "left" },
|
|
2301
|
+
{ "name": "left-start" },
|
|
2302
|
+
{ "name": "left-end" }
|
|
2303
|
+
]
|
|
2304
|
+
},
|
|
2305
|
+
{
|
|
2306
|
+
"name": "tooltip-distance",
|
|
2307
|
+
"description": "The distance in pixels from which to offset the tooltip away from the icon button.",
|
|
2248
2308
|
"values": []
|
|
2249
2309
|
},
|
|
2250
2310
|
{
|
|
2251
|
-
"name": "
|
|
2252
|
-
"description": "
|
|
2311
|
+
"name": "tooltip-skidding",
|
|
2312
|
+
"description": "The distance in pixels from which to offset the tooltip along the icon button.",
|
|
2313
|
+
"values": []
|
|
2314
|
+
}
|
|
2315
|
+
],
|
|
2316
|
+
"references": []
|
|
2317
|
+
},
|
|
2318
|
+
{
|
|
2319
|
+
"name": "flow-ui-split-view-toggle-button",
|
|
2320
|
+
"description": "Use a split panel toggle button to control a parent panel's open/closed state\n\n\n---\n\n\n",
|
|
2321
|
+
"attributes": [
|
|
2322
|
+
{
|
|
2323
|
+
"name": "name",
|
|
2324
|
+
"description": "The icon to use for the button.",
|
|
2253
2325
|
"values": []
|
|
2254
2326
|
},
|
|
2255
2327
|
{
|
|
2256
|
-
"name": "
|
|
2257
|
-
"description": "
|
|
2328
|
+
"name": "library",
|
|
2329
|
+
"description": "The icon library to use for the button icon.",
|
|
2330
|
+
"values": []
|
|
2331
|
+
},
|
|
2332
|
+
{
|
|
2333
|
+
"name": "closed",
|
|
2334
|
+
"description": "Set to control the open/closed state of the parent split pane.",
|
|
2258
2335
|
"values": []
|
|
2259
2336
|
}
|
|
2260
2337
|
],
|
|
@@ -2293,61 +2370,32 @@
|
|
|
2293
2370
|
"references": []
|
|
2294
2371
|
},
|
|
2295
2372
|
{
|
|
2296
|
-
"name": "flow-ui-
|
|
2297
|
-
"description": "
|
|
2373
|
+
"name": "flow-ui-stepper-panel",
|
|
2374
|
+
"description": "Stepper panels provide a single page in a stepper to guide users through a series of steps.\n\n\n---\n\n\n",
|
|
2298
2375
|
"attributes": [
|
|
2299
2376
|
{
|
|
2300
|
-
"name": "
|
|
2301
|
-
"description": "The
|
|
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",
|
|
2377
|
+
"name": "name",
|
|
2378
|
+
"description": "The tab panel's name.",
|
|
2312
2379
|
"values": []
|
|
2313
2380
|
},
|
|
2314
2381
|
{
|
|
2315
|
-
"name": "
|
|
2316
|
-
"description": "
|
|
2382
|
+
"name": "title",
|
|
2383
|
+
"description": "The stepper panel's title.",
|
|
2317
2384
|
"values": []
|
|
2318
2385
|
},
|
|
2319
2386
|
{
|
|
2320
|
-
"name": "
|
|
2321
|
-
"description": "
|
|
2387
|
+
"name": "sub-title",
|
|
2388
|
+
"description": "The stepper panel's sub-title.",
|
|
2322
2389
|
"values": []
|
|
2323
2390
|
},
|
|
2324
2391
|
{
|
|
2325
|
-
"name": "
|
|
2326
|
-
"description": "
|
|
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.",
|
|
2392
|
+
"name": "active",
|
|
2393
|
+
"description": "When true, the stepper panel will be shown.",
|
|
2346
2394
|
"values": []
|
|
2347
2395
|
},
|
|
2348
2396
|
{
|
|
2349
|
-
"name": "
|
|
2350
|
-
"description": "
|
|
2397
|
+
"name": "complete",
|
|
2398
|
+
"description": "When true, the stepper panel is marked as complete",
|
|
2351
2399
|
"values": []
|
|
2352
2400
|
}
|
|
2353
2401
|
],
|
|
@@ -2376,40 +2424,62 @@
|
|
|
2376
2424
|
"references": []
|
|
2377
2425
|
},
|
|
2378
2426
|
{
|
|
2379
|
-
"name": "flow-ui-
|
|
2380
|
-
"description": "
|
|
2427
|
+
"name": "flow-ui-timer",
|
|
2428
|
+
"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.",
|
|
2381
2429
|
"attributes": [
|
|
2382
2430
|
{
|
|
2383
|
-
"name": "
|
|
2384
|
-
"description": "The
|
|
2385
|
-
"values": [
|
|
2386
|
-
{ "name": "" },
|
|
2387
|
-
{ "name": "primary" },
|
|
2388
|
-
{ "name": "secondary" },
|
|
2389
|
-
{ "name": "success" },
|
|
2390
|
-
{ "name": "neutral" },
|
|
2391
|
-
{ "name": "warning" },
|
|
2392
|
-
{ "name": "danger" },
|
|
2393
|
-
{ "name": "text" }
|
|
2394
|
-
]
|
|
2431
|
+
"name": "value",
|
|
2432
|
+
"description": "The value of the timer. (ISO8601 date/time string)",
|
|
2433
|
+
"values": []
|
|
2395
2434
|
},
|
|
2396
2435
|
{
|
|
2397
|
-
"name": "
|
|
2398
|
-
"description": "The
|
|
2399
|
-
"values": [
|
|
2400
|
-
{ "name": "small" },
|
|
2401
|
-
{ "name": "medium" },
|
|
2402
|
-
{ "name": "large" }
|
|
2403
|
-
]
|
|
2436
|
+
"name": "timezone",
|
|
2437
|
+
"description": "The timezone to use for display. (IANA timezone string).\nIf not set, the timezone will be the browser's local timezone.",
|
|
2438
|
+
"values": []
|
|
2404
2439
|
},
|
|
2405
2440
|
{
|
|
2406
|
-
"name": "
|
|
2407
|
-
"description": "
|
|
2441
|
+
"name": "locale",
|
|
2442
|
+
"description": "The locale to use for display. (IETF BCP 47 language tag).\nIf not set, the locale will be the browser's default locale.",
|
|
2408
2443
|
"values": []
|
|
2409
2444
|
},
|
|
2410
2445
|
{
|
|
2411
|
-
"name": "
|
|
2412
|
-
"description": "
|
|
2446
|
+
"name": "running",
|
|
2447
|
+
"description": "Set to `true` to start the timer running.",
|
|
2448
|
+
"values": []
|
|
2449
|
+
},
|
|
2450
|
+
{
|
|
2451
|
+
"name": "dateFormat",
|
|
2452
|
+
"description": "The date format to use for display as a [Luxon format string](https://moment.github.io/luxon/#/formatting?id=table-of-tokens).",
|
|
2453
|
+
"values": []
|
|
2454
|
+
},
|
|
2455
|
+
{
|
|
2456
|
+
"name": "dayFormat",
|
|
2457
|
+
"description": "The day format to use for display as a [Luxon format string](https://moment.github.io/luxon/#/formatting?id=table-of-tokens).",
|
|
2458
|
+
"values": []
|
|
2459
|
+
},
|
|
2460
|
+
{
|
|
2461
|
+
"name": "timeFormat",
|
|
2462
|
+
"description": "The time format to use for display as a [Luxon format string](https://moment.github.io/luxon/#/formatting?id=table-of-tokens).",
|
|
2463
|
+
"values": []
|
|
2464
|
+
},
|
|
2465
|
+
{
|
|
2466
|
+
"name": "zoneFormat",
|
|
2467
|
+
"description": "The timezone format to use for display as a [Luxon format string](https://moment.github.io/luxon/#/formatting?id=table-of-tokens).",
|
|
2468
|
+
"values": []
|
|
2469
|
+
},
|
|
2470
|
+
{
|
|
2471
|
+
"name": "major-step",
|
|
2472
|
+
"description": "The major step size to use for the timer step controls.",
|
|
2473
|
+
"values": []
|
|
2474
|
+
},
|
|
2475
|
+
{
|
|
2476
|
+
"name": "minor-step",
|
|
2477
|
+
"description": "The minor step size to use for the timer step controls.",
|
|
2478
|
+
"values": []
|
|
2479
|
+
},
|
|
2480
|
+
{
|
|
2481
|
+
"name": "hide-zone",
|
|
2482
|
+
"description": "Set to `true` to hide the timezone display.",
|
|
2413
2483
|
"values": []
|
|
2414
2484
|
}
|
|
2415
2485
|
],
|
|
@@ -2565,65 +2635,62 @@
|
|
|
2565
2635
|
"references": []
|
|
2566
2636
|
},
|
|
2567
2637
|
{
|
|
2568
|
-
"name": "flow-ui-
|
|
2569
|
-
"description": "
|
|
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",
|
|
2638
|
+
"name": "flow-ui-tag",
|
|
2639
|
+
"description": "Tags are used as labels to organize things or to indicate a selection.\n\n\n---\n\n\n\n\n### **Events:**\n - **flow-ui-remove** - Emitted when the remove button is activated.\n\n### **Slots:**\n - _default_ - The tag's content.\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.\n- **content** - The tag's content.\n- **remove-button** - The tag's remove button, an `<flow-ui-icon-button>`.\n- **remove-button__base** - The remove button's exported `base` part.",
|
|
2576
2640
|
"attributes": [
|
|
2577
2641
|
{
|
|
2578
|
-
"name": "
|
|
2579
|
-
"description": "The
|
|
2580
|
-
"values": [
|
|
2581
|
-
|
|
2582
|
-
|
|
2583
|
-
|
|
2584
|
-
|
|
2585
|
-
|
|
2642
|
+
"name": "variant",
|
|
2643
|
+
"description": "The tag's theme variant.",
|
|
2644
|
+
"values": [
|
|
2645
|
+
{ "name": "" },
|
|
2646
|
+
{ "name": "primary" },
|
|
2647
|
+
{ "name": "secondary" },
|
|
2648
|
+
{ "name": "success" },
|
|
2649
|
+
{ "name": "neutral" },
|
|
2650
|
+
{ "name": "warning" },
|
|
2651
|
+
{ "name": "danger" },
|
|
2652
|
+
{ "name": "text" }
|
|
2653
|
+
]
|
|
2586
2654
|
},
|
|
2587
2655
|
{
|
|
2588
|
-
"name": "
|
|
2589
|
-
"description": "The
|
|
2590
|
-
"values": [
|
|
2656
|
+
"name": "size",
|
|
2657
|
+
"description": "The tag's size.",
|
|
2658
|
+
"values": [
|
|
2659
|
+
{ "name": "small" },
|
|
2660
|
+
{ "name": "medium" },
|
|
2661
|
+
{ "name": "large" }
|
|
2662
|
+
]
|
|
2591
2663
|
},
|
|
2592
2664
|
{
|
|
2593
|
-
"name": "
|
|
2594
|
-
"description": "
|
|
2665
|
+
"name": "pill",
|
|
2666
|
+
"description": "Draws a pill-style tag with rounded edges.",
|
|
2595
2667
|
"values": []
|
|
2596
2668
|
},
|
|
2597
2669
|
{
|
|
2598
|
-
"name": "
|
|
2599
|
-
"description": "
|
|
2670
|
+
"name": "removable",
|
|
2671
|
+
"description": "Makes the tag removable and shows a remove button.",
|
|
2600
2672
|
"values": []
|
|
2601
2673
|
}
|
|
2602
2674
|
],
|
|
2603
2675
|
"references": []
|
|
2604
2676
|
},
|
|
2605
2677
|
{
|
|
2606
|
-
"name": "flow-ui-tool-button
|
|
2607
|
-
"description": "Tool buttons
|
|
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.",
|
|
2608
2680
|
"attributes": [
|
|
2609
2681
|
{
|
|
2610
|
-
"name": "
|
|
2611
|
-
"description": "The radio
|
|
2682
|
+
"name": "value",
|
|
2683
|
+
"description": "The radio's value. When selected, the radio group will receive this value.",
|
|
2612
2684
|
"values": []
|
|
2613
2685
|
},
|
|
2614
2686
|
{
|
|
2615
|
-
"name": "
|
|
2616
|
-
"description": "
|
|
2687
|
+
"name": "disabled",
|
|
2688
|
+
"description": "Disables the radio button.",
|
|
2617
2689
|
"values": []
|
|
2618
2690
|
},
|
|
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
2691
|
{
|
|
2625
2692
|
"name": "size",
|
|
2626
|
-
"description": "The radio
|
|
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.",
|
|
2627
2694
|
"values": [
|
|
2628
2695
|
{ "name": "x-small" },
|
|
2629
2696
|
{ "name": "small" },
|
|
@@ -2633,100 +2700,140 @@
|
|
|
2633
2700
|
},
|
|
2634
2701
|
{
|
|
2635
2702
|
"name": "pill",
|
|
2636
|
-
"description": "Draws pill-style
|
|
2703
|
+
"description": "Draws a pill-style radio button with rounded edges.",
|
|
2637
2704
|
"values": []
|
|
2638
2705
|
},
|
|
2639
2706
|
{
|
|
2640
2707
|
"name": "outline",
|
|
2641
|
-
"description": "Draws
|
|
2708
|
+
"description": "Draws an tool button with with an outline.",
|
|
2642
2709
|
"values": []
|
|
2643
2710
|
},
|
|
2644
2711
|
{
|
|
2645
|
-
"name": "
|
|
2646
|
-
"
|
|
2647
|
-
|
|
2648
|
-
|
|
2649
|
-
|
|
2650
|
-
|
|
2651
|
-
|
|
2652
|
-
|
|
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",
|
|
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.",
|
|
2719
|
+
"values": [
|
|
2720
|
+
{ "name": "" },
|
|
2721
|
+
{ "name": "top" },
|
|
2722
|
+
{ "name": "top-start" },
|
|
2723
|
+
{ "name": "top-end" },
|
|
2724
|
+
{ "name": "right" },
|
|
2725
|
+
{ "name": "right-start" },
|
|
2726
|
+
{ "name": "right-end" },
|
|
2727
|
+
{ "name": "bottom" },
|
|
2728
|
+
{ "name": "bottom-start" },
|
|
2729
|
+
{ "name": "bottom-end" },
|
|
2730
|
+
{ "name": "left" },
|
|
2731
|
+
{ "name": "left-start" },
|
|
2732
|
+
{ "name": "left-end" }
|
|
2653
2733
|
]
|
|
2654
2734
|
},
|
|
2655
2735
|
{
|
|
2656
|
-
"name": "
|
|
2657
|
-
"description": "
|
|
2736
|
+
"name": "tooltip-distance",
|
|
2737
|
+
"description": "The distance in pixels from which to offset the tooltip away from the button.",
|
|
2658
2738
|
"values": []
|
|
2659
2739
|
},
|
|
2660
2740
|
{
|
|
2661
|
-
"name": "
|
|
2662
|
-
"description": "
|
|
2741
|
+
"name": "tooltip-skidding",
|
|
2742
|
+
"description": "The distance in pixels from which to offset the tooltip along the button.",
|
|
2663
2743
|
"values": []
|
|
2664
2744
|
},
|
|
2665
2745
|
{
|
|
2666
|
-
"name": "
|
|
2667
|
-
"
|
|
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.",
|
|
2748
|
+
"values": []
|
|
2749
|
+
},
|
|
2750
|
+
{
|
|
2751
|
+
"name": "icon-src",
|
|
2752
|
+
"description": "Specify an external SVG file to display as an icon above the tool button label.",
|
|
2753
|
+
"values": []
|
|
2754
|
+
},
|
|
2755
|
+
{
|
|
2756
|
+
"name": "icon-library",
|
|
2757
|
+
"description": "The name of a registered custom icon library.",
|
|
2758
|
+
"values": []
|
|
2759
|
+
},
|
|
2760
|
+
{
|
|
2761
|
+
"name": "variant",
|
|
2762
|
+
"values": [
|
|
2763
|
+
{ "name": "primary" },
|
|
2764
|
+
{ "name": "secondary" },
|
|
2765
|
+
{ "name": "success" },
|
|
2766
|
+
{ "name": "warning" },
|
|
2767
|
+
{ "name": "danger" },
|
|
2768
|
+
{ "name": "neutral" }
|
|
2769
|
+
]
|
|
2668
2770
|
}
|
|
2669
2771
|
],
|
|
2670
2772
|
"references": []
|
|
2671
2773
|
},
|
|
2672
2774
|
{
|
|
2673
|
-
"name": "flow-ui-
|
|
2674
|
-
"description": "
|
|
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.",
|
|
2675
2777
|
"attributes": [
|
|
2676
2778
|
{
|
|
2677
|
-
"name": "
|
|
2678
|
-
"description": "The
|
|
2679
|
-
"values": []
|
|
2680
|
-
},
|
|
2681
|
-
{
|
|
2682
|
-
"name": "timezone",
|
|
2683
|
-
"description": "The timezone to use for display. (IANA timezone string).\nIf not set, the timezone will be the browser's local timezone.",
|
|
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.",
|
|
2684
2781
|
"values": []
|
|
2685
2782
|
},
|
|
2686
2783
|
{
|
|
2687
|
-
"name": "
|
|
2688
|
-
"description": "The
|
|
2784
|
+
"name": "name",
|
|
2785
|
+
"description": "The name of the tool button group, submitted as a name/value pair with form data.",
|
|
2689
2786
|
"values": []
|
|
2690
2787
|
},
|
|
2691
2788
|
{
|
|
2692
|
-
"name": "
|
|
2693
|
-
"description": "
|
|
2694
|
-
"values": []
|
|
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[]" }]
|
|
2695
2792
|
},
|
|
2696
2793
|
{
|
|
2697
|
-
"name": "
|
|
2698
|
-
"description": "The
|
|
2699
|
-
"values": [
|
|
2794
|
+
"name": "size",
|
|
2795
|
+
"description": "The radio group's size. This size will be applied to all child radios and radio buttons.",
|
|
2796
|
+
"values": [
|
|
2797
|
+
{ "name": "x-small" },
|
|
2798
|
+
{ "name": "small" },
|
|
2799
|
+
{ "name": "medium" },
|
|
2800
|
+
{ "name": "large" }
|
|
2801
|
+
]
|
|
2700
2802
|
},
|
|
2701
2803
|
{
|
|
2702
|
-
"name": "
|
|
2703
|
-
"description": "
|
|
2804
|
+
"name": "pill",
|
|
2805
|
+
"description": "Draws pill-style tool buttons. This style will be applied to all child tool buttons.",
|
|
2704
2806
|
"values": []
|
|
2705
2807
|
},
|
|
2706
2808
|
{
|
|
2707
|
-
"name": "
|
|
2708
|
-
"description": "
|
|
2809
|
+
"name": "outline",
|
|
2810
|
+
"description": "Draws outline-style tool buttons. This style will be applied to all child tool buttons.",
|
|
2709
2811
|
"values": []
|
|
2710
2812
|
},
|
|
2711
2813
|
{
|
|
2712
|
-
"name": "
|
|
2713
|
-
"
|
|
2714
|
-
|
|
2814
|
+
"name": "variant",
|
|
2815
|
+
"values": [
|
|
2816
|
+
{ "name": "primary" },
|
|
2817
|
+
{ "name": "secondary" },
|
|
2818
|
+
{ "name": "success" },
|
|
2819
|
+
{ "name": "warning" },
|
|
2820
|
+
{ "name": "danger" },
|
|
2821
|
+
{ "name": "neutral" }
|
|
2822
|
+
]
|
|
2715
2823
|
},
|
|
2716
2824
|
{
|
|
2717
|
-
"name": "
|
|
2718
|
-
"description": "
|
|
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.",
|
|
2719
2827
|
"values": []
|
|
2720
2828
|
},
|
|
2721
2829
|
{
|
|
2722
|
-
"name": "
|
|
2723
|
-
"description": "
|
|
2830
|
+
"name": "vertical",
|
|
2831
|
+
"description": "Use vertical layout for the radio group.",
|
|
2724
2832
|
"values": []
|
|
2725
2833
|
},
|
|
2726
2834
|
{
|
|
2727
|
-
"name": "
|
|
2728
|
-
"
|
|
2729
|
-
"values": []
|
|
2835
|
+
"name": "mode",
|
|
2836
|
+
"values": [{ "name": "radio" }, { "name": "checkbox" }]
|
|
2730
2837
|
}
|
|
2731
2838
|
],
|
|
2732
2839
|
"references": []
|
|
@@ -2762,107 +2869,63 @@
|
|
|
2762
2869
|
"references": []
|
|
2763
2870
|
},
|
|
2764
2871
|
{
|
|
2765
|
-
"name": "flow-ui-
|
|
2766
|
-
"description": "
|
|
2872
|
+
"name": "flow-ui-tree-item",
|
|
2873
|
+
"description": "A tree item serves as a hierarchical node that lives inside a [tree](/components/tree).\n\n\n---\n\n\n\n\n### **Events:**\n - **flow-ui-expand** - Emitted when the tree item expands.\n- **flow-ui-after-expand** - Emitted after the tree item expands and all animations are complete.\n- **flow-ui-collapse** - Emitted when the tree item collapses.\n- **flow-ui-after-collapse** - Emitted after the tree item collapses and all animations are complete.\n- **flow-ui-lazy-change** - Emitted when the tree item's lazy state changes.\n- **flow-ui-lazy-load** - Emitted when a lazy item is selected. Use this event to asynchronously load data and append items to the tree before expanding. After appending new items, remove the `lazy` attribute to remove the loading state and update the tree.\n\n### **Methods:**\n - **getChildrenItems({ includeDisabled = true }: _{ includeDisabled?: boolean }_): _FlowUiTreeItem[]_** - Gets all the nested tree items in this node.\n\n### **Slots:**\n - _default_ - The default slot.\n- **expand-icon** - The icon to show when the tree item is expanded.\n- **collapse-icon** - The icon to show when the tree item is collapsed.\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.\n- **item** - The tree item's container. This element wraps everything except slotted tree item children.\n- **item--disabled** - Applied when the tree item is disabled.\n- **item--expanded** - Applied when the tree item is expanded.\n- **item--indeterminate** - Applied when the selection is indeterminate.\n- **item--selected** - Applied when the tree item is selected.\n- **indentation** - The tree item's indentation container.\n- **expand-button** - The container that wraps the tree item's expand button and spinner.\n- **label** - The tree item's label.\n- **children** - The container that wraps the tree item's nested children.\n- **checkbox** - The checkbox that shows when using multiselect.\n- **checkbox__base** - The checkbox's exported `base` part.\n- **checkbox__control** - The checkbox's exported `control` part.\n- **checkbox__control--checked** - The checkbox's exported `control--checked` part.\n- **checkbox__control--indeterminate** - The checkbox's exported `control--indeterminate` part.\n- **checkbox__checked-icon** - The checkbox's exported `checked-icon` part.\n- **checkbox__indeterminate-icon** - The checkbox's exported `indeterminate-icon` part.\n- **checkbox__label** - The checkbox's exported `label` part.",
|
|
2767
2874
|
"attributes": [
|
|
2768
2875
|
{
|
|
2769
|
-
"name": "
|
|
2770
|
-
"description": "The
|
|
2771
|
-
"values": []
|
|
2772
|
-
},
|
|
2773
|
-
{
|
|
2774
|
-
"name": "placement",
|
|
2775
|
-
"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
|
-
"values": [
|
|
2777
|
-
{ "name": "" },
|
|
2778
|
-
{ "name": "top" },
|
|
2779
|
-
{ "name": "top-start" },
|
|
2780
|
-
{ "name": "top-end" },
|
|
2781
|
-
{ "name": "right" },
|
|
2782
|
-
{ "name": "right-start" },
|
|
2783
|
-
{ "name": "right-end" },
|
|
2784
|
-
{ "name": "bottom" },
|
|
2785
|
-
{ "name": "bottom-start" },
|
|
2786
|
-
{ "name": "bottom-end" },
|
|
2787
|
-
{ "name": "left" },
|
|
2788
|
-
{ "name": "left-start" },
|
|
2789
|
-
{ "name": "left-end" }
|
|
2790
|
-
]
|
|
2791
|
-
},
|
|
2792
|
-
{
|
|
2793
|
-
"name": "disabled",
|
|
2794
|
-
"description": "Disables the tooltip so it won't show when triggered.",
|
|
2795
|
-
"values": []
|
|
2796
|
-
},
|
|
2797
|
-
{
|
|
2798
|
-
"name": "distance",
|
|
2799
|
-
"description": "The distance in pixels from which to offset the tooltip away from its target.",
|
|
2800
|
-
"values": []
|
|
2801
|
-
},
|
|
2802
|
-
{
|
|
2803
|
-
"name": "open",
|
|
2804
|
-
"description": "Indicates whether or not the tooltip is open. You can use this in lieu of the show/hide methods.",
|
|
2876
|
+
"name": "value",
|
|
2877
|
+
"description": "The tree-items's value. When selected, the containing tree control will receive this value. The value must be unique\nfrom other tree-items in the same tree. Values may not contain spaces, as spaces are used as delimiters when listing\nmultiple values.",
|
|
2805
2878
|
"values": []
|
|
2806
2879
|
},
|
|
2807
2880
|
{
|
|
2808
|
-
"name": "
|
|
2809
|
-
"description": "
|
|
2881
|
+
"name": "expanded",
|
|
2882
|
+
"description": "Expands the tree item.",
|
|
2810
2883
|
"values": []
|
|
2811
2884
|
},
|
|
2812
2885
|
{
|
|
2813
|
-
"name": "
|
|
2814
|
-
"description": "
|
|
2886
|
+
"name": "selected",
|
|
2887
|
+
"description": "Draws the tree item in a selected state.",
|
|
2815
2888
|
"values": []
|
|
2816
2889
|
},
|
|
2817
2890
|
{
|
|
2818
|
-
"name": "
|
|
2819
|
-
"description": "
|
|
2820
|
-
"values": []
|
|
2821
|
-
}
|
|
2822
|
-
],
|
|
2823
|
-
"references": []
|
|
2824
|
-
},
|
|
2825
|
-
{
|
|
2826
|
-
"name": "flow-ui-tool-button",
|
|
2827
|
-
"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.",
|
|
2828
|
-
"attributes": [
|
|
2829
|
-
{
|
|
2830
|
-
"name": "value",
|
|
2831
|
-
"description": "The radio's value. When selected, the radio group will receive this value.",
|
|
2891
|
+
"name": "disabled",
|
|
2892
|
+
"description": "Disables the tree item.",
|
|
2832
2893
|
"values": []
|
|
2833
2894
|
},
|
|
2834
2895
|
{
|
|
2835
|
-
"name": "
|
|
2836
|
-
"description": "
|
|
2896
|
+
"name": "lazy",
|
|
2897
|
+
"description": "Enables lazy loading behavior.",
|
|
2837
2898
|
"values": []
|
|
2838
2899
|
},
|
|
2839
2900
|
{
|
|
2840
2901
|
"name": "size",
|
|
2841
|
-
"description": "The
|
|
2902
|
+
"description": "The select's size.",
|
|
2842
2903
|
"values": [
|
|
2843
|
-
{ "name": "x-small" },
|
|
2844
2904
|
{ "name": "small" },
|
|
2845
2905
|
{ "name": "medium" },
|
|
2846
2906
|
{ "name": "large" }
|
|
2847
2907
|
]
|
|
2848
|
-
}
|
|
2849
|
-
|
|
2850
|
-
|
|
2851
|
-
|
|
2852
|
-
|
|
2853
|
-
|
|
2854
|
-
|
|
2855
|
-
|
|
2856
|
-
|
|
2857
|
-
|
|
2858
|
-
|
|
2908
|
+
}
|
|
2909
|
+
],
|
|
2910
|
+
"references": []
|
|
2911
|
+
},
|
|
2912
|
+
{
|
|
2913
|
+
"name": "flow-ui-visually-hidden",
|
|
2914
|
+
"description": "The visually hidden utility makes content accessible to assistive devices without displaying it on the screen.\n\n\n---\n\n\n\n\n### **Slots:**\n - _default_ - The content to be visually hidden.",
|
|
2915
|
+
"attributes": [],
|
|
2916
|
+
"references": []
|
|
2917
|
+
},
|
|
2918
|
+
{
|
|
2919
|
+
"name": "flow-ui-tooltip",
|
|
2920
|
+
"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.",
|
|
2921
|
+
"attributes": [
|
|
2859
2922
|
{
|
|
2860
|
-
"name": "
|
|
2861
|
-
"description": "
|
|
2923
|
+
"name": "content",
|
|
2924
|
+
"description": "The tooltip's content. If you need to display HTML, use the `content` slot instead.",
|
|
2862
2925
|
"values": []
|
|
2863
2926
|
},
|
|
2864
2927
|
{
|
|
2865
|
-
"name": "
|
|
2928
|
+
"name": "placement",
|
|
2866
2929
|
"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
2930
|
"values": [
|
|
2868
2931
|
{ "name": "" },
|
|
@@ -2881,90 +2944,37 @@
|
|
|
2881
2944
|
]
|
|
2882
2945
|
},
|
|
2883
2946
|
{
|
|
2884
|
-
"name": "
|
|
2885
|
-
"description": "
|
|
2886
|
-
"values": []
|
|
2887
|
-
},
|
|
2888
|
-
{
|
|
2889
|
-
"name": "tooltip-skidding",
|
|
2890
|
-
"description": "The distance in pixels from which to offset the tooltip along the button.",
|
|
2891
|
-
"values": []
|
|
2892
|
-
},
|
|
2893
|
-
{
|
|
2894
|
-
"name": "icon",
|
|
2895
|
-
"description": "Specify an icon by name to display above the tool button label. Available names depend on the icon library being used.",
|
|
2896
|
-
"values": []
|
|
2897
|
-
},
|
|
2898
|
-
{
|
|
2899
|
-
"name": "icon-src",
|
|
2900
|
-
"description": "Specify an external SVG file to display as an icon above the tool button label.",
|
|
2901
|
-
"values": []
|
|
2902
|
-
},
|
|
2903
|
-
{
|
|
2904
|
-
"name": "icon-library",
|
|
2905
|
-
"description": "The name of a registered custom icon library.",
|
|
2947
|
+
"name": "disabled",
|
|
2948
|
+
"description": "Disables the tooltip so it won't show when triggered.",
|
|
2906
2949
|
"values": []
|
|
2907
2950
|
},
|
|
2908
2951
|
{
|
|
2909
|
-
"name": "
|
|
2910
|
-
"
|
|
2911
|
-
{ "name": "primary" },
|
|
2912
|
-
{ "name": "secondary" },
|
|
2913
|
-
{ "name": "success" },
|
|
2914
|
-
{ "name": "warning" },
|
|
2915
|
-
{ "name": "danger" },
|
|
2916
|
-
{ "name": "neutral" }
|
|
2917
|
-
]
|
|
2918
|
-
}
|
|
2919
|
-
],
|
|
2920
|
-
"references": []
|
|
2921
|
-
},
|
|
2922
|
-
{
|
|
2923
|
-
"name": "flow-ui-tree-item",
|
|
2924
|
-
"description": "A tree item serves as a hierarchical node that lives inside a [tree](/components/tree).\n\n\n---\n\n\n\n\n### **Events:**\n - **flow-ui-expand** - Emitted when the tree item expands.\n- **flow-ui-after-expand** - Emitted after the tree item expands and all animations are complete.\n- **flow-ui-collapse** - Emitted when the tree item collapses.\n- **flow-ui-after-collapse** - Emitted after the tree item collapses and all animations are complete.\n- **flow-ui-lazy-change** - Emitted when the tree item's lazy state changes.\n- **flow-ui-lazy-load** - Emitted when a lazy item is selected. Use this event to asynchronously load data and append items to the tree before expanding. After appending new items, remove the `lazy` attribute to remove the loading state and update the tree.\n\n### **Methods:**\n - **getChildrenItems({ includeDisabled = true }: _{ includeDisabled?: boolean }_): _FlowUiTreeItem[]_** - Gets all the nested tree items in this node.\n\n### **Slots:**\n - _default_ - The default slot.\n- **expand-icon** - The icon to show when the tree item is expanded.\n- **collapse-icon** - The icon to show when the tree item is collapsed.\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.\n- **item** - The tree item's container. This element wraps everything except slotted tree item children.\n- **item--disabled** - Applied when the tree item is disabled.\n- **item--expanded** - Applied when the tree item is expanded.\n- **item--indeterminate** - Applied when the selection is indeterminate.\n- **item--selected** - Applied when the tree item is selected.\n- **indentation** - The tree item's indentation container.\n- **expand-button** - The container that wraps the tree item's expand button and spinner.\n- **label** - The tree item's label.\n- **children** - The container that wraps the tree item's nested children.\n- **checkbox** - The checkbox that shows when using multiselect.\n- **checkbox__base** - The checkbox's exported `base` part.\n- **checkbox__control** - The checkbox's exported `control` part.\n- **checkbox__control--checked** - The checkbox's exported `control--checked` part.\n- **checkbox__control--indeterminate** - The checkbox's exported `control--indeterminate` part.\n- **checkbox__checked-icon** - The checkbox's exported `checked-icon` part.\n- **checkbox__indeterminate-icon** - The checkbox's exported `indeterminate-icon` part.\n- **checkbox__label** - The checkbox's exported `label` part.",
|
|
2925
|
-
"attributes": [
|
|
2926
|
-
{
|
|
2927
|
-
"name": "value",
|
|
2928
|
-
"description": "The tree-items's value. When selected, the containing tree control will receive this value. The value must be unique\nfrom other tree-items in the same tree. Values may not contain spaces, as spaces are used as delimiters when listing\nmultiple values.",
|
|
2952
|
+
"name": "distance",
|
|
2953
|
+
"description": "The distance in pixels from which to offset the tooltip away from its target.",
|
|
2929
2954
|
"values": []
|
|
2930
2955
|
},
|
|
2931
2956
|
{
|
|
2932
|
-
"name": "
|
|
2933
|
-
"description": "
|
|
2957
|
+
"name": "open",
|
|
2958
|
+
"description": "Indicates whether or not the tooltip is open. You can use this in lieu of the show/hide methods.",
|
|
2934
2959
|
"values": []
|
|
2935
2960
|
},
|
|
2936
2961
|
{
|
|
2937
|
-
"name": "
|
|
2938
|
-
"description": "
|
|
2962
|
+
"name": "skidding",
|
|
2963
|
+
"description": "The distance in pixels from which to offset the tooltip along its target.",
|
|
2939
2964
|
"values": []
|
|
2940
2965
|
},
|
|
2941
2966
|
{
|
|
2942
|
-
"name": "
|
|
2943
|
-
"description": "
|
|
2967
|
+
"name": "trigger",
|
|
2968
|
+
"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.",
|
|
2944
2969
|
"values": []
|
|
2945
2970
|
},
|
|
2946
2971
|
{
|
|
2947
|
-
"name": "
|
|
2948
|
-
"description": "
|
|
2972
|
+
"name": "hoist",
|
|
2973
|
+
"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.",
|
|
2949
2974
|
"values": []
|
|
2950
|
-
},
|
|
2951
|
-
{
|
|
2952
|
-
"name": "size",
|
|
2953
|
-
"description": "The select's size.",
|
|
2954
|
-
"values": [
|
|
2955
|
-
{ "name": "small" },
|
|
2956
|
-
{ "name": "medium" },
|
|
2957
|
-
{ "name": "large" }
|
|
2958
|
-
]
|
|
2959
2975
|
}
|
|
2960
2976
|
],
|
|
2961
2977
|
"references": []
|
|
2962
|
-
},
|
|
2963
|
-
{
|
|
2964
|
-
"name": "flow-ui-visually-hidden",
|
|
2965
|
-
"description": "The visually hidden utility makes content accessible to assistive devices without displaying it on the screen.\n\n\n---\n\n\n\n\n### **Slots:**\n - _default_ - The content to be visually hidden.",
|
|
2966
|
-
"attributes": [],
|
|
2967
|
-
"references": []
|
|
2968
2978
|
}
|
|
2969
2979
|
]
|
|
2970
2980
|
}
|