@emuanalytics/flow-rdf-ui 0.0.3 → 0.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 +7005 -6347
- package/dist/flow-rdf-ui.d.ts +26 -1
- package/dist/flow-rdf-ui.js +829 -735
- package/dist/flow-rdf-ui.umd.cjs +847 -752
- package/dist/vscode.html-custom-data.json +179 -270
- package/package.json +1 -1
|
@@ -34,68 +34,6 @@
|
|
|
34
34
|
],
|
|
35
35
|
"references": []
|
|
36
36
|
},
|
|
37
|
-
{
|
|
38
|
-
"name": "flow-ui-animation",
|
|
39
|
-
"description": "Animate elements declaratively with nearly 100 baked-in presets, or roll your own with custom keyframes. 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.",
|
|
40
|
-
"attributes": [
|
|
41
|
-
{
|
|
42
|
-
"name": "name",
|
|
43
|
-
"description": "The name of the built-in animation to use. For custom animations, use the `keyframes` prop.",
|
|
44
|
-
"values": []
|
|
45
|
-
},
|
|
46
|
-
{
|
|
47
|
-
"name": "play",
|
|
48
|
-
"description": "Plays the animation. When omitted, the animation will be paused. This attribute will be automatically removed when\nthe animation finishes or gets canceled.",
|
|
49
|
-
"values": []
|
|
50
|
-
},
|
|
51
|
-
{
|
|
52
|
-
"name": "delay",
|
|
53
|
-
"description": "The number of milliseconds to delay the start of the animation.",
|
|
54
|
-
"values": []
|
|
55
|
-
},
|
|
56
|
-
{
|
|
57
|
-
"name": "direction",
|
|
58
|
-
"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)",
|
|
59
|
-
"values": [{ "name": "PlaybackDirection" }]
|
|
60
|
-
},
|
|
61
|
-
{
|
|
62
|
-
"name": "duration",
|
|
63
|
-
"description": "The number of milliseconds each iteration of the animation takes to complete.",
|
|
64
|
-
"values": []
|
|
65
|
-
},
|
|
66
|
-
{
|
|
67
|
-
"name": "easing",
|
|
68
|
-
"description": "The easing function to use for the animation. This can be a Flo.w RDF UI easing function or a custom easing function\nsuch as `cubic-bezier(0, 1, .76, 1.14)`.",
|
|
69
|
-
"values": []
|
|
70
|
-
},
|
|
71
|
-
{
|
|
72
|
-
"name": "end-delay",
|
|
73
|
-
"description": "The number of milliseconds to delay after the active period of an animation sequence.",
|
|
74
|
-
"values": []
|
|
75
|
-
},
|
|
76
|
-
{
|
|
77
|
-
"name": "fill",
|
|
78
|
-
"description": "Sets how the animation applies styles to its target before and after its execution.",
|
|
79
|
-
"values": [{ "name": "FillMode" }]
|
|
80
|
-
},
|
|
81
|
-
{
|
|
82
|
-
"name": "iterations",
|
|
83
|
-
"description": "The number of iterations to run before the animation completes. Defaults to `Infinity`, which loops.",
|
|
84
|
-
"values": []
|
|
85
|
-
},
|
|
86
|
-
{
|
|
87
|
-
"name": "iteration-start",
|
|
88
|
-
"description": "The offset at which to start the animation, usually between 0 (start) and 1 (end).",
|
|
89
|
-
"values": []
|
|
90
|
-
},
|
|
91
|
-
{
|
|
92
|
-
"name": "playback-rate",
|
|
93
|
-
"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.",
|
|
94
|
-
"values": []
|
|
95
|
-
}
|
|
96
|
-
],
|
|
97
|
-
"references": []
|
|
98
|
-
},
|
|
99
37
|
{
|
|
100
38
|
"name": "flow-ui-avatar",
|
|
101
39
|
"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.",
|
|
@@ -132,6 +70,45 @@
|
|
|
132
70
|
],
|
|
133
71
|
"references": []
|
|
134
72
|
},
|
|
73
|
+
{
|
|
74
|
+
"name": "flow-ui-breadcrumb",
|
|
75
|
+
"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.",
|
|
76
|
+
"attributes": [
|
|
77
|
+
{
|
|
78
|
+
"name": "label",
|
|
79
|
+
"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.",
|
|
80
|
+
"values": []
|
|
81
|
+
}
|
|
82
|
+
],
|
|
83
|
+
"references": []
|
|
84
|
+
},
|
|
85
|
+
{
|
|
86
|
+
"name": "flow-ui-breadcrumb-item",
|
|
87
|
+
"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.",
|
|
88
|
+
"attributes": [
|
|
89
|
+
{
|
|
90
|
+
"name": "href",
|
|
91
|
+
"description": "Optional URL to direct the user to when the breadcrumb item is activated. When set, a link will be rendered\ninternally. When unset, a button will be rendered instead.",
|
|
92
|
+
"values": []
|
|
93
|
+
},
|
|
94
|
+
{
|
|
95
|
+
"name": "target",
|
|
96
|
+
"description": "Tells the browser where to open the link. Only used when `href` is set.",
|
|
97
|
+
"values": [
|
|
98
|
+
{ "name": "_blank" },
|
|
99
|
+
{ "name": "_parent" },
|
|
100
|
+
{ "name": "_self" },
|
|
101
|
+
{ "name": "_top" }
|
|
102
|
+
]
|
|
103
|
+
},
|
|
104
|
+
{
|
|
105
|
+
"name": "rel",
|
|
106
|
+
"description": "The `rel` attribute to use on the link. Only used when `href` is set.",
|
|
107
|
+
"values": []
|
|
108
|
+
}
|
|
109
|
+
],
|
|
110
|
+
"references": []
|
|
111
|
+
},
|
|
135
112
|
{
|
|
136
113
|
"name": "flow-ui-button",
|
|
137
114
|
"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.",
|
|
@@ -276,33 +253,6 @@
|
|
|
276
253
|
],
|
|
277
254
|
"references": []
|
|
278
255
|
},
|
|
279
|
-
{
|
|
280
|
-
"name": "flow-ui-breadcrumb-item",
|
|
281
|
-
"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.",
|
|
282
|
-
"attributes": [
|
|
283
|
-
{
|
|
284
|
-
"name": "href",
|
|
285
|
-
"description": "Optional URL to direct the user to when the breadcrumb item is activated. When set, a link will be rendered\ninternally. When unset, a button will be rendered instead.",
|
|
286
|
-
"values": []
|
|
287
|
-
},
|
|
288
|
-
{
|
|
289
|
-
"name": "target",
|
|
290
|
-
"description": "Tells the browser where to open the link. Only used when `href` is set.",
|
|
291
|
-
"values": [
|
|
292
|
-
{ "name": "_blank" },
|
|
293
|
-
{ "name": "_parent" },
|
|
294
|
-
{ "name": "_self" },
|
|
295
|
-
{ "name": "_top" }
|
|
296
|
-
]
|
|
297
|
-
},
|
|
298
|
-
{
|
|
299
|
-
"name": "rel",
|
|
300
|
-
"description": "The `rel` attribute to use on the link. Only used when `href` is set.",
|
|
301
|
-
"values": []
|
|
302
|
-
}
|
|
303
|
-
],
|
|
304
|
-
"references": []
|
|
305
|
-
},
|
|
306
256
|
{
|
|
307
257
|
"name": "flow-ui-button-group",
|
|
308
258
|
"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.",
|
|
@@ -317,12 +267,62 @@
|
|
|
317
267
|
"references": []
|
|
318
268
|
},
|
|
319
269
|
{
|
|
320
|
-
"name": "flow-ui-
|
|
321
|
-
"description": "
|
|
270
|
+
"name": "flow-ui-animation",
|
|
271
|
+
"description": "Animate elements declaratively with nearly 100 baked-in presets, or roll your own with custom keyframes. 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.",
|
|
322
272
|
"attributes": [
|
|
323
273
|
{
|
|
324
|
-
"name": "
|
|
325
|
-
"description": "The
|
|
274
|
+
"name": "name",
|
|
275
|
+
"description": "The name of the built-in animation to use. For custom animations, use the `keyframes` prop.",
|
|
276
|
+
"values": []
|
|
277
|
+
},
|
|
278
|
+
{
|
|
279
|
+
"name": "play",
|
|
280
|
+
"description": "Plays the animation. When omitted, the animation will be paused. This attribute will be automatically removed when\nthe animation finishes or gets canceled.",
|
|
281
|
+
"values": []
|
|
282
|
+
},
|
|
283
|
+
{
|
|
284
|
+
"name": "delay",
|
|
285
|
+
"description": "The number of milliseconds to delay the start of the animation.",
|
|
286
|
+
"values": []
|
|
287
|
+
},
|
|
288
|
+
{
|
|
289
|
+
"name": "direction",
|
|
290
|
+
"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)",
|
|
291
|
+
"values": [{ "name": "PlaybackDirection" }]
|
|
292
|
+
},
|
|
293
|
+
{
|
|
294
|
+
"name": "duration",
|
|
295
|
+
"description": "The number of milliseconds each iteration of the animation takes to complete.",
|
|
296
|
+
"values": []
|
|
297
|
+
},
|
|
298
|
+
{
|
|
299
|
+
"name": "easing",
|
|
300
|
+
"description": "The easing function to use for the animation. This can be a Flo.w RDF UI easing function or a custom easing function\nsuch as `cubic-bezier(0, 1, .76, 1.14)`.",
|
|
301
|
+
"values": []
|
|
302
|
+
},
|
|
303
|
+
{
|
|
304
|
+
"name": "end-delay",
|
|
305
|
+
"description": "The number of milliseconds to delay after the active period of an animation sequence.",
|
|
306
|
+
"values": []
|
|
307
|
+
},
|
|
308
|
+
{
|
|
309
|
+
"name": "fill",
|
|
310
|
+
"description": "Sets how the animation applies styles to its target before and after its execution.",
|
|
311
|
+
"values": [{ "name": "FillMode" }]
|
|
312
|
+
},
|
|
313
|
+
{
|
|
314
|
+
"name": "iterations",
|
|
315
|
+
"description": "The number of iterations to run before the animation completes. Defaults to `Infinity`, which loops.",
|
|
316
|
+
"values": []
|
|
317
|
+
},
|
|
318
|
+
{
|
|
319
|
+
"name": "iteration-start",
|
|
320
|
+
"description": "The offset at which to start the animation, usually between 0 (start) and 1 (end).",
|
|
321
|
+
"values": []
|
|
322
|
+
},
|
|
323
|
+
{
|
|
324
|
+
"name": "playback-rate",
|
|
325
|
+
"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.",
|
|
326
326
|
"values": []
|
|
327
327
|
}
|
|
328
328
|
],
|
|
@@ -826,97 +826,6 @@
|
|
|
826
826
|
],
|
|
827
827
|
"references": []
|
|
828
828
|
},
|
|
829
|
-
{
|
|
830
|
-
"name": "flow-ui-icon-button",
|
|
831
|
-
"description": "Icons buttons are simple, icon-only buttons that can be used for actions and in toolbars.\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\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.",
|
|
832
|
-
"attributes": [
|
|
833
|
-
{
|
|
834
|
-
"name": "name",
|
|
835
|
-
"description": "The name of the icon to draw. Available names depend on the icon library being used.",
|
|
836
|
-
"values": []
|
|
837
|
-
},
|
|
838
|
-
{
|
|
839
|
-
"name": "library",
|
|
840
|
-
"description": "The name of a registered custom icon library.",
|
|
841
|
-
"values": []
|
|
842
|
-
},
|
|
843
|
-
{
|
|
844
|
-
"name": "src",
|
|
845
|
-
"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.",
|
|
846
|
-
"values": []
|
|
847
|
-
},
|
|
848
|
-
{
|
|
849
|
-
"name": "href",
|
|
850
|
-
"description": "When set, the underlying button will be rendered as an `<a>` with this `href` instead of a `<button>`.",
|
|
851
|
-
"values": []
|
|
852
|
-
},
|
|
853
|
-
{
|
|
854
|
-
"name": "target",
|
|
855
|
-
"description": "Tells the browser where to open the link. Only used when `href` is set.",
|
|
856
|
-
"values": [
|
|
857
|
-
{ "name": "_blank" },
|
|
858
|
-
{ "name": "_parent" },
|
|
859
|
-
{ "name": "_self" },
|
|
860
|
-
{ "name": "_top" }
|
|
861
|
-
]
|
|
862
|
-
},
|
|
863
|
-
{
|
|
864
|
-
"name": "download",
|
|
865
|
-
"description": "Tells the browser to download the linked file as this filename. Only used when `href` is set.",
|
|
866
|
-
"values": []
|
|
867
|
-
},
|
|
868
|
-
{
|
|
869
|
-
"name": "label",
|
|
870
|
-
"description": "A description that gets read by assistive devices. For optimal accessibility, you should always include a label\nthat describes what the icon button does.",
|
|
871
|
-
"values": []
|
|
872
|
-
},
|
|
873
|
-
{
|
|
874
|
-
"name": "tooltip",
|
|
875
|
-
"description": "Tooltip text that gets displayed when the user hovers over the icon button. If you need to display HTML, use the\n`tooltip` slot instead.",
|
|
876
|
-
"values": []
|
|
877
|
-
},
|
|
878
|
-
{
|
|
879
|
-
"name": "tooltip-placement",
|
|
880
|
-
"description": "The preferred placement of the tooltip. Note that the actual placement may vary as needed to keep the tooltip\ninside of the viewport.",
|
|
881
|
-
"values": [
|
|
882
|
-
{ "name": "" },
|
|
883
|
-
{ "name": "top" },
|
|
884
|
-
{ "name": "top-start" },
|
|
885
|
-
{ "name": "top-end" },
|
|
886
|
-
{ "name": "right" },
|
|
887
|
-
{ "name": "right-start" },
|
|
888
|
-
{ "name": "right-end" },
|
|
889
|
-
{ "name": "bottom" },
|
|
890
|
-
{ "name": "bottom-start" },
|
|
891
|
-
{ "name": "bottom-end" },
|
|
892
|
-
{ "name": "left" },
|
|
893
|
-
{ "name": "left-start" },
|
|
894
|
-
{ "name": "left-end" }
|
|
895
|
-
]
|
|
896
|
-
},
|
|
897
|
-
{
|
|
898
|
-
"name": "tooltip-distance",
|
|
899
|
-
"description": "The distance in pixels from which to offset the tooltip away from the icon button.",
|
|
900
|
-
"values": []
|
|
901
|
-
},
|
|
902
|
-
{
|
|
903
|
-
"name": "tooltip-skidding",
|
|
904
|
-
"description": "The distance in pixels from which to offset the tooltip along the icon button.",
|
|
905
|
-
"values": []
|
|
906
|
-
},
|
|
907
|
-
{
|
|
908
|
-
"name": "disabled",
|
|
909
|
-
"description": "Disables the button.",
|
|
910
|
-
"values": []
|
|
911
|
-
},
|
|
912
|
-
{
|
|
913
|
-
"name": "confirm",
|
|
914
|
-
"description": "Confirmation text that gets displayed in a tooltip when the user clicks the icon button.\n If you need to display HTML, use the `confirm` slot instead.",
|
|
915
|
-
"values": []
|
|
916
|
-
}
|
|
917
|
-
],
|
|
918
|
-
"references": []
|
|
919
|
-
},
|
|
920
829
|
{
|
|
921
830
|
"name": "flow-ui-input",
|
|
922
831
|
"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.",
|
|
@@ -1121,76 +1030,12 @@
|
|
|
1121
1030
|
"attributes": [],
|
|
1122
1031
|
"references": []
|
|
1123
1032
|
},
|
|
1124
|
-
{
|
|
1125
|
-
"name": "flow-ui-menu-item",
|
|
1126
|
-
"description": "Menu items provide options for the user to pick from in a menu.\n\n\n---\n\n\n\n\n### **Methods:**\n - **getTextLabel()** - Returns a text label based on the contents of the menu item's default slot.\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).",
|
|
1127
|
-
"attributes": [
|
|
1128
|
-
{
|
|
1129
|
-
"name": "type",
|
|
1130
|
-
"description": "The type of menu item to render. To use `checked`, this value must be set to `checkbox`.",
|
|
1131
|
-
"values": [{ "name": "normal" }, { "name": "checkbox" }]
|
|
1132
|
-
},
|
|
1133
|
-
{
|
|
1134
|
-
"name": "checked",
|
|
1135
|
-
"description": "Draws the item in a checked state.",
|
|
1136
|
-
"values": []
|
|
1137
|
-
},
|
|
1138
|
-
{
|
|
1139
|
-
"name": "value",
|
|
1140
|
-
"description": "A unique value to store in the menu item. This can be used as a way to identify menu items when selected.",
|
|
1141
|
-
"values": []
|
|
1142
|
-
},
|
|
1143
|
-
{
|
|
1144
|
-
"name": "disabled",
|
|
1145
|
-
"description": "Draws the menu item in a disabled state, preventing selection.",
|
|
1146
|
-
"values": []
|
|
1147
|
-
}
|
|
1148
|
-
],
|
|
1149
|
-
"references": []
|
|
1150
|
-
},
|
|
1151
1033
|
{
|
|
1152
1034
|
"name": "flow-ui-menu-label",
|
|
1153
1035
|
"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.",
|
|
1154
1036
|
"attributes": [],
|
|
1155
1037
|
"references": []
|
|
1156
1038
|
},
|
|
1157
|
-
{
|
|
1158
|
-
"name": "flow-ui-mutation-observer",
|
|
1159
|
-
"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.",
|
|
1160
|
-
"attributes": [
|
|
1161
|
-
{
|
|
1162
|
-
"name": "attr",
|
|
1163
|
-
"description": "Watches for changes to attributes. To watch only specific attributes, separate them by a space, e.g.\n`attr=\"class id title\"`. To watch all attributes, use `*`.",
|
|
1164
|
-
"values": []
|
|
1165
|
-
},
|
|
1166
|
-
{
|
|
1167
|
-
"name": "attr-old-value",
|
|
1168
|
-
"description": "Indicates whether or not the attribute's previous value should be recorded when monitoring changes.",
|
|
1169
|
-
"values": []
|
|
1170
|
-
},
|
|
1171
|
-
{
|
|
1172
|
-
"name": "char-data",
|
|
1173
|
-
"description": "Watches for changes to the character data contained within the node.",
|
|
1174
|
-
"values": []
|
|
1175
|
-
},
|
|
1176
|
-
{
|
|
1177
|
-
"name": "char-data-old-value",
|
|
1178
|
-
"description": "Indicates whether or not the previous value of the node's text should be recorded.",
|
|
1179
|
-
"values": []
|
|
1180
|
-
},
|
|
1181
|
-
{
|
|
1182
|
-
"name": "child-list",
|
|
1183
|
-
"description": "Watches for the addition or removal of new child nodes.",
|
|
1184
|
-
"values": []
|
|
1185
|
-
},
|
|
1186
|
-
{
|
|
1187
|
-
"name": "disabled",
|
|
1188
|
-
"description": "Disables the observer.",
|
|
1189
|
-
"values": []
|
|
1190
|
-
}
|
|
1191
|
-
],
|
|
1192
|
-
"references": []
|
|
1193
|
-
},
|
|
1194
1039
|
{
|
|
1195
1040
|
"name": "flow-ui-option",
|
|
1196
1041
|
"description": "Options define the selectable items within various form controls such as [select](/components/select).\n\n\n---\n\n\n\n\n### **Methods:**\n - **getTextLabel()** - Returns a plain text label based on the option's content.\n\n### **Slots:**\n - _default_ - The option'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 - **checked-icon** - The checked icon, a `<flow-ui-icon>` element.\n- **base** - The component's base wrapper.\n- **label** - The option's label.\n- **prefix** - The container that wraps the prefix.\n- **suffix** - The container that wraps the suffix.",
|
|
@@ -1348,36 +1193,56 @@
|
|
|
1348
1193
|
"references": []
|
|
1349
1194
|
},
|
|
1350
1195
|
{
|
|
1351
|
-
"name": "flow-ui-
|
|
1352
|
-
"description": "
|
|
1196
|
+
"name": "flow-ui-mutation-observer",
|
|
1197
|
+
"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.",
|
|
1353
1198
|
"attributes": [
|
|
1354
1199
|
{
|
|
1355
|
-
"name": "
|
|
1356
|
-
"description": "
|
|
1200
|
+
"name": "attr",
|
|
1201
|
+
"description": "Watches for changes to attributes. To watch only specific attributes, separate them by a space, e.g.\n`attr=\"class id title\"`. To watch all attributes, use `*`.",
|
|
1357
1202
|
"values": []
|
|
1358
1203
|
},
|
|
1359
1204
|
{
|
|
1360
|
-
"name": "
|
|
1361
|
-
"description": "
|
|
1205
|
+
"name": "attr-old-value",
|
|
1206
|
+
"description": "Indicates whether or not the attribute's previous value should be recorded when monitoring changes.",
|
|
1362
1207
|
"values": []
|
|
1363
1208
|
},
|
|
1364
1209
|
{
|
|
1365
|
-
"name": "
|
|
1366
|
-
"description": "
|
|
1210
|
+
"name": "char-data",
|
|
1211
|
+
"description": "Watches for changes to the character data contained within the node.",
|
|
1212
|
+
"values": []
|
|
1213
|
+
},
|
|
1214
|
+
{
|
|
1215
|
+
"name": "char-data-old-value",
|
|
1216
|
+
"description": "Indicates whether or not the previous value of the node's text should be recorded.",
|
|
1217
|
+
"values": []
|
|
1218
|
+
},
|
|
1219
|
+
{
|
|
1220
|
+
"name": "child-list",
|
|
1221
|
+
"description": "Watches for the addition or removal of new child nodes.",
|
|
1222
|
+
"values": []
|
|
1223
|
+
},
|
|
1224
|
+
{
|
|
1225
|
+
"name": "disabled",
|
|
1226
|
+
"description": "Disables the observer.",
|
|
1367
1227
|
"values": []
|
|
1368
1228
|
}
|
|
1369
1229
|
],
|
|
1370
1230
|
"references": []
|
|
1371
1231
|
},
|
|
1372
1232
|
{
|
|
1373
|
-
"name": "flow-ui-progress-
|
|
1374
|
-
"description": "Progress
|
|
1233
|
+
"name": "flow-ui-progress-bar",
|
|
1234
|
+
"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.",
|
|
1375
1235
|
"attributes": [
|
|
1376
1236
|
{
|
|
1377
1237
|
"name": "value",
|
|
1378
1238
|
"description": "The current progress as a percentage, 0 to 100.",
|
|
1379
1239
|
"values": []
|
|
1380
1240
|
},
|
|
1241
|
+
{
|
|
1242
|
+
"name": "indeterminate",
|
|
1243
|
+
"description": "When true, percentage is ignored, the label is hidden, and the progress bar is drawn in an indeterminate state.",
|
|
1244
|
+
"values": []
|
|
1245
|
+
},
|
|
1381
1246
|
{
|
|
1382
1247
|
"name": "label",
|
|
1383
1248
|
"description": "A custom label for assistive devices.",
|
|
@@ -1463,6 +1328,23 @@
|
|
|
1463
1328
|
],
|
|
1464
1329
|
"references": []
|
|
1465
1330
|
},
|
|
1331
|
+
{
|
|
1332
|
+
"name": "flow-ui-progress-ring",
|
|
1333
|
+
"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.",
|
|
1334
|
+
"attributes": [
|
|
1335
|
+
{
|
|
1336
|
+
"name": "value",
|
|
1337
|
+
"description": "The current progress as a percentage, 0 to 100.",
|
|
1338
|
+
"values": []
|
|
1339
|
+
},
|
|
1340
|
+
{
|
|
1341
|
+
"name": "label",
|
|
1342
|
+
"description": "A custom label for assistive devices.",
|
|
1343
|
+
"values": []
|
|
1344
|
+
}
|
|
1345
|
+
],
|
|
1346
|
+
"references": []
|
|
1347
|
+
},
|
|
1466
1348
|
{
|
|
1467
1349
|
"name": "flow-ui-range",
|
|
1468
1350
|
"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.",
|
|
@@ -1525,18 +1407,6 @@
|
|
|
1525
1407
|
],
|
|
1526
1408
|
"references": []
|
|
1527
1409
|
},
|
|
1528
|
-
{
|
|
1529
|
-
"name": "flow-ui-resize-observer",
|
|
1530
|
-
"description": "The Resize Observer component offers a thin, declarative interface to the [`ResizeObserver API`](https://developer.mozilla.org/en-US/docs/Web/API/ResizeObserver).\n\n\n---\n\n\n\n\n### **Events:**\n - **flow-ui-resize** - Emitted when the element is resized.\n\n### **Slots:**\n - _default_ - One or more elements to watch for resizing.",
|
|
1531
|
-
"attributes": [
|
|
1532
|
-
{
|
|
1533
|
-
"name": "disabled",
|
|
1534
|
-
"description": "Disables the observer.",
|
|
1535
|
-
"values": []
|
|
1536
|
-
}
|
|
1537
|
-
],
|
|
1538
|
-
"references": []
|
|
1539
|
-
},
|
|
1540
1410
|
{
|
|
1541
1411
|
"name": "flow-ui-select",
|
|
1542
1412
|
"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-ui-option>` elements. You can use `<flow-ui-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- **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, combobox, clear icon, and expand button.\n- **prefix** - The container that wraps the prefix 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.",
|
|
@@ -1633,6 +1503,18 @@
|
|
|
1633
1503
|
],
|
|
1634
1504
|
"references": []
|
|
1635
1505
|
},
|
|
1506
|
+
{
|
|
1507
|
+
"name": "flow-ui-resize-observer",
|
|
1508
|
+
"description": "The Resize Observer component offers a thin, declarative interface to the [`ResizeObserver API`](https://developer.mozilla.org/en-US/docs/Web/API/ResizeObserver).\n\n\n---\n\n\n\n\n### **Events:**\n - **flow-ui-resize** - Emitted when the element is resized.\n\n### **Slots:**\n - _default_ - One or more elements to watch for resizing.",
|
|
1509
|
+
"attributes": [
|
|
1510
|
+
{
|
|
1511
|
+
"name": "disabled",
|
|
1512
|
+
"description": "Disables the observer.",
|
|
1513
|
+
"values": []
|
|
1514
|
+
}
|
|
1515
|
+
],
|
|
1516
|
+
"references": []
|
|
1517
|
+
},
|
|
1636
1518
|
{
|
|
1637
1519
|
"name": "flow-ui-spinner",
|
|
1638
1520
|
"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.",
|
|
@@ -1775,6 +1657,33 @@
|
|
|
1775
1657
|
],
|
|
1776
1658
|
"references": []
|
|
1777
1659
|
},
|
|
1660
|
+
{
|
|
1661
|
+
"name": "flow-ui-menu-item",
|
|
1662
|
+
"description": "Menu items provide options for the user to pick from in a menu.\n\n\n---\n\n\n\n\n### **Methods:**\n - **getTextLabel()** - Returns a text label based on the contents of the menu item's default slot.\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).",
|
|
1663
|
+
"attributes": [
|
|
1664
|
+
{
|
|
1665
|
+
"name": "type",
|
|
1666
|
+
"description": "The type of menu item to render. To use `checked`, this value must be set to `checkbox`.",
|
|
1667
|
+
"values": [{ "name": "normal" }, { "name": "checkbox" }]
|
|
1668
|
+
},
|
|
1669
|
+
{
|
|
1670
|
+
"name": "checked",
|
|
1671
|
+
"description": "Draws the item in a checked state.",
|
|
1672
|
+
"values": []
|
|
1673
|
+
},
|
|
1674
|
+
{
|
|
1675
|
+
"name": "value",
|
|
1676
|
+
"description": "A unique value to store in the menu item. This can be used as a way to identify menu items when selected.",
|
|
1677
|
+
"values": []
|
|
1678
|
+
},
|
|
1679
|
+
{
|
|
1680
|
+
"name": "disabled",
|
|
1681
|
+
"description": "Draws the menu item in a disabled state, preventing selection.",
|
|
1682
|
+
"values": []
|
|
1683
|
+
}
|
|
1684
|
+
],
|
|
1685
|
+
"references": []
|
|
1686
|
+
},
|
|
1778
1687
|
{
|
|
1779
1688
|
"name": "flow-ui-tab-panel",
|
|
1780
1689
|
"description": "Tab panels are used inside [tab groups](/components/tab-group) to display tabbed content.\n\n\n---\n\n\n\n\n### **Slots:**\n - _default_ - The tab panel's content.\n\n### **CSS Properties:**\n - **--padding** - The tab panel's padding. _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.",
|