@emuanalytics/flow-rdf-ui 0.0.36 → 0.0.37
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 +6817 -6817
- package/dist/index.cjs +1 -6
- package/dist/index.d.cts +0 -1
- package/dist/index.d.mts +0 -1
- package/dist/index.d.ts +0 -1
- package/dist/index.mjs +1 -2
- package/dist/vscode.html-custom-data.json +457 -457
- package/package.json +1 -1
|
@@ -34,6 +34,18 @@
|
|
|
34
34
|
],
|
|
35
35
|
"references": []
|
|
36
36
|
},
|
|
37
|
+
{
|
|
38
|
+
"name": "flow-ui-breadcrumb",
|
|
39
|
+
"description": "Breadcrumbs provide a group of links so users can easily navigate a website's hierarchy.\n\n\n---\n\n\n\n\n### **Slots:**\n - _default_ - One or more breadcrumb items to display.\n- **separator** - The separator to use between breadcrumb items. Works best with `<flow-ui-icon>`.\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.",
|
|
40
|
+
"attributes": [
|
|
41
|
+
{
|
|
42
|
+
"name": "label",
|
|
43
|
+
"description": "The label to use for the breadcrumb control. This will not be shown on the screen, but it will be announced by\nscreen readers and other assistive devices to provide more context for users.",
|
|
44
|
+
"values": []
|
|
45
|
+
}
|
|
46
|
+
],
|
|
47
|
+
"references": []
|
|
48
|
+
},
|
|
37
49
|
{
|
|
38
50
|
"name": "flow-ui-avatar",
|
|
39
51
|
"description": "Avatars are used to represent a person or object.\n\n\n---\n\n\n\n\n### **Slots:**\n - **icon** - The default icon to use when no image or initials are present. Works best with `<flow-ui-icon>`.\n\n### **CSS Properties:**\n - **--size** - The size of the avatar. _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.\n- **icon** - The container that wraps the avatar's icon.\n- **initials** - The container that wraps the avatar's initials.\n- **image** - The avatar image. Only shown when the `image` attribute is set.",
|
|
@@ -98,18 +110,6 @@
|
|
|
98
110
|
],
|
|
99
111
|
"references": []
|
|
100
112
|
},
|
|
101
|
-
{
|
|
102
|
-
"name": "flow-ui-breadcrumb",
|
|
103
|
-
"description": "Breadcrumbs provide a group of links so users can easily navigate a website's hierarchy.\n\n\n---\n\n\n\n\n### **Slots:**\n - _default_ - One or more breadcrumb items to display.\n- **separator** - The separator to use between breadcrumb items. Works best with `<flow-ui-icon>`.\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.",
|
|
104
|
-
"attributes": [
|
|
105
|
-
{
|
|
106
|
-
"name": "label",
|
|
107
|
-
"description": "The label to use for the breadcrumb control. This will not be shown on the screen, but it will be announced by\nscreen readers and other assistive devices to provide more context for users.",
|
|
108
|
-
"values": []
|
|
109
|
-
}
|
|
110
|
-
],
|
|
111
|
-
"references": []
|
|
112
|
-
},
|
|
113
113
|
{
|
|
114
114
|
"name": "flow-ui-breadcrumb-item",
|
|
115
115
|
"description": "Breadcrumb Items are used inside [breadcrumbs](/components/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.",
|
|
@@ -137,6 +137,19 @@
|
|
|
137
137
|
],
|
|
138
138
|
"references": []
|
|
139
139
|
},
|
|
140
|
+
{
|
|
141
|
+
"name": "flow-ui-button-group",
|
|
142
|
+
"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.",
|
|
143
|
+
"attributes": [
|
|
144
|
+
{ "name": "label", "values": [] },
|
|
145
|
+
{
|
|
146
|
+
"name": "vertical",
|
|
147
|
+
"description": "Use vertical layout for the button group.",
|
|
148
|
+
"values": []
|
|
149
|
+
}
|
|
150
|
+
],
|
|
151
|
+
"references": []
|
|
152
|
+
},
|
|
140
153
|
{
|
|
141
154
|
"name": "flow-ui-button",
|
|
142
155
|
"description": "Buttons represent actions that are available to the user.\n\n\n---\n\n\n\n\n### **Events:**\n - **flow-ui-blur** - Emitted when the button loses focus.\n- **flow-ui-focus** - Emitted when the button gains focus.\n- **flow-ui-invalid** - Emitted when the form control has been checked for validity and its constraints aren't satisfied.\n\n### **Methods:**\n - **click()** - Simulates a click on the button.\n- **focus(options: _FocusOptions_)** - Sets focus on the button.\n- **blur()** - Removes focus from the button.\n- **checkValidity()** - Checks for validity but does not show a validation message. Returns `true` when valid and `false` when invalid.\n- **getForm(): _HTMLFormElement | null_** - Gets the associated form, if one exists.\n- **reportValidity()** - Checks for validity and shows the browser's validation message if the control is invalid.\n- **setCustomValidity(message: _string_)** - Sets a custom validation message. Pass an empty string to restore validity.\n\n### **Slots:**\n - _default_ - The button's label.\n- **prefix** - A presentational prefix icon or similar element.\n- **suffix** - A presentational suffix icon or similar element.\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.\n- **prefix** - The container that wraps the prefix.\n- **label** - The button's label.\n- **suffix** - The container that wraps the suffix.\n- **caret** - The button's caret icon, an `<flow-ui-icon>` element.",
|
|
@@ -287,19 +300,6 @@
|
|
|
287
300
|
],
|
|
288
301
|
"references": []
|
|
289
302
|
},
|
|
290
|
-
{
|
|
291
|
-
"name": "flow-ui-button-group",
|
|
292
|
-
"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.",
|
|
293
|
-
"attributes": [
|
|
294
|
-
{ "name": "label", "values": [] },
|
|
295
|
-
{
|
|
296
|
-
"name": "vertical",
|
|
297
|
-
"description": "Use vertical layout for the button group.",
|
|
298
|
-
"values": []
|
|
299
|
-
}
|
|
300
|
-
],
|
|
301
|
-
"references": []
|
|
302
|
-
},
|
|
303
303
|
{
|
|
304
304
|
"name": "flow-ui-calendar",
|
|
305
305
|
"description": "A calendar component for selecting dates and times.\n\n\n---\n\n\n",
|
|
@@ -417,121 +417,6 @@
|
|
|
417
417
|
],
|
|
418
418
|
"references": []
|
|
419
419
|
},
|
|
420
|
-
{
|
|
421
|
-
"name": "flow-ui-checkbox",
|
|
422
|
-
"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.",
|
|
423
|
-
"attributes": [
|
|
424
|
-
{ "name": "title", "values": [] },
|
|
425
|
-
{
|
|
426
|
-
"name": "name",
|
|
427
|
-
"description": "The name of the checkbox, submitted as a name/value pair with form data.",
|
|
428
|
-
"values": []
|
|
429
|
-
},
|
|
430
|
-
{
|
|
431
|
-
"name": "value",
|
|
432
|
-
"description": "The current value of the checkbox, submitted as a name/value pair with form data.",
|
|
433
|
-
"values": []
|
|
434
|
-
},
|
|
435
|
-
{
|
|
436
|
-
"name": "size",
|
|
437
|
-
"description": "The checkbox's size.",
|
|
438
|
-
"values": [
|
|
439
|
-
{ "name": "small" },
|
|
440
|
-
{ "name": "medium" },
|
|
441
|
-
{ "name": "large" }
|
|
442
|
-
]
|
|
443
|
-
},
|
|
444
|
-
{
|
|
445
|
-
"name": "disabled",
|
|
446
|
-
"description": "Disables the checkbox.",
|
|
447
|
-
"values": []
|
|
448
|
-
},
|
|
449
|
-
{
|
|
450
|
-
"name": "checked",
|
|
451
|
-
"description": "Draws the checkbox in a checked state.",
|
|
452
|
-
"values": []
|
|
453
|
-
},
|
|
454
|
-
{
|
|
455
|
-
"name": "indeterminate",
|
|
456
|
-
"description": "Draws the checkbox in an indeterminate state. This is usually applied to checkboxes that represents a \"select\nall/none\" behavior when associated checkboxes have a mix of checked and unchecked states.",
|
|
457
|
-
"values": []
|
|
458
|
-
},
|
|
459
|
-
{
|
|
460
|
-
"name": "form",
|
|
461
|
-
"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.",
|
|
462
|
-
"values": []
|
|
463
|
-
},
|
|
464
|
-
{
|
|
465
|
-
"name": "required",
|
|
466
|
-
"description": "Makes the checkbox a required field.",
|
|
467
|
-
"values": []
|
|
468
|
-
}
|
|
469
|
-
],
|
|
470
|
-
"references": []
|
|
471
|
-
},
|
|
472
|
-
{
|
|
473
|
-
"name": "flow-ui-color-mapper",
|
|
474
|
-
"description": "A component for defining mappings between data values and colors.\n\n\n---\n\n\n",
|
|
475
|
-
"attributes": [
|
|
476
|
-
{ "name": "field", "values": [] },
|
|
477
|
-
{ "name": "options", "values": [{ "name": "ColorMapperOptions" }] },
|
|
478
|
-
{ "name": "value", "values": [{ "name": "ColorMapperValue" }] },
|
|
479
|
-
{
|
|
480
|
-
"name": "size",
|
|
481
|
-
"values": [
|
|
482
|
-
{ "name": "small" },
|
|
483
|
-
{ "name": "medium" },
|
|
484
|
-
{ "name": "large" }
|
|
485
|
-
]
|
|
486
|
-
},
|
|
487
|
-
{ "name": "defaultColorStop", "values": [] },
|
|
488
|
-
{
|
|
489
|
-
"name": "swatches",
|
|
490
|
-
"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.",
|
|
491
|
-
"values": [{ "name": "string[]" }]
|
|
492
|
-
}
|
|
493
|
-
],
|
|
494
|
-
"references": []
|
|
495
|
-
},
|
|
496
|
-
{
|
|
497
|
-
"name": "flow-ui-color-stop",
|
|
498
|
-
"description": "A single color stop used by the `flow-ui-color-mapper` component.\n\n\n---\n\n\n",
|
|
499
|
-
"attributes": [
|
|
500
|
-
{
|
|
501
|
-
"name": "name",
|
|
502
|
-
"description": "The name of the color stop, submitted as a name/value pair with form data.",
|
|
503
|
-
"values": []
|
|
504
|
-
},
|
|
505
|
-
{
|
|
506
|
-
"name": "form",
|
|
507
|
-
"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.",
|
|
508
|
-
"values": []
|
|
509
|
-
},
|
|
510
|
-
{
|
|
511
|
-
"name": "required",
|
|
512
|
-
"description": "Makes the color stop as a required field.",
|
|
513
|
-
"values": []
|
|
514
|
-
},
|
|
515
|
-
{ "name": "options", "values": [{ "name": "ColorStopOptions" }] },
|
|
516
|
-
{ "name": "value", "values": [{ "name": "ColorStopValue" }] },
|
|
517
|
-
{
|
|
518
|
-
"name": "size",
|
|
519
|
-
"values": [
|
|
520
|
-
{ "name": "small" },
|
|
521
|
-
{ "name": "medium" },
|
|
522
|
-
{ "name": "large" }
|
|
523
|
-
]
|
|
524
|
-
},
|
|
525
|
-
{ "name": "placeholder", "values": [] },
|
|
526
|
-
{ "name": "fixed", "values": [] },
|
|
527
|
-
{
|
|
528
|
-
"name": "swatches",
|
|
529
|
-
"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.",
|
|
530
|
-
"values": [{ "name": "string[]" }]
|
|
531
|
-
}
|
|
532
|
-
],
|
|
533
|
-
"references": []
|
|
534
|
-
},
|
|
535
420
|
{
|
|
536
421
|
"name": "flow-ui-color-picker",
|
|
537
422
|
"description": "Color pickers allow the user to select a color.\n\n\n---\n\n\n\n\n### **Events:**\n - **flow-ui-blur** - Emitted when the color picker loses focus.\n- **flow-ui-change** - Emitted when the color picker's value changes.\n- **flow-ui-focus** - Emitted when the color picker receives focus.\n- **flow-ui-input** - Emitted when the color picker 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 color picker.\n- **blur()** - Removes focus from the color picker.\n- **getFormattedValue(format: _'hex' | 'hexa' | 'rgb' | 'rgba' | 'hsl' | 'hsla' | 'hsv' | 'hsva'_)** - Returns the current value as a string in the specified format.\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 color picker's form label. Alternatively, you can use the `label` attribute.\n\n### **CSS Properties:**\n - **--grid-width** - The width of the color grid. _(default: undefined)_\n- **--grid-height** - The height of the color grid. _(default: undefined)_\n- **--grid-handle-size** - The size of the color grid's handle. _(default: undefined)_\n- **--slider-height** - The height of the hue and alpha sliders. _(default: undefined)_\n- **--slider-handle-size** - The diameter of the slider's handle. _(default: undefined)_\n- **--swatch-size** - The size of each predefined color swatch. _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.\n- **trigger** - The color picker's dropdown trigger.\n- **swatches** - The container that holds the swatches.\n- **swatch** - Each individual swatch.\n- **grid** - The color grid.\n- **grid-handle** - The color grid's handle.\n- **slider** - Hue and opacity sliders.\n- **slider-handle** - Hue and opacity slider handles.\n- **hue-slider** - The hue slider.\n- **hue-slider-handle** - The hue slider's handle.\n- **opacity-slider** - The opacity slider.\n- **opacity-slider-handle** - The opacity slider's handle.\n- **preview** - The preview color.\n- **input** - The text input.\n- **eye-dropper-button** - The eye dropper button.\n- **eye-dropper-button__base** - The eye dropper button's exported `button` part.\n- **eye-dropper-button__prefix** - The eye dropper button's exported `prefix` part.\n- **eye-dropper-button__label** - The eye dropper button's exported `label` part.\n- **eye-dropper-button__suffix** - The eye dropper button's exported `suffix` part.\n- **eye-dropper-button__caret** - The eye dropper button's exported `caret` part.\n- **format-button** - The format button.\n- **format-button__base** - The format button's exported `button` part.\n- **format-button__prefix** - The format button's exported `prefix` part.\n- **format-button__label** - The format button's exported `label` part.\n- **format-button__suffix** - The format button's exported `suffix` part.\n- **format-button__caret** - The format button's exported `caret` part.",
|
|
@@ -648,83 +533,198 @@
|
|
|
648
533
|
"references": []
|
|
649
534
|
},
|
|
650
535
|
{
|
|
651
|
-
"name": "flow-ui-
|
|
652
|
-
"description": "
|
|
536
|
+
"name": "flow-ui-checkbox",
|
|
537
|
+
"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.",
|
|
653
538
|
"attributes": [
|
|
539
|
+
{ "name": "title", "values": [] },
|
|
654
540
|
{
|
|
655
|
-
"name": "
|
|
656
|
-
"description": "
|
|
541
|
+
"name": "name",
|
|
542
|
+
"description": "The name of the checkbox, submitted as a name/value pair with form data.",
|
|
657
543
|
"values": []
|
|
658
544
|
},
|
|
659
545
|
{
|
|
660
|
-
"name": "
|
|
661
|
-
"description": "The
|
|
546
|
+
"name": "value",
|
|
547
|
+
"description": "The current value of the checkbox, submitted as a name/value pair with form data.",
|
|
662
548
|
"values": []
|
|
663
549
|
},
|
|
550
|
+
{
|
|
551
|
+
"name": "size",
|
|
552
|
+
"description": "The checkbox's size.",
|
|
553
|
+
"values": [
|
|
554
|
+
{ "name": "small" },
|
|
555
|
+
{ "name": "medium" },
|
|
556
|
+
{ "name": "large" }
|
|
557
|
+
]
|
|
558
|
+
},
|
|
664
559
|
{
|
|
665
560
|
"name": "disabled",
|
|
666
|
-
"description": "Disables the
|
|
561
|
+
"description": "Disables the checkbox.",
|
|
667
562
|
"values": []
|
|
668
|
-
}
|
|
669
|
-
],
|
|
670
|
-
"references": []
|
|
671
|
-
},
|
|
672
|
-
{
|
|
673
|
-
"name": "flow-ui-dialog",
|
|
674
|
-
"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.",
|
|
675
|
-
"attributes": [
|
|
563
|
+
},
|
|
676
564
|
{
|
|
677
|
-
"name": "
|
|
678
|
-
"description": "
|
|
565
|
+
"name": "checked",
|
|
566
|
+
"description": "Draws the checkbox in a checked state.",
|
|
679
567
|
"values": []
|
|
680
568
|
},
|
|
681
569
|
{
|
|
682
|
-
"name": "
|
|
683
|
-
"description": "
|
|
570
|
+
"name": "indeterminate",
|
|
571
|
+
"description": "Draws the checkbox in an indeterminate state. This is usually applied to checkboxes that represents a \"select\nall/none\" behavior when associated checkboxes have a mix of checked and unchecked states.",
|
|
684
572
|
"values": []
|
|
685
573
|
},
|
|
686
574
|
{
|
|
687
|
-
"name": "
|
|
688
|
-
"description": "
|
|
575
|
+
"name": "form",
|
|
576
|
+
"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.",
|
|
577
|
+
"values": []
|
|
578
|
+
},
|
|
579
|
+
{
|
|
580
|
+
"name": "required",
|
|
581
|
+
"description": "Makes the checkbox a required field.",
|
|
689
582
|
"values": []
|
|
690
583
|
}
|
|
691
584
|
],
|
|
692
585
|
"references": []
|
|
693
586
|
},
|
|
694
587
|
{
|
|
695
|
-
"name": "flow-ui-
|
|
696
|
-
"description": "
|
|
588
|
+
"name": "flow-ui-color-mapper",
|
|
589
|
+
"description": "A component for defining mappings between data values and colors.\n\n\n---\n\n\n",
|
|
697
590
|
"attributes": [
|
|
591
|
+
{ "name": "field", "values": [] },
|
|
592
|
+
{ "name": "options", "values": [{ "name": "ColorMapperOptions" }] },
|
|
593
|
+
{ "name": "value", "values": [{ "name": "ColorMapperValue" }] },
|
|
698
594
|
{
|
|
699
|
-
"name": "
|
|
700
|
-
"
|
|
701
|
-
|
|
595
|
+
"name": "size",
|
|
596
|
+
"values": [
|
|
597
|
+
{ "name": "small" },
|
|
598
|
+
{ "name": "medium" },
|
|
599
|
+
{ "name": "large" }
|
|
600
|
+
]
|
|
601
|
+
},
|
|
602
|
+
{ "name": "defaultColorStop", "values": [] },
|
|
603
|
+
{
|
|
604
|
+
"name": "swatches",
|
|
605
|
+
"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.",
|
|
606
|
+
"values": [{ "name": "string[]" }]
|
|
702
607
|
}
|
|
703
608
|
],
|
|
704
609
|
"references": []
|
|
705
610
|
},
|
|
706
611
|
{
|
|
707
|
-
"name": "flow-ui-
|
|
708
|
-
"description": "
|
|
612
|
+
"name": "flow-ui-color-stop",
|
|
613
|
+
"description": "A single color stop used by the `flow-ui-color-mapper` component.\n\n\n---\n\n\n",
|
|
709
614
|
"attributes": [
|
|
710
615
|
{
|
|
711
|
-
"name": "
|
|
712
|
-
"description": "
|
|
616
|
+
"name": "name",
|
|
617
|
+
"description": "The name of the color stop, submitted as a name/value pair with form data.",
|
|
713
618
|
"values": []
|
|
714
619
|
},
|
|
715
620
|
{
|
|
716
|
-
"name": "
|
|
717
|
-
"description": "
|
|
621
|
+
"name": "form",
|
|
622
|
+
"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.",
|
|
718
623
|
"values": []
|
|
719
624
|
},
|
|
720
625
|
{
|
|
721
|
-
"name": "
|
|
722
|
-
"description": "
|
|
723
|
-
"values": [
|
|
724
|
-
|
|
725
|
-
|
|
726
|
-
|
|
727
|
-
|
|
626
|
+
"name": "required",
|
|
627
|
+
"description": "Makes the color stop as a required field.",
|
|
628
|
+
"values": []
|
|
629
|
+
},
|
|
630
|
+
{ "name": "options", "values": [{ "name": "ColorStopOptions" }] },
|
|
631
|
+
{ "name": "value", "values": [{ "name": "ColorStopValue" }] },
|
|
632
|
+
{
|
|
633
|
+
"name": "size",
|
|
634
|
+
"values": [
|
|
635
|
+
{ "name": "small" },
|
|
636
|
+
{ "name": "medium" },
|
|
637
|
+
{ "name": "large" }
|
|
638
|
+
]
|
|
639
|
+
},
|
|
640
|
+
{ "name": "placeholder", "values": [] },
|
|
641
|
+
{ "name": "fixed", "values": [] },
|
|
642
|
+
{
|
|
643
|
+
"name": "swatches",
|
|
644
|
+
"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.",
|
|
645
|
+
"values": [{ "name": "string[]" }]
|
|
646
|
+
}
|
|
647
|
+
],
|
|
648
|
+
"references": []
|
|
649
|
+
},
|
|
650
|
+
{
|
|
651
|
+
"name": "flow-ui-details",
|
|
652
|
+
"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.",
|
|
653
|
+
"attributes": [
|
|
654
|
+
{
|
|
655
|
+
"name": "open",
|
|
656
|
+
"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.",
|
|
657
|
+
"values": []
|
|
658
|
+
},
|
|
659
|
+
{
|
|
660
|
+
"name": "summary",
|
|
661
|
+
"description": "The summary to show in the header. If you need to display HTML, use the `summary` slot instead.",
|
|
662
|
+
"values": []
|
|
663
|
+
},
|
|
664
|
+
{
|
|
665
|
+
"name": "disabled",
|
|
666
|
+
"description": "Disables the details so it can't be toggled.",
|
|
667
|
+
"values": []
|
|
668
|
+
}
|
|
669
|
+
],
|
|
670
|
+
"references": []
|
|
671
|
+
},
|
|
672
|
+
{
|
|
673
|
+
"name": "flow-ui-dialog",
|
|
674
|
+
"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.",
|
|
675
|
+
"attributes": [
|
|
676
|
+
{
|
|
677
|
+
"name": "open",
|
|
678
|
+
"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.",
|
|
679
|
+
"values": []
|
|
680
|
+
},
|
|
681
|
+
{
|
|
682
|
+
"name": "label",
|
|
683
|
+
"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.",
|
|
684
|
+
"values": []
|
|
685
|
+
},
|
|
686
|
+
{
|
|
687
|
+
"name": "no-header",
|
|
688
|
+
"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.",
|
|
689
|
+
"values": []
|
|
690
|
+
}
|
|
691
|
+
],
|
|
692
|
+
"references": []
|
|
693
|
+
},
|
|
694
|
+
{
|
|
695
|
+
"name": "flow-ui-divider",
|
|
696
|
+
"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)_",
|
|
697
|
+
"attributes": [
|
|
698
|
+
{
|
|
699
|
+
"name": "vertical",
|
|
700
|
+
"description": "Draws the divider in a vertical orientation.",
|
|
701
|
+
"values": []
|
|
702
|
+
}
|
|
703
|
+
],
|
|
704
|
+
"references": []
|
|
705
|
+
},
|
|
706
|
+
{
|
|
707
|
+
"name": "flow-ui-drawer",
|
|
708
|
+
"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.",
|
|
709
|
+
"attributes": [
|
|
710
|
+
{
|
|
711
|
+
"name": "open",
|
|
712
|
+
"description": "Indicates whether or not the drawer is open. You can toggle this attribute to show and hide the drawer, or you can\nuse the `show()` and `hide()` methods and this attribute will reflect the drawer's open state.",
|
|
713
|
+
"values": []
|
|
714
|
+
},
|
|
715
|
+
{
|
|
716
|
+
"name": "label",
|
|
717
|
+
"description": "The drawer'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.",
|
|
718
|
+
"values": []
|
|
719
|
+
},
|
|
720
|
+
{
|
|
721
|
+
"name": "placement",
|
|
722
|
+
"description": "The direction from which the drawer will open.",
|
|
723
|
+
"values": [
|
|
724
|
+
{ "name": "top" },
|
|
725
|
+
{ "name": "end" },
|
|
726
|
+
{ "name": "bottom" },
|
|
727
|
+
{ "name": "start" }
|
|
728
728
|
]
|
|
729
729
|
},
|
|
730
730
|
{
|
|
@@ -740,6 +740,46 @@
|
|
|
740
740
|
],
|
|
741
741
|
"references": []
|
|
742
742
|
},
|
|
743
|
+
{
|
|
744
|
+
"name": "flow-ui-gauge",
|
|
745
|
+
"description": "Gauges are used to display a single value with an optional icon and heading.\n\n\n---\n\n\n",
|
|
746
|
+
"attributes": [
|
|
747
|
+
{ "name": "heading", "values": [] },
|
|
748
|
+
{ "name": "units", "values": [] },
|
|
749
|
+
{ "name": "value", "values": [] },
|
|
750
|
+
{ "name": "icon", "values": [] },
|
|
751
|
+
{ "name": "icon-library", "values": [] },
|
|
752
|
+
{ "name": "format", "values": [] }
|
|
753
|
+
],
|
|
754
|
+
"references": []
|
|
755
|
+
},
|
|
756
|
+
{
|
|
757
|
+
"name": "flow-ui-icon",
|
|
758
|
+
"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.",
|
|
759
|
+
"attributes": [
|
|
760
|
+
{
|
|
761
|
+
"name": "name",
|
|
762
|
+
"description": "The name of the icon to draw. Available names depend on the icon library being used.",
|
|
763
|
+
"values": []
|
|
764
|
+
},
|
|
765
|
+
{
|
|
766
|
+
"name": "src",
|
|
767
|
+
"description": "An external URL of an SVG file. Be sure you trust the content you are including, as it will be executed as code and\ncan result in XSS attacks.",
|
|
768
|
+
"values": []
|
|
769
|
+
},
|
|
770
|
+
{
|
|
771
|
+
"name": "label",
|
|
772
|
+
"description": "An alternate description to use for assistive devices. If omitted, the icon will be considered presentational and\nignored by assistive devices.",
|
|
773
|
+
"values": []
|
|
774
|
+
},
|
|
775
|
+
{
|
|
776
|
+
"name": "library",
|
|
777
|
+
"description": "The name of a registered custom icon library.",
|
|
778
|
+
"values": []
|
|
779
|
+
}
|
|
780
|
+
],
|
|
781
|
+
"references": []
|
|
782
|
+
},
|
|
743
783
|
{
|
|
744
784
|
"name": "flow-ui-dropdown",
|
|
745
785
|
"description": "Dropdowns expose additional content that \"drops down\" in a panel.\n\n\n---\n\n\n\n\n### **Events:**\n - **flow-ui-show** - Emitted when the dropdown opens.\n- **flow-ui-after-show** - Emitted after the dropdown opens and all animations are complete.\n- **flow-ui-hide** - Emitted when the dropdown closes.\n- **flow-ui-after-hide** - Emitted after the dropdown closes and all animations are complete.\n\n### **Methods:**\n - **show()** - Shows the dropdown panel.\n- **hide()** - Hides the dropdown panel\n- **reposition()** - Instructs the dropdown menu to reposition. Useful when the position or size of the trigger changes when the menu\nis activated.\n\n### **Slots:**\n - _default_ - The dropdown's main content.\n- **trigger** - The dropdown's trigger, usually a `<flow-ui-button>` element.\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- **trigger** - The container that wraps the trigger.\n- **panel** - The panel that gets shown when the dropdown is open.",
|
|
@@ -805,46 +845,6 @@
|
|
|
805
845
|
],
|
|
806
846
|
"references": []
|
|
807
847
|
},
|
|
808
|
-
{
|
|
809
|
-
"name": "flow-ui-gauge",
|
|
810
|
-
"description": "Gauges are used to display a single value with an optional icon and heading.\n\n\n---\n\n\n",
|
|
811
|
-
"attributes": [
|
|
812
|
-
{ "name": "heading", "values": [] },
|
|
813
|
-
{ "name": "units", "values": [] },
|
|
814
|
-
{ "name": "value", "values": [] },
|
|
815
|
-
{ "name": "icon", "values": [] },
|
|
816
|
-
{ "name": "icon-library", "values": [] },
|
|
817
|
-
{ "name": "format", "values": [] }
|
|
818
|
-
],
|
|
819
|
-
"references": []
|
|
820
|
-
},
|
|
821
|
-
{
|
|
822
|
-
"name": "flow-ui-icon",
|
|
823
|
-
"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.",
|
|
824
|
-
"attributes": [
|
|
825
|
-
{
|
|
826
|
-
"name": "name",
|
|
827
|
-
"description": "The name of the icon to draw. Available names depend on the icon library being used.",
|
|
828
|
-
"values": []
|
|
829
|
-
},
|
|
830
|
-
{
|
|
831
|
-
"name": "src",
|
|
832
|
-
"description": "An external URL of an SVG file. Be sure you trust the content you are including, as it will be executed as code and\ncan result in XSS attacks.",
|
|
833
|
-
"values": []
|
|
834
|
-
},
|
|
835
|
-
{
|
|
836
|
-
"name": "label",
|
|
837
|
-
"description": "An alternate description to use for assistive devices. If omitted, the icon will be considered presentational and\nignored by assistive devices.",
|
|
838
|
-
"values": []
|
|
839
|
-
},
|
|
840
|
-
{
|
|
841
|
-
"name": "library",
|
|
842
|
-
"description": "The name of a registered custom icon library.",
|
|
843
|
-
"values": []
|
|
844
|
-
}
|
|
845
|
-
],
|
|
846
|
-
"references": []
|
|
847
|
-
},
|
|
848
848
|
{
|
|
849
849
|
"name": "flow-ui-input",
|
|
850
850
|
"description": "Inputs collect data from the user.\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-clear** - Emitted when the clear button is activated.\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 input.\n- **blur()** - Removes focus from the input.\n- **select()** - Selects all the text in the input.\n- **setSelectionRange(selectionStart: _number_, selectionEnd: _number_, selectionDirection: _'forward' | 'backward' | 'none'_)** - Sets the start and end positions of the text selection (0-based).\n- **setRangeText(replacement: _string_, start: _number_, end: _number_, selectMode: _'select' | 'start' | 'end' | 'preserve'_)** - Replaces a range of text with a new string.\n- **showPicker()** - Displays the browser picker for an input element (only works if the browser supports it for the input type).\n- **stepUp()** - Increments the value of a numeric input type by the value of the step attribute.\n- **stepDown()** - Decrements the value of a numeric input type 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 input's label. Alternatively, you can use the `label` attribute.\n- **prefix** - Used to prepend a presentational icon or similar element to the input.\n- **suffix** - Used to append a presentational icon or similar element to the input.\n- **clear-icon** - An icon to use in lieu of the default clear icon.\n- **show-password-icon** - An icon to use in lieu of the default show password icon.\n- **hide-password-icon** - An icon to use in lieu of the default hide password 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-input** - The input's wrapper.\n- **form-control-help-text** - The help text's wrapper.\n- **base** - The component's base wrapper.\n- **input** - The internal `<input>` control.\n- **prefix** - The container that wraps the prefix.\n- **clear-button** - The clear button.\n- **password-toggle-button** - The password toggle button.\n- **suffix** - The container that wraps the suffix.",
|
|
@@ -1043,6 +1043,48 @@
|
|
|
1043
1043
|
],
|
|
1044
1044
|
"references": []
|
|
1045
1045
|
},
|
|
1046
|
+
{
|
|
1047
|
+
"name": "flow-ui-map",
|
|
1048
|
+
"description": "Display a Flo.w map.\n\n\n---\n\n\n\n\n### **Events:**\n - **flow-ui-load** - Dispatched when the map is first initialized and has completed loading.\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.",
|
|
1049
|
+
"attributes": [
|
|
1050
|
+
{
|
|
1051
|
+
"name": "map-id",
|
|
1052
|
+
"description": "The map ID. If not provided, a unique ID will be generated.",
|
|
1053
|
+
"values": []
|
|
1054
|
+
},
|
|
1055
|
+
{
|
|
1056
|
+
"name": "base-style",
|
|
1057
|
+
"description": "The base style of the map.",
|
|
1058
|
+
"values": []
|
|
1059
|
+
},
|
|
1060
|
+
{
|
|
1061
|
+
"name": "center",
|
|
1062
|
+
"description": "The center of the map specified as a longitude and latitude pair.\n\nAlternatively, use the `setCenter` method to update the center of the map\nwith animation options.",
|
|
1063
|
+
"values": [{ "name": "[number" }, { "name": "number]" }]
|
|
1064
|
+
},
|
|
1065
|
+
{
|
|
1066
|
+
"name": "zoom",
|
|
1067
|
+
"description": "The zoom level of the map.\n\nAlternatively, use the `setCenter` method to update the center of the map\nwith animation options.",
|
|
1068
|
+
"values": []
|
|
1069
|
+
},
|
|
1070
|
+
{
|
|
1071
|
+
"name": "bearing",
|
|
1072
|
+
"description": "The bearing of the map.\n\nAlternatively, use the `setCenter` method to update the center of the map\nwith animation options.",
|
|
1073
|
+
"values": []
|
|
1074
|
+
},
|
|
1075
|
+
{
|
|
1076
|
+
"name": "pitch",
|
|
1077
|
+
"description": "The pitch of the map.\n\nAlternatively, use the `setCenter` method to update the center of the map\nwith animation options.",
|
|
1078
|
+
"values": []
|
|
1079
|
+
},
|
|
1080
|
+
{
|
|
1081
|
+
"name": "busy",
|
|
1082
|
+
"description": "Set to `true` to show a busy indicator on the map.\n\nNote that the busy indicator will also be automatically be shown when the map\nis loading data.",
|
|
1083
|
+
"values": []
|
|
1084
|
+
}
|
|
1085
|
+
],
|
|
1086
|
+
"references": []
|
|
1087
|
+
},
|
|
1046
1088
|
{
|
|
1047
1089
|
"name": "flow-ui-menu",
|
|
1048
1090
|
"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.",
|
|
@@ -1167,28 +1209,6 @@
|
|
|
1167
1209
|
],
|
|
1168
1210
|
"references": []
|
|
1169
1211
|
},
|
|
1170
|
-
{
|
|
1171
|
-
"name": "flow-ui-panel-header",
|
|
1172
|
-
"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 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.",
|
|
1173
|
-
"attributes": [
|
|
1174
|
-
{
|
|
1175
|
-
"name": "closed",
|
|
1176
|
-
"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.",
|
|
1177
|
-
"values": []
|
|
1178
|
-
},
|
|
1179
|
-
{
|
|
1180
|
-
"name": "title",
|
|
1181
|
-
"description": "The header title text. Use the `title` slot instead to display HTML.",
|
|
1182
|
-
"values": []
|
|
1183
|
-
},
|
|
1184
|
-
{
|
|
1185
|
-
"name": "fixed",
|
|
1186
|
-
"description": "Set to `true` to hide the panel expand/collapse button.",
|
|
1187
|
-
"values": []
|
|
1188
|
-
}
|
|
1189
|
-
],
|
|
1190
|
-
"references": []
|
|
1191
|
-
},
|
|
1192
1212
|
{
|
|
1193
1213
|
"name": "flow-ui-progress-bar",
|
|
1194
1214
|
"description": "Progress bars are used to show the status of an ongoing operation.\n\n\n---\n\n\n\n\n### **Slots:**\n - _default_ - A label to show inside the progress indicator.\n\n### **CSS Properties:**\n - **--height** - The progress bar's height. _(default: undefined)_\n- **--track-color** - The color of the track. _(default: undefined)_\n- **--indicator-color** - The color of the indicator. _(default: undefined)_\n- **--label-color** - The color of the label. _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.\n- **indicator** - The progress bar's indicator.\n- **label** - The progress bar's label.",
|
|
@@ -1211,48 +1231,6 @@
|
|
|
1211
1231
|
],
|
|
1212
1232
|
"references": []
|
|
1213
1233
|
},
|
|
1214
|
-
{
|
|
1215
|
-
"name": "flow-ui-map",
|
|
1216
|
-
"description": "Display a Flo.w map.\n\n\n---\n\n\n\n\n### **Events:**\n - **flow-ui-load** - Dispatched when the map is first initialized and has completed loading.\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.",
|
|
1217
|
-
"attributes": [
|
|
1218
|
-
{
|
|
1219
|
-
"name": "map-id",
|
|
1220
|
-
"description": "The map ID. If not provided, a unique ID will be generated.",
|
|
1221
|
-
"values": []
|
|
1222
|
-
},
|
|
1223
|
-
{
|
|
1224
|
-
"name": "base-style",
|
|
1225
|
-
"description": "The base style of the map.",
|
|
1226
|
-
"values": []
|
|
1227
|
-
},
|
|
1228
|
-
{
|
|
1229
|
-
"name": "center",
|
|
1230
|
-
"description": "The center of the map specified as a longitude and latitude pair.\n\nAlternatively, use the `setCenter` method to update the center of the map\nwith animation options.",
|
|
1231
|
-
"values": [{ "name": "[number" }, { "name": "number]" }]
|
|
1232
|
-
},
|
|
1233
|
-
{
|
|
1234
|
-
"name": "zoom",
|
|
1235
|
-
"description": "The zoom level of the map.\n\nAlternatively, use the `setCenter` method to update the center of the map\nwith animation options.",
|
|
1236
|
-
"values": []
|
|
1237
|
-
},
|
|
1238
|
-
{
|
|
1239
|
-
"name": "bearing",
|
|
1240
|
-
"description": "The bearing of the map.\n\nAlternatively, use the `setCenter` method to update the center of the map\nwith animation options.",
|
|
1241
|
-
"values": []
|
|
1242
|
-
},
|
|
1243
|
-
{
|
|
1244
|
-
"name": "pitch",
|
|
1245
|
-
"description": "The pitch of the map.\n\nAlternatively, use the `setCenter` method to update the center of the map\nwith animation options.",
|
|
1246
|
-
"values": []
|
|
1247
|
-
},
|
|
1248
|
-
{
|
|
1249
|
-
"name": "busy",
|
|
1250
|
-
"description": "Set to `true` to show a busy indicator on the map.\n\nNote that the busy indicator will also be automatically be shown when the map\nis loading data.",
|
|
1251
|
-
"values": []
|
|
1252
|
-
}
|
|
1253
|
-
],
|
|
1254
|
-
"references": []
|
|
1255
|
-
},
|
|
1256
1234
|
{
|
|
1257
1235
|
"name": "flow-ui-progress-ring",
|
|
1258
1236
|
"description": "Progress rings are used to show the progress of a determinate operation in a circular fashion.\n\n\n---\n\n\n\n\n### **Slots:**\n - _default_ - A label to show inside the ring.\n\n### **CSS Properties:**\n - **--size** - The diameter of the progress ring (cannot be a percentage). _(default: undefined)_\n- **--track-width** - The width of the track. _(default: undefined)_\n- **--track-color** - The color of the track. _(default: undefined)_\n- **--indicator-width** - The width of the indicator. Defaults to the track width. _(default: undefined)_\n- **--indicator-color** - The color of the indicator. _(default: undefined)_\n- **--indicator-transition-duration** - The duration of the indicator's transition when the value changes. _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.\n- **label** - The progress ring label.",
|
|
@@ -1270,32 +1248,6 @@
|
|
|
1270
1248
|
],
|
|
1271
1249
|
"references": []
|
|
1272
1250
|
},
|
|
1273
|
-
{
|
|
1274
|
-
"name": "flow-ui-radio",
|
|
1275
|
-
"description": "Radios allow the user to select a single option from a group.\n\n\n---\n\n\n\n\n### **Events:**\n - **flow-ui-blur** - Emitted when the control loses focus.\n- **flow-ui-focus** - Emitted when the control gains focus.\n\n### **Slots:**\n - _default_ - The radio's label.\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.\n- **control** - The circular container that wraps the radio's checked state.\n- **control--checked** - The radio control when the radio is checked.\n- **checked-icon** - The checked icon, an `<flow-ui-icon>` element.\n- **label** - The container that wraps the radio's label.",
|
|
1276
|
-
"attributes": [
|
|
1277
|
-
{
|
|
1278
|
-
"name": "value",
|
|
1279
|
-
"description": "The radio's value. When selected, the radio group will receive this value.",
|
|
1280
|
-
"values": []
|
|
1281
|
-
},
|
|
1282
|
-
{
|
|
1283
|
-
"name": "size",
|
|
1284
|
-
"description": "The radio's size. When used inside a radio group, the size will be determined by the radio group's size so this\nattribute can typically be omitted.",
|
|
1285
|
-
"values": [
|
|
1286
|
-
{ "name": "small" },
|
|
1287
|
-
{ "name": "medium" },
|
|
1288
|
-
{ "name": "large" }
|
|
1289
|
-
]
|
|
1290
|
-
},
|
|
1291
|
-
{
|
|
1292
|
-
"name": "disabled",
|
|
1293
|
-
"description": "Disables the radio.",
|
|
1294
|
-
"values": []
|
|
1295
|
-
}
|
|
1296
|
-
],
|
|
1297
|
-
"references": []
|
|
1298
|
-
},
|
|
1299
1251
|
{
|
|
1300
1252
|
"name": "flow-ui-query-builder",
|
|
1301
1253
|
"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- **isRule(value: _unknown_): _value is FlowQueryBuilderRule_** - Static helper method to determine if supplied argument is\na `FlowQueryBuilderRule`.\n- **isRuleSet(value: _unknown_): __** - Static helper method to determine if supplied argument is\na `FlowQueryBuilderRuleSet`.\n- **filterRuleSet(ruleset: _FlowQueryBuilderRuleSet_, options: _{ excludeFields?: string[]; includeFields?: string[] }_): __** - Static helper method to recursively filter a `FlowQueryBuilderRuleSet`.\n\nThis can be used to sanitize user queries before they are executed.\n- **renameRuleSetFields(ruleset: _FlowQueryBuilderRuleSet_, replacements: _Record<string, string>_, ruleSet): __** - Static helper method to rename fields in a `FlowQueryBuilderRuleSet`.\n- **transformRuleSet(ruleSet: _FlowQueryBuilderRuleSet_, transformFn: _(rule: FlowQueryBuilderRule) => FlowQueryBuilderRule | undefined_): __** - Static helper method to recursively apply a transform function to each rule\nin a `FlowQueryBuilderRuleSet`.\n\nThe transform fn should expect a single FlowQueryBuilderRule and return:\n\n- the same rule unmodifed or modified in place\n- `undefined` to exclude the rule from the rule set\n\nThis can be used to sanitize rule sets before they are used to perform queries.\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.",
|
|
@@ -1343,32 +1295,17 @@
|
|
|
1343
1295
|
"references": []
|
|
1344
1296
|
},
|
|
1345
1297
|
{
|
|
1346
|
-
"name": "flow-ui-radio
|
|
1347
|
-
"description": "
|
|
1298
|
+
"name": "flow-ui-radio",
|
|
1299
|
+
"description": "Radios allow the user to select a single option from a group.\n\n\n---\n\n\n\n\n### **Events:**\n - **flow-ui-blur** - Emitted when the control loses focus.\n- **flow-ui-focus** - Emitted when the control gains focus.\n\n### **Slots:**\n - _default_ - The radio's label.\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.\n- **control** - The circular container that wraps the radio's checked state.\n- **control--checked** - The radio control when the radio is checked.\n- **checked-icon** - The checked icon, an `<flow-ui-icon>` element.\n- **label** - The container that wraps the radio's label.",
|
|
1348
1300
|
"attributes": [
|
|
1349
|
-
{
|
|
1350
|
-
"name": "label",
|
|
1351
|
-
"description": "The radio group's label. Required for proper accessibility. If you need to display HTML, use the `label` slot\ninstead.",
|
|
1352
|
-
"values": []
|
|
1353
|
-
},
|
|
1354
|
-
{
|
|
1355
|
-
"name": "help-text",
|
|
1356
|
-
"description": "The radio groups's help text. If you need to display HTML, use the `help-text` slot instead.",
|
|
1357
|
-
"values": []
|
|
1358
|
-
},
|
|
1359
|
-
{
|
|
1360
|
-
"name": "name",
|
|
1361
|
-
"description": "The name of the radio group, submitted as a name/value pair with form data.",
|
|
1362
|
-
"values": []
|
|
1363
|
-
},
|
|
1364
1301
|
{
|
|
1365
1302
|
"name": "value",
|
|
1366
|
-
"description": "The
|
|
1303
|
+
"description": "The radio's value. When selected, the radio group will receive this value.",
|
|
1367
1304
|
"values": []
|
|
1368
1305
|
},
|
|
1369
1306
|
{
|
|
1370
1307
|
"name": "size",
|
|
1371
|
-
"description": "The radio
|
|
1308
|
+
"description": "The radio's size. When used inside a radio group, the size will be determined by the radio group's size so this\nattribute can typically be omitted.",
|
|
1372
1309
|
"values": [
|
|
1373
1310
|
{ "name": "small" },
|
|
1374
1311
|
{ "name": "medium" },
|
|
@@ -1376,18 +1313,8 @@
|
|
|
1376
1313
|
]
|
|
1377
1314
|
},
|
|
1378
1315
|
{
|
|
1379
|
-
"name": "
|
|
1380
|
-
"description": "
|
|
1381
|
-
"values": []
|
|
1382
|
-
},
|
|
1383
|
-
{
|
|
1384
|
-
"name": "required",
|
|
1385
|
-
"description": "Ensures a child radio is checked before allowing the containing form to submit.",
|
|
1386
|
-
"values": []
|
|
1387
|
-
},
|
|
1388
|
-
{
|
|
1389
|
-
"name": "vertical",
|
|
1390
|
-
"description": "Use vertical layout for the radio group.",
|
|
1316
|
+
"name": "disabled",
|
|
1317
|
+
"description": "Disables the radio.",
|
|
1391
1318
|
"values": []
|
|
1392
1319
|
}
|
|
1393
1320
|
],
|
|
@@ -1410,46 +1337,97 @@
|
|
|
1410
1337
|
},
|
|
1411
1338
|
{
|
|
1412
1339
|
"name": "label",
|
|
1413
|
-
"description": "The range's label. If you need to display HTML, use the `label` slot instead.",
|
|
1340
|
+
"description": "The range's label. If you need to display HTML, use the `label` slot instead.",
|
|
1341
|
+
"values": []
|
|
1342
|
+
},
|
|
1343
|
+
{
|
|
1344
|
+
"name": "help-text",
|
|
1345
|
+
"description": "The range's help text. If you need to display HTML, use the help-text slot instead.",
|
|
1346
|
+
"values": []
|
|
1347
|
+
},
|
|
1348
|
+
{
|
|
1349
|
+
"name": "disabled",
|
|
1350
|
+
"description": "Disables the range.",
|
|
1351
|
+
"values": []
|
|
1352
|
+
},
|
|
1353
|
+
{
|
|
1354
|
+
"name": "min",
|
|
1355
|
+
"description": "The minimum acceptable value of the range.",
|
|
1356
|
+
"values": []
|
|
1357
|
+
},
|
|
1358
|
+
{
|
|
1359
|
+
"name": "max",
|
|
1360
|
+
"description": "The maximum acceptable value of the range.",
|
|
1361
|
+
"values": []
|
|
1362
|
+
},
|
|
1363
|
+
{
|
|
1364
|
+
"name": "step",
|
|
1365
|
+
"description": "The interval at which the range will increase and decrease.",
|
|
1366
|
+
"values": []
|
|
1367
|
+
},
|
|
1368
|
+
{
|
|
1369
|
+
"name": "tooltip",
|
|
1370
|
+
"description": "The preferred placement of the range's tooltip.",
|
|
1371
|
+
"values": [
|
|
1372
|
+
{ "name": "top" },
|
|
1373
|
+
{ "name": "bottom" },
|
|
1374
|
+
{ "name": "none" }
|
|
1375
|
+
]
|
|
1376
|
+
},
|
|
1377
|
+
{
|
|
1378
|
+
"name": "form",
|
|
1379
|
+
"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.",
|
|
1380
|
+
"values": []
|
|
1381
|
+
}
|
|
1382
|
+
],
|
|
1383
|
+
"references": []
|
|
1384
|
+
},
|
|
1385
|
+
{
|
|
1386
|
+
"name": "flow-ui-radio-group",
|
|
1387
|
+
"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.",
|
|
1388
|
+
"attributes": [
|
|
1389
|
+
{
|
|
1390
|
+
"name": "label",
|
|
1391
|
+
"description": "The radio group's label. Required for proper accessibility. If you need to display HTML, use the `label` slot\ninstead.",
|
|
1414
1392
|
"values": []
|
|
1415
1393
|
},
|
|
1416
1394
|
{
|
|
1417
1395
|
"name": "help-text",
|
|
1418
|
-
"description": "The
|
|
1396
|
+
"description": "The radio groups's help text. If you need to display HTML, use the `help-text` slot instead.",
|
|
1419
1397
|
"values": []
|
|
1420
1398
|
},
|
|
1421
1399
|
{
|
|
1422
|
-
"name": "
|
|
1423
|
-
"description": "
|
|
1400
|
+
"name": "name",
|
|
1401
|
+
"description": "The name of the radio group, submitted as a name/value pair with form data.",
|
|
1424
1402
|
"values": []
|
|
1425
1403
|
},
|
|
1426
1404
|
{
|
|
1427
|
-
"name": "
|
|
1428
|
-
"description": "The
|
|
1405
|
+
"name": "value",
|
|
1406
|
+
"description": "The current value of the radio group, submitted as a name/value pair with form data.",
|
|
1429
1407
|
"values": []
|
|
1430
1408
|
},
|
|
1431
1409
|
{
|
|
1432
|
-
"name": "
|
|
1433
|
-
"description": "The
|
|
1434
|
-
"values": [
|
|
1410
|
+
"name": "size",
|
|
1411
|
+
"description": "The radio group's size. This size will be applied to all child radios and radio buttons.",
|
|
1412
|
+
"values": [
|
|
1413
|
+
{ "name": "small" },
|
|
1414
|
+
{ "name": "medium" },
|
|
1415
|
+
{ "name": "large" }
|
|
1416
|
+
]
|
|
1435
1417
|
},
|
|
1436
1418
|
{
|
|
1437
|
-
"name": "
|
|
1438
|
-
"description": "
|
|
1419
|
+
"name": "form",
|
|
1420
|
+
"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.",
|
|
1439
1421
|
"values": []
|
|
1440
1422
|
},
|
|
1441
1423
|
{
|
|
1442
|
-
"name": "
|
|
1443
|
-
"description": "
|
|
1444
|
-
"values": [
|
|
1445
|
-
{ "name": "top" },
|
|
1446
|
-
{ "name": "bottom" },
|
|
1447
|
-
{ "name": "none" }
|
|
1448
|
-
]
|
|
1424
|
+
"name": "required",
|
|
1425
|
+
"description": "Ensures a child radio is checked before allowing the containing form to submit.",
|
|
1426
|
+
"values": []
|
|
1449
1427
|
},
|
|
1450
1428
|
{
|
|
1451
|
-
"name": "
|
|
1452
|
-
"description": "
|
|
1429
|
+
"name": "vertical",
|
|
1430
|
+
"description": "Use vertical layout for the radio group.",
|
|
1453
1431
|
"values": []
|
|
1454
1432
|
}
|
|
1455
1433
|
],
|
|
@@ -1512,58 +1490,42 @@
|
|
|
1512
1490
|
"references": []
|
|
1513
1491
|
},
|
|
1514
1492
|
{
|
|
1515
|
-
"name": "flow-ui-
|
|
1516
|
-
"description": "
|
|
1517
|
-
"attributes": [],
|
|
1518
|
-
"references": []
|
|
1519
|
-
},
|
|
1520
|
-
{
|
|
1521
|
-
"name": "flow-ui-split-view",
|
|
1522
|
-
"description": "Split-views contain 2 or more split-view panes to create resizable areas.\n\n\n---\n\n\n",
|
|
1523
|
-
"attributes": [
|
|
1524
|
-
{ "name": "no-drag-close", "values": [] },
|
|
1525
|
-
{ "name": "positions", "values": [{ "name": "string[]" }] },
|
|
1526
|
-
{ "name": "vertical", "values": [] },
|
|
1527
|
-
{ "name": "dragging", "values": [] }
|
|
1528
|
-
],
|
|
1529
|
-
"references": []
|
|
1530
|
-
},
|
|
1531
|
-
{
|
|
1532
|
-
"name": "flow-ui-split-view-divider",
|
|
1533
|
-
"description": "Split-view dividers are used internally by split-views to create resizable areas.\n\n\n---\n\n\n",
|
|
1534
|
-
"attributes": [
|
|
1535
|
-
{ "name": "disabled", "values": [] },
|
|
1536
|
-
{ "name": "vertical", "values": [] }
|
|
1537
|
-
],
|
|
1538
|
-
"references": []
|
|
1539
|
-
},
|
|
1540
|
-
{
|
|
1541
|
-
"name": "flow-ui-split-view-pane",
|
|
1542
|
-
"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)** - Shows the details.\n- **collapse(emitEvent)** - Hides the details",
|
|
1493
|
+
"name": "flow-ui-panel-header",
|
|
1494
|
+
"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 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.",
|
|
1543
1495
|
"attributes": [
|
|
1544
|
-
{ "name": "vertical", "values": [] },
|
|
1545
|
-
{ "name": "size", "values": [] },
|
|
1546
|
-
{ "name": "min-size", "values": [] },
|
|
1547
|
-
{ "name": "max-size", "values": [] },
|
|
1548
|
-
{ "name": "closed-size", "values": [] },
|
|
1549
1496
|
{
|
|
1550
1497
|
"name": "closed",
|
|
1551
|
-
"description": "Indicates
|
|
1498
|
+
"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.",
|
|
1552
1499
|
"values": []
|
|
1553
1500
|
},
|
|
1554
1501
|
{
|
|
1555
|
-
"name": "
|
|
1556
|
-
"description": "
|
|
1502
|
+
"name": "title",
|
|
1503
|
+
"description": "The header title text. Use the `title` slot instead to display HTML.",
|
|
1557
1504
|
"values": []
|
|
1558
1505
|
},
|
|
1559
1506
|
{
|
|
1560
|
-
"name": "
|
|
1561
|
-
"description": "
|
|
1507
|
+
"name": "fixed",
|
|
1508
|
+
"description": "Set to `true` to hide the panel expand/collapse button.",
|
|
1562
1509
|
"values": []
|
|
1563
1510
|
}
|
|
1564
1511
|
],
|
|
1565
1512
|
"references": []
|
|
1566
1513
|
},
|
|
1514
|
+
{
|
|
1515
|
+
"name": "flow-ui-spinner",
|
|
1516
|
+
"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.",
|
|
1517
|
+
"attributes": [],
|
|
1518
|
+
"references": []
|
|
1519
|
+
},
|
|
1520
|
+
{
|
|
1521
|
+
"name": "flow-ui-split-view-divider",
|
|
1522
|
+
"description": "Split-view dividers are used internally by split-views to create resizable areas.\n\n\n---\n\n\n",
|
|
1523
|
+
"attributes": [
|
|
1524
|
+
{ "name": "disabled", "values": [] },
|
|
1525
|
+
{ "name": "vertical", "values": [] }
|
|
1526
|
+
],
|
|
1527
|
+
"references": []
|
|
1528
|
+
},
|
|
1567
1529
|
{
|
|
1568
1530
|
"name": "flow-ui-split-view-toggle-button",
|
|
1569
1531
|
"description": "Use a split panel toggle button to control a parent panel's open/closed state\n\n\n---\n\n\n\n\n### **Events:**\n - **flow-ui-blur** - Emitted when the icon button loses focus.\n- **flow-ui-focus** - Emitted when the icon button gains focus.\n\n### **Methods:**\n - **click()** - Simulates a click on the icon button.\n- **focus(options: _FocusOptions_)** - Sets focus on the icon button.\n- **blur()** - Removes focus from the icon button.\n- **hideConfirm()** - Hide the confirmation tooltip if it is showing\n- **showConfirm()** - Show the confirmation tooltip",
|
|
@@ -1661,9 +1623,14 @@
|
|
|
1661
1623
|
"references": []
|
|
1662
1624
|
},
|
|
1663
1625
|
{
|
|
1664
|
-
"name": "flow-ui-
|
|
1665
|
-
"description": "
|
|
1666
|
-
"attributes": [
|
|
1626
|
+
"name": "flow-ui-split-view",
|
|
1627
|
+
"description": "Split-views contain 2 or more split-view panes to create resizable areas.\n\n\n---\n\n\n",
|
|
1628
|
+
"attributes": [
|
|
1629
|
+
{ "name": "no-drag-close", "values": [] },
|
|
1630
|
+
{ "name": "positions", "values": [{ "name": "string[]" }] },
|
|
1631
|
+
{ "name": "vertical", "values": [] },
|
|
1632
|
+
{ "name": "dragging", "values": [] }
|
|
1633
|
+
],
|
|
1667
1634
|
"references": []
|
|
1668
1635
|
},
|
|
1669
1636
|
{
|
|
@@ -1690,6 +1657,12 @@
|
|
|
1690
1657
|
],
|
|
1691
1658
|
"references": []
|
|
1692
1659
|
},
|
|
1660
|
+
{
|
|
1661
|
+
"name": "flow-ui-stepper",
|
|
1662
|
+
"description": "Steppers are used to guide users through a series of steps in a wizard-like UI.\n\n\n---\n\n\n",
|
|
1663
|
+
"attributes": [],
|
|
1664
|
+
"references": []
|
|
1665
|
+
},
|
|
1693
1666
|
{
|
|
1694
1667
|
"name": "flow-ui-switch",
|
|
1695
1668
|
"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.",
|
|
@@ -1852,6 +1825,33 @@
|
|
|
1852
1825
|
],
|
|
1853
1826
|
"references": []
|
|
1854
1827
|
},
|
|
1828
|
+
{
|
|
1829
|
+
"name": "flow-ui-split-view-pane",
|
|
1830
|
+
"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)** - Shows the details.\n- **collapse(emitEvent)** - Hides the details",
|
|
1831
|
+
"attributes": [
|
|
1832
|
+
{ "name": "vertical", "values": [] },
|
|
1833
|
+
{ "name": "size", "values": [] },
|
|
1834
|
+
{ "name": "min-size", "values": [] },
|
|
1835
|
+
{ "name": "max-size", "values": [] },
|
|
1836
|
+
{ "name": "closed-size", "values": [] },
|
|
1837
|
+
{
|
|
1838
|
+
"name": "closed",
|
|
1839
|
+
"description": "Indicates if the split-view pane is open or closed.",
|
|
1840
|
+
"values": []
|
|
1841
|
+
},
|
|
1842
|
+
{
|
|
1843
|
+
"name": "divider",
|
|
1844
|
+
"description": "Indicates if the split-view pane has a divider.",
|
|
1845
|
+
"values": []
|
|
1846
|
+
},
|
|
1847
|
+
{
|
|
1848
|
+
"name": "hidden",
|
|
1849
|
+
"description": "Indicates if the split-view pane is hidden.",
|
|
1850
|
+
"values": []
|
|
1851
|
+
}
|
|
1852
|
+
],
|
|
1853
|
+
"references": []
|
|
1854
|
+
},
|
|
1855
1855
|
{
|
|
1856
1856
|
"name": "flow-ui-textarea",
|
|
1857
1857
|
"description": "Textareas collect data from the user and allow multiple lines of text.\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 textarea.\n- **blur()** - Removes focus from the textarea.\n- **select()** - Selects all the text in the textarea.\n- **scrollPosition(position: _{ top?: number; left?: number }_): _{ top: number; left: number } | undefined_** - Gets or sets the textarea's scroll position.\n- **setSelectionRange(selectionStart: _number_, selectionEnd: _number_, selectionDirection: _'forward' | 'backward' | 'none'_)** - Sets the start and end positions of the text selection (0-based).\n- **setRangeText(replacement: _string_, start: _number_, end: _number_, selectMode: _'select' | 'start' | 'end' | 'preserve'_)** - Replaces a range of text with a new string.\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 textarea'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 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- **base** - The component's base wrapper.\n- **textarea** - The internal `<textarea>` control.",
|
|
@@ -2032,6 +2032,62 @@
|
|
|
2032
2032
|
],
|
|
2033
2033
|
"references": []
|
|
2034
2034
|
},
|
|
2035
|
+
{
|
|
2036
|
+
"name": "flow-ui-tool-button-group",
|
|
2037
|
+
"description": "Tool buttons groups are used to build toolbars.\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.",
|
|
2038
|
+
"attributes": [
|
|
2039
|
+
{
|
|
2040
|
+
"name": "label",
|
|
2041
|
+
"description": "The radio group's label. Required for proper accessibility. If you need to display HTML, use the `label` slot\ninstead.",
|
|
2042
|
+
"values": []
|
|
2043
|
+
},
|
|
2044
|
+
{
|
|
2045
|
+
"name": "name",
|
|
2046
|
+
"description": "The name of the radio group, submitted as a name/value pair with form data.",
|
|
2047
|
+
"values": []
|
|
2048
|
+
},
|
|
2049
|
+
{
|
|
2050
|
+
"name": "value",
|
|
2051
|
+
"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.",
|
|
2052
|
+
"values": [{ "name": "string[]" }]
|
|
2053
|
+
},
|
|
2054
|
+
{
|
|
2055
|
+
"name": "size",
|
|
2056
|
+
"description": "The radio group's size. This size will be applied to all child radios and radio buttons.",
|
|
2057
|
+
"values": [
|
|
2058
|
+
{ "name": "x-small" },
|
|
2059
|
+
{ "name": "small" },
|
|
2060
|
+
{ "name": "medium" },
|
|
2061
|
+
{ "name": "large" }
|
|
2062
|
+
]
|
|
2063
|
+
},
|
|
2064
|
+
{
|
|
2065
|
+
"name": "pill",
|
|
2066
|
+
"description": "Draws pill-style tool buttons. This style will be applied to all child tool buttons.",
|
|
2067
|
+
"values": []
|
|
2068
|
+
},
|
|
2069
|
+
{
|
|
2070
|
+
"name": "outline",
|
|
2071
|
+
"description": "Draws outline-style tool buttons. This style will be applied to all child tool buttons.",
|
|
2072
|
+
"values": []
|
|
2073
|
+
},
|
|
2074
|
+
{
|
|
2075
|
+
"name": "form",
|
|
2076
|
+
"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.",
|
|
2077
|
+
"values": []
|
|
2078
|
+
},
|
|
2079
|
+
{
|
|
2080
|
+
"name": "vertical",
|
|
2081
|
+
"description": "Use vertical layout for the radio group.",
|
|
2082
|
+
"values": []
|
|
2083
|
+
},
|
|
2084
|
+
{
|
|
2085
|
+
"name": "mode",
|
|
2086
|
+
"values": [{ "name": "radio" }, { "name": "checkbox" }]
|
|
2087
|
+
}
|
|
2088
|
+
],
|
|
2089
|
+
"references": []
|
|
2090
|
+
},
|
|
2035
2091
|
{
|
|
2036
2092
|
"name": "flow-ui-tool-button",
|
|
2037
2093
|
"description": "Tool buttons are used in toolbars. 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.",
|
|
@@ -2118,62 +2174,6 @@
|
|
|
2118
2174
|
],
|
|
2119
2175
|
"references": []
|
|
2120
2176
|
},
|
|
2121
|
-
{
|
|
2122
|
-
"name": "flow-ui-tool-button-group",
|
|
2123
|
-
"description": "Tool buttons groups are used to build toolbars.\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.",
|
|
2124
|
-
"attributes": [
|
|
2125
|
-
{
|
|
2126
|
-
"name": "label",
|
|
2127
|
-
"description": "The radio group's label. Required for proper accessibility. If you need to display HTML, use the `label` slot\ninstead.",
|
|
2128
|
-
"values": []
|
|
2129
|
-
},
|
|
2130
|
-
{
|
|
2131
|
-
"name": "name",
|
|
2132
|
-
"description": "The name of the radio group, submitted as a name/value pair with form data.",
|
|
2133
|
-
"values": []
|
|
2134
|
-
},
|
|
2135
|
-
{
|
|
2136
|
-
"name": "value",
|
|
2137
|
-
"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.",
|
|
2138
|
-
"values": [{ "name": "string[]" }]
|
|
2139
|
-
},
|
|
2140
|
-
{
|
|
2141
|
-
"name": "size",
|
|
2142
|
-
"description": "The radio group's size. This size will be applied to all child radios and radio buttons.",
|
|
2143
|
-
"values": [
|
|
2144
|
-
{ "name": "x-small" },
|
|
2145
|
-
{ "name": "small" },
|
|
2146
|
-
{ "name": "medium" },
|
|
2147
|
-
{ "name": "large" }
|
|
2148
|
-
]
|
|
2149
|
-
},
|
|
2150
|
-
{
|
|
2151
|
-
"name": "pill",
|
|
2152
|
-
"description": "Draws pill-style tool buttons. This style will be applied to all child tool buttons.",
|
|
2153
|
-
"values": []
|
|
2154
|
-
},
|
|
2155
|
-
{
|
|
2156
|
-
"name": "outline",
|
|
2157
|
-
"description": "Draws outline-style tool buttons. This style will be applied to all child tool buttons.",
|
|
2158
|
-
"values": []
|
|
2159
|
-
},
|
|
2160
|
-
{
|
|
2161
|
-
"name": "form",
|
|
2162
|
-
"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.",
|
|
2163
|
-
"values": []
|
|
2164
|
-
},
|
|
2165
|
-
{
|
|
2166
|
-
"name": "vertical",
|
|
2167
|
-
"description": "Use vertical layout for the radio group.",
|
|
2168
|
-
"values": []
|
|
2169
|
-
},
|
|
2170
|
-
{
|
|
2171
|
-
"name": "mode",
|
|
2172
|
-
"values": [{ "name": "radio" }, { "name": "checkbox" }]
|
|
2173
|
-
}
|
|
2174
|
-
],
|
|
2175
|
-
"references": []
|
|
2176
|
-
},
|
|
2177
2177
|
{
|
|
2178
2178
|
"name": "flow-ui-tooltip",
|
|
2179
2179
|
"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.",
|