{ "schemaVersion": "1.0.0", "readme": "", "modules": [ { "kind": "javascript-module", "path": "components/alert/alert.component.js", "declarations": [ { "kind": "class", "description": "", "name": "FlowUiAlert", "cssParts": [ { "description": "The component's base wrapper.", "name": "base" }, { "description": "The container that wraps the optional icon.", "name": "icon" }, { "description": "The container that wraps the alert's main content.", "name": "message" }, { "description": "The close button, an ``.", "name": "close-button" }, { "description": "The close button's exported `base` part.", "name": "close-button__base" } ], "slots": [ { "description": "The alert's main content.", "name": "" }, { "description": "An icon to show in the alert. Works best with ``.", "name": "icon" } ], "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "static": true, "default": "'flow-ui-alert'" }, { "kind": "field", "name": "dependencies", "type": { "text": "array" }, "static": true, "default": "[FlowUiIconButton]" }, { "kind": "field", "name": "autoHideTimeout", "type": { "text": "number" }, "privacy": "private" }, { "kind": "field", "name": "hasSlotController", "privacy": "private", "readonly": true, "default": "new HasSlotController(this, 'icon', 'suffix')" }, { "kind": "field", "name": "localize", "privacy": "private", "readonly": true, "default": "new LocalizeController(this)" }, { "kind": "field", "name": "base", "type": { "text": "HTMLElement" }, "privacy": "private" }, { "kind": "field", "name": "open", "type": { "text": "boolean" }, "default": "false", "description": "Set to `true` to display the alert. You can also\nuse the `show()` and `hide()` methods.", "attribute": "open", "reflects": true }, { "kind": "field", "name": "closable", "type": { "text": "boolean" }, "default": "false", "description": "Enables a close button that allows the user to dismiss the alert.", "attribute": "closable", "reflects": true }, { "kind": "field", "name": "variant", "type": { "text": "'primary' | 'secondary' | 'success' | 'neutral' | 'warning' | 'danger'" }, "default": "'primary'", "description": "The alert's theme variant.", "attribute": "variant", "reflects": true }, { "kind": "field", "name": "duration", "default": "Infinity", "description": "The length of time (in ms) that the alert will show itself before closing. If the user interacts with\nthe alert before it closes (e.g. by moving the mouse over it), the timer will restart.", "attribute": "duration" }, { "kind": "method", "name": "restartAutoHide", "privacy": "private" }, { "kind": "method", "name": "handleCloseClick", "privacy": "private" }, { "kind": "method", "name": "handleMouseMove", "privacy": "private" }, { "kind": "method", "name": "show", "description": "Shows the alert." }, { "kind": "method", "name": "hide", "description": "Hides the alert" }, { "kind": "method", "name": "toast", "return": { "type": { "text": "Promise" } }, "description": "Displays the alert as a toast notification. This will move the alert out of its position in the DOM and, when\ndismissed, it will be removed from the DOM completely. By storing a reference to the alert, you can reuse it by\ncalling this method again. The returned promise will resolve after the alert is hidden." } ], "events": [ { "description": "Emitted when the alert opens.", "name": "flow-ui-show", "reactName": "onFlowUiShow" }, { "description": "Emitted after the alert opens and all animations are complete.", "name": "flow-ui-after-show", "reactName": "onFlowUiAfterShow" }, { "description": "Emitted when the alert closes.", "name": "flow-ui-hide", "reactName": "onFlowUiHide" }, { "description": "Emitted after the alert closes and all animations are complete.", "name": "flow-ui-after-hide", "reactName": "onFlowUiAfterHide" } ], "attributes": [ { "name": "open", "type": { "text": "boolean" }, "default": "false", "description": "Set to `true` to display the alert. You can also\nuse the `show()` and `hide()` methods.", "fieldName": "open" }, { "name": "closable", "type": { "text": "boolean" }, "default": "false", "description": "Enables a close button that allows the user to dismiss the alert.", "fieldName": "closable" }, { "name": "variant", "type": { "text": "'primary' | 'secondary' | 'success' | 'neutral' | 'warning' | 'danger'" }, "default": "'primary'", "description": "The alert's theme variant.", "fieldName": "variant" }, { "name": "duration", "default": "Infinity", "description": "The length of time (in ms) that the alert will show itself before closing. If the user interacts with\nthe alert before it closes (e.g. by moving the mouse over it), the timer will restart.", "resolveInitializer": { "module": "src/components/alert/alert.component.ts" }, "fieldName": "duration" } ], "superclass": { "name": "FlowRdfElement", "module": "/src/internal/flow-ui-rdf-element" }, "tagName": "flow-ui-alert", "summary": "Alerts are used to display important messages inline or as toast notifications.", "dependencies": [ "flow-ui-icon-button" ], "animations": [ { "name": "alert.show", "description": "The animation to use when showing the alert." }, { "name": "alert.hide", "description": "The animation to use when hiding the alert." } ], "customElement": true } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "FlowUiAlert", "module": "components/alert/alert.component.js" } } ] }, { "kind": "javascript-module", "path": "components/alert/alert.js", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./alert.component" } }, { "kind": "js", "name": "default", "declaration": { "name": "FlowUiAlert", "module": "components/alert/alert.js" } } ] }, { "kind": "javascript-module", "path": "components/animation/animation.component.js", "declarations": [ { "kind": "class", "description": "", "name": "FlowUiAnimation", "slots": [ { "description": "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 `` elements.", "name": "" } ], "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "static": true, "default": "'flow-ui-animation'" }, { "kind": "field", "name": "animation", "type": { "text": "Animation | undefined" }, "privacy": "private" }, { "kind": "field", "name": "hasStarted", "type": { "text": "boolean" }, "privacy": "private", "default": "false" }, { "kind": "field", "name": "defaultSlot", "type": { "text": "Promise" }, "privacy": "private" }, { "kind": "field", "name": "name", "type": { "text": "string" }, "default": "'none'", "description": "The name of the built-in animation to use. For custom animations, use the `keyframes` prop.\nUse `getAnimationNames()` to retrieve a list of available animations.", "attribute": "name" }, { "kind": "field", "name": "play", "type": { "text": "boolean" }, "default": "false", "description": "Plays the animation. When omitted, the animation will be paused. This attribute will be automatically removed when\nthe animation finishes or gets canceled.", "attribute": "play", "reflects": true }, { "kind": "field", "name": "delay", "type": { "text": "number" }, "default": "0", "description": "The number of milliseconds to delay the start of the animation.", "attribute": "delay" }, { "kind": "field", "name": "direction", "type": { "text": "PlaybackDirection" }, "default": "'normal'", "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)", "attribute": "direction" }, { "kind": "field", "name": "duration", "type": { "text": "number" }, "default": "1000", "description": "The number of milliseconds each iteration of the animation takes to complete.", "attribute": "duration" }, { "kind": "field", "name": "easing", "type": { "text": "string" }, "default": "'linear'", "description": "The easing function to use for the animation. This can be a Shoelace easing function or a custom easing function\nsuch as `cubic-bezier(0, 1, .76, 1.14)`.", "attribute": "easing" }, { "kind": "field", "name": "endDelay", "type": { "text": "number" }, "default": "0", "description": "The number of milliseconds to delay after the active period of an animation sequence.", "attribute": "end-delay" }, { "kind": "field", "name": "fill", "type": { "text": "FillMode" }, "default": "'auto'", "description": "Sets how the animation applies styles to its target before and after its execution.", "attribute": "fill" }, { "kind": "field", "name": "iterations", "default": "Infinity", "description": "The number of iterations to run before the animation completes. Defaults to `Infinity`, which loops.", "attribute": "iterations" }, { "kind": "field", "name": "iterationStart", "type": { "text": "number" }, "default": "0", "description": "The offset at which to start the animation, usually between 0 (start) and 1 (end).", "attribute": "iteration-start" }, { "kind": "field", "name": "keyframes", "type": { "text": "Keyframe[] | undefined" }, "description": "The keyframes to use for the animation. If this is set, `name` will be ignored." }, { "kind": "field", "name": "playbackRate", "type": { "text": "number" }, "default": "1", "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.", "attribute": "playback-rate" }, { "kind": "field", "name": "currentTime", "type": { "text": "CSSNumberish" }, "description": "Gets and sets the current animation time." }, { "kind": "field", "name": "handleAnimationFinish", "privacy": "private" }, { "kind": "field", "name": "handleAnimationCancel", "privacy": "private" }, { "kind": "method", "name": "handleSlotChange", "privacy": "private" }, { "kind": "method", "name": "createAnimation", "privacy": "private" }, { "kind": "method", "name": "destroyAnimation", "privacy": "private" }, { "kind": "method", "name": "cancel", "description": "Clears all keyframe effects caused by this animation and aborts its playback." }, { "kind": "method", "name": "finish", "description": "Sets the playback time to the end of the animation corresponding to the current playback direction." } ], "events": [ { "description": "Emitted when the animation is canceled.", "name": "flow-ui-cancel", "reactName": "onFlowUiCancel" }, { "description": "Emitted when the animation finishes.", "name": "flow-ui-finish", "reactName": "onFlowUiFinish" }, { "description": "Emitted when the animation starts or restarts.", "name": "flow-ui-start", "reactName": "onFlowUiStart" } ], "attributes": [ { "name": "name", "type": { "text": "string" }, "default": "'none'", "description": "The name of the built-in animation to use. For custom animations, use the `keyframes` prop.\nUse `getAnimationNames()` to retrieve a list of available animations.", "fieldName": "name" }, { "name": "play", "type": { "text": "boolean" }, "default": "false", "description": "Plays the animation. When omitted, the animation will be paused. This attribute will be automatically removed when\nthe animation finishes or gets canceled.", "fieldName": "play" }, { "name": "delay", "type": { "text": "number" }, "default": "0", "description": "The number of milliseconds to delay the start of the animation.", "fieldName": "delay" }, { "name": "direction", "type": { "text": "PlaybackDirection" }, "default": "'normal'", "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)", "fieldName": "direction" }, { "name": "duration", "type": { "text": "number" }, "default": "1000", "description": "The number of milliseconds each iteration of the animation takes to complete.", "fieldName": "duration" }, { "name": "easing", "type": { "text": "string" }, "default": "'linear'", "description": "The easing function to use for the animation. This can be a Shoelace easing function or a custom easing function\nsuch as `cubic-bezier(0, 1, .76, 1.14)`.", "fieldName": "easing" }, { "name": "end-delay", "type": { "text": "number" }, "default": "0", "description": "The number of milliseconds to delay after the active period of an animation sequence.", "fieldName": "endDelay" }, { "name": "fill", "type": { "text": "FillMode" }, "default": "'auto'", "description": "Sets how the animation applies styles to its target before and after its execution.", "fieldName": "fill" }, { "name": "iterations", "default": "Infinity", "description": "The number of iterations to run before the animation completes. Defaults to `Infinity`, which loops.", "resolveInitializer": { "module": "src/components/animation/animation.component.ts" }, "fieldName": "iterations" }, { "name": "iteration-start", "type": { "text": "number" }, "default": "0", "description": "The offset at which to start the animation, usually between 0 (start) and 1 (end).", "fieldName": "iterationStart" }, { "name": "playback-rate", "type": { "text": "number" }, "default": "1", "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.", "fieldName": "playbackRate" } ], "superclass": { "name": "FlowRdfElement", "module": "/src/internal/flow-ui-rdf-element" }, "tagName": "flow-ui-animation", "summary": "Animate elements declaratively with over 100 animation presets. Powered by the [Web Animations API](https://developer.mozilla.org/en-US/docs/Web/API/Web_Animations_API).", "customElement": true } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "FlowUiAnimation", "module": "components/animation/animation.component.js" } } ] }, { "kind": "javascript-module", "path": "components/animation/animation.js", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./animation.component" } }, { "kind": "js", "name": "default", "declaration": { "name": "FlowUiAnimation", "module": "components/animation/animation.js" } } ] }, { "kind": "javascript-module", "path": "components/animation/animations.js", "declarations": [ { "kind": "function", "name": "getAnimationNames", "description": "Returns a list of all supported animation names.\n\nSupply the required animation as the `name` property of the\n`` component." }, { "kind": "function", "name": "getEasingNames", "description": "Returns a list of all supported easing method names.\n\nSupply the required easing method as the `easing` property of the\n`` component." } ], "exports": [ { "kind": "js", "name": "animations", "declaration": { "name": "animations", "module": "components/animation/animations.js" } }, { "kind": "js", "name": "getAnimationNames", "declaration": { "name": "getAnimationNames", "module": "components/animation/animations.js" } }, { "kind": "js", "name": "getEasingNames", "declaration": { "name": "getEasingNames", "module": "components/animation/animations.js" } } ] }, { "kind": "javascript-module", "path": "components/badge/badge.component.js", "declarations": [ { "kind": "class", "description": "", "name": "FlowUiBadge", "cssParts": [ { "description": "The component's base wrapper.", "name": "base" } ], "slots": [ { "description": "The badge's content.", "name": "" } ], "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "static": true, "default": "'flow-ui-badge'" }, { "kind": "field", "name": "variant", "type": { "text": "'primary' | 'secondary' | 'success' | 'neutral' | 'warning' | 'danger'" }, "default": "'primary'", "description": "The badge's theme variant.", "attribute": "variant", "reflects": true }, { "kind": "field", "name": "size", "type": { "text": "'small' | 'medium' | 'large'" }, "default": "'medium'", "description": "The badge size.", "attribute": "size", "reflects": true }, { "kind": "field", "name": "pill", "type": { "text": "boolean" }, "default": "false", "description": "Draws a pill-style badge with rounded edges.", "attribute": "pill", "reflects": true }, { "kind": "field", "name": "pulse", "type": { "text": "boolean" }, "default": "false", "description": "Makes the badge pulsate to draw attention.", "attribute": "pulse", "reflects": true } ], "attributes": [ { "name": "variant", "type": { "text": "'primary' | 'secondary' | 'success' | 'neutral' | 'warning' | 'danger'" }, "default": "'primary'", "description": "The badge's theme variant.", "fieldName": "variant" }, { "name": "size", "type": { "text": "'small' | 'medium' | 'large'" }, "default": "'medium'", "description": "The badge size.", "fieldName": "size" }, { "name": "pill", "type": { "text": "boolean" }, "default": "false", "description": "Draws a pill-style badge with rounded edges.", "fieldName": "pill" }, { "name": "pulse", "type": { "text": "boolean" }, "default": "false", "description": "Makes the badge pulsate to draw attention.", "fieldName": "pulse" } ], "superclass": { "name": "FlowRdfElement", "module": "/src/internal/flow-ui-rdf-element" }, "tagName": "flow-ui-badge", "summary": "Badges are used to draw attention and display statuses or counts.", "customElement": true } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "FlowUiBadge", "module": "components/badge/badge.component.js" } } ] }, { "kind": "javascript-module", "path": "components/badge/badge.js", "declarations": [], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "FlowUiBadge", "module": "components/badge/badge.js" } } ] }, { "kind": "javascript-module", "path": "components/breadcrumb/breadcrumb.component.js", "declarations": [ { "kind": "class", "description": "", "name": "FlowUiBreadcrumb", "cssParts": [ { "description": "The component's base wrapper.", "name": "base" } ], "slots": [ { "description": "One or more breadcrumb items to display.", "name": "" }, { "description": "The separator to use between breadcrumb items. Works best with ``.", "name": "separator" } ], "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "static": true, "default": "'flow-ui-breadcrumb'" }, { "kind": "field", "name": "dependencies", "type": { "text": "array" }, "static": true, "default": "[FlowUiIcon]" }, { "kind": "field", "name": "localize", "privacy": "private", "readonly": true, "default": "new LocalizeController(this)" }, { "kind": "field", "name": "separatorDir", "privacy": "private" }, { "kind": "field", "name": "defaultSlot", "type": { "text": "HTMLSlotElement" }, "privacy": "private" }, { "kind": "field", "name": "separatorSlot", "type": { "text": "HTMLSlotElement" }, "privacy": "private" }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "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.", "attribute": "label" }, { "kind": "method", "name": "getSeparator", "privacy": "private" }, { "kind": "method", "name": "handleSlotChange", "privacy": "private" } ], "attributes": [ { "name": "label", "type": { "text": "string" }, "default": "''", "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.", "fieldName": "label" } ], "superclass": { "name": "FlowRdfElement", "module": "/src/internal/flow-ui-rdf-element" }, "tagName": "flow-ui-breadcrumb", "summary": "Breadcrumbs provide a group of links so users can easily navigate a website's hierarchy.", "docgroup": "breadcrumb", "dependencies": [ "flow-ui-icon" ], "customElement": true } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "FlowUiBreadcrumb", "module": "components/breadcrumb/breadcrumb.component.js" } } ] }, { "kind": "javascript-module", "path": "components/breadcrumb/breadcrumb.js", "declarations": [], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "FlowUiBreadcrumb", "module": "components/breadcrumb/breadcrumb.js" } } ] }, { "kind": "javascript-module", "path": "components/base-control/base-control.component.js", "declarations": [ { "kind": "class", "description": "", "name": "FlowUiBaseControl", "cssParts": [ { "description": "The form control that wraps the label, input, and help text.", "name": "form-control" }, { "description": "The label's wrapper.", "name": "form-control-label" }, { "description": "The input's wrapper.", "name": "form-control-input" }, { "description": "The help text's wrapper.", "name": "form-control-help-text" }, { "description": "The component's base wrapper.", "name": "base" }, { "description": "The internal `` control.", "name": "input" }, { "description": "The container that wraps the prefix.", "name": "prefix" }, { "description": "The clear button.", "name": "clear-button" }, { "description": "The password toggle button.", "name": "password-toggle-button" }, { "description": "The container that wraps the suffix.", "name": "suffix" } ], "slots": [ { "description": "The input's label. Alternatively, you can use the `label` attribute.", "name": "label" }, { "description": "Used to prepend a presentational icon or similar element to the input.", "name": "prefix" }, { "description": "Used to append a presentational icon or similar element to the input.", "name": "suffix" }, { "description": "An icon to use in lieu of the default clear icon.", "name": "clear-icon" }, { "description": "An icon to use in lieu of the default show password icon.", "name": "show-password-icon" }, { "description": "An icon to use in lieu of the default hide password icon.", "name": "hide-password-icon" }, { "description": "Text that describes how to use the input. Alternatively, you can use the `help-text` attribute.", "name": "help-text" } ], "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "static": true, "default": "'flow-ui-base-control'" }, { "kind": "field", "name": "dependencies", "type": { "text": "array" }, "static": true, "default": "[FlowUiDivider]" }, { "kind": "field", "name": "formControlController", "privacy": "private", "readonly": true, "default": "new FormControlController(this, {\n assumeInteractionOn: ['flow-ui-blur', 'flow-ui-input']\n })" }, { "kind": "field", "name": "hasSlotController", "privacy": "private", "readonly": true, "default": "new HasSlotController(this, 'help-text', 'label')" }, { "kind": "field", "name": "hasFocus", "type": { "text": "boolean" }, "privacy": "private", "default": "false" }, { "kind": "field", "name": "size", "type": { "text": "'small' | 'medium' | 'large'" }, "default": "'medium'", "description": "The input's size.", "attribute": "size", "reflects": true }, { "kind": "field", "name": "filled", "type": { "text": "boolean" }, "default": "false", "description": "Draws a filled input.", "attribute": "filled", "reflects": true }, { "kind": "field", "name": "pill", "type": { "text": "boolean" }, "default": "false", "description": "Draws a pill-style input with rounded edges.", "attribute": "pill", "reflects": true }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "The input's label. If you need to display HTML, use the `label` slot instead.", "attribute": "label" }, { "kind": "field", "name": "helpText", "type": { "text": "string" }, "default": "''", "description": "The input's help text. If you need to display HTML, use the `help-text` slot instead.", "attribute": "help-text" }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Disables the input.", "attribute": "disabled", "reflects": true }, { "kind": "field", "name": "form", "type": { "text": "string" }, "default": "''", "description": "By default, form controls are associated with the nearest containing `
` 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.", "attribute": "form", "reflects": true }, { "kind": "field", "name": "required", "type": { "text": "boolean" }, "default": "false", "description": "Makes the input a required field.", "attribute": "required", "reflects": true }, { "kind": "field", "name": "inline", "type": { "text": "boolean" }, "default": "false", "description": "Display the input in the 'inline' form control style.", "attribute": "inline", "reflects": true }, { "kind": "field", "name": "divider", "type": { "text": "boolean" }, "default": "false", "description": "Indicates that the control should display a divider", "attribute": "divider", "reflects": true }, { "kind": "field", "name": "validity", "description": "Gets the validity state object", "readonly": true }, { "kind": "field", "name": "validationMessage", "description": "Gets the validation message", "readonly": true }, { "kind": "method", "name": "handleBlur", "privacy": "private" }, { "kind": "method", "name": "handleFocus", "privacy": "private" }, { "kind": "method", "name": "focus", "parameters": [ { "name": "options", "optional": true, "type": { "text": "FocusOptions" } } ], "description": "Sets focus on the input." }, { "kind": "method", "name": "blur", "description": "Removes focus from the input." }, { "kind": "method", "name": "checkValidity", "description": "Checks for validity but does not show a validation message. Returns `true` when valid and `false` when invalid." }, { "kind": "method", "name": "getForm", "return": { "type": { "text": "HTMLFormElement | null" } }, "description": "Gets the associated form, if one exists." }, { "kind": "method", "name": "reportValidity", "description": "Checks for validity and shows the browser's validation message if the control is invalid." }, { "kind": "method", "name": "setCustomValidity", "parameters": [ { "name": "message", "type": { "text": "string" } } ], "description": "Sets a custom validation message. Pass an empty string to restore validity." } ], "events": [ { "description": "Emitted when the control loses focus.", "name": "flow-ui-blur", "reactName": "onFlowUiBlur" }, { "description": "Emitted when an alteration to the control's value is committed by the user.", "name": "flow-ui-change", "reactName": "onFlowUiChange" }, { "description": "Emitted when the clear button is activated.", "name": "flow-ui-clear", "reactName": "onFlowUiClear" }, { "description": "Emitted when the control gains focus.", "name": "flow-ui-focus", "reactName": "onFlowUiFocus" }, { "description": "Emitted when the control receives input.", "name": "flow-ui-input", "reactName": "onFlowUiInput" }, { "description": "Emitted when the form control has been checked for validity and its constraints aren't satisfied.", "name": "flow-ui-invalid", "reactName": "onFlowUiInvalid" } ], "attributes": [ { "name": "size", "type": { "text": "'small' | 'medium' | 'large'" }, "default": "'medium'", "description": "The input's size.", "fieldName": "size" }, { "name": "filled", "type": { "text": "boolean" }, "default": "false", "description": "Draws a filled input.", "fieldName": "filled" }, { "name": "pill", "type": { "text": "boolean" }, "default": "false", "description": "Draws a pill-style input with rounded edges.", "fieldName": "pill" }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "The input's label. If you need to display HTML, use the `label` slot instead.", "fieldName": "label" }, { "name": "help-text", "type": { "text": "string" }, "default": "''", "description": "The input's help text. If you need to display HTML, use the `help-text` slot instead.", "fieldName": "helpText" }, { "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Disables the input.", "fieldName": "disabled" }, { "name": "form", "type": { "text": "string" }, "default": "''", "description": "By default, form controls are associated with the nearest containing `` 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.", "fieldName": "form" }, { "name": "required", "type": { "text": "boolean" }, "default": "false", "description": "Makes the input a required field.", "fieldName": "required" }, { "name": "inline", "type": { "text": "boolean" }, "default": "false", "description": "Display the input in the 'inline' form control style.", "fieldName": "inline" }, { "name": "divider", "type": { "text": "boolean" }, "default": "false", "description": "Indicates that the control should display a divider", "fieldName": "divider" } ], "superclass": { "name": "FlowRdfFormControl", "module": "/src/internal/flow-ui-rdf-element" }, "tagName": "flow-ui-base-control", "summary": "Inputs collect data from the user.", "documentation": "https://developer.emu-analytics.net/docs/flow-ui-rdf/components/input", "status": "stable", "since": "2.0", "dependencies": [ "flow-ui-divider" ], "customElement": true } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "FlowUiBaseControl", "module": "components/base-control/base-control.component.js" } } ] }, { "kind": "javascript-module", "path": "components/base-control/base-control.js", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./base-control.component" } }, { "kind": "js", "name": "default", "declaration": { "name": "FlowUiBaseControl", "module": "components/base-control/base-control.js" } } ] }, { "kind": "javascript-module", "path": "components/avatar/avatar.component.js", "declarations": [ { "kind": "class", "description": "", "name": "FlowUiAvatar", "cssProperties": [ { "description": "The size of the avatar.", "name": "--size" } ], "cssParts": [ { "description": "The component's base wrapper.", "name": "base" }, { "description": "The container that wraps the avatar's icon.", "name": "icon" }, { "description": "The container that wraps the avatar's initials.", "name": "initials" }, { "description": "The avatar image. Only shown when the `image` attribute is set.", "name": "image" } ], "slots": [ { "description": "The default icon to use when no image or initials are present. Works best with ``.", "name": "icon" } ], "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "static": true, "default": "'flow-ui-avatar'" }, { "kind": "field", "name": "dependencies", "type": { "text": "array" }, "static": true, "default": "[FlowUiIcon]" }, { "kind": "field", "name": "hasError", "type": { "text": "boolean" }, "privacy": "private", "default": "false" }, { "kind": "field", "name": "image", "type": { "text": "string" }, "default": "''", "description": "The image source to use for the avatar.", "attribute": "image" }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "A label to use to describe the avatar to assistive devices.", "attribute": "label" }, { "kind": "field", "name": "initials", "type": { "text": "string" }, "default": "''", "description": "Initials to use as a fallback when no image is available (1-2 characters max recommended).", "attribute": "initials" }, { "kind": "field", "name": "loading", "type": { "text": "'eager' | 'lazy'" }, "default": "'eager'", "description": "Indicates how the browser should load the image.", "attribute": "loading" }, { "kind": "field", "name": "shape", "type": { "text": "'circle' | 'square' | 'rounded'" }, "default": "'circle'", "description": "The shape of the avatar.", "attribute": "shape", "reflects": true } ], "attributes": [ { "name": "image", "type": { "text": "string" }, "default": "''", "description": "The image source to use for the avatar.", "fieldName": "image" }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "A label to use to describe the avatar to assistive devices.", "fieldName": "label" }, { "name": "initials", "type": { "text": "string" }, "default": "''", "description": "Initials to use as a fallback when no image is available (1-2 characters max recommended).", "fieldName": "initials" }, { "name": "loading", "type": { "text": "'eager' | 'lazy'" }, "default": "'eager'", "description": "Indicates how the browser should load the image.", "fieldName": "loading" }, { "name": "shape", "type": { "text": "'circle' | 'square' | 'rounded'" }, "default": "'circle'", "description": "The shape of the avatar.", "fieldName": "shape" } ], "superclass": { "name": "FlowRdfElement", "module": "/src/internal/flow-ui-rdf-element" }, "tagName": "flow-ui-avatar", "summary": "Avatars are used to represent a person or object.", "dependencies": [ "flow-ui-icon" ], "customElement": true } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "FlowUiAvatar", "module": "components/avatar/avatar.component.js" } } ] }, { "kind": "javascript-module", "path": "components/avatar/avatar.js", "declarations": [], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "FlowUiAvatar", "module": "components/avatar/avatar.js" } } ] }, { "kind": "javascript-module", "path": "components/autocomplete/autocomplete.component.js", "declarations": [ { "kind": "class", "description": "The autocomplete component does not filter its options itself. Listen for the `flow-ui-input` event, read the text\nthat the user has typed with `getInputText()`, and replace the slotted `` elements with the options\nthat match. The autocomplete's value is the option value of the selected option. Use `displayWith` to show a label\nin the input instead of the option value.", "name": "FlowUiAutocomplete", "cssParts": [ { "description": "The form control that wraps the label, input, and help text.", "name": "form-control" }, { "description": "The label's wrapper.", "name": "label" }, { "description": "The help text's wrapper.", "name": "help-text" }, { "description": "The input's wrapper.", "name": "control" }, { "description": "The container that wraps the prefix, suffix, input and clear button.", "name": "combobox" }, { "description": "The container that wraps the prefix.", "name": "prefix" }, { "description": "The container that wraps the suffix.", "name": "suffix" }, { "description": "The text input, an `` element.", "name": "display-input" }, { "description": "The listbox container where options are slotted.", "name": "listbox" }, { "description": "The clear button.", "name": "clear-button" } ], "slots": [ { "description": "The listbox options. Must be `` elements. You can use `` to group items visually.", "name": "" }, { "description": "The autocomplete's label. Alternatively, you can use the `label` attribute.", "name": "label" }, { "description": "Used to prepend a presentational icon or similar element to the combobox.", "name": "prefix" }, { "description": "Used to append a presentational icon or similar element to the combobox.", "name": "suffix" }, { "description": "An icon to use in lieu of the default clear icon.", "name": "clear-icon" }, { "description": "Text that describes how to use the autocomplete. Alternatively, you can use the `help-text` attribute.", "name": "help-text" } ], "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "static": true, "default": "'flow-ui-autocomplete'" }, { "kind": "field", "name": "dependencies", "type": { "text": "array" }, "static": true, "default": "[FlowUiDivider, FlowIcon, FlowPopup]" }, { "kind": "field", "name": "hasSlotController", "privacy": "private", "readonly": true, "default": "new HasSlotController(this, 'help-text', 'label')" }, { "kind": "field", "name": "localize", "privacy": "private", "readonly": true, "default": "new LocalizeController(this)" }, { "kind": "field", "name": "pendingChangeEvent", "type": { "text": "boolean" }, "privacy": "private", "default": "false" }, { "kind": "field", "name": "pendingInputEvent", "type": { "text": "boolean" }, "privacy": "private", "default": "false" }, { "kind": "field", "name": "hasOptions", "type": { "text": "boolean" }, "privacy": "private", "default": "false" }, { "kind": "field", "name": "formControlController", "privacy": "private", "readonly": true, "default": "new FormControlController(this, {\n assumeInteractionOn: ['flow-ui-blur', 'flow-ui-input']\n })" }, { "kind": "field", "name": "size", "type": { "text": "'small' | 'medium' | 'large'" }, "default": "'medium'", "description": "The autocomplete's size.", "attribute": "size", "reflects": true }, { "kind": "field", "name": "filled", "type": { "text": "boolean" }, "default": "false", "description": "Draws a filled autocomplete input.", "attribute": "filled", "reflects": true }, { "kind": "field", "name": "pill", "type": { "text": "boolean" }, "default": "false", "description": "Draws a pill-style autocomplete input with rounded edges.", "attribute": "pill", "reflects": true }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "The autocomplete's label. If you need to display HTML, use the `label` slot instead.", "attribute": "label" }, { "kind": "field", "name": "helpText", "type": { "text": "string" }, "default": "''", "description": "The autocomplete's help text. If you need to display HTML, use the `help-text` slot instead.", "attribute": "help-text" }, { "kind": "field", "name": "placeholder", "type": { "text": "string" }, "default": "''", "description": "The autocomplete's placeholder text.", "attribute": "placeholder" }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Disables the autocomplete.", "attribute": "disabled", "reflects": true }, { "kind": "field", "name": "form", "type": { "text": "string" }, "description": "The \"form owner\" to associate the autocomplete with. If omitted, the closest containing form will be used\ninstead. The value of this attribute must be an id of a form in the same document or shadow root as the\nautocomplete.", "attribute": "form" }, { "kind": "field", "name": "required", "type": { "text": "boolean" }, "default": "false", "description": "Makes the autocomplete a required field.", "attribute": "required", "reflects": true }, { "kind": "field", "name": "inline", "type": { "text": "boolean" }, "default": "false", "description": "Set to `true` to display the autocomplete in the inline form control style.", "attribute": "inline", "reflects": true }, { "kind": "field", "name": "divider", "type": { "text": "boolean" }, "default": "false", "description": "Set to `true` to display a divider below the control.", "attribute": "divider", "reflects": true }, { "kind": "field", "name": "hoist", "type": { "text": "boolean" }, "default": "false", "description": "Enable this option to prevent the listbox from being clipped when the component is placed inside a container with\n`overflow: auto|scroll`. Hoisting uses a fixed positioning strategy that works in many, but not all, scenarios.", "attribute": "hoist" }, { "kind": "field", "name": "placement", "type": { "text": "'top' | 'bottom'" }, "default": "'bottom'", "description": "The preferred placement of the autocomplete's menu. Note that the actual placement may vary as needed to keep the listbox\ninside of the viewport.", "attribute": "placement", "reflects": true }, { "kind": "field", "name": "value", "type": { "text": "string" }, "default": "''", "description": "The option value of the selected option.", "attribute": "value" }, { "kind": "field", "name": "displayWith", "type": { "text": "((value: string) => string) | ((value: string) => Promise)" }, "description": "The function that returns the text to show in the input for a given `value`. It can return a promise. If not set,\nthe input shows the value itself.", "attribute": "displayWith" }, { "kind": "field", "name": "debounceDelay", "type": { "text": "number" }, "default": "0", "description": "The delay in milliseconds between the user's last keystroke and the `flow-ui-input` event.", "attribute": "debounce-delay", "reflects": true }, { "kind": "field", "name": "clearable", "type": { "text": "boolean" }, "default": "false", "description": "Set to `true` to show a clear button when the autocomplete has a value.", "attribute": "clearable", "reflects": true }, { "kind": "field", "name": "clearOnFocus", "type": { "text": "boolean" }, "default": "false", "description": "Set to `true` to clear the value when the autocomplete gains focus.", "attribute": "clear-on-focus", "reflects": true }, { "kind": "field", "name": "inputText", "type": { "text": "string" }, "privacy": "private", "default": "''", "description": "Current value displayed by the control; this can be what the user is typing or the label of the selected option" }, { "kind": "field", "name": "selectedOption", "type": { "text": "FlowOption | null" }, "privacy": "private", "default": "null" }, { "kind": "field", "name": "currentOption", "type": { "text": "FlowOption | null" }, "privacy": "private", "default": "null" }, { "kind": "field", "name": "input", "type": { "text": "HTMLInputElement" }, "privacy": "private" }, { "kind": "field", "name": "popup", "type": { "text": "FlowPopup" }, "privacy": "private" }, { "kind": "field", "name": "listbox", "type": { "text": "HTMLElement" }, "privacy": "private" }, { "kind": "method", "name": "getForm", "return": { "type": { "text": "HTMLFormElement | null" } }, "description": "Gets the associated form, if one exists." }, { "kind": "field", "name": "validity", "description": "Gets the validity state object.", "readonly": true }, { "kind": "field", "name": "validationMessage", "description": "Gets the validation message.", "readonly": true }, { "kind": "method", "name": "checkValidity", "return": { "type": { "text": "boolean" } }, "description": "Checks for validity but does not show a validation message. Returns `true` when valid and `false` when invalid." }, { "kind": "method", "name": "reportValidity", "return": { "type": { "text": "boolean" } }, "description": "Checks for validity and shows the browser's validation message if the control is invalid." }, { "kind": "method", "name": "setCustomValidity", "parameters": [ { "name": "_", "type": { "text": "string" } } ], "description": "Sets a custom validation message. Pass an empty string to restore validity." }, { "kind": "method", "name": "handleClearClick", "parameters": [ { "name": "event", "type": { "text": "MouseEvent" } } ] }, { "kind": "method", "name": "focus", "description": "Focuses on the control" }, { "kind": "method", "name": "blur", "description": "Blurs from the control." }, { "kind": "method", "name": "show", "description": "Shows the listbox." }, { "kind": "method", "name": "hide", "description": "Hides the listbox." }, { "kind": "method", "name": "getInputText", "description": "Gets the current value of the text input" } ], "events": [ { "description": "Emitted when the input text changes. When the user types, the event is emitted after the `debounce-delay`. Call `getInputText()` to read the text, for example to update the options.", "name": "flow-ui-input", "reactName": "onFlowUiInput" }, { "description": "Emitted when the autocomplete's value changes.", "name": "flow-ui-change", "reactName": "onFlowUiChange" }, { "description": "Emitted when the autocomplete gains focus.", "name": "flow-ui-focus", "reactName": "onFlowUiFocus" }, { "description": "Emitted when the autocomplete loses focus.", "name": "flow-ui-blur", "reactName": "onFlowUiBlur" }, { "description": "Emitted when the listbox opens.", "name": "flow-ui-show", "reactName": "onFlowUiShow" }, { "description": "Emitted after the listbox opens and all animations are complete.", "name": "flow-ui-after-show", "reactName": "onFlowUiAfterShow" }, { "description": "Emitted when the listbox closes.", "name": "flow-ui-hide", "reactName": "onFlowUiHide" }, { "description": "Emitted after the listbox closes and all animations are complete.", "name": "flow-ui-after-hide", "reactName": "onFlowUiAfterHide" } ], "attributes": [ { "name": "size", "type": { "text": "'small' | 'medium' | 'large'" }, "default": "'medium'", "description": "The autocomplete's size.", "fieldName": "size" }, { "name": "filled", "type": { "text": "boolean" }, "default": "false", "description": "Draws a filled autocomplete input.", "fieldName": "filled" }, { "name": "pill", "type": { "text": "boolean" }, "default": "false", "description": "Draws a pill-style autocomplete input with rounded edges.", "fieldName": "pill" }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "The autocomplete's label. If you need to display HTML, use the `label` slot instead.", "fieldName": "label" }, { "name": "help-text", "type": { "text": "string" }, "default": "''", "description": "The autocomplete's help text. If you need to display HTML, use the `help-text` slot instead.", "fieldName": "helpText" }, { "name": "placeholder", "type": { "text": "string" }, "default": "''", "description": "The autocomplete's placeholder text.", "fieldName": "placeholder" }, { "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Disables the autocomplete.", "fieldName": "disabled" }, { "name": "form", "type": { "text": "string" }, "description": "The \"form owner\" to associate the autocomplete with. If omitted, the closest containing form will be used\ninstead. The value of this attribute must be an id of a form in the same document or shadow root as the\nautocomplete.", "fieldName": "form" }, { "name": "required", "type": { "text": "boolean" }, "default": "false", "description": "Makes the autocomplete a required field.", "fieldName": "required" }, { "name": "inline", "type": { "text": "boolean" }, "default": "false", "description": "Set to `true` to display the autocomplete in the inline form control style.", "fieldName": "inline" }, { "name": "divider", "type": { "text": "boolean" }, "default": "false", "description": "Set to `true` to display a divider below the control.", "fieldName": "divider" }, { "name": "hoist", "type": { "text": "boolean" }, "default": "false", "description": "Enable this option to prevent the listbox from being clipped when the component is placed inside a container with\n`overflow: auto|scroll`. Hoisting uses a fixed positioning strategy that works in many, but not all, scenarios.", "fieldName": "hoist" }, { "name": "placement", "type": { "text": "'top' | 'bottom'" }, "default": "'bottom'", "description": "The preferred placement of the autocomplete's menu. Note that the actual placement may vary as needed to keep the listbox\ninside of the viewport.", "fieldName": "placement" }, { "name": "value", "type": { "text": "string" }, "default": "''", "description": "The option value of the selected option.", "fieldName": "value" }, { "name": "displayWith", "type": { "text": "((value: string) => string) | ((value: string) => Promise)" }, "description": "The function that returns the text to show in the input for a given `value`. It can return a promise. If not set,\nthe input shows the value itself.", "fieldName": "displayWith" }, { "name": "debounce-delay", "type": { "text": "number" }, "default": "0", "description": "The delay in milliseconds between the user's last keystroke and the `flow-ui-input` event.", "fieldName": "debounceDelay" }, { "name": "clearable", "type": { "text": "boolean" }, "default": "false", "description": "Set to `true` to show a clear button when the autocomplete has a value.", "fieldName": "clearable" }, { "name": "clear-on-focus", "type": { "text": "boolean" }, "default": "false", "description": "Set to `true` to clear the value when the autocomplete gains focus.", "fieldName": "clearOnFocus" } ], "superclass": { "name": "FlowRdfFormControl", "module": "/src/internal/flow-ui-rdf-element" }, "tagName": "flow-ui-autocomplete", "summary": "Autocompletes allow users to type into a text input and choose a value from a list of suggested [options](./flow-ui-option).", "dependencies": [ "flow-ui-divider", "flow-ui-icon", "flow-ui-popup" ], "customElement": true } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "FlowUiAutocomplete", "module": "components/autocomplete/autocomplete.component.js" } } ] }, { "kind": "javascript-module", "path": "components/autocomplete/autocomplete.js", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./autocomplete.component" } }, { "kind": "js", "name": "default", "declaration": { "name": "FlowUiAutocomplete", "module": "components/autocomplete/autocomplete.js" } } ] }, { "kind": "javascript-module", "path": "components/breadcrumb-item/breadcrumb-item.component.js", "declarations": [ { "kind": "class", "description": "", "name": "FlowUiBreadcrumbItem", "cssParts": [ { "description": "The component's base wrapper.", "name": "base" }, { "description": "The breadcrumb item's label.", "name": "label" }, { "description": "The container that wraps the prefix.", "name": "prefix" }, { "description": "The container that wraps the suffix.", "name": "suffix" }, { "description": "The container that wraps the separator.", "name": "separator" } ], "slots": [ { "description": "The breadcrumb item's label.", "name": "" }, { "description": "An optional prefix, usually an icon or icon button.", "name": "prefix" }, { "description": "An optional suffix, usually an icon or icon button.", "name": "suffix" }, { "description": "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 `` instead.", "name": "separator" } ], "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "static": true, "default": "'flow-ui-breadcrumb-item'" }, { "kind": "field", "name": "hasSlotController", "privacy": "private", "readonly": true, "default": "new HasSlotController(this, 'prefix', 'suffix')" }, { "kind": "field", "name": "href", "type": { "text": "string | undefined" }, "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.", "attribute": "href" }, { "kind": "field", "name": "target", "type": { "text": "'_blank' | '_parent' | '_self' | '_top' | undefined" }, "description": "Tells the browser where to open the link. Only used when `href` is set.", "attribute": "target" }, { "kind": "field", "name": "rel", "type": { "text": "string" }, "default": "'noreferrer noopener'", "description": "The `rel` attribute to use on the link. Only used when `href` is set.", "attribute": "rel" } ], "attributes": [ { "name": "href", "type": { "text": "string | undefined" }, "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.", "fieldName": "href" }, { "name": "target", "type": { "text": "'_blank' | '_parent' | '_self' | '_top' | undefined" }, "description": "Tells the browser where to open the link. Only used when `href` is set.", "fieldName": "target" }, { "name": "rel", "type": { "text": "string" }, "default": "'noreferrer noopener'", "description": "The `rel` attribute to use on the link. Only used when `href` is set.", "fieldName": "rel" } ], "superclass": { "name": "FlowRdfElement", "module": "/src/internal/flow-ui-rdf-element" }, "tagName": "flow-ui-breadcrumb-item", "summary": "Breadcrumb Items are used inside [breadcrumbs](./flow-ui-breadcrumb) to represent different links.", "docgroup": "breadcrumb", "customElement": true } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "FlowUiBreadcrumbItem", "module": "components/breadcrumb-item/breadcrumb-item.component.js" } } ] }, { "kind": "javascript-module", "path": "components/breadcrumb-item/breadcrumb-item.js", "declarations": [], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "FlowUiBreadcrumbItem", "module": "components/breadcrumb-item/breadcrumb-item.js" } } ] }, { "kind": "javascript-module", "path": "components/busy-overlay/busy-overlay.component.js", "declarations": [ { "kind": "class", "description": "", "name": "FlowUiBusyOverlay", "cssProperties": [ { "description": "The delay after which the overlay is shown.", "name": "--transition-delay" }, { "description": "The duration of the overlay's fade-in/out transition.", "name": "--transition-duration" }, { "description": "The size of the default progress ring loading animation.", "name": "--progress-ring-size" }, { "description": "The width of the default progress ring's track.", "name": "--progress-ring-track-width" }, { "description": "The color of the default progress ring's track.", "name": "--progress-ring-track-color" }, { "description": "The background color of the overlay.", "name": "--overlay-background-color" } ], "slots": [ { "description": "The component to overlay with when busy.", "name": "" }, { "description": "The indeterminate custom loading animation to display when busy.", "name": "busy-animation" } ], "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "static": true, "default": "'flow-ui-busy-overlay'" }, { "kind": "field", "name": "dependencies", "type": { "text": "array" }, "static": true, "default": "[FlowUiProgressRing]" }, { "kind": "field", "name": "busy", "type": { "text": "boolean" }, "default": "false", "attribute": "busy", "reflects": true }, { "kind": "field", "name": "variant", "type": { "text": "'primary' | 'secondary' | 'success' | 'neutral' | 'warning' | 'danger'" }, "default": "'neutral'", "description": "The default loading animation's theme variant.", "attribute": "variant", "reflects": true }, { "kind": "field", "name": "size", "type": { "text": "'small' | 'medium' | 'large'" }, "default": "'medium'", "description": "Size of the loading animation", "attribute": "size", "reflects": true }, { "kind": "field", "name": "overlayParent", "type": { "text": "boolean" }, "default": "false", "description": "To overlay the parent element", "attribute": "overlay-parent", "reflects": true } ], "attributes": [ { "name": "busy", "type": { "text": "boolean" }, "default": "false", "fieldName": "busy" }, { "name": "variant", "type": { "text": "'primary' | 'secondary' | 'success' | 'neutral' | 'warning' | 'danger'" }, "default": "'neutral'", "description": "The default loading animation's theme variant.", "fieldName": "variant" }, { "name": "size", "type": { "text": "'small' | 'medium' | 'large'" }, "default": "'medium'", "description": "Size of the loading animation", "fieldName": "size" }, { "name": "overlay-parent", "type": { "text": "boolean" }, "default": "false", "description": "To overlay the parent element", "fieldName": "overlayParent" } ], "superclass": { "name": "FlowRdfElement", "module": "/src/internal/flow-ui-rdf-element" }, "tagName": "flow-ui-busy-overlay", "summary": "Busy overlay is used to indicate that a component which displays data is being currently updated.", "dependencies": [ "flow-ui-progress-ring" ], "customElement": true } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "FlowUiBusyOverlay", "module": "components/busy-overlay/busy-overlay.component.js" } } ] }, { "kind": "javascript-module", "path": "components/busy-overlay/busy-overlay.js", "declarations": [], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "FlowUiBusyOverlay", "module": "components/busy-overlay/busy-overlay.js" } } ] }, { "kind": "javascript-module", "path": "components/button/button.component.js", "declarations": [ { "kind": "class", "description": "", "name": "FlowUiButton", "cssParts": [ { "description": "The component's base wrapper.", "name": "base" }, { "description": "The container that wraps the prefix.", "name": "prefix" }, { "description": "The button's label.", "name": "label" }, { "description": "The container that wraps the suffix.", "name": "suffix" }, { "description": "The button's caret icon, an `` element.", "name": "caret" } ], "slots": [ { "description": "The button's label.", "name": "" }, { "description": "A presentational prefix icon or similar element.", "name": "prefix" }, { "description": "A presentational suffix icon or similar element.", "name": "suffix" } ], "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "static": true, "default": "'flow-ui-button'" }, { "kind": "field", "name": "dependencies", "type": { "text": "array" }, "static": true, "default": "[FlowUiIcon, FlowUiProgressRing]" }, { "kind": "field", "name": "formControlController", "privacy": "private", "readonly": true, "default": "new FormControlController(this, {\n form: (input) => {\n // Buttons support a form attribute that points to an arbitrary form, so if this attribute is set we need to query\n // the form from the same root using its id\n if (input.hasAttribute('form')) {\n const doc = input.getRootNode() as Document | ShadowRoot;\n const formId = input.getAttribute('form')!;\n return doc.getElementById(formId) as HTMLFormElement;\n }\n\n // Fall back to the closest containing form\n return input.closest('form');\n },\n assumeInteractionOn: ['click']\n })" }, { "kind": "field", "name": "hasSlotController", "privacy": "private", "readonly": true, "default": "new HasSlotController(this, '[default]', 'prefix', 'suffix')" }, { "kind": "field", "name": "localize", "privacy": "private", "readonly": true, "default": "new LocalizeController(this)" }, { "kind": "field", "name": "hasFocus", "type": { "text": "boolean" }, "privacy": "private", "default": "false" }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "attribute": "label" }, { "kind": "field", "name": "variant", "type": { "text": "| 'default'\n | 'primary'\n | 'secondary'\n | 'success'\n | 'neutral'\n | 'warning'\n | 'danger'\n | 'text'" }, "default": "'default'", "description": "The button's theme variant.", "attribute": "variant", "reflects": true }, { "kind": "field", "name": "size", "type": { "text": "'small' | 'medium' | 'large'" }, "default": "'medium'", "description": "The button's size.", "attribute": "size", "reflects": true }, { "kind": "field", "name": "caret", "type": { "text": "boolean" }, "default": "false", "description": "Draws the button with a caret. Used to indicate that the button triggers a dropdown menu or similar behavior.", "attribute": "caret", "reflects": true }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Disables the button.", "attribute": "disabled", "reflects": true }, { "kind": "field", "name": "loading", "type": { "text": "boolean" }, "default": "false", "description": "Draws the button in a loading state.", "attribute": "loading", "reflects": true }, { "kind": "field", "name": "outline", "type": { "text": "boolean" }, "default": "false", "description": "Draws an outlined button.", "attribute": "outline", "reflects": true }, { "kind": "field", "name": "pill", "type": { "text": "boolean" }, "default": "false", "description": "Draws a pill-style button with rounded edges.", "attribute": "pill", "reflects": true }, { "kind": "field", "name": "fabCircle", "type": { "text": "boolean" }, "default": "false", "description": "Draws a circular FAB. When this attribute is present, the button expects a single `` in the\ndefault slot.", "attribute": "fab-circle", "reflects": true }, { "kind": "field", "name": "fabSquare", "type": { "text": "boolean" }, "default": "false", "description": "Draws a square FAB. When this attribute is present, the button expects a single `` in the\ndefault slot.", "attribute": "fab-square", "reflects": true }, { "kind": "field", "name": "type", "type": { "text": "'button' | 'submit' | 'reset'" }, "default": "'button'", "description": "The type of button. Note that the default value is `button` instead of `submit`, which is opposite of how native\n`