{ "schemaVersion": "1.0.0", "readme": "", "modules": [ { "kind": "javascript-module", "path": "accordion/content/element.css", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "accordion/content/element.js", "declarations": [ { "kind": "class", "description": "Accordion Content", "name": "BpAccordionContent", "cssProperties": [ { "name": "--color" }, { "name": "--font-size" }, { "name": "--font-weight" }, { "name": "--background" } ], "slots": [ { "description": "slot for content", "name": "" } ], "members": [], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "bp-accordion-content", "customElement": true, "metadata": { "since": "1.0.0" } } ], "exports": [ { "kind": "js", "name": "BpAccordionContent", "declaration": { "name": "BpAccordionContent", "module": "accordion/content/element.js" } } ] }, { "kind": "javascript-module", "path": "accordion/element.css", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "accordion/element.js", "declarations": [ { "kind": "class", "description": "```javascript\nimport '@blueprintui/components/include/accordion.js';\n```\n\n```html\n\n \n Item 1\n Content 1\n \n \n Item 2\n Content 2\n \n \n Item 3\n Content 3\n \n\n```", "name": "BpAccordion", "cssProperties": [ { "name": "--border-color" }, { "name": "--border-width" }, { "name": "--border-radius" }, { "name": "--background" } ], "slots": [ { "description": "bp-accordion-panel", "name": "" } ], "members": [ { "kind": "field", "name": "layer", "type": { "text": "'flat' | 'container'" }, "default": "'container'", "description": "Determines the visual layer style, with 'container' providing backgrounds and borders, while 'flat' removes them for nested contexts", "attribute": "layer", "reflects": true } ], "attributes": [ { "name": "layer", "type": { "text": "'flat' | 'container'" }, "default": "'container'", "description": "Determines the visual layer style, with 'container' providing backgrounds and borders, while 'flat' removes them for nested contexts", "fieldName": "layer" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "bp-accordion", "customElement": true, "summary": "The accordion component is used to display a large amount of content in a small space. The accordion should be used to group related content together.", "metadata": { "since": "1.0.0" } } ], "exports": [ { "kind": "js", "name": "BpAccordion", "declaration": { "name": "BpAccordion", "module": "accordion/element.js" } } ] }, { "kind": "javascript-module", "path": "accordion/element.visual.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "accordion/header/element.css", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "accordion/header/element.js", "declarations": [ { "kind": "class", "description": "Accordion Header", "name": "BpAccordionHeader", "cssProperties": [ { "name": "--background" }, { "name": "--color" }, { "name": "--font-size" }, { "name": "--padding" } ], "slots": [ { "description": "slot for header content", "name": "" } ], "members": [ { "kind": "field", "name": "expanded", "type": { "text": "boolean" }, "description": "indicate if a control is expanded or collapsed", "attribute": "expanded", "default": "false", "privacy": "private", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "pressed", "type": { "text": "boolean" }, "description": "turns the button into a toggle button", "attribute": "pressed", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "selected", "type": { "text": "boolean" }, "description": "indicate the current \"selected\" state of various widgets", "attribute": "selected", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "readonly", "type": { "text": "boolean" }, "description": "makes the element not mutable, meaning the user can not interact with button", "attribute": "readonly", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "determines if element is mutable or focusable", "attribute": "disabled", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "type", "type": { "text": "'button' | 'submit'" }, "description": "default behavior of the button", "attribute": "type", "reflects": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "name", "type": { "text": "string" }, "description": "represents the name of the current
element as a string.", "attribute": "name", "reflects": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "value", "type": { "text": "string" }, "description": "determines the current value", "attribute": "value", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "popoverTargetAction", "type": { "text": "'toggle' | 'show' | 'hide'" }, "description": "The action to perform on the target popover element\nhttps://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/button#popovertargetaction", "attribute": "popovertargetaction", "reflects": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "popoverTargetElement", "type": { "text": "HTMLElement" }, "description": "The target element for the popover\nhttps://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/button#popovertarget", "attribute": "popoverTargetElement", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "command", "type": { "text": "string" }, "description": "The command property of the HTMLButtonElement interface gets and sets the action to be performed on an element being controlled by this button. For this to have an effect, commandfor must be set.\nhttps://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/button#command", "attribute": "command", "reflects": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "commandForElement", "type": { "text": "HTMLElement" }, "description": "The commandForElement property of the HTMLButtonElement interface gets and sets the id of the element being controlled by this button. For this to have an effect, command must be set.\nhttps://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/button#command", "attribute": "commandForElement", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "interestForElement", "type": { "text": "HTMLElement" }, "description": "The interestForElement property of the HTMLButtonElement interface gets and sets the id of the element being controlled by this button. For this to have an effect, command must be set.\nhttps://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/button#interest", "attribute": "interestForElement", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "form", "type": { "text": "HTMLFormElement" }, "readonly": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "formAction", "type": { "text": "string" }, "readonly": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "formEnctype", "type": { "text": "string" }, "readonly": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "formMethod", "type": { "text": "string" }, "readonly": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "formNoValidate", "type": { "text": "boolean" }, "readonly": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "formTarget", "type": { "text": "string" }, "readonly": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "labels", "type": { "text": "NodeListOf" }, "readonly": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "validationMessage", "type": { "text": "string" }, "readonly": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "validity", "type": { "text": "ValidityState" }, "readonly": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "willValidate", "type": { "text": "boolean" }, "readonly": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "checkValidity", "type": { "text": "any" }, "readonly": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "reportValidity", "type": { "text": "any" }, "readonly": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "setCustomValidity", "type": { "text": "any" }, "readonly": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "_internals", "type": { "text": "ElementInternals" }, "readonly": true, "privacy": "private", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "formAssociated", "type": { "text": "boolean" }, "static": true, "default": "true", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } } ], "superclass": { "name": "BaseButton", "package": "@blueprintui/components/internals" }, "tagName": "bp-accordion-header", "customElement": true, "metadata": { "since": "1.0.0" }, "attributes": [ { "name": "pressed", "type": { "text": "boolean" }, "description": "turns the button into a toggle button", "fieldName": "pressed", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "name": "selected", "type": { "text": "boolean" }, "description": "indicate the current \"selected\" state of various widgets", "fieldName": "selected", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "name": "expanded", "type": { "text": "boolean" }, "description": "indicate if a control is expanded or collapsed", "fieldName": "expanded", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "name": "readonly", "type": { "text": "boolean" }, "description": "makes the element not mutable, meaning the user can not interact with button", "fieldName": "readonly", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "determines if element is mutable or focusable", "fieldName": "disabled", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "name": "type", "type": { "text": "'button' | 'submit'" }, "description": "default behavior of the button", "fieldName": "type", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "name": "name", "type": { "text": "string" }, "description": "represents the name of the current element as a string.", "fieldName": "name", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "name": "value", "type": { "text": "string" }, "description": "determines the current value", "fieldName": "value", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "name": "popovertargetaction", "type": { "text": "'toggle' | 'show' | 'hide'" }, "description": "The action to perform on the target popover element\nhttps://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/button#popovertargetaction", "fieldName": "popoverTargetAction", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "name": "popoverTargetElement", "type": { "text": "HTMLElement" }, "description": "The target element for the popover\nhttps://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/button#popovertarget", "fieldName": "popoverTargetElement", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "name": "command", "type": { "text": "string" }, "description": "The command property of the HTMLButtonElement interface gets and sets the action to be performed on an element being controlled by this button. For this to have an effect, commandfor must be set.\nhttps://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/button#command", "fieldName": "command", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "name": "commandForElement", "type": { "text": "HTMLElement" }, "description": "The commandForElement property of the HTMLButtonElement interface gets and sets the id of the element being controlled by this button. For this to have an effect, command must be set.\nhttps://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/button#command", "fieldName": "commandForElement", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "name": "interestForElement", "type": { "text": "HTMLElement" }, "description": "The interestForElement property of the HTMLButtonElement interface gets and sets the id of the element being controlled by this button. For this to have an effect, command must be set.\nhttps://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/button#interest", "fieldName": "interestForElement", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } } ] } ], "exports": [ { "kind": "js", "name": "BpAccordionHeader", "declaration": { "name": "BpAccordionHeader", "module": "accordion/header/element.js" } } ] }, { "kind": "javascript-module", "path": "accordion/index.js", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "accordion/element.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "accordion/panel/element.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "accordion/content/element.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "accordion/header/element.js" } } ] }, { "kind": "javascript-module", "path": "accordion/panel/element.css", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "accordion/panel/element.js", "declarations": [ { "kind": "class", "description": "Accordion Panel", "name": "BpAccordionPanel", "slots": [ { "description": "slot for header and content", "name": "" }, { "name": "bp-accordion-header" }, { "name": "bp-accordion-content" } ], "members": [ { "kind": "field", "name": "expanded", "type": { "text": "boolean" }, "default": "false", "description": "determine if element is expanded", "attribute": "expanded" }, { "kind": "field", "name": "#header", "privacy": "private", "readonly": true }, { "kind": "field", "name": "#content", "privacy": "private", "readonly": true } ], "attributes": [ { "name": "expanded", "type": { "text": "boolean" }, "default": "false", "description": "determine if element is expanded", "fieldName": "expanded" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "bp-accordion-panel", "customElement": true, "metadata": { "since": "1.0.0" }, "commands": [ { "name": "--toggle", "description": "" }, { "name": "--close", "description": "" }, { "name": "--open", "description": "" } ] } ], "exports": [ { "kind": "js", "name": "BpAccordionPanel", "declaration": { "name": "BpAccordionPanel", "module": "accordion/panel/element.js" } } ] }, { "kind": "javascript-module", "path": "alert/element.css", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "alert/element.js", "declarations": [ { "kind": "class", "description": "```typescript\nimport '@blueprintui/components/include/alert.js';\n```\n\n```html\nalert\n```", "name": "BpAlert", "cssProperties": [ { "name": "--icon-color" }, { "name": "--color" } ], "slots": [ { "description": "slot for content", "name": "" } ], "members": [ { "kind": "field", "name": "status", "type": { "text": "'accent' | 'success' | 'warning' | 'danger'" }, "description": "Defines the visual status type of the alert, affecting its color, icon, and semantic meaning", "attribute": "status", "reflects": true }, { "kind": "field", "name": "closable", "type": { "text": "boolean" }, "default": "false", "description": "Controls whether the alert displays a close button, allowing users to dismiss it", "attribute": "closable" }, { "kind": "field", "name": "hidden", "type": { "text": "boolean" }, "default": "false", "description": "Controls the visibility state of the alert, hiding it from view when set to true", "attribute": "hidden", "reflects": true }, { "kind": "field", "name": "i18n", "description": "Provides internationalization strings for accessibility labels and screen reader announcements", "attribute": "i18n" }, { "kind": "field", "name": "typeClosableController", "type": { "text": "TypeClosableController" }, "privacy": "private" }, { "kind": "method", "name": "#close", "privacy": "private" } ], "events": [ { "description": "close", "name": "" }, { "description": "open", "name": "" } ], "attributes": [ { "name": "status", "type": { "text": "'accent' | 'success' | 'warning' | 'danger'" }, "description": "Defines the visual status type of the alert, affecting its color, icon, and semantic meaning", "fieldName": "status" }, { "name": "closable", "type": { "text": "boolean" }, "default": "false", "description": "Controls whether the alert displays a close button, allowing users to dismiss it", "fieldName": "closable" }, { "name": "hidden", "type": { "text": "boolean" }, "default": "false", "description": "Controls the visibility state of the alert, hiding it from view when set to true", "fieldName": "hidden" }, { "name": "i18n", "description": "Provides internationalization strings for accessibility labels and screen reader announcements", "fieldName": "i18n" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "bp-alert", "customElement": true, "summary": "The alert component is used to inform users of important information or to provide feedback on an action they have taken.", "metadata": { "since": "1.0.0" }, "commands": [ { "name": "--toggle", "description": "" }, { "name": "--close", "description": "" }, { "name": "--open", "description": "" } ] } ], "exports": [ { "kind": "js", "name": "BpAlert", "declaration": { "name": "BpAlert", "module": "alert/element.js" } } ] }, { "kind": "javascript-module", "path": "alert/element.visual.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "alert/group/element.css", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "alert/group/element.global.css", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "alert/group/element.js", "declarations": [ { "kind": "class", "description": "```typescript\nimport '@blueprintui/components/include/alert.js';\n```\n\n```html\n\n alert\n\n```", "name": "BpAlertGroup", "cssProperties": [ { "name": "--background" }, { "name": "--color" }, { "name": "--padding" }, { "name": "--border-radius" } ], "slots": [ { "description": "slot for content", "name": "" } ], "members": [ { "kind": "field", "name": "status", "type": { "text": "'accent' | 'success' | 'warning' | 'danger'" }, "description": "determine the visual status state", "attribute": "status", "reflects": true }, { "kind": "field", "name": "type", "type": { "text": "'banner'" }, "description": "determine the visual styles for top/pinned banners", "attribute": "type", "reflects": true } ], "attributes": [ { "name": "status", "type": { "text": "'accent' | 'success' | 'warning' | 'danger'" }, "description": "determine the visual status state", "fieldName": "status" }, { "name": "type", "type": { "text": "'banner'" }, "description": "determine the visual styles for top/pinned banners", "fieldName": "type" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "bp-alert-group", "customElement": true, "summary": "The alert group component is used to inform users of important information or to provide feedback on an action they have taken.", "metadata": { "since": "1.0.0" } } ], "exports": [ { "kind": "js", "name": "BpAlertGroup", "declaration": { "name": "BpAlertGroup", "module": "alert/group/element.js" } } ] }, { "kind": "javascript-module", "path": "alert/index.js", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "alert/element.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "alert/group/element.js" } } ] }, { "kind": "javascript-module", "path": "avatar/element.css", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "avatar/element.js", "declarations": [ { "kind": "class", "description": "```typescript\nimport '@blueprintui/components/include/avatar.js';\n```\n\n```html\n\n \n\n```", "name": "BpAvatar", "cssProperties": [ { "description": "Size of the avatar (default: var(--bp-size-900))", "name": "--size" }, { "description": "Background color", "name": "--background" }, { "description": "Text/icon color", "name": "--color" }, { "description": "Border radius (controlled by shape attribute)", "name": "--border-radius" } ], "cssParts": [ { "description": "The container wrapping the avatar content", "name": "internal" } ], "slots": [ { "description": "Content to display - text for initials, img for image, or icon for custom icon", "name": "" } ], "members": [ { "kind": "field", "name": "shape", "type": { "text": "'square' | 'rounded'" }, "description": "determine the visual shape of the avatar", "attribute": "shape", "reflects": true }, { "kind": "field", "name": "status", "type": { "text": "'accent' | 'success' | 'warning' | 'danger'" }, "description": "optional status indicator color", "attribute": "status", "reflects": true }, { "kind": "field", "name": "_internals", "type": { "text": "ElementInternals" } } ], "attributes": [ { "name": "shape", "type": { "text": "'square' | 'rounded'" }, "description": "determine the visual shape of the avatar", "fieldName": "shape" }, { "name": "status", "type": { "text": "'accent' | 'success' | 'warning' | 'danger'" }, "description": "optional status indicator color", "fieldName": "status" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "bp-avatar", "customElement": true, "summary": "The avatar component is used to represent a user or entity with an image, icon, or initials", "metadata": { "since": "2.9.0" } } ], "exports": [ { "kind": "js", "name": "BpAvatar", "declaration": { "name": "BpAvatar", "module": "avatar/element.js" } } ] }, { "kind": "javascript-module", "path": "avatar/element.visual.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "avatar/index.js", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "avatar/element.js" } } ] }, { "kind": "javascript-module", "path": "badge/element.css", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "badge/element.js", "declarations": [ { "kind": "class", "description": "```typescript\nimport '@blueprintui/components/include/badge.js';\n```\n\n```html\n2\n```", "name": "BpBadge", "cssProperties": [ { "name": "--background" }, { "name": "--color" }, { "name": "--font-size" }, { "name": "--width" }, { "name": "--height" }, { "name": "--min-width" }, { "name": "--min-height" }, { "name": "--border-radius" }, { "name": "--padding" } ], "slots": [ { "description": "badge content", "name": "" } ], "members": [ { "kind": "field", "name": "status", "type": { "text": "'accent' | 'success' | 'warning' | 'danger'" }, "description": "Defines the visual status type of the badge, affecting its color and semantic meaning", "attribute": "status", "reflects": true }, { "kind": "field", "name": "_internals", "type": { "text": "ElementInternals" } } ], "attributes": [ { "name": "status", "type": { "text": "'accent' | 'success' | 'warning' | 'danger'" }, "description": "Defines the visual status type of the badge, affecting its color and semantic meaning", "fieldName": "status" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "bp-badge", "customElement": true, "summary": "The badge component is used to display a small amount of information, such as a count or status, in a compact and visually distinct way. It is often used to display notifications or unread messages.", "metadata": { "since": "1.0.0", "docs": "https://blueprintui.dev/docs/components/badge" } } ], "exports": [ { "kind": "js", "name": "BpBadge", "declaration": { "name": "BpBadge", "module": "badge/element.js" } } ] }, { "kind": "javascript-module", "path": "badge/element.visual.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "badge/index.js", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "badge/element.js" } } ] }, { "kind": "javascript-module", "path": "breadcrumb/element.css", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "breadcrumb/element.js", "declarations": [ { "kind": "class", "description": "```typescript\nimport '@blueprintui/components/include/breadcrumb.js';\n```\n\n```html\n\n Home\n Parent page\n

Current page

\n\n```", "name": "BpBreadcrumb", "cssProperties": [ { "name": "--font-size" }, { "name": "--font-weight" }, { "name": "--color" }, { "name": "--gap" } ], "cssParts": [ { "name": "separator" } ], "slots": [ { "description": "breadcrumb items", "name": "" }, { "description": "separator", "name": "separator" } ], "members": [ { "kind": "field", "name": "#items", "privacy": "private", "readonly": true }, { "kind": "field", "name": "#separator", "privacy": "private", "readonly": true } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "bp-breadcrumb", "customElement": true, "summary": "The breadcrumb component is used to show the user's current location, and provides an easy way to navigate back to previous sections.", "metadata": { "since": "1.0.0" } } ], "exports": [ { "kind": "js", "name": "BpBreadcrumb", "declaration": { "name": "BpBreadcrumb", "module": "breadcrumb/element.js" } } ] }, { "kind": "javascript-module", "path": "breadcrumb/element.visual.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "breadcrumb/index.js", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "breadcrumb/element.js" } } ] }, { "kind": "javascript-module", "path": "button-copy/element.css", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "button-copy/element.js", "declarations": [ { "kind": "class", "description": "```typescript\nimport '@blueprintui/components/include/button-copy.js';\n```\n\n```html\n\n```", "name": "BpButtonCopy", "cssProperties": [ { "name": "--background", "inheritedFrom": { "name": "BpButton", "module": "button/element.js" } }, { "name": "--color", "inheritedFrom": { "name": "BpButton", "module": "button/element.js" } }, { "name": "--border", "inheritedFrom": { "name": "BpButton", "module": "button/element.js" } }, { "name": "--padding", "inheritedFrom": { "name": "BpButton", "module": "button/element.js" } }, { "name": "--min-width", "inheritedFrom": { "name": "BpButton", "module": "button/element.js" } }, { "name": "--font-size", "inheritedFrom": { "name": "BpButton", "module": "button/element.js" } }, { "name": "--width", "inheritedFrom": { "name": "BpButtonIcon", "module": "button-icon/element.js" } }, { "name": "--height", "inheritedFrom": { "name": "BpButtonIcon", "module": "button-icon/element.js" } }, { "name": "--cursor", "inheritedFrom": { "name": "BpButtonIcon", "module": "button-icon/element.js" } }, { "name": "--outline", "inheritedFrom": { "name": "BpButtonIcon", "module": "button-icon/element.js" } }, { "name": "--outline-offset", "inheritedFrom": { "name": "BpButtonIcon", "module": "button-icon/element.js" } }, { "name": "--line-height", "inheritedFrom": { "name": "BpButton", "module": "button/element.js" } }, { "name": "--text-align", "inheritedFrom": { "name": "BpButton", "module": "button/element.js" } } ], "slots": [ { "description": "Icon shown in default/rest state", "name": "", "inheritedFrom": { "name": "BpButton", "module": "button/element.js" } }, { "description": "content shown after successful copy", "name": "success" }, { "description": "content shown after copy error", "name": "error" } ], "members": [ { "kind": "field", "name": "value", "type": { "text": "string" }, "description": "The text value to copy to clipboard", "attribute": "value", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" }, "default": "''" }, { "kind": "field", "name": "i18n", "description": "set default aria/i18n strings", "attribute": "i18n", "inheritedFrom": { "name": "BpButtonIcon", "module": "button-icon/element.js" } }, { "kind": "field", "name": "#feedbackState", "privacy": "private", "type": { "text": "'' | 'success' | 'error'" }, "default": "''" }, { "kind": "field", "name": "#feedbackTimer", "privacy": "private", "type": { "text": "number | null" }, "default": "null" }, { "kind": "method", "name": "copy" }, { "kind": "method", "name": "#dispatchCopyEvent", "privacy": "private", "parameters": [ { "name": "status", "type": { "text": "'success' | 'error'" } } ] }, { "kind": "method", "name": "#setFeedbackState", "privacy": "private", "parameters": [ { "name": "state", "type": { "text": "'success' | 'error'" } } ] }, { "kind": "field", "name": "#handleClick", "privacy": "private" }, { "kind": "field", "name": "#handleCommand", "privacy": "private" }, { "kind": "field", "name": "shape", "type": { "text": "string" }, "default": "'ellipsis-vertical'", "description": "Defines the icon shape to display within the button", "attribute": "shape", "reflects": true, "inheritedFrom": { "name": "BpButtonIcon", "module": "button-icon/element.js" } }, { "kind": "field", "name": "direction", "type": { "text": "'up' | 'down' | 'left' | 'right'" }, "description": "Controls the directional orientation of the icon within the button", "attribute": "direction", "reflects": true, "inheritedFrom": { "name": "BpButtonIcon", "module": "button-icon/element.js" } }, { "kind": "field", "name": "icon", "readonly": true, "inheritedFrom": { "name": "BpButtonIcon", "module": "button-icon/element.js" } }, { "kind": "field", "name": "action", "type": { "text": "'primary' | 'secondary' | 'flat' | 'inline'" }, "description": "Controls the visual styling variant of the button, affecting background, border, and emphasis level", "attribute": "action", "reflects": true, "inheritedFrom": { "name": "BpButton", "module": "button/element.js" } }, { "kind": "field", "name": "status", "type": { "text": "'accent' | 'success' | 'warning' | 'danger'" }, "description": "Defines the visual status type of the button, affecting its color and semantic meaning", "attribute": "status", "reflects": true, "inheritedFrom": { "name": "BpButton", "module": "button/element.js" } }, { "kind": "field", "name": "pressed", "type": { "text": "boolean" }, "description": "turns the button into a toggle button", "attribute": "pressed", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "selected", "type": { "text": "boolean" }, "description": "indicate the current \"selected\" state of various widgets", "attribute": "selected", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "expanded", "type": { "text": "boolean" }, "description": "indicate if a control is expanded or collapsed", "attribute": "expanded", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "readonly", "type": { "text": "boolean" }, "description": "makes the element not mutable, meaning the user can not interact with button", "attribute": "readonly", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "determines if element is mutable or focusable", "attribute": "disabled", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "type", "type": { "text": "'button' | 'submit'" }, "description": "default behavior of the button", "attribute": "type", "reflects": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "name", "type": { "text": "string" }, "description": "represents the name of the current element as a string.", "attribute": "name", "reflects": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "popoverTargetAction", "type": { "text": "'toggle' | 'show' | 'hide'" }, "description": "The action to perform on the target popover element\nhttps://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/button#popovertargetaction", "attribute": "popovertargetaction", "reflects": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "popoverTargetElement", "type": { "text": "HTMLElement" }, "description": "The target element for the popover\nhttps://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/button#popovertarget", "attribute": "popoverTargetElement", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "command", "type": { "text": "string" }, "description": "The command property of the HTMLButtonElement interface gets and sets the action to be performed on an element being controlled by this button. For this to have an effect, commandfor must be set.\nhttps://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/button#command", "attribute": "command", "reflects": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "commandForElement", "type": { "text": "HTMLElement" }, "description": "The commandForElement property of the HTMLButtonElement interface gets and sets the id of the element being controlled by this button. For this to have an effect, command must be set.\nhttps://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/button#command", "attribute": "commandForElement", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "interestForElement", "type": { "text": "HTMLElement" }, "description": "The interestForElement property of the HTMLButtonElement interface gets and sets the id of the element being controlled by this button. For this to have an effect, command must be set.\nhttps://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/button#interest", "attribute": "interestForElement", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "form", "type": { "text": "HTMLFormElement" }, "readonly": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "formAction", "type": { "text": "string" }, "readonly": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "formEnctype", "type": { "text": "string" }, "readonly": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "formMethod", "type": { "text": "string" }, "readonly": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "formNoValidate", "type": { "text": "boolean" }, "readonly": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "formTarget", "type": { "text": "string" }, "readonly": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "labels", "type": { "text": "NodeListOf" }, "readonly": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "validationMessage", "type": { "text": "string" }, "readonly": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "validity", "type": { "text": "ValidityState" }, "readonly": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "willValidate", "type": { "text": "boolean" }, "readonly": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "checkValidity", "type": { "text": "any" }, "readonly": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "reportValidity", "type": { "text": "any" }, "readonly": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "setCustomValidity", "type": { "text": "any" }, "readonly": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "_internals", "type": { "text": "ElementInternals" }, "readonly": true, "privacy": "private", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "formAssociated", "type": { "text": "boolean" }, "static": true, "default": "true", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } } ], "events": [ { "name": "copy", "type": { "text": "CustomEvent<{ value: string, error?: Error }>" }, "description": "Fires when copy is initiated" } ], "attributes": [ { "name": "value", "type": { "text": "string" }, "description": "The text value to copy to clipboard", "fieldName": "value", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" }, "default": "''" }, { "name": "i18n", "description": "set default aria/i18n strings", "fieldName": "i18n", "inheritedFrom": { "name": "BpButtonIcon", "module": "button-icon/element.js" } }, { "name": "shape", "type": { "text": "string" }, "default": "'ellipsis-vertical'", "description": "Defines the icon shape to display within the button", "fieldName": "shape", "inheritedFrom": { "name": "BpButtonIcon", "module": "button-icon/element.js" } }, { "name": "direction", "type": { "text": "'up' | 'down' | 'left' | 'right'" }, "description": "Controls the directional orientation of the icon within the button", "fieldName": "direction", "inheritedFrom": { "name": "BpButtonIcon", "module": "button-icon/element.js" } }, { "name": "action", "type": { "text": "'primary' | 'secondary' | 'flat' | 'inline'" }, "description": "Controls the visual styling variant of the button, affecting background, border, and emphasis level", "fieldName": "action", "inheritedFrom": { "name": "BpButton", "module": "button/element.js" } }, { "name": "status", "type": { "text": "'accent' | 'success' | 'warning' | 'danger'" }, "description": "Defines the visual status type of the button, affecting its color and semantic meaning", "fieldName": "status", "inheritedFrom": { "name": "BpButton", "module": "button/element.js" } }, { "name": "pressed", "type": { "text": "boolean" }, "description": "turns the button into a toggle button", "fieldName": "pressed", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "name": "selected", "type": { "text": "boolean" }, "description": "indicate the current \"selected\" state of various widgets", "fieldName": "selected", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "name": "expanded", "type": { "text": "boolean" }, "description": "indicate if a control is expanded or collapsed", "fieldName": "expanded", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "name": "readonly", "type": { "text": "boolean" }, "description": "makes the element not mutable, meaning the user can not interact with button", "fieldName": "readonly", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "determines if element is mutable or focusable", "fieldName": "disabled", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "name": "type", "type": { "text": "'button' | 'submit'" }, "description": "default behavior of the button", "fieldName": "type", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "name": "name", "type": { "text": "string" }, "description": "represents the name of the current element as a string.", "fieldName": "name", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "name": "popovertargetaction", "type": { "text": "'toggle' | 'show' | 'hide'" }, "description": "The action to perform on the target popover element\nhttps://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/button#popovertargetaction", "fieldName": "popoverTargetAction", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "name": "popoverTargetElement", "type": { "text": "HTMLElement" }, "description": "The target element for the popover\nhttps://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/button#popovertarget", "fieldName": "popoverTargetElement", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "name": "command", "type": { "text": "string" }, "description": "The command property of the HTMLButtonElement interface gets and sets the action to be performed on an element being controlled by this button. For this to have an effect, commandfor must be set.\nhttps://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/button#command", "fieldName": "command", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "name": "commandForElement", "type": { "text": "HTMLElement" }, "description": "The commandForElement property of the HTMLButtonElement interface gets and sets the id of the element being controlled by this button. For this to have an effect, command must be set.\nhttps://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/button#command", "fieldName": "commandForElement", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "name": "interestForElement", "type": { "text": "HTMLElement" }, "description": "The interestForElement property of the HTMLButtonElement interface gets and sets the id of the element being controlled by this button. For this to have an effect, command must be set.\nhttps://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/button#interest", "fieldName": "interestForElement", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } } ], "superclass": { "name": "BpButtonIcon", "package": "@blueprintui/components/button-icon" }, "tagName": "bp-button-copy", "customElement": true, "summary": "The button copy component provides a simple way to copy text to the clipboard with visual feedback.", "metadata": { "since": "2.8.0" }, "cssParts": [ { "name": "icon", "inheritedFrom": { "name": "BpButtonIcon", "module": "button-icon/element.js" } } ] } ], "exports": [ { "kind": "js", "name": "BpButtonCopy", "declaration": { "name": "BpButtonCopy", "module": "button-copy/element.js" } } ] }, { "kind": "javascript-module", "path": "button-copy/element.visual.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "button-copy/index.js", "declarations": [], "exports": [ { "kind": "js", "name": "BpButtonCopy", "declaration": { "name": "BpButtonCopy", "module": "./element.js" } } ] }, { "kind": "javascript-module", "path": "button-expand/element.css", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "button-expand/element.js", "declarations": [ { "kind": "class", "description": "```typescript\nimport '@blueprintui/components/include/button-expand.js';\n```\n\n```html\n\n```", "name": "BpButtonExpand", "cssProperties": [ { "name": "--animation-duration" } ], "slots": [ { "description": "slot for custom bp-icon", "name": "" } ], "members": [ { "kind": "field", "name": "orientation", "type": { "text": "'vertical' | 'horizontal'" }, "default": "'vertical'", "description": "Controls the icon direction based on expand context, either vertical (down/right) or horizontal (left/right)", "attribute": "orientation", "reflects": true }, { "kind": "field", "name": "i18n", "type": { "text": "I18nStrings['actions']" }, "description": "Provides internationalization strings for accessibility labels and screen reader announcements", "attribute": "i18n" }, { "kind": "field", "name": "formAssociated", "type": { "text": "boolean" }, "static": true, "default": "true" }, { "kind": "field", "name": "#iconDirection", "privacy": "private", "readonly": true } ], "events": [ { "type": { "text": "InputEvent" }, "description": "occurs when the value changes", "name": "input" }, { "type": { "text": "InputEvent" }, "description": "occurs when the value changes", "name": "change" } ], "attributes": [ { "name": "orientation", "type": { "text": "'vertical' | 'horizontal'" }, "default": "'vertical'", "description": "Controls the icon direction based on expand context, either vertical (down/right) or horizontal (left/right)", "fieldName": "orientation" }, { "name": "i18n", "type": { "text": "I18nStrings['actions']" }, "description": "Provides internationalization strings for accessibility labels and screen reader announcements", "fieldName": "i18n" } ], "mixins": [ { "name": "CheckboxFormControlMixin", "package": "@blueprintui/components/forms" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "bp-button-expand", "customElement": true, "summary": "The expand button component is used to reveal and hide additional content, such as a dropdown menu or a nested list.", "metadata": { "since": "1.0.0" } } ], "exports": [ { "kind": "js", "name": "BpButtonExpand", "declaration": { "name": "BpButtonExpand", "module": "button-expand/element.js" } } ] }, { "kind": "javascript-module", "path": "button-expand/element.visual.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "button-expand/index.js", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "button-expand/element.js" } } ] }, { "kind": "javascript-module", "path": "button-group/element.css", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "button-group/element.global.css", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "button-group/element.js", "declarations": [ { "kind": "class", "description": "```typescript\nimport '@blueprintui/components/include/button.js';\n```\n\n```html\n\n \n \n\n```", "name": "BpButtonGroup", "slots": [ { "description": "button content", "name": "" } ], "members": [ { "kind": "field", "name": "action", "type": { "text": "'primary' | 'secondary' | 'flat'" }, "description": "Controls the visual styling variant applied to all buttons within the group", "attribute": "action", "reflects": true }, { "kind": "field", "name": "buttons", "type": { "text": "(\n | BpButton\n | BpButtonIcon\n )[]" }, "privacy": "private", "default": "[]" }, { "kind": "method", "name": "#slotchange", "privacy": "private" } ], "attributes": [ { "name": "action", "type": { "text": "'primary' | 'secondary' | 'flat'" }, "description": "Controls the visual styling variant applied to all buttons within the group", "fieldName": "action" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "bp-button-group", "customElement": true, "summary": "The button group component is used to group together related buttons and present them as a single visual unit.", "metadata": { "since": "1.0.0" } } ], "exports": [ { "kind": "js", "name": "BpButtonGroup", "declaration": { "name": "BpButtonGroup", "module": "button-group/element.js" } } ] }, { "kind": "javascript-module", "path": "button-group/element.visual.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "button-group/index.js", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "button-group/element.js" } } ] }, { "kind": "javascript-module", "path": "button-handle/element.css", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "button-handle/element.js", "declarations": [ { "kind": "class", "description": "```typescript\nimport '@blueprintui/components/include/button-handle.js';\n```\n\n```html\n\n```", "name": "BpButtonHandle", "cssProperties": [ { "name": "--cursoe" }, { "name": "--icon-width" }, { "name": "--icon-height" } ], "slots": [ { "description": "slot for text content or bp-icon", "name": "" } ], "members": [ { "kind": "field", "name": "shape", "type": { "text": "string" }, "default": "'drag-handle'", "description": "Defines the icon shape used for the drag handle visual indicator", "attribute": "shape", "reflects": true }, { "kind": "field", "name": "direction", "type": { "text": "'up' | 'down' | 'left' | 'right'" }, "description": "Controls the directional orientation of the drag handle icon", "attribute": "direction", "reflects": true }, { "kind": "field", "name": "pressed", "type": { "text": "boolean" }, "description": "turns the button into a toggle button", "attribute": "pressed", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "selected", "type": { "text": "boolean" }, "description": "indicate the current \"selected\" state of various widgets", "attribute": "selected", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "expanded", "type": { "text": "boolean" }, "description": "indicate if a control is expanded or collapsed", "attribute": "expanded", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "readonly", "type": { "text": "boolean" }, "description": "makes the element not mutable, meaning the user can not interact with button", "attribute": "readonly", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "determines if element is mutable or focusable", "attribute": "disabled", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "type", "type": { "text": "'button' | 'submit'" }, "description": "default behavior of the button", "attribute": "type", "reflects": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "name", "type": { "text": "string" }, "description": "represents the name of the current element as a string.", "attribute": "name", "reflects": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "value", "type": { "text": "string" }, "description": "determines the current value", "attribute": "value", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "popoverTargetAction", "type": { "text": "'toggle' | 'show' | 'hide'" }, "description": "The action to perform on the target popover element\nhttps://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/button#popovertargetaction", "attribute": "popovertargetaction", "reflects": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "popoverTargetElement", "type": { "text": "HTMLElement" }, "description": "The target element for the popover\nhttps://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/button#popovertarget", "attribute": "popoverTargetElement", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "command", "type": { "text": "string" }, "description": "The command property of the HTMLButtonElement interface gets and sets the action to be performed on an element being controlled by this button. For this to have an effect, commandfor must be set.\nhttps://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/button#command", "attribute": "command", "reflects": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "commandForElement", "type": { "text": "HTMLElement" }, "description": "The commandForElement property of the HTMLButtonElement interface gets and sets the id of the element being controlled by this button. For this to have an effect, command must be set.\nhttps://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/button#command", "attribute": "commandForElement", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "interestForElement", "type": { "text": "HTMLElement" }, "description": "The interestForElement property of the HTMLButtonElement interface gets and sets the id of the element being controlled by this button. For this to have an effect, command must be set.\nhttps://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/button#interest", "attribute": "interestForElement", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "form", "type": { "text": "HTMLFormElement" }, "readonly": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "formAction", "type": { "text": "string" }, "readonly": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "formEnctype", "type": { "text": "string" }, "readonly": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "formMethod", "type": { "text": "string" }, "readonly": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "formNoValidate", "type": { "text": "boolean" }, "readonly": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "formTarget", "type": { "text": "string" }, "readonly": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "labels", "type": { "text": "NodeListOf" }, "readonly": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "validationMessage", "type": { "text": "string" }, "readonly": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "validity", "type": { "text": "ValidityState" }, "readonly": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "willValidate", "type": { "text": "boolean" }, "readonly": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "checkValidity", "type": { "text": "any" }, "readonly": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "reportValidity", "type": { "text": "any" }, "readonly": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "setCustomValidity", "type": { "text": "any" }, "readonly": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "_internals", "type": { "text": "ElementInternals" }, "readonly": true, "privacy": "private", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "formAssociated", "type": { "text": "boolean" }, "static": true, "default": "true", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } } ], "attributes": [ { "name": "shape", "type": { "text": "string" }, "default": "'drag-handle'", "description": "Defines the icon shape used for the drag handle visual indicator", "fieldName": "shape" }, { "name": "direction", "type": { "text": "'up' | 'down' | 'left' | 'right'" }, "description": "Controls the directional orientation of the drag handle icon", "fieldName": "direction" }, { "name": "pressed", "type": { "text": "boolean" }, "description": "turns the button into a toggle button", "fieldName": "pressed", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "name": "selected", "type": { "text": "boolean" }, "description": "indicate the current \"selected\" state of various widgets", "fieldName": "selected", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "name": "expanded", "type": { "text": "boolean" }, "description": "indicate if a control is expanded or collapsed", "fieldName": "expanded", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "name": "readonly", "type": { "text": "boolean" }, "description": "makes the element not mutable, meaning the user can not interact with button", "fieldName": "readonly", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "determines if element is mutable or focusable", "fieldName": "disabled", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "name": "type", "type": { "text": "'button' | 'submit'" }, "description": "default behavior of the button", "fieldName": "type", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "name": "name", "type": { "text": "string" }, "description": "represents the name of the current element as a string.", "fieldName": "name", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "name": "value", "type": { "text": "string" }, "description": "determines the current value", "fieldName": "value", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "name": "popovertargetaction", "type": { "text": "'toggle' | 'show' | 'hide'" }, "description": "The action to perform on the target popover element\nhttps://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/button#popovertargetaction", "fieldName": "popoverTargetAction", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "name": "popoverTargetElement", "type": { "text": "HTMLElement" }, "description": "The target element for the popover\nhttps://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/button#popovertarget", "fieldName": "popoverTargetElement", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "name": "command", "type": { "text": "string" }, "description": "The command property of the HTMLButtonElement interface gets and sets the action to be performed on an element being controlled by this button. For this to have an effect, commandfor must be set.\nhttps://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/button#command", "fieldName": "command", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "name": "commandForElement", "type": { "text": "HTMLElement" }, "description": "The commandForElement property of the HTMLButtonElement interface gets and sets the id of the element being controlled by this button. For this to have an effect, command must be set.\nhttps://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/button#command", "fieldName": "commandForElement", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "name": "interestForElement", "type": { "text": "HTMLElement" }, "description": "The interestForElement property of the HTMLButtonElement interface gets and sets the id of the element being controlled by this button. For this to have an effect, command must be set.\nhttps://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/button#interest", "fieldName": "interestForElement", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } } ], "superclass": { "name": "BaseButton", "package": "@blueprintui/components/internals" }, "tagName": "bp-button-handle", "customElement": true, "summary": "The button handle component is used to act as a handle to drag and move an element, such as a slidebar or a modal window.", "metadata": { "since": "1.0.0" } } ], "exports": [ { "kind": "js", "name": "BpButtonHandle", "declaration": { "name": "BpButtonHandle", "module": "button-handle/element.js" } } ] }, { "kind": "javascript-module", "path": "button-handle/element.visual.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "button-handle/index.js", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "button-handle/element.js" } } ] }, { "kind": "javascript-module", "path": "button-icon/element.css", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "button-icon/element.js", "declarations": [ { "kind": "variable", "name": "buttonIconStyles", "default": "styles" }, { "kind": "class", "description": "```typescript\nimport '@blueprintui/components/include/button-icon.js';\n```\n\n```html\n\n```", "name": "BpButtonIcon", "cssProperties": [ { "name": "--width" }, { "name": "--height" }, { "name": "--color", "inheritedFrom": { "name": "BpButton", "module": "button/element.js" } }, { "name": "--cursor" }, { "name": "--background", "inheritedFrom": { "name": "BpButton", "module": "button/element.js" } }, { "name": "--padding", "inheritedFrom": { "name": "BpButton", "module": "button/element.js" } }, { "name": "--outline" }, { "name": "--outline-offset" }, { "name": "--border", "inheritedFrom": { "name": "BpButton", "module": "button/element.js" } }, { "name": "--min-width", "inheritedFrom": { "name": "BpButton", "module": "button/element.js" } }, { "name": "--font-size", "inheritedFrom": { "name": "BpButton", "module": "button/element.js" } }, { "name": "--line-height", "inheritedFrom": { "name": "BpButton", "module": "button/element.js" } }, { "name": "--text-align", "inheritedFrom": { "name": "BpButton", "module": "button/element.js" } } ], "cssParts": [ { "name": "icon" } ], "slots": [ { "description": "slot for text content or bp-icon", "name": "", "inheritedFrom": { "name": "BpButton", "module": "button/element.js" } } ], "members": [ { "kind": "field", "name": "shape", "type": { "text": "string" }, "default": "'ellipsis-vertical'", "description": "Defines the icon shape to display within the button", "attribute": "shape", "reflects": true }, { "kind": "field", "name": "direction", "type": { "text": "'up' | 'down' | 'left' | 'right'" }, "description": "Controls the directional orientation of the icon within the button", "attribute": "direction", "reflects": true }, { "kind": "field", "name": "i18n", "description": "Provides internationalization strings for accessibility labels and screen reader announcements", "attribute": "i18n" }, { "kind": "field", "name": "icon", "readonly": true }, { "kind": "field", "name": "action", "type": { "text": "'primary' | 'secondary' | 'flat' | 'inline'" }, "description": "Controls the visual styling variant of the button, affecting background, border, and emphasis level", "attribute": "action", "reflects": true, "inheritedFrom": { "name": "BpButton", "module": "button/element.js" } }, { "kind": "field", "name": "status", "type": { "text": "'accent' | 'success' | 'warning' | 'danger'" }, "description": "Defines the visual status type of the button, affecting its color and semantic meaning", "attribute": "status", "reflects": true, "inheritedFrom": { "name": "BpButton", "module": "button/element.js" } }, { "kind": "field", "name": "pressed", "type": { "text": "boolean" }, "description": "turns the button into a toggle button", "attribute": "pressed", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "selected", "type": { "text": "boolean" }, "description": "indicate the current \"selected\" state of various widgets", "attribute": "selected", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "expanded", "type": { "text": "boolean" }, "description": "indicate if a control is expanded or collapsed", "attribute": "expanded", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "readonly", "type": { "text": "boolean" }, "description": "makes the element not mutable, meaning the user can not interact with button", "attribute": "readonly", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "determines if element is mutable or focusable", "attribute": "disabled", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "type", "type": { "text": "'button' | 'submit'" }, "description": "default behavior of the button", "attribute": "type", "reflects": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "name", "type": { "text": "string" }, "description": "represents the name of the current element as a string.", "attribute": "name", "reflects": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "value", "type": { "text": "string" }, "description": "determines the current value", "attribute": "value", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "popoverTargetAction", "type": { "text": "'toggle' | 'show' | 'hide'" }, "description": "The action to perform on the target popover element\nhttps://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/button#popovertargetaction", "attribute": "popovertargetaction", "reflects": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "popoverTargetElement", "type": { "text": "HTMLElement" }, "description": "The target element for the popover\nhttps://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/button#popovertarget", "attribute": "popoverTargetElement", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "command", "type": { "text": "string" }, "description": "The command property of the HTMLButtonElement interface gets and sets the action to be performed on an element being controlled by this button. For this to have an effect, commandfor must be set.\nhttps://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/button#command", "attribute": "command", "reflects": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "commandForElement", "type": { "text": "HTMLElement" }, "description": "The commandForElement property of the HTMLButtonElement interface gets and sets the id of the element being controlled by this button. For this to have an effect, command must be set.\nhttps://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/button#command", "attribute": "commandForElement", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "interestForElement", "type": { "text": "HTMLElement" }, "description": "The interestForElement property of the HTMLButtonElement interface gets and sets the id of the element being controlled by this button. For this to have an effect, command must be set.\nhttps://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/button#interest", "attribute": "interestForElement", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "form", "type": { "text": "HTMLFormElement" }, "readonly": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "formAction", "type": { "text": "string" }, "readonly": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "formEnctype", "type": { "text": "string" }, "readonly": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "formMethod", "type": { "text": "string" }, "readonly": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "formNoValidate", "type": { "text": "boolean" }, "readonly": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "formTarget", "type": { "text": "string" }, "readonly": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "labels", "type": { "text": "NodeListOf" }, "readonly": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "validationMessage", "type": { "text": "string" }, "readonly": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "validity", "type": { "text": "ValidityState" }, "readonly": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "willValidate", "type": { "text": "boolean" }, "readonly": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "checkValidity", "type": { "text": "any" }, "readonly": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "reportValidity", "type": { "text": "any" }, "readonly": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "setCustomValidity", "type": { "text": "any" }, "readonly": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "_internals", "type": { "text": "ElementInternals" }, "readonly": true, "privacy": "private", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "formAssociated", "type": { "text": "boolean" }, "static": true, "default": "true", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } } ], "attributes": [ { "name": "shape", "type": { "text": "string" }, "default": "'ellipsis-vertical'", "description": "Defines the icon shape to display within the button", "fieldName": "shape" }, { "name": "direction", "type": { "text": "'up' | 'down' | 'left' | 'right'" }, "description": "Controls the directional orientation of the icon within the button", "fieldName": "direction" }, { "name": "i18n", "description": "Provides internationalization strings for accessibility labels and screen reader announcements", "fieldName": "i18n" }, { "name": "action", "type": { "text": "'primary' | 'secondary' | 'flat' | 'inline'" }, "description": "Controls the visual styling variant of the button, affecting background, border, and emphasis level", "fieldName": "action", "inheritedFrom": { "name": "BpButton", "module": "button/element.js" } }, { "name": "status", "type": { "text": "'accent' | 'success' | 'warning' | 'danger'" }, "description": "Defines the visual status type of the button, affecting its color and semantic meaning", "fieldName": "status", "inheritedFrom": { "name": "BpButton", "module": "button/element.js" } }, { "name": "pressed", "type": { "text": "boolean" }, "description": "turns the button into a toggle button", "fieldName": "pressed", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "name": "selected", "type": { "text": "boolean" }, "description": "indicate the current \"selected\" state of various widgets", "fieldName": "selected", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "name": "expanded", "type": { "text": "boolean" }, "description": "indicate if a control is expanded or collapsed", "fieldName": "expanded", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "name": "readonly", "type": { "text": "boolean" }, "description": "makes the element not mutable, meaning the user can not interact with button", "fieldName": "readonly", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "determines if element is mutable or focusable", "fieldName": "disabled", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "name": "type", "type": { "text": "'button' | 'submit'" }, "description": "default behavior of the button", "fieldName": "type", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "name": "name", "type": { "text": "string" }, "description": "represents the name of the current element as a string.", "fieldName": "name", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "name": "value", "type": { "text": "string" }, "description": "determines the current value", "fieldName": "value", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "name": "popovertargetaction", "type": { "text": "'toggle' | 'show' | 'hide'" }, "description": "The action to perform on the target popover element\nhttps://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/button#popovertargetaction", "fieldName": "popoverTargetAction", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "name": "popoverTargetElement", "type": { "text": "HTMLElement" }, "description": "The target element for the popover\nhttps://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/button#popovertarget", "fieldName": "popoverTargetElement", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "name": "command", "type": { "text": "string" }, "description": "The command property of the HTMLButtonElement interface gets and sets the action to be performed on an element being controlled by this button. For this to have an effect, commandfor must be set.\nhttps://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/button#command", "fieldName": "command", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "name": "commandForElement", "type": { "text": "HTMLElement" }, "description": "The commandForElement property of the HTMLButtonElement interface gets and sets the id of the element being controlled by this button. For this to have an effect, command must be set.\nhttps://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/button#command", "fieldName": "commandForElement", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "name": "interestForElement", "type": { "text": "HTMLElement" }, "description": "The interestForElement property of the HTMLButtonElement interface gets and sets the id of the element being controlled by this button. For this to have an effect, command must be set.\nhttps://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/button#interest", "fieldName": "interestForElement", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } } ], "superclass": { "name": "BpButton", "package": "@blueprintui/components/button" }, "tagName": "bp-button-icon", "customElement": true, "summary": "The icon button component is used to provide a visual representation of an action.", "metadata": { "since": "1.0.0" } } ], "exports": [ { "kind": "js", "name": "buttonIconStyles", "declaration": { "name": "buttonIconStyles", "module": "button-icon/element.js" } }, { "kind": "js", "name": "BpButtonIcon", "declaration": { "name": "BpButtonIcon", "module": "button-icon/element.js" } } ] }, { "kind": "javascript-module", "path": "button-icon/element.visual.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "button-icon/index.js", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "button-icon/element.js" } } ] }, { "kind": "javascript-module", "path": "button-resize/element.css", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "button-resize/element.js", "declarations": [ { "kind": "class", "description": "```typescript\nimport '@blueprintui/components/include/button-reisze.js';\n```\n\n```html\n\n```", "name": "BpButtonResize", "cssProperties": [ { "name": "--background" }, { "name": "--width" }, { "name": "--height" } ], "members": [], "mixins": [ { "name": "SliderFormControlMixin", "package": "@blueprintui/components/forms" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "bp-button-resize", "customElement": true, "summary": "The resize button component is used to act as a drag handle to resize an element. Key navigation is supported and the step value can be used to adjust the amount of change when using the arrow keys.", "metadata": { "since": "1.0.0" } } ], "exports": [ { "kind": "js", "name": "BpButtonResize", "declaration": { "name": "BpButtonResize", "module": "button-resize/element.js" } } ] }, { "kind": "javascript-module", "path": "button-resize/element.visual.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "button-resize/index.js", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "button-resize/element.js" } } ] }, { "kind": "javascript-module", "path": "button-sort/element.css", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "button-sort/element.js", "declarations": [ { "kind": "class", "description": "```typescript\nimport '@blueprintui/components/include/button-sort.js';\n```\n\n```html\n\n```", "name": "BpButtonSort", "cssProperties": [ { "name": "--width" }, { "name": "--height" }, { "name": "--color" }, { "name": "--cursor" }, { "name": "--background" }, { "name": "--padding" }, { "name": "--outline" }, { "name": "--outline-offset" }, { "name": "--border" }, { "name": "--gap" } ], "members": [ { "kind": "field", "name": "value", "type": { "text": "ButtonSort" }, "description": "Defines the current sort direction state, cycling through none, ascending, and descending" }, { "kind": "field", "name": "readonly", "type": { "text": "boolean" }, "description": "Sets the button as read-only, preventing sort state changes while maintaining focusability" }, { "kind": "field", "name": "i18n", "type": { "text": "I18nStrings['actions']" }, "description": "Provides internationalization strings for accessibility labels and screen reader announcements", "attribute": "i18n" }, { "kind": "method", "name": "#keydown", "privacy": "private", "parameters": [ { "name": "e", "type": { "text": "KeyboardEvent" } } ] }, { "kind": "method", "name": "#updateValue", "privacy": "private", "parameters": [ { "name": "step", "type": { "text": "number" } } ] }, { "kind": "method", "name": "#updateStates", "privacy": "private" }, { "kind": "method", "name": "#input", "privacy": "private" }, { "kind": "method", "name": "#change", "privacy": "private" } ], "events": [ { "name": "input", "type": { "text": "InputEvent" }, "description": "occurs when the value changes" }, { "name": "change", "type": { "text": "InputEvent" }, "description": "occurs when the value changes" } ], "attributes": [ { "name": "i18n", "type": { "text": "I18nStrings['actions']" }, "description": "Provides internationalization strings for accessibility labels and screen reader announcements", "fieldName": "i18n" } ], "mixins": [ { "name": "FormControlMixin", "package": "@blueprintui/components/forms" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "bp-button-sort", "customElement": true, "summary": "The sort button component is used to allow users to sort a list of items by a specific criteria. It is typically used in tables, lists, or other data focused components.", "metadata": { "since": "1.0.0" } } ], "exports": [ { "kind": "js", "name": "BpButtonSort", "declaration": { "name": "BpButtonSort", "module": "button-sort/element.js" } } ] }, { "kind": "javascript-module", "path": "button-sort/element.visual.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "button-sort/index.js", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "button-sort/element.js" } } ] }, { "kind": "javascript-module", "path": "button/element.css", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "button/element.js", "declarations": [ { "kind": "class", "description": "```typescript\nimport '@blueprintui/components/include/button.js';\n```\n\n```html\nsubmit\n```", "name": "BpButton", "cssProperties": [ { "name": "--background" }, { "name": "--color" }, { "name": "--border" }, { "name": "--padding" }, { "name": "--min-width" }, { "name": "--font-size" }, { "name": "--line-height" }, { "name": "--text-align" } ], "slots": [ { "description": "button content", "name": "" } ], "members": [ { "kind": "field", "name": "action", "type": { "text": "'primary' | 'secondary' | 'flat' | 'inline'" }, "description": "Controls the visual styling variant of the button, affecting background, border, and emphasis level", "attribute": "action", "reflects": true }, { "kind": "field", "name": "status", "type": { "text": "'accent' | 'success' | 'warning' | 'danger'" }, "description": "Defines the visual status type of the button, affecting its color and semantic meaning", "attribute": "status", "reflects": true }, { "kind": "field", "name": "pressed", "type": { "text": "boolean" }, "description": "turns the button into a toggle button", "attribute": "pressed", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "selected", "type": { "text": "boolean" }, "description": "indicate the current \"selected\" state of various widgets", "attribute": "selected", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "expanded", "type": { "text": "boolean" }, "description": "indicate if a control is expanded or collapsed", "attribute": "expanded", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "readonly", "type": { "text": "boolean" }, "description": "makes the element not mutable, meaning the user can not interact with button", "attribute": "readonly", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "determines if element is mutable or focusable", "attribute": "disabled", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "type", "type": { "text": "'button' | 'submit'" }, "description": "default behavior of the button", "attribute": "type", "reflects": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "name", "type": { "text": "string" }, "description": "represents the name of the current element as a string.", "attribute": "name", "reflects": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "value", "type": { "text": "string" }, "description": "determines the current value", "attribute": "value", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "popoverTargetAction", "type": { "text": "'toggle' | 'show' | 'hide'" }, "description": "The action to perform on the target popover element\nhttps://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/button#popovertargetaction", "attribute": "popovertargetaction", "reflects": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "popoverTargetElement", "type": { "text": "HTMLElement" }, "description": "The target element for the popover\nhttps://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/button#popovertarget", "attribute": "popoverTargetElement", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "command", "type": { "text": "string" }, "description": "The command property of the HTMLButtonElement interface gets and sets the action to be performed on an element being controlled by this button. For this to have an effect, commandfor must be set.\nhttps://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/button#command", "attribute": "command", "reflects": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "commandForElement", "type": { "text": "HTMLElement" }, "description": "The commandForElement property of the HTMLButtonElement interface gets and sets the id of the element being controlled by this button. For this to have an effect, command must be set.\nhttps://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/button#command", "attribute": "commandForElement", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "interestForElement", "type": { "text": "HTMLElement" }, "description": "The interestForElement property of the HTMLButtonElement interface gets and sets the id of the element being controlled by this button. For this to have an effect, command must be set.\nhttps://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/button#interest", "attribute": "interestForElement", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "form", "type": { "text": "HTMLFormElement" }, "readonly": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "formAction", "type": { "text": "string" }, "readonly": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "formEnctype", "type": { "text": "string" }, "readonly": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "formMethod", "type": { "text": "string" }, "readonly": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "formNoValidate", "type": { "text": "boolean" }, "readonly": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "formTarget", "type": { "text": "string" }, "readonly": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "labels", "type": { "text": "NodeListOf" }, "readonly": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "validationMessage", "type": { "text": "string" }, "readonly": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "validity", "type": { "text": "ValidityState" }, "readonly": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "willValidate", "type": { "text": "boolean" }, "readonly": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "checkValidity", "type": { "text": "any" }, "readonly": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "reportValidity", "type": { "text": "any" }, "readonly": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "setCustomValidity", "type": { "text": "any" }, "readonly": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "_internals", "type": { "text": "ElementInternals" }, "readonly": true, "privacy": "private", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "formAssociated", "type": { "text": "boolean" }, "static": true, "default": "true", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } } ], "attributes": [ { "name": "action", "type": { "text": "'primary' | 'secondary' | 'flat' | 'inline'" }, "description": "Controls the visual styling variant of the button, affecting background, border, and emphasis level", "fieldName": "action" }, { "name": "status", "type": { "text": "'accent' | 'success' | 'warning' | 'danger'" }, "description": "Defines the visual status type of the button, affecting its color and semantic meaning", "fieldName": "status" }, { "name": "pressed", "type": { "text": "boolean" }, "description": "turns the button into a toggle button", "fieldName": "pressed", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "name": "selected", "type": { "text": "boolean" }, "description": "indicate the current \"selected\" state of various widgets", "fieldName": "selected", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "name": "expanded", "type": { "text": "boolean" }, "description": "indicate if a control is expanded or collapsed", "fieldName": "expanded", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "name": "readonly", "type": { "text": "boolean" }, "description": "makes the element not mutable, meaning the user can not interact with button", "fieldName": "readonly", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "determines if element is mutable or focusable", "fieldName": "disabled", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "name": "type", "type": { "text": "'button' | 'submit'" }, "description": "default behavior of the button", "fieldName": "type", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "name": "name", "type": { "text": "string" }, "description": "represents the name of the current element as a string.", "fieldName": "name", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "name": "value", "type": { "text": "string" }, "description": "determines the current value", "fieldName": "value", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "name": "popovertargetaction", "type": { "text": "'toggle' | 'show' | 'hide'" }, "description": "The action to perform on the target popover element\nhttps://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/button#popovertargetaction", "fieldName": "popoverTargetAction", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "name": "popoverTargetElement", "type": { "text": "HTMLElement" }, "description": "The target element for the popover\nhttps://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/button#popovertarget", "fieldName": "popoverTargetElement", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "name": "command", "type": { "text": "string" }, "description": "The command property of the HTMLButtonElement interface gets and sets the action to be performed on an element being controlled by this button. For this to have an effect, commandfor must be set.\nhttps://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/button#command", "fieldName": "command", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "name": "commandForElement", "type": { "text": "HTMLElement" }, "description": "The commandForElement property of the HTMLButtonElement interface gets and sets the id of the element being controlled by this button. For this to have an effect, command must be set.\nhttps://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/button#command", "fieldName": "commandForElement", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "name": "interestForElement", "type": { "text": "HTMLElement" }, "description": "The interestForElement property of the HTMLButtonElement interface gets and sets the id of the element being controlled by this button. For this to have an effect, command must be set.\nhttps://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/button#interest", "fieldName": "interestForElement", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } } ], "superclass": { "name": "BaseButton", "package": "@blueprintui/components/internals" }, "tagName": "bp-button", "customElement": true, "summary": "The button component should be used when the user needs to take an action. The text or icon used in the button should be clear and concise, communicating the action the button will take.", "metadata": { "since": "1.0.0" } } ], "exports": [ { "kind": "js", "name": "BpButton", "declaration": { "name": "BpButton", "module": "button/element.js" } } ] }, { "kind": "javascript-module", "path": "button/element.visual.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "button/index.js", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "button/element.js" } } ] }, { "kind": "javascript-module", "path": "card/element.css", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "card/element.global.css", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "card/element.js", "declarations": [ { "kind": "class", "description": "```typescript\nimport '@blueprintui/components/include/card.js';\n```\n\n```html\n\n Card Content\n\n```", "name": "BpCard", "cssProperties": [ { "name": "--background" }, { "name": "--background" }, { "name": "--color" }, { "name": "--border-radius" }, { "name": "--padding" }, { "name": "--height" }, { "name": "--width" } ], "slots": [ { "description": "slot for card content", "name": "" }, { "description": "slot for card header", "name": "header" }, { "description": "slot for card footer", "name": "footer" } ], "members": [ { "kind": "field", "name": "_internals", "type": { "text": "ElementInternals" } } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "bp-card", "customElement": true, "summary": "The card component is used to group related content together in a visually organized way. The card should have a clear and consistent structure. The header should contain content that describes the content of the card.", "metadata": { "since": "1.0.0" } } ], "exports": [ { "kind": "js", "name": "BpCard", "declaration": { "name": "BpCard", "module": "card/element.js" } } ] }, { "kind": "javascript-module", "path": "card/element.visual.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "card/index.js", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "card/element.js" } } ] }, { "kind": "javascript-module", "path": "chat/element.css", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "chat/element.js", "declarations": [ { "kind": "class", "description": "```typescript\nimport '@blueprintui/components/include/chat.js';\n```\n\n```html\n\n How are you?\n Great!\n\n```", "name": "BpChatMessage", "slots": [ { "description": "content", "name": "" } ], "members": [ { "kind": "field", "name": "type", "type": { "text": "'sent' | 'received'" }, "description": "Defines the message type, determining alignment and styling for sent or received messages", "attribute": "type", "reflects": true }, { "kind": "field", "name": "color", "type": { "text": "'blue' | 'green' | 'red' | 'yellow' | 'purple'" }, "description": "Sets the base color variant for distinguishing different participants in multi-user chat groups", "attribute": "color", "reflects": true }, { "kind": "field", "name": "arrow", "type": { "text": "Position" }, "description": "Controls the position of the speech bubble arrow relative to the message container", "attribute": "arrow", "reflects": true }, { "kind": "field", "name": "progress", "type": { "text": "boolean" }, "description": "Controls whether to display a typing or progress spinner instead of message content", "attribute": "progress" }, { "kind": "field", "name": "_internals", "type": { "text": "ElementInternals" } } ], "attributes": [ { "name": "type", "type": { "text": "'sent' | 'received'" }, "description": "Defines the message type, determining alignment and styling for sent or received messages", "fieldName": "type" }, { "name": "color", "type": { "text": "'blue' | 'green' | 'red' | 'yellow' | 'purple'" }, "description": "Sets the base color variant for distinguishing different participants in multi-user chat groups", "fieldName": "color" }, { "name": "arrow", "type": { "text": "Position" }, "description": "Controls the position of the speech bubble arrow relative to the message container", "fieldName": "arrow" }, { "name": "progress", "type": { "text": "boolean" }, "description": "Controls whether to display a typing or progress spinner instead of message content", "fieldName": "progress" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "bp-chat-message", "customElement": true, "summary": "The Chat message is a component designed to display chat messages in a conversational format. It improves readability and provides a visual context for conversations.", "metadata": { "since": "1.0.0" } } ], "exports": [ { "kind": "js", "name": "BpChatMessage", "declaration": { "name": "BpChatMessage", "module": "chat/element.js" } } ] }, { "kind": "javascript-module", "path": "chat/element.visual.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "chat/group/element.css", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "chat/group/element.js", "declarations": [ { "kind": "class", "description": "```typescript\nimport '@blueprintui/components/include/chat.js';\n```\n\n```html\n\n How are you?\n Great!\n\n```", "name": "BpChatGroup", "slots": [ { "description": "content", "name": "" } ], "members": [ { "kind": "field", "name": "_internals", "type": { "text": "ElementInternals" } } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "bp-chat-group", "customElement": true, "metadata": { "since": "1.0.0" } } ], "exports": [ { "kind": "js", "name": "BpChatGroup", "declaration": { "name": "BpChatGroup", "module": "chat/group/element.js" } } ] }, { "kind": "javascript-module", "path": "chat/index.js", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "chat/element.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "chat/group/element.js" } } ] }, { "kind": "javascript-module", "path": "checkbox/element.css", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "checkbox/element.js", "declarations": [ { "kind": "class", "description": "```typescript\nimport '@blueprintui/components/include/checkbox.js';\n```\n\n```html\n\n \n \n\n```", "name": "BpCheckbox", "members": [], "events": [ { "type": { "text": "InputEvent" }, "description": "occurs when the value changes", "name": "change" } ], "mixins": [ { "name": "CheckboxFormControlMixin", "package": "@blueprintui/components/forms" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "bp-checkbox", "customElement": true, "summary": "Checkboxes are used to select one or more options from a list. They are not intended for lists where only one option can be selected. Each checkbox can be selected independently of the others.", "metadata": { "since": "1.0.0" } } ], "exports": [ { "kind": "js", "name": "BpCheckbox", "declaration": { "name": "BpCheckbox", "module": "checkbox/element.js" } } ] }, { "kind": "javascript-module", "path": "checkbox/element.visual.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "checkbox/index.js", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "checkbox/element.js" } } ] }, { "kind": "javascript-module", "path": "color/element.css", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "color/element.js", "declarations": [ { "kind": "class", "description": "```typescript\nimport '@blueprintui/components/include/color.js';\n```\n\n```html\n\n \n \n\n```", "name": "BpColor", "cssProperties": [ { "name": "--background", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "name": "--background-size", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "name": "--color", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "name": "--border", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "name": "--border-radius", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "name": "--outline", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "name": "--outline-offset", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "name": "--padding", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "name": "--font-size", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "name": "--line-height", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "name": "--height", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "name": "--min-width", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "name": "--width", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "name": "--transition", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "name": "--text-align", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "name": "--cursor", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } } ], "slots": [ { "description": "slot for prefix text or icons", "name": "prefix", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "description": "slot for suffix text or icons", "name": "suffix", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } } ], "members": [ { "kind": "field", "name": "type", "type": { "text": "string" }, "default": "'color'", "description": "Defines the input type as color, enabling color picker functionality", "attribute": "type", "reflects": true, "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "kind": "field", "name": "suffixTemplate", "type": { "text": "TemplateResult | null" }, "privacy": "protected", "readonly": true, "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "kind": "method", "name": "#chooseColor", "privacy": "private" }, { "kind": "field", "name": "prefixTemplate", "type": { "text": "TemplateResult | null" }, "privacy": "protected", "readonly": true, "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "kind": "field", "name": "input", "privacy": "protected", "readonly": true, "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "kind": "method", "name": "showPicker", "privacy": "protected", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } } ], "events": [ { "type": { "text": "InputEvent" }, "description": "occurs when the value changes", "name": "input", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "type": { "text": "InputEvent" }, "description": "occurs when the value changes", "name": "change", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } } ], "attributes": [ { "name": "type", "type": { "text": "string" }, "default": "'color'", "description": "Defines the input type as color, enabling color picker functionality", "fieldName": "type", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } } ], "superclass": { "name": "BpInput", "package": "@blueprintui/components/input" }, "tagName": "bp-color", "customElement": true, "summary": "The color input component is used to allow users to select a color from a predefined set of options or to input a specific color value.", "metadata": { "since": "1.0.0" } } ], "exports": [ { "kind": "js", "name": "BpColor", "declaration": { "name": "BpColor", "module": "color/element.js" } } ] }, { "kind": "javascript-module", "path": "color/element.visual.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "color/index.js", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "color/element.js" } } ] }, { "kind": "javascript-module", "path": "date/element.css", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "date/element.js", "declarations": [ { "kind": "class", "description": "```typescript\nimport '@blueprintui/components/include/date.js';\n```\n\n```html\n\n \n \n message text\n\n```", "name": "BpDate", "slots": [ { "description": "slot for prefix text or icons", "name": "prefix", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "description": "slot for suffic text or icons", "name": "suffix", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } } ], "members": [ { "kind": "field", "name": "type", "type": { "text": "string" }, "default": "'date'", "description": "Defines the input type as date, enabling native browser date picker functionality", "attribute": "type", "reflects": true, "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "kind": "field", "name": "valueAsDate" }, { "kind": "field", "name": "suffixTemplate", "type": { "text": "TemplateResult | null" }, "privacy": "protected", "readonly": true, "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "kind": "field", "name": "prefixTemplate", "type": { "text": "TemplateResult | null" }, "privacy": "protected", "readonly": true, "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "kind": "field", "name": "input", "privacy": "protected", "readonly": true, "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "kind": "method", "name": "showPicker", "privacy": "protected", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } } ], "events": [ { "type": { "text": "InputEvent" }, "description": "occurs when the value changes", "name": "input", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "type": { "text": "InputEvent" }, "description": "occurs when the value changes", "name": "change", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } } ], "attributes": [ { "name": "type", "type": { "text": "string" }, "default": "'date'", "description": "Defines the input type as date, enabling native browser date picker functionality", "fieldName": "type", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } } ], "superclass": { "name": "BpInput", "package": "@blueprintui/components/input" }, "tagName": "bp-date", "customElement": true, "summary": "The date input component is used to allow users to select a date from the native browser datepicker input type.", "metadata": { "since": "1.0.0" }, "cssProperties": [ { "name": "--background-size", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "name": "--color", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "name": "--background", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "name": "--border", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "name": "--border-radius", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "name": "--outline", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "name": "--outline-offset", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "name": "--padding", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "name": "--font-size", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "name": "--line-height", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "name": "--height", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "name": "--min-width", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "name": "--width", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "name": "--transition", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "name": "--text-align", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "name": "--cursor", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } } ] } ], "exports": [ { "kind": "js", "name": "BpDate", "declaration": { "name": "BpDate", "module": "date/element.js" } } ] }, { "kind": "javascript-module", "path": "date/element.visual.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "date/index.js", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "date/element.js" } } ] }, { "kind": "javascript-module", "path": "dialog/element.css", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "dialog/element.global.css", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "dialog/element.js", "declarations": [ { "kind": "class", "description": "```typescript\nimport '@blueprintui/components/include/dialog.js';\n```\n\n```html\n\n\n\n```", "name": "BpDialog", "cssProperties": [ { "name": "--padding" }, { "name": "--filter" }, { "name": "--background" }, { "name": "--color" }, { "name": "--width" }, { "name": "--height" }, { "name": "--min-width" }, { "name": "--min-height" }, { "name": "--font-size" }, { "name": "--animation-duration" } ], "slots": [ { "description": "slot for dialog content", "name": "" }, { "description": "slot for dialog header", "name": "header" }, { "description": "slot for dialog footer", "name": "footer" } ], "members": [ { "kind": "field", "name": "size", "type": { "text": "'sm' | 'md' | 'lg'" }, "description": "Determines the visual size variant of the dialog, affecting width and content scaling", "attribute": "size", "reflects": true }, { "kind": "field", "name": "position", "type": { "text": "Position" }, "default": "'center'", "description": "Controls the position of the dialog relative to the viewport", "attribute": "position", "reflects": true }, { "kind": "field", "name": "closable", "type": { "text": "boolean" }, "default": "false", "description": "Controls whether the dialog displays a close button, allowing users to dismiss it", "attribute": "closable" }, { "kind": "field", "name": "modal", "type": { "text": "boolean" }, "default": "false", "description": "Controls whether the dialog is modal with a backdrop layer that prevents interaction with underlying content", "attribute": "modal", "reflects": true }, { "kind": "field", "name": "i18n", "description": "Provides internationalization strings for accessibility labels and screen reader announcements", "attribute": "i18n" }, { "kind": "field", "name": "popoverConfig", "readonly": true } ], "events": [ { "description": "dispatched when the dialog is opened", "name": "open" }, { "description": "dispatched when the dialog is closed", "name": "close" } ], "attributes": [ { "name": "size", "type": { "text": "'sm' | 'md' | 'lg'" }, "description": "Determines the visual size variant of the dialog, affecting width and content scaling", "fieldName": "size" }, { "name": "position", "type": { "text": "Position" }, "default": "'center'", "description": "Controls the position of the dialog relative to the viewport", "fieldName": "position" }, { "name": "closable", "type": { "text": "boolean" }, "default": "false", "description": "Controls whether the dialog displays a close button, allowing users to dismiss it", "fieldName": "closable" }, { "name": "modal", "type": { "text": "boolean" }, "default": "false", "description": "Controls whether the dialog is modal with a backdrop layer that prevents interaction with underlying content", "fieldName": "modal" }, { "name": "i18n", "description": "Provides internationalization strings for accessibility labels and screen reader announcements", "fieldName": "i18n" } ], "mixins": [ { "name": "PopoverMixin", "package": "@blueprintui/components/internals" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "bp-dialog", "customElement": true, "summary": "The dialog component is used to display content in a overlay that appears on top of the current view. It is used to display information that requires the user's attention or interaction.", "metadata": { "since": "1.0.0" }, "commands": [ { "name": "--toggle-popover", "description": "" }, { "name": "--show-popover", "description": "" }, { "name": "--hide-popover", "description": "" } ] } ], "exports": [ { "kind": "js", "name": "BpDialog", "declaration": { "name": "BpDialog", "module": "dialog/element.js" } } ] }, { "kind": "javascript-module", "path": "dialog/element.visual.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "dialog/index.js", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "dialog/element.js" } } ] }, { "kind": "javascript-module", "path": "divider/element.css", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "divider/element.js", "declarations": [ { "kind": "class", "description": "```typescript\nimport '@blueprintui/components/include/divider.js';\n```\n\n```html\n\n```", "name": "BpDivider", "cssProperties": [ { "name": "--background" }, { "name": "--size" } ], "members": [ { "kind": "field", "name": "orientation", "type": { "text": "'horizontal' | 'vertical'" }, "default": "'horizontal'", "description": "Controls the layout direction of the divider, either horizontal or vertical", "attribute": "orientation", "reflects": true }, { "kind": "field", "name": "_internals", "type": { "text": "ElementInternals" } }, { "kind": "field", "name": "role", "type": { "text": "string" }, "default": "'separator'" }, { "kind": "field", "name": "ariaOrientation", "type": { "text": "string" }, "default": "'horizontal'" } ], "attributes": [ { "name": "orientation", "type": { "text": "'horizontal' | 'vertical'" }, "default": "'horizontal'", "description": "Controls the layout direction of the divider, either horizontal or vertical", "fieldName": "orientation" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "bp-divider", "customElement": true, "summary": "The divider component is used to visually separate content into distinct sections. It can be used to separate a group of related items or to indicate a change in content or context.", "metadata": { "since": "1.0.0" } } ], "exports": [ { "kind": "js", "name": "BpDivider", "declaration": { "name": "BpDivider", "module": "divider/element.js" } } ] }, { "kind": "javascript-module", "path": "divider/element.visual.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "divider/index.js", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "divider/element.js" } } ] }, { "kind": "javascript-module", "path": "drawer/element.css", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "drawer/element.js", "declarations": [ { "kind": "class", "description": "```typescript\nimport '@blueprintui/components/include/drawer.js';\n```\n\n```html\n\n```", "name": "BpDrawer", "cssProperties": [ { "name": "--background" }, { "name": "--padding" }, { "name": "--width" }, { "name": "--height" }, { "name": "--overflow" } ], "slots": [ { "description": "slot for drawer content", "name": "" } ], "members": [ { "kind": "field", "name": "closable", "type": { "text": "boolean" }, "default": "false", "description": "Controls whether the drawer displays a close button, allowing users to dismiss it", "attribute": "closable" }, { "kind": "field", "name": "position", "type": { "text": "'left' | 'right'" }, "default": "'left'", "description": "Controls the drawer position relative to the viewport, sliding in from the left or right edge", "attribute": "position", "reflects": true }, { "kind": "field", "name": "i18n", "description": "Provides internationalization strings for accessibility labels and screen reader announcements", "attribute": "i18n" }, { "kind": "field", "name": "popoverConfig", "readonly": true } ], "events": [ { "description": "dispatched when the drawer is opened", "name": "open" }, { "description": "dispatched when the drawer is closed", "name": "close" } ], "attributes": [ { "name": "closable", "type": { "text": "boolean" }, "default": "false", "description": "Controls whether the drawer displays a close button, allowing users to dismiss it", "fieldName": "closable" }, { "name": "position", "type": { "text": "'left' | 'right'" }, "default": "'left'", "description": "Controls the drawer position relative to the viewport, sliding in from the left or right edge", "fieldName": "position" }, { "name": "i18n", "description": "Provides internationalization strings for accessibility labels and screen reader announcements", "fieldName": "i18n" } ], "mixins": [ { "name": "PopoverMixin", "package": "@blueprintui/components/internals" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "bp-drawer", "customElement": true, "summary": "The drawer component is used to provide a hidden off-screen section that can be revealed by the user. It is commonly used to provide additional navigation or content that is not immediately necessary, but can be easily accessed when needed.", "metadata": { "since": "1.0.0" }, "commands": [ { "name": "--toggle-popover", "description": "" }, { "name": "--show-popover", "description": "" }, { "name": "--hide-popover", "description": "" } ] } ], "exports": [ { "kind": "js", "name": "BpDrawer", "declaration": { "name": "BpDrawer", "module": "drawer/element.js" } } ] }, { "kind": "javascript-module", "path": "drawer/element.visual.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "drawer/index.js", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "drawer/element.js" } } ] }, { "kind": "javascript-module", "path": "dropdown/element.css", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "dropdown/element.js", "declarations": [ { "kind": "class", "description": "```typescript\nimport '@blueprintui/components/include/dropdown.js';\n```\n\n```html\n\n\n\n```", "name": "BpDropdown", "cssProperties": [ { "name": "--padding" }, { "name": "--filter" }, { "name": "--background" }, { "name": "--color" }, { "name": "--width" }, { "name": "--height" }, { "name": "--min-width" }, { "name": "--min-height" }, { "name": "--font-size" } ], "slots": [ { "description": "content", "name": "" } ], "members": [ { "kind": "field", "name": "position", "type": { "text": "Position" }, "default": "'bottom'", "description": "Controls the position of the dropdown relative to its anchor element", "attribute": "position", "reflects": true }, { "kind": "field", "name": "closable", "type": { "text": "boolean" }, "default": "false", "description": "Controls whether the dropdown displays a close button, allowing users to dismiss it", "attribute": "closable" }, { "kind": "field", "name": "i18n", "description": "Provides internationalization strings for accessibility labels and screen reader announcements", "attribute": "i18n" }, { "kind": "field", "name": "popoverConfig", "readonly": true }, { "kind": "method", "name": "#setMenu", "privacy": "private" } ], "events": [ { "description": "dispatched when the dialog is opened", "name": "open" }, { "description": "dispatched when the dialog is closed", "name": "close" } ], "attributes": [ { "name": "position", "type": { "text": "Position" }, "default": "'bottom'", "description": "Controls the position of the dropdown relative to its anchor element", "fieldName": "position" }, { "name": "closable", "type": { "text": "boolean" }, "default": "false", "description": "Controls whether the dropdown displays a close button, allowing users to dismiss it", "fieldName": "closable" }, { "name": "i18n", "description": "Provides internationalization strings for accessibility labels and screen reader announcements", "fieldName": "i18n" } ], "mixins": [ { "name": "PopoverMixin", "package": "@blueprintui/components/internals" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "bp-dropdown", "customElement": true, "summary": "The dropdown are a is a generic popup component that can be positioned relative to an anchor element.", "metadata": { "since": "1.0.0" }, "commands": [ { "name": "--toggle-popover", "description": "" }, { "name": "--show-popover", "description": "" }, { "name": "--hide-popover", "description": "" } ] } ], "exports": [ { "kind": "js", "name": "BpDropdown", "declaration": { "name": "BpDropdown", "module": "dropdown/element.js" } } ] }, { "kind": "javascript-module", "path": "dropdown/element.visual.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "dropdown/index.js", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "dropdown/element.js" } } ] }, { "kind": "javascript-module", "path": "file/element.css", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "file/element.js", "declarations": [ { "kind": "class", "description": "```typescript\nimport '@blueprintui/components/include/file.js';\n```\n\n```html\n\n \n \n\n```", "name": "BpFile", "members": [ { "kind": "field", "name": "i18n", "description": "Provides internationalization strings for accessibility labels and screen reader announcements", "attribute": "i18n" }, { "kind": "field", "name": "accept", "type": { "text": "string" }, "description": "Specifies the file types that the file input should accept, using MIME types or file extensions", "attribute": "accept" }, { "kind": "field", "name": "buttonLabel", "privacy": "private" }, { "kind": "field", "name": "files", "readonly": true }, { "kind": "field", "name": "input", "privacy": "protected", "readonly": true }, { "kind": "field", "name": "#button", "privacy": "private", "readonly": true }, { "kind": "method", "name": "#showPicker", "privacy": "private" }, { "kind": "method", "name": "#change", "privacy": "private", "parameters": [ { "name": "e", "type": { "text": "InputEvent" } } ] }, { "kind": "method", "name": "#setControlWidth", "privacy": "private" }, { "kind": "method", "name": "#clearFiles", "privacy": "private", "parameters": [ { "name": "fireEvent", "default": "true" } ] }, { "kind": "method", "name": "#updateLabelAndFocus", "privacy": "private", "parameters": [ { "name": "files", "optional": true, "type": { "text": "FileList" } } ] } ], "events": [ { "type": { "text": "InputEvent" }, "description": "occurs when the value changes", "name": "input" }, { "type": { "text": "InputEvent" }, "description": "occurs when the value changes", "name": "change" } ], "attributes": [ { "name": "i18n", "description": "Provides internationalization strings for accessibility labels and screen reader announcements", "fieldName": "i18n" }, { "name": "accept", "type": { "text": "string" }, "description": "Specifies the file types that the file input should accept, using MIME types or file extensions", "fieldName": "accept" } ], "mixins": [ { "name": "FormControlMixin", "package": "@blueprintui/components/forms" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "bp-file", "customElement": true, "summary": "The file input component allows users to select and upload one or multiple files from their local device.", "metadata": { "since": "1.0.0" } } ], "exports": [ { "kind": "js", "name": "BpFile", "declaration": { "name": "BpFile", "module": "file/element.js" } } ] }, { "kind": "javascript-module", "path": "file/element.visual.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "file/index.js", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "file/element.js" } } ] }, { "kind": "javascript-module", "path": "format-bytes/element.css", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "format-bytes/element.js", "declarations": [ { "kind": "class", "description": "```typescript\nimport '@blueprintui/components/include/format-bytes.js';\n```\n\n```html\n\n```", "name": "BpFormatBytes", "members": [ { "kind": "field", "name": "display", "type": { "text": "'decimal' | 'binary'" }, "default": "'decimal'", "description": "determines the base unit system: 'decimal' (1000-based) or 'binary' (1024-based)", "attribute": "display" }, { "kind": "field", "name": "unit", "type": { "text": "'b' | 'kb' | 'mb' | 'gb' | 'tb' | 'pb'" }, "description": "force a specific unit instead of auto-detection (b, kb, mb, gb, tb, pb)", "attribute": "unit" }, { "kind": "field", "name": "unitDisplay", "type": { "text": "'long' | 'short'" }, "default": "'short'", "description": "determines how units are displayed: 'short' (kb), 'long' (kilobytes)", "attribute": "unit-display" }, { "kind": "field", "name": "locales", "type": { "text": "string[]" }, "description": "locales to use for number formatting", "attribute": "locales" }, { "kind": "field", "name": "minimumFractionDigits", "type": { "text": "number" }, "default": "0", "description": "minimum number of fraction digits to display", "attribute": "minimum-fraction-digits" }, { "kind": "field", "name": "maximumFractionDigits", "type": { "text": "number" }, "default": "2", "description": "maximum number of fraction digits to display", "attribute": "maximum-fraction-digits" }, { "kind": "field", "name": "value", "type": { "text": "number" }, "default": "0", "description": "Defines the numeric byte value to be formatted and displayed", "attribute": "value" }, { "kind": "field", "name": "#divisor", "privacy": "private", "readonly": true }, { "kind": "field", "name": "#units", "privacy": "private", "readonly": true }, { "kind": "field", "name": "#formattedValue", "privacy": "private", "readonly": true } ], "attributes": [ { "name": "display", "type": { "text": "'decimal' | 'binary'" }, "default": "'decimal'", "description": "determines the base unit system: 'decimal' (1000-based) or 'binary' (1024-based)", "fieldName": "display" }, { "name": "unit", "type": { "text": "'b' | 'kb' | 'mb' | 'gb' | 'tb' | 'pb'" }, "description": "force a specific unit instead of auto-detection (b, kb, mb, gb, tb, pb)", "fieldName": "unit" }, { "name": "unit-display", "type": { "text": "'long' | 'short'" }, "default": "'short'", "description": "determines how units are displayed: 'short' (kb), 'long' (kilobytes)", "fieldName": "unitDisplay" }, { "name": "locales", "type": { "text": "string[]" }, "description": "locales to use for number formatting", "fieldName": "locales" }, { "name": "minimum-fraction-digits", "type": { "text": "number" }, "default": "0", "description": "minimum number of fraction digits to display", "fieldName": "minimumFractionDigits" }, { "name": "maximum-fraction-digits", "type": { "text": "number" }, "default": "2", "description": "maximum number of fraction digits to display", "fieldName": "maximumFractionDigits" }, { "name": "value", "type": { "text": "number" }, "default": "0", "description": "Defines the numeric byte value to be formatted and displayed", "fieldName": "value" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "bp-format-bytes", "customElement": true, "summary": "The format-bytes component is used to display byte values in a human-readable format with automatic unit conversion (b, kb, mb, gb, tb, pb).", "metadata": { "since": "2.9.0" } } ], "exports": [ { "kind": "js", "name": "BpFormatBytes", "declaration": { "name": "BpFormatBytes", "module": "format-bytes/element.js" } } ] }, { "kind": "javascript-module", "path": "format-bytes/index.js", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "format-bytes/element.js" } } ] }, { "kind": "javascript-module", "path": "format-datetime/element.css", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "format-datetime/element.js", "declarations": [ { "kind": "class", "description": "```typescript\nimport '@blueprintui/components/include/format-datetime.js';\n```\n\n```html\n\n```", "name": "BpFormatDatetime", "members": [ { "kind": "field", "name": "locale", "type": { "text": "string" }, "description": "Specifies the locale for date and time formatting", "attribute": "locale" }, { "kind": "field", "name": "weekday", "type": { "text": "'long' | 'short' | 'narrow'" }, "description": "Controls the weekday representation in the formatted date", "attribute": "weekday" }, { "kind": "field", "name": "year", "type": { "text": "'numeric' | '2-digit'" }, "description": "Controls the year representation in the formatted date", "attribute": "year" }, { "kind": "field", "name": "month", "type": { "text": "'numeric' | '2-digit' | 'long' | 'short' | 'narrow'" }, "description": "Controls the month representation in the formatted date", "attribute": "month" }, { "kind": "field", "name": "day", "type": { "text": "'numeric' | '2-digit'" }, "description": "Controls the day representation in the formatted date", "attribute": "day" }, { "kind": "field", "name": "hour", "type": { "text": "'numeric' | '2-digit'" }, "description": "Controls the hour representation in the formatted time", "attribute": "hour" }, { "kind": "field", "name": "minute", "type": { "text": "'numeric' | '2-digit'" }, "description": "Controls the minute representation in the formatted time", "attribute": "minute" }, { "kind": "field", "name": "second", "type": { "text": "'numeric' | '2-digit'" }, "description": "Controls the second representation in the formatted time", "attribute": "second" }, { "kind": "field", "name": "dateStyle", "type": { "text": "'full' | 'long' | 'medium' | 'short'" }, "description": "Defines a preset formatting style for the date portion", "attribute": "date-style" }, { "kind": "field", "name": "timeStyle", "type": { "text": "'full' | 'long' | 'medium' | 'short'" }, "description": "Defines a preset formatting style for the time portion", "attribute": "time-style" }, { "kind": "field", "name": "timeZoneName", "type": { "text": "'long' | 'short'" }, "description": "Controls how the time zone name is displayed in the formatted datetime", "attribute": "time-zone-name" }, { "kind": "field", "name": "timeZone", "type": { "text": "string" }, "description": "Specifies the time zone to use for formatting", "attribute": "time-zone" }, { "kind": "field", "name": "_value", "privacy": "private" }, { "kind": "field", "name": "#value", "privacy": "private", "readonly": true }, { "kind": "field", "name": "_internals", "type": { "text": "ElementInternals" } } ], "attributes": [ { "name": "locale", "type": { "text": "string" }, "description": "Specifies the locale for date and time formatting", "fieldName": "locale" }, { "name": "weekday", "type": { "text": "'long' | 'short' | 'narrow'" }, "description": "Controls the weekday representation in the formatted date", "fieldName": "weekday" }, { "name": "year", "type": { "text": "'numeric' | '2-digit'" }, "description": "Controls the year representation in the formatted date", "fieldName": "year" }, { "name": "month", "type": { "text": "'numeric' | '2-digit' | 'long' | 'short' | 'narrow'" }, "description": "Controls the month representation in the formatted date", "fieldName": "month" }, { "name": "day", "type": { "text": "'numeric' | '2-digit'" }, "description": "Controls the day representation in the formatted date", "fieldName": "day" }, { "name": "hour", "type": { "text": "'numeric' | '2-digit'" }, "description": "Controls the hour representation in the formatted time", "fieldName": "hour" }, { "name": "minute", "type": { "text": "'numeric' | '2-digit'" }, "description": "Controls the minute representation in the formatted time", "fieldName": "minute" }, { "name": "second", "type": { "text": "'numeric' | '2-digit'" }, "description": "Controls the second representation in the formatted time", "fieldName": "second" }, { "name": "date-style", "type": { "text": "'full' | 'long' | 'medium' | 'short'" }, "description": "Defines a preset formatting style for the date portion", "fieldName": "dateStyle" }, { "name": "time-style", "type": { "text": "'full' | 'long' | 'medium' | 'short'" }, "description": "Defines a preset formatting style for the time portion", "fieldName": "timeStyle" }, { "name": "time-zone-name", "type": { "text": "'long' | 'short'" }, "description": "Controls how the time zone name is displayed in the formatted datetime", "fieldName": "timeZoneName" }, { "name": "time-zone", "type": { "text": "string" }, "description": "Specifies the time zone to use for formatting", "fieldName": "timeZone" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "bp-format-datetime", "customElement": true, "summary": "The format-datetime component is used to display a date and time in a human-readable format. The element API reflects the [Intl.DateTimeFormat](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat) API.", "metadata": { "since": "1.17.0" } } ], "exports": [ { "kind": "js", "name": "BpFormatDatetime", "declaration": { "name": "BpFormatDatetime", "module": "format-datetime/element.js" } } ] }, { "kind": "javascript-module", "path": "format-datetime/index.js", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "format-datetime/element.js" } } ] }, { "kind": "javascript-module", "path": "format-number/element.css", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "format-number/element.js", "declarations": [ { "kind": "class", "description": "```typescript\nimport '@blueprintui/components/include/format-number.js';\n```\n\n```html\n\n```", "name": "BpFormatNumber", "members": [ { "kind": "field", "name": "format", "type": { "text": "'currency' | 'decimal' | 'percent'" }, "default": "'decimal'", "description": "Defines the number formatting style, such as currency, decimal, or percent", "attribute": "format" }, { "kind": "field", "name": "currency", "type": { "text": "string" }, "description": "Specifies the currency code to use for currency formatting", "attribute": "currency" }, { "kind": "field", "name": "locales", "type": { "text": "string[]" }, "description": "Specifies the locales to use for number formatting", "attribute": "locales" }, { "kind": "field", "name": "currencySign", "type": { "text": "'standard' | 'accounting'" }, "description": "Controls how to display the currency sign in accounting or standard format", "attribute": "currency-sign" }, { "kind": "field", "name": "currencyDisplay", "type": { "text": "'symbol' | 'code' | 'name'" }, "description": "Controls how the currency is displayed, as symbol, code, or name", "attribute": "currency-display" }, { "kind": "field", "name": "compactDisplay", "type": { "text": "'short' | 'long'" }, "description": "Controls how compact notation displays, using short or long forms", "attribute": "compact-display" }, { "kind": "field", "name": "unitDisplay", "type": { "text": "'long' | 'short' | 'narrow'" }, "description": "Controls how units are displayed in formatted numbers", "attribute": "unit-display" }, { "kind": "field", "name": "notation", "type": { "text": "'standard' | 'scientific' | 'engineering' | 'compact'" }, "description": "Defines the number notation style, such as standard, scientific, or compact", "attribute": "notation" }, { "kind": "field", "name": "signDisplay", "type": { "text": "| 'auto'\n | 'never'\n | 'always'\n | 'exceptZero'" }, "description": "Controls when to display the sign for positive and negative numbers", "attribute": "sign-display" }, { "kind": "field", "name": "value", "type": { "text": "number" }, "privacy": "private", "default": "0" }, { "kind": "field", "name": "#value", "privacy": "private", "readonly": true } ], "attributes": [ { "name": "format", "type": { "text": "'currency' | 'decimal' | 'percent'" }, "default": "'decimal'", "description": "Defines the number formatting style, such as currency, decimal, or percent", "fieldName": "format" }, { "name": "currency", "type": { "text": "string" }, "description": "Specifies the currency code to use for currency formatting", "fieldName": "currency" }, { "name": "locales", "type": { "text": "string[]" }, "description": "Specifies the locales to use for number formatting", "fieldName": "locales" }, { "name": "currency-sign", "type": { "text": "'standard' | 'accounting'" }, "description": "Controls how to display the currency sign in accounting or standard format", "fieldName": "currencySign" }, { "name": "currency-display", "type": { "text": "'symbol' | 'code' | 'name'" }, "description": "Controls how the currency is displayed, as symbol, code, or name", "fieldName": "currencyDisplay" }, { "name": "compact-display", "type": { "text": "'short' | 'long'" }, "description": "Controls how compact notation displays, using short or long forms", "fieldName": "compactDisplay" }, { "name": "unit-display", "type": { "text": "'long' | 'short' | 'narrow'" }, "description": "Controls how units are displayed in formatted numbers", "fieldName": "unitDisplay" }, { "name": "notation", "type": { "text": "'standard' | 'scientific' | 'engineering' | 'compact'" }, "description": "Defines the number notation style, such as standard, scientific, or compact", "fieldName": "notation" }, { "name": "sign-display", "type": { "text": "| 'auto'\n | 'never'\n | 'always'\n | 'exceptZero'" }, "description": "Controls when to display the sign for positive and negative numbers", "fieldName": "signDisplay" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "bp-format-number", "customElement": true, "summary": "The format-datetime component is used to display numbers in a human-readable format. The element reflects the [Intl.NumberFormat](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat) API.", "metadata": { "since": "1.17.0" } } ], "exports": [ { "kind": "js", "name": "BpFormatNumber", "declaration": { "name": "BpFormatNumber", "module": "format-number/element.js" } } ] }, { "kind": "javascript-module", "path": "format-number/index.js", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "format-number/element.js" } } ] }, { "kind": "javascript-module", "path": "format-relative-time/element.css", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "format-relative-time/element.js", "declarations": [ { "kind": "class", "description": "```typescript\nimport '@blueprintui/components/include/format-relative-time.js';\n```\n\n```html\n2024-11-16T10:30:00Z\n```", "name": "BpFormatRelativeTime", "members": [ { "kind": "field", "name": "numeric", "type": { "text": "'always' | 'auto'" }, "default": "'auto'", "description": "determines how to format the time: 'auto' shows \"yesterday\" vs \"1 day ago\"", "attribute": "numeric" }, { "kind": "field", "name": "formatStyle", "type": { "text": "'long' | 'short' | 'narrow'" }, "default": "'long'", "description": "determines the formatting style: 'long', 'short', or 'narrow'", "attribute": "format-style" }, { "kind": "field", "name": "unit", "type": { "text": "'second' | 'minute' | 'hour' | 'day' | 'week' | 'month' | 'year' | 'auto'" }, "default": "'auto'", "description": "the time unit to use, or 'auto' to automatically select the best unit", "attribute": "unit" }, { "kind": "field", "name": "sync", "type": { "text": "boolean" }, "default": "false", "description": "auto-update the displayed time at appropriate intervals", "attribute": "sync" }, { "kind": "field", "name": "locale", "type": { "text": "string" }, "description": "locale to use for formatting", "attribute": "locale" }, { "kind": "field", "name": "_value", "type": { "text": "string" }, "privacy": "private", "default": "''" }, { "kind": "field", "name": "_now", "privacy": "private" }, { "kind": "field", "name": "#syncInterval", "privacy": "private", "type": { "text": "number | null" }, "default": "null" }, { "kind": "field", "name": "#relativeTime", "privacy": "private", "readonly": true }, { "kind": "field", "name": "#updateInterval", "privacy": "private", "readonly": true }, { "kind": "method", "name": "#setupSync", "privacy": "private" }, { "kind": "method", "name": "#clearSync", "privacy": "private" } ], "attributes": [ { "name": "numeric", "type": { "text": "'always' | 'auto'" }, "default": "'auto'", "description": "determines how to format the time: 'auto' shows \"yesterday\" vs \"1 day ago\"", "fieldName": "numeric" }, { "name": "format-style", "type": { "text": "'long' | 'short' | 'narrow'" }, "default": "'long'", "description": "determines the formatting style: 'long', 'short', or 'narrow'", "fieldName": "formatStyle" }, { "name": "unit", "type": { "text": "'second' | 'minute' | 'hour' | 'day' | 'week' | 'month' | 'year' | 'auto'" }, "default": "'auto'", "description": "the time unit to use, or 'auto' to automatically select the best unit", "fieldName": "unit" }, { "name": "sync", "type": { "text": "boolean" }, "default": "false", "description": "auto-update the displayed time at appropriate intervals", "fieldName": "sync" }, { "name": "locale", "type": { "text": "string" }, "description": "locale to use for formatting", "fieldName": "locale" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "bp-format-relative-time", "customElement": true, "summary": "The format-relative-time component displays relative time (e.g., \"2 hours ago\", \"in 3 days\") using the Intl.RelativeTimeFormat API.", "metadata": { "since": "2.10.0" } } ], "exports": [ { "kind": "js", "name": "BpFormatRelativeTime", "declaration": { "name": "BpFormatRelativeTime", "module": "format-relative-time/element.js" } } ] }, { "kind": "javascript-module", "path": "format-relative-time/index.js", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "format-relative-time/element.js" } } ] }, { "kind": "javascript-module", "path": "format-token/element.css", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "format-token/element.js", "declarations": [ { "kind": "class", "description": "```typescript\nimport '@blueprintui/components/include/format-token.js';\n```\n\n```html\nHello world!\n```", "name": "BpFormatToken", "cssProperties": [ { "name": "--padding" }, { "name": "--border-radius" }, { "name": "--border" }, { "name": "--font-family" }, { "name": "--line-height" }, { "name": "--gap" } ], "slots": [ { "description": "Provide text content to be tokenized", "name": "" } ], "members": [ { "kind": "field", "name": "format", "type": { "text": "| 'bpe'\n | 'word-piece'\n | 'sentence-piece'\n | 'llama'\n | 'character'\n | 'whitespace'" }, "default": "'bpe'", "description": "Specifies the tokenization strategy used to split text into tokens for language model visualization", "attribute": "format", "reflects": true }, { "kind": "field", "name": "_text", "type": { "text": "string" }, "privacy": "private", "default": "''" }, { "kind": "field", "name": "tokens", "type": { "text": "string[]" }, "readonly": true }, { "kind": "field", "name": "#tokens", "privacy": "private", "type": { "text": "string[]" }, "default": "[]" }, { "kind": "field", "name": "#colors", "privacy": "private", "type": { "text": "array" }, "default": "[ 'var(--bp-color-red-100)', 'var(--bp-color-blue-100)', 'var(--bp-color-green-100)', 'var(--bp-color-yellow-100)', 'var(--bp-color-violet-100)' ]" }, { "kind": "method", "name": "#updateTokens", "privacy": "private" }, { "kind": "method", "name": "#tokenize", "privacy": "private", "return": { "type": { "text": "string[]" } }, "parameters": [ { "name": "text", "type": { "text": "string" } } ] }, { "kind": "method", "name": "#tokenizeWordPiece", "privacy": "private", "return": { "type": { "text": "string[]" } }, "parameters": [ { "name": "text", "type": { "text": "string" } } ] }, { "kind": "method", "name": "#tokenizeLLaMA", "privacy": "private", "return": { "type": { "text": "string[]" } }, "parameters": [ { "name": "text", "type": { "text": "string" } } ] }, { "kind": "method", "name": "#tokenizeCharacter", "privacy": "private", "return": { "type": { "text": "string[]" } }, "parameters": [ { "name": "text", "type": { "text": "string" } } ] }, { "kind": "method", "name": "#tokenizeWhitespace", "privacy": "private", "return": { "type": { "text": "string[]" } }, "parameters": [ { "name": "text", "type": { "text": "string" } } ] }, { "kind": "method", "name": "#tokenizeBPE", "privacy": "private", "return": { "type": { "text": "string[]" } }, "parameters": [ { "name": "text", "type": { "text": "string" } } ] }, { "kind": "method", "name": "#tokenizeSentencePiece", "privacy": "private", "return": { "type": { "text": "string[]" } }, "parameters": [ { "name": "text", "type": { "text": "string" } } ] }, { "kind": "method", "name": "#splitIntoSubwords", "privacy": "private", "return": { "type": { "text": "string[]" } }, "parameters": [ { "name": "word", "type": { "text": "string" } }, { "name": "format", "type": { "text": "'word-piece' | 'bpe' | 'sentence-piece' | 'llama' | 'character' | 'whitespace'" } } ] }, { "kind": "method", "name": "#extractNextToken", "privacy": "private", "return": { "type": { "text": "string" } }, "parameters": [ { "name": "text", "type": { "text": "string" } }, { "name": "startIndex", "type": { "text": "number" } } ] }, { "kind": "method", "name": "#isAfterSpace", "privacy": "private", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "text", "type": { "text": "string" } }, { "name": "index", "type": { "text": "number" } } ] } ], "attributes": [ { "name": "format", "type": { "text": "| 'bpe'\n | 'word-piece'\n | 'sentence-piece'\n | 'llama'\n | 'character'\n | 'whitespace'" }, "default": "'bpe'", "description": "Specifies the tokenization strategy used to split text into tokens for language model visualization", "fieldName": "format" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "bp-format-token", "customElement": true, "summary": "The format token component visualizes text tokenization for language models, displaying how text is split into tokens using various tokenization strategies like WordPiece, BPE, SentencePiece, and LLaMA.", "metadata": { "since": "2.8.0" } } ], "exports": [ { "kind": "js", "name": "BpFormatToken", "declaration": { "name": "BpFormatToken", "module": "format-token/element.js" } } ] }, { "kind": "javascript-module", "path": "format-token/element.visual.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "format-token/index.js", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "format-token/element.js" } } ] }, { "kind": "javascript-module", "path": "forms/element.visual.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "forms/field-message/element.css", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "forms/field-message/element.js", "declarations": [ { "kind": "class", "description": "Control Message\n\n```typescript\nimport '@blueprintui/components/include/forms.js';\n```\n\n```html\n\n \n \n helper text\n\n```", "name": "BpFieldMessage", "cssProperties": [ { "name": "--color" }, { "name": "--font-size" }, { "name": "--font-weight" }, { "name": "--max-width" }, { "name": "--min-width" } ], "slots": [ { "description": "For projecting helper message text", "name": "" } ], "members": [ { "kind": "field", "name": "status", "type": { "text": "'error' | 'success'" }, "description": "Set the status of field message validation", "attribute": "status", "reflects": true }, { "kind": "field", "name": "error", "type": { "text": "keyof ValidityState" }, "description": "HTML5 ValidityState https://developer.mozilla.org/en-US/docs/Web/API/ValidityState", "attribute": "error", "reflects": true } ], "attributes": [ { "name": "status", "type": { "text": "'error' | 'success'" }, "description": "Set the status of field message validation", "fieldName": "status" }, { "name": "error", "type": { "text": "keyof ValidityState" }, "description": "HTML5 ValidityState https://developer.mozilla.org/en-US/docs/Web/API/ValidityState", "fieldName": "error" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "bp-field-message", "customElement": true, "metadata": { "since": "1.0.0" } } ], "exports": [ { "kind": "js", "name": "BpFieldMessage", "declaration": { "name": "BpFieldMessage", "module": "forms/field-message/element.js" } } ] }, { "kind": "javascript-module", "path": "forms/field/element.css", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "forms/field/element.js", "declarations": [ { "kind": "class", "description": "\n```typescript\nimport '@blueprintui/components/include/forms.js';\n```\n\n```html\n\n \n \n\n```", "name": "BpField", "cssProperties": [ { "name": "--background" } ], "slots": [ {} ], "members": [ { "kind": "field", "name": "layout", "type": { "text": "ControlLayout" }, "default": "'vertical'", "attribute": "layout", "reflects": true }, { "kind": "field", "name": "controlWidth", "type": { "text": "'shrink'" }, "attribute": "control-width", "reflects": true }, { "kind": "field", "name": "inputControl", "readonly": true }, { "kind": "field", "name": "#label", "privacy": "private", "readonly": true }, { "kind": "field", "name": "#messages", "privacy": "private", "readonly": true }, { "kind": "field", "name": "#datalist", "privacy": "private", "readonly": true }, { "kind": "field", "name": "#isInline", "privacy": "private", "readonly": true }, { "kind": "field", "name": "prefixTemplate", "type": { "text": "TemplateResult | null" }, "privacy": "protected", "readonly": true }, { "kind": "field", "name": "suffixTemplate", "type": { "text": "TemplateResult | null" }, "privacy": "protected", "readonly": true }, { "kind": "field", "name": "_internals", "type": { "text": "ElementInternals" }, "privacy": "private" }, { "kind": "method", "name": "#updateSlotState", "privacy": "private" } ], "attributes": [ { "name": "layout", "type": { "text": "ControlLayout" }, "default": "'vertical'", "fieldName": "layout" }, { "name": "control-width", "type": { "text": "'shrink'" }, "fieldName": "controlWidth" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "bp-field", "customElement": true, "metadata": { "since": "1.0.0" } } ], "exports": [ { "kind": "js", "name": "BpField", "declaration": { "name": "BpField", "module": "forms/field/element.js" } } ] }, { "kind": "javascript-module", "path": "forms/fieldset/element.css", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "forms/fieldset/element.js", "declarations": [ { "kind": "class", "description": "Control Group\n\n```typescript\nimport '@blueprintui/components/include/forms.js';\n```\n\n```html\n\n \n\n \n \n\n \n \n\n```", "name": "BpFieldset", "slots": [ {} ], "members": [ { "kind": "field", "name": "layout", "type": { "text": "FormLayout" }, "default": "'vertical'", "description": "determine field layout", "attribute": "layout", "reflects": true }, { "kind": "field", "name": "#inputs", "privacy": "private", "readonly": true }, { "kind": "field", "name": "#labels", "privacy": "private", "readonly": true }, { "kind": "field", "name": "#messages", "privacy": "private", "readonly": true }, { "kind": "field", "name": "inlineItems", "privacy": "protected", "readonly": true }, { "kind": "field", "name": "#isAssociatedGroup", "privacy": "private", "readonly": true }, { "kind": "field", "name": "#isInlineGroup", "privacy": "private", "readonly": true }, { "kind": "field", "name": "_internals", "type": { "text": "ElementInternals" }, "privacy": "private" }, { "kind": "method", "name": "#updateSlotState", "privacy": "private" }, { "kind": "method", "name": "#updateAriaDescribedBy", "privacy": "private" } ], "attributes": [ { "name": "layout", "type": { "text": "FormLayout" }, "default": "'vertical'", "description": "determine field layout", "fieldName": "layout" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "bp-fieldset", "customElement": true, "metadata": { "since": "1.0.0" } } ], "exports": [ { "kind": "js", "name": "BpFieldset", "declaration": { "name": "BpFieldset", "module": "forms/fieldset/element.js" } } ] }, { "kind": "javascript-module", "path": "forms/form-group/element.css", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "forms/form-group/element.js", "declarations": [ { "kind": "class", "description": "Form\n\n```typescript\nimport '@blueprintui/components/include/forms.js';\n```\n\n```html\n\n \n \n \n \n\n \n \n \n \n\n```", "name": "BpFormGroup", "cssProperties": [ { "name": "--label-width" } ], "slots": [ { "description": "For projecting input fields", "name": "" } ], "members": [ { "kind": "field", "name": "layout", "type": { "text": "horizontal | horizontal" }, "default": "'vertical'", "description": "-inline | vertical | vertical-inline | compact}", "attribute": "layout", "reflects": true }, { "kind": "field", "name": "#fields", "privacy": "private", "readonly": true }, { "kind": "field", "name": "#groups", "privacy": "private", "readonly": true }, { "kind": "field", "name": "#observers", "privacy": "private", "type": { "text": "(MutationObserver | ResizeObserver)[]" }, "default": "[]" }, { "kind": "field", "name": "#fieldsAndFieldsets", "privacy": "private", "readonly": true }, { "kind": "field", "name": "#internals", "privacy": "private" }, { "kind": "method", "name": "#setControlLabelWidths", "privacy": "private" } ], "attributes": [ { "name": "layout", "type": { "text": "horizontal | horizontal" }, "default": "'vertical'", "description": "-inline | vertical | vertical-inline | compact}", "fieldName": "layout" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "bp-form-group", "customElement": true, "metadata": { "since": "1.0.0" } } ], "exports": [ { "kind": "js", "name": "BpFormGroup", "declaration": { "name": "BpFormGroup", "module": "forms/form-group/element.js" } } ] }, { "kind": "javascript-module", "path": "forms/index.js", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "forms/field/element.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "forms/fieldset/element.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "forms/field-message/element.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "forms/form-group/element.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "forms/utils/utils.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "forms/utils/validity.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "forms/mixins/form-control.mixin.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "forms/mixins/select.mixin.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "forms/mixins/checkbox.mixin.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "forms/mixins/radio.mixin.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "forms/mixins/slider.mixin.js" } } ] }, { "kind": "javascript-module", "path": "forms/mixins/README.md", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "forms/mixins/checkbox.mixin.js", "declarations": [ { "kind": "function", "name": "CheckboxFormControlMixin", "return": { "type": { "text": "TBase & CheckboxFormControlMixin" } }, "parameters": [ { "name": "SuperClass", "type": { "text": "TBase" } } ], "description": "Mixin that extends FormControlMixin with checkbox-specific functionality.\nProvides native HTMLInputElement[type=checkbox]-like behavior for custom checkbox components.\n\nFeatures:\n- checked: Get/set the checked state of the checkbox\n- indeterminate: Get/set the indeterminate state (displays a dash)\n- value: Defaults to 'on' (native checkbox behavior)\n- type: Returns 'checkbox'\n- CSS state management for :state(checked) and :state(indeterminate)\n- Form value handling based on checked state" } ], "exports": [ { "kind": "js", "name": "CheckboxFormControlMixin", "declaration": { "name": "CheckboxFormControlMixin", "module": "forms/mixins/checkbox.mixin.js" } } ] }, { "kind": "javascript-module", "path": "forms/mixins/form-control.md", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "forms/mixins/form-control.mixin.js", "declarations": [ { "kind": "function", "name": "FormControlMixin", "return": { "type": { "text": "TBase & FormControlMixin" } }, "parameters": [ { "name": "SuperClass", "type": { "text": "TBase" } } ] } ], "exports": [ { "kind": "js", "name": "FormControlMixin", "declaration": { "name": "FormControlMixin", "module": "forms/mixins/form-control.mixin.js" } } ] }, { "kind": "javascript-module", "path": "forms/mixins/radio.mixin.js", "declarations": [ { "kind": "function", "name": "RadioFormControlMixin", "return": { "type": { "text": "TBase & RadioFormControlMixin" } }, "parameters": [ { "name": "SuperClass", "type": { "text": "TBase" } } ], "description": "Mixin that extends FormControlMixin with radio-specific functionality.\nProvides native HTMLInputElement[type=radio]-like behavior for custom radio components.\n\nFeatures:\n- checked: Get/set the checked state of the radio\n- value: Defaults to 'on' (native radio behavior)\n- type: Returns 'radio'\n- CSS state management for :state(checked)\n- Form value handling based on checked state\n- Radio group exclusivity (only one radio with same name can be checked)" } ], "exports": [ { "kind": "js", "name": "RadioFormControlMixin", "declaration": { "name": "RadioFormControlMixin", "module": "forms/mixins/radio.mixin.js" } } ] }, { "kind": "javascript-module", "path": "forms/mixins/select.md", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "forms/mixins/select.mixin.js", "declarations": [ { "kind": "function", "name": "SelectFormControlMixin", "return": { "type": { "text": "TBase & SelectFormControlMixin" } }, "parameters": [ { "name": "SuperClass", "type": { "text": "TBase" } } ], "description": "Mixin that extends FormControlMixin with select-specific functionality.\nProvides native HTMLSelectElement-like behavior for custom select components.\n\nFeatures:\n- options: Returns array of option elements\n- selectedOptions: Returns array of selected option elements\n- selectedIndex: Get/set the index of the first selected option\n- length: Returns the number of options\n- type: Returns 'select-one' or 'select-multiple'\n- size: Defaults to 1 (unlike input which defaults to 20)\n- Multiple select support with FormData for form submission" }, { "kind": "function", "name": "OptionMixin", "return": { "type": { "text": "TBase & OptionMixin" } }, "parameters": [ { "name": "SuperClass", "type": { "text": "TBase" } } ], "description": "Mixin that provides option-specific functionality for custom option elements.\nProvides native HTMLOptionElement-like behavior.\n\nFeatures:\n- value: Get/set the option value (defaults to textContent if not set)\n- selected: Get/set whether the option is selected\n- disabled: Get/set whether the option is disabled" } ], "exports": [ { "kind": "js", "name": "SelectFormControlMixin", "declaration": { "name": "SelectFormControlMixin", "module": "forms/mixins/select.mixin.js" } }, { "kind": "js", "name": "OptionMixin", "declaration": { "name": "OptionMixin", "module": "forms/mixins/select.mixin.js" } } ] }, { "kind": "javascript-module", "path": "forms/mixins/slider.mixin.js", "declarations": [ { "kind": "function", "name": "SliderFormControlMixin", "return": { "type": { "text": "TBase & SliderFormControlMixin" } }, "parameters": [ { "name": "SuperClass", "type": { "text": "TBase" } } ], "description": "Mixin that extends FormControlMixin with slider-specific functionality.\nProvides native HTMLInputElement[type=range]-like behavior for custom slider components.\n\nFeatures:\n- value: Numeric value within min/max range\n- min/max: Define the allowed value boundaries\n- step: Granularity of value changes\n- orientation: horizontal or vertical layout\n- Keyboard navigation (Arrow keys, Home, End)\n- Touch/pointer drag support\n- Form value handling" } ], "exports": [ { "kind": "js", "name": "SliderFormControlMixin", "declaration": { "name": "SliderFormControlMixin", "module": "forms/mixins/slider.mixin.js" } } ] }, { "kind": "javascript-module", "path": "forms/mixins/types.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "forms/utils/interfaces.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "forms/utils/utils.js", "declarations": [ { "kind": "variable", "name": "formLayouts", "type": { "text": "FormLayout[]" }, "default": "['vertical', 'vertical-inline', 'horizontal', 'horizontal-inline', 'compact']" }, { "kind": "function", "name": "updateFieldStatusState", "parameters": [ { "name": "field", "type": { "text": "BpField" } }, { "name": "messages", "type": { "text": "BpFieldMessage[]" } } ] }, { "kind": "function", "name": "syncValidationMessages", "parameters": [ { "name": "field", "type": { "text": "BpField" } }, { "name": "messages", "type": { "text": "BpFieldMessage[]" } } ] }, { "kind": "function", "name": "isObjectLiteral", "return": { "type": { "text": "value is Record" } }, "parameters": [ { "name": "value", "type": { "text": "unknown" } } ] } ], "exports": [ { "kind": "js", "name": "formLayouts", "declaration": { "name": "formLayouts", "module": "forms/utils/utils.js" } }, { "kind": "js", "name": "updateFieldStatusState", "declaration": { "name": "updateFieldStatusState", "module": "forms/utils/utils.js" } }, { "kind": "js", "name": "syncValidationMessages", "declaration": { "name": "syncValidationMessages", "module": "forms/utils/utils.js" } }, { "kind": "js", "name": "isObjectLiteral", "declaration": { "name": "isObjectLiteral", "module": "forms/utils/utils.js" } } ] }, { "kind": "javascript-module", "path": "forms/utils/validity.js", "declarations": [ { "kind": "function", "name": "valueMissing", "parameters": [ { "name": "element", "type": { "text": "any" } } ] }, { "kind": "function", "name": "tooShort", "parameters": [ { "name": "element", "type": { "text": "HTMLInputElement" } } ] }, { "kind": "function", "name": "tooLong", "parameters": [ { "name": "element", "type": { "text": "HTMLInputElement" } } ] }, { "kind": "function", "name": "rangeUnderflow", "parameters": [ { "name": "element", "type": { "text": "HTMLInputElement" } } ] }, { "kind": "function", "name": "rangeOverflow", "parameters": [ { "name": "element", "type": { "text": "HTMLInputElement" } } ] }, { "kind": "function", "name": "stepMismatch", "parameters": [ { "name": "element", "type": { "text": "HTMLInputElement" } } ] }, { "kind": "function", "name": "typeMismatch", "parameters": [ { "name": "element", "type": { "text": "HTMLInputElement" } } ] }, { "kind": "function", "name": "badInput", "parameters": [ { "name": "element", "type": { "text": "HTMLInputElement" } } ] }, { "kind": "function", "name": "patternMismatch", "parameters": [ { "name": "element", "type": { "text": "HTMLInputElement" } } ] } ], "exports": [ { "kind": "js", "name": "valueMissing", "declaration": { "name": "valueMissing", "module": "forms/utils/validity.js" } }, { "kind": "js", "name": "tooShort", "declaration": { "name": "tooShort", "module": "forms/utils/validity.js" } }, { "kind": "js", "name": "tooLong", "declaration": { "name": "tooLong", "module": "forms/utils/validity.js" } }, { "kind": "js", "name": "rangeUnderflow", "declaration": { "name": "rangeUnderflow", "module": "forms/utils/validity.js" } }, { "kind": "js", "name": "rangeOverflow", "declaration": { "name": "rangeOverflow", "module": "forms/utils/validity.js" } }, { "kind": "js", "name": "stepMismatch", "declaration": { "name": "stepMismatch", "module": "forms/utils/validity.js" } }, { "kind": "js", "name": "typeMismatch", "declaration": { "name": "typeMismatch", "module": "forms/utils/validity.js" } }, { "kind": "js", "name": "badInput", "declaration": { "name": "badInput", "module": "forms/utils/validity.js" } }, { "kind": "js", "name": "patternMismatch", "declaration": { "name": "patternMismatch", "module": "forms/utils/validity.js" } } ] }, { "kind": "javascript-module", "path": "header/element.css", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "header/element.js", "declarations": [ { "kind": "class", "description": "```typescript\nimport '@blueprintui/components/include/header.js';\n```\n\n```html\n\n header\n\n```", "name": "BpHeader", "cssProperties": [ { "name": "--padding" }, { "name": "--background" }, { "name": "--color" }, { "name": "--height" }, { "name": "--font-size" }, { "name": "--gap" } ], "slots": [ { "description": "badge content", "name": "" } ], "members": [], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "bp-header", "customElement": true, "summary": "The header component is used to provide a consistent and recognizable top bar, typically containing a logo and main navigation.", "metadata": { "since": "1.0.0" } } ], "exports": [ { "kind": "js", "name": "BpHeader", "declaration": { "name": "BpHeader", "module": "header/element.js" } } ] }, { "kind": "javascript-module", "path": "header/element.visual.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "header/index.js", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "header/element.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "header/item/element.js" } } ] }, { "kind": "javascript-module", "path": "header/item/element.css", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "header/item/element.js", "declarations": [ { "kind": "class", "description": "Header Item", "name": "BpHeaderItem", "slots": [ {} ], "members": [ { "kind": "field", "name": "pressed", "type": { "text": "boolean" }, "description": "turns the button into a toggle button", "attribute": "pressed", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "selected", "type": { "text": "boolean" }, "description": "indicate the current \"selected\" state of various widgets", "attribute": "selected", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "expanded", "type": { "text": "boolean" }, "description": "indicate if a control is expanded or collapsed", "attribute": "expanded", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "readonly", "type": { "text": "boolean" }, "description": "makes the element not mutable, meaning the user can not interact with button", "attribute": "readonly", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "determines if element is mutable or focusable", "attribute": "disabled", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "type", "type": { "text": "'button' | 'submit'" }, "description": "default behavior of the button", "attribute": "type", "reflects": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "name", "type": { "text": "string" }, "description": "represents the name of the current element as a string.", "attribute": "name", "reflects": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "value", "type": { "text": "string" }, "description": "determines the current value", "attribute": "value", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "popoverTargetAction", "type": { "text": "'toggle' | 'show' | 'hide'" }, "description": "The action to perform on the target popover element\nhttps://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/button#popovertargetaction", "attribute": "popovertargetaction", "reflects": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "popoverTargetElement", "type": { "text": "HTMLElement" }, "description": "The target element for the popover\nhttps://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/button#popovertarget", "attribute": "popoverTargetElement", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "command", "type": { "text": "string" }, "description": "The command property of the HTMLButtonElement interface gets and sets the action to be performed on an element being controlled by this button. For this to have an effect, commandfor must be set.\nhttps://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/button#command", "attribute": "command", "reflects": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "commandForElement", "type": { "text": "HTMLElement" }, "description": "The commandForElement property of the HTMLButtonElement interface gets and sets the id of the element being controlled by this button. For this to have an effect, command must be set.\nhttps://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/button#command", "attribute": "commandForElement", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "interestForElement", "type": { "text": "HTMLElement" }, "description": "The interestForElement property of the HTMLButtonElement interface gets and sets the id of the element being controlled by this button. For this to have an effect, command must be set.\nhttps://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/button#interest", "attribute": "interestForElement", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "form", "type": { "text": "HTMLFormElement" }, "readonly": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "formAction", "type": { "text": "string" }, "readonly": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "formEnctype", "type": { "text": "string" }, "readonly": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "formMethod", "type": { "text": "string" }, "readonly": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "formNoValidate", "type": { "text": "boolean" }, "readonly": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "formTarget", "type": { "text": "string" }, "readonly": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "labels", "type": { "text": "NodeListOf" }, "readonly": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "validationMessage", "type": { "text": "string" }, "readonly": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "validity", "type": { "text": "ValidityState" }, "readonly": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "willValidate", "type": { "text": "boolean" }, "readonly": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "checkValidity", "type": { "text": "any" }, "readonly": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "reportValidity", "type": { "text": "any" }, "readonly": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "setCustomValidity", "type": { "text": "any" }, "readonly": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "_internals", "type": { "text": "ElementInternals" }, "readonly": true, "privacy": "private", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "formAssociated", "type": { "text": "boolean" }, "static": true, "default": "true", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } } ], "superclass": { "name": "BaseButton", "package": "@blueprintui/components/internals" }, "deprecated": "use \"bp-button\"", "tagName": "bp-header-item", "customElement": true, "metadata": { "since": "1.0.0" }, "attributes": [ { "name": "pressed", "type": { "text": "boolean" }, "description": "turns the button into a toggle button", "fieldName": "pressed", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "name": "selected", "type": { "text": "boolean" }, "description": "indicate the current \"selected\" state of various widgets", "fieldName": "selected", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "name": "expanded", "type": { "text": "boolean" }, "description": "indicate if a control is expanded or collapsed", "fieldName": "expanded", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "name": "readonly", "type": { "text": "boolean" }, "description": "makes the element not mutable, meaning the user can not interact with button", "fieldName": "readonly", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "determines if element is mutable or focusable", "fieldName": "disabled", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "name": "type", "type": { "text": "'button' | 'submit'" }, "description": "default behavior of the button", "fieldName": "type", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "name": "name", "type": { "text": "string" }, "description": "represents the name of the current element as a string.", "fieldName": "name", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "name": "value", "type": { "text": "string" }, "description": "determines the current value", "fieldName": "value", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "name": "popovertargetaction", "type": { "text": "'toggle' | 'show' | 'hide'" }, "description": "The action to perform on the target popover element\nhttps://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/button#popovertargetaction", "fieldName": "popoverTargetAction", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "name": "popoverTargetElement", "type": { "text": "HTMLElement" }, "description": "The target element for the popover\nhttps://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/button#popovertarget", "fieldName": "popoverTargetElement", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "name": "command", "type": { "text": "string" }, "description": "The command property of the HTMLButtonElement interface gets and sets the action to be performed on an element being controlled by this button. For this to have an effect, commandfor must be set.\nhttps://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/button#command", "fieldName": "command", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "name": "commandForElement", "type": { "text": "HTMLElement" }, "description": "The commandForElement property of the HTMLButtonElement interface gets and sets the id of the element being controlled by this button. For this to have an effect, command must be set.\nhttps://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/button#command", "fieldName": "commandForElement", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "name": "interestForElement", "type": { "text": "HTMLElement" }, "description": "The interestForElement property of the HTMLButtonElement interface gets and sets the id of the element being controlled by this button. For this to have an effect, command must be set.\nhttps://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/button#interest", "fieldName": "interestForElement", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } } ] } ], "exports": [ { "kind": "js", "name": "BpHeaderItem", "declaration": { "name": "BpHeaderItem", "module": "header/item/element.js" } } ] }, { "kind": "javascript-module", "path": "i18n/index.js", "declarations": [], "exports": [ { "kind": "js", "name": "I18nService", "declaration": { "name": "I18nService", "package": "@blueprintui/components/internals" } } ] }, { "kind": "javascript-module", "path": "include/accordion.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "include/alert.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "include/all.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "include/avatar.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "include/badge.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "include/breadcrumb.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "include/button-copy.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "include/button-expand.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "include/button-group.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "include/button-handle.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "include/button-icon.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "include/button-resize.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "include/button-sort.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "include/button.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "include/card.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "include/chat.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "include/checkbox.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "include/color.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "include/date.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "include/dialog.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "include/divider.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "include/drawer.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "include/dropdown.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "include/file.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "include/format-bytes.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "include/format-datetime.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "include/format-number.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "include/format-relative-time.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "include/format-token.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "include/forms.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "include/header.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "include/input.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "include/lazy.js", "declarations": [ { "kind": "variable", "name": "loader", "type": { "text": "object" }, "default": "{ accordion: () => import('@blueprintui/components/include/accordion.js'), alert: () => import('@blueprintui/components/include/alert.js'), badge: () => import('@blueprintui/components/include/badge.js'), breadcrumb: () => import('@blueprintui/components/include/breadcrumb.js'), 'button-expand': () => import('@blueprintui/components/include/button-expand.js'), 'button-group': () => import('@blueprintui/components/include/button-group.js'), 'button-handle': () => import('@blueprintui/components/include/button-handle.js'), 'button-icon': () => import('@blueprintui/components/include/button-icon.js'), 'button-sort': () => import('@blueprintui/components/include/button-sort.js'), button: () => import('@blueprintui/components/include/button.js'), card: () => import('@blueprintui/components/include/card.js'), chat: () => import('@blueprintui/components/include/chat.js'), checkbox: () => import('@blueprintui/components/include/checkbox.js'), color: () => import('@blueprintui/components/include/color.js'), date: () => import('@blueprintui/components/include/date.js'), dialog: () => import('@blueprintui/components/include/dialog.js'), divider: () => import('@blueprintui/components/include/divider.js'), drawer: () => import('@blueprintui/components/include/drawer.js'), dropdown: () => import('@blueprintui/components/include/dropdown.js'), file: () => import('@blueprintui/components/include/file.js'), forms: () => import('@blueprintui/components/include/forms.js'), header: () => import('@blueprintui/components/include/header.js'), icon: () => import('@blueprintui/icons/include.js'), input: () => import('@blueprintui/components/include/input.js'), menu: () => import('@blueprintui/components/include/menu.js'), month: () => import('@blueprintui/components/include/month.js'), nav: () => import('@blueprintui/components/include/nav.js'), number: () => import('@blueprintui/components/include/number.js'), 'number-stepper': () => import('@blueprintui/components/include/number-stepper.js'), page: () => import('@blueprintui/components/include/page.js'), pagination: () => import('@blueprintui/components/include/pagination.js'), panel: () => import('@blueprintui/components/include/panel.js'), password: () => import('@blueprintui/components/include/password.js'), pin: () => import('@blueprintui/components/include/pin.js'), 'progress-bar': () => import('@blueprintui/components/include/progress-bar.js'), 'progress-circle': () => import('@blueprintui/components/include/progress-circle.js'), 'progress-dot': () => import('@blueprintui/components/include/progress-dot.js'), radio: () => import('@blueprintui/components/include/radio.js'), range: () => import('@blueprintui/components/include/range.js'), rating: () => import('@blueprintui/components/include/rating.js'), search: () => import('@blueprintui/components/include/search.js'), select: () => import('@blueprintui/components/include/select.js'), skeleton: () => import('@blueprintui/components/include/skeleton.js'), stepper: () => import('@blueprintui/components/include/stepper.js'), switch: () => import('@blueprintui/components/include/switch.js'), tabs: () => import('@blueprintui/components/include/tabs.js'), tag: () => import('@blueprintui/components/include/tag.js'), textarea: () => import('@blueprintui/components/include/textarea.js'), time: () => import('@blueprintui/components/include/time.js'), toast: () => import('@blueprintui/components/include/toast.js'), tooltip: () => import('@blueprintui/components/include/tooltip.js'), tree: () => import('@blueprintui/components/include/tree.js') }" } ], "exports": [ { "kind": "js", "name": "loader", "declaration": { "name": "loader", "module": "include/lazy.js" } } ] }, { "kind": "javascript-module", "path": "include/menu.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "include/month.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "include/nav.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "include/number-stepper.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "include/number.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "include/page.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "include/pagination.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "include/panel.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "include/password.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "include/pin.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "include/progress-bar.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "include/progress-circle.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "include/progress-dot.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "include/radio.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "include/range.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "include/rating.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "include/search.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "include/select.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "include/skeleton.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "include/stepper.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "include/switch.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "include/tabs.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "include/tag.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "include/telephone.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "include/textarea.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "include/time.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "include/toast.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "include/toggletip.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "include/tooltip.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "include/tree.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "index.js", "declarations": [], "exports": [ { "kind": "js", "name": "version", "declaration": { "name": "version", "module": "./internals/utils/define.js" } }, { "kind": "js", "name": "blueprintRegistry", "declaration": { "name": "blueprintRegistry", "module": "./internals/utils/define.js" } } ] }, { "kind": "javascript-module", "path": "input/element.css", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "input/element.js", "declarations": [ { "kind": "variable", "name": "inputStyles", "default": "styles" }, { "kind": "class", "description": "```typescript\nimport '@blueprintui/components/include/input.js';\n```\n\n```html\n\n \n \n message text\n\n```", "name": "BpInput", "cssProperties": [ { "name": "--background-size" }, { "name": "--color" }, { "name": "--background" }, { "name": "--border" }, { "name": "--border-radius" }, { "name": "--outline" }, { "name": "--outline-offset" }, { "name": "--padding" }, { "name": "--font-size" }, { "name": "--line-height" }, { "name": "--height" }, { "name": "--min-width" }, { "name": "--width" }, { "name": "--transition" }, { "name": "--text-align" }, { "name": "--cursor" } ], "slots": [ { "description": "slot for prefix text or icons", "name": "prefix" }, { "description": "slot for suffix text or icons", "name": "suffix" } ], "members": [ { "kind": "field", "name": "type", "type": { "text": "string" }, "default": "'text'", "description": "Specifies the input type, affecting behavior and validation", "attribute": "type" }, { "kind": "field", "name": "prefixTemplate", "type": { "text": "TemplateResult | null" }, "privacy": "protected", "readonly": true }, { "kind": "field", "name": "suffixTemplate", "type": { "text": "TemplateResult | null" }, "privacy": "protected", "readonly": true }, { "kind": "field", "name": "input", "privacy": "protected", "readonly": true }, { "kind": "method", "name": "showPicker", "privacy": "protected" } ], "events": [ { "type": { "text": "InputEvent" }, "description": "occurs when the value changes", "name": "input" }, { "type": { "text": "InputEvent" }, "description": "occurs when the value changes", "name": "change" } ], "attributes": [ { "name": "type", "type": { "text": "string" }, "default": "'text'", "description": "Specifies the input type, affecting behavior and validation", "fieldName": "type" } ], "mixins": [ { "name": "FormControlMixin", "package": "@blueprintui/components/forms" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "bp-input", "customElement": true, "summary": "The text input component is used to allow users to input and edit text. The text input should have a clear, descriptive label that explains what the user should enter as well as a placeholder text that gives an example of the expected input format.", "metadata": { "since": "1.0.0" } } ], "exports": [ { "kind": "js", "name": "inputStyles", "declaration": { "name": "inputStyles", "module": "input/element.js" } }, { "kind": "js", "name": "BpInput", "declaration": { "name": "BpInput", "module": "input/element.js" } } ] }, { "kind": "javascript-module", "path": "input/element.visual.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "input/index.js", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "input/element.js" } } ] }, { "kind": "javascript-module", "path": "internals/components/button.js", "declarations": [ { "kind": "class", "description": "", "name": "BaseButton", "members": [ { "kind": "field", "name": "pressed", "type": { "text": "boolean" }, "description": "turns the button into a toggle button", "attribute": "pressed" }, { "kind": "field", "name": "selected", "type": { "text": "boolean" }, "description": "indicate the current \"selected\" state of various widgets", "attribute": "selected" }, { "kind": "field", "name": "expanded", "type": { "text": "boolean" }, "description": "indicate if a control is expanded or collapsed", "attribute": "expanded" }, { "kind": "field", "name": "readonly", "type": { "text": "boolean" }, "description": "makes the element not mutable, meaning the user can not interact with button", "attribute": "readonly" }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "determines if element is mutable or focusable", "attribute": "disabled" }, { "kind": "field", "name": "type", "type": { "text": "'button' | 'submit'" }, "description": "default behavior of the button", "attribute": "type", "reflects": true }, { "kind": "field", "name": "name", "type": { "text": "string" }, "description": "represents the name of the current element as a string.", "attribute": "name", "reflects": true }, { "kind": "field", "name": "value", "type": { "text": "string" }, "description": "determines the current value", "attribute": "value" }, { "kind": "field", "name": "popoverTargetAction", "type": { "text": "'toggle' | 'show' | 'hide'" }, "description": "The action to perform on the target popover element\nhttps://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/button#popovertargetaction", "attribute": "popovertargetaction", "reflects": true }, { "kind": "field", "name": "popoverTargetElement", "type": { "text": "HTMLElement" }, "description": "The target element for the popover\nhttps://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/button#popovertarget", "attribute": "popoverTargetElement" }, { "kind": "field", "name": "command", "type": { "text": "string" }, "description": "The command property of the HTMLButtonElement interface gets and sets the action to be performed on an element being controlled by this button. For this to have an effect, commandfor must be set.\nhttps://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/button#command", "attribute": "command", "reflects": true }, { "kind": "field", "name": "commandForElement", "type": { "text": "HTMLElement" }, "description": "The commandForElement property of the HTMLButtonElement interface gets and sets the id of the element being controlled by this button. For this to have an effect, command must be set.\nhttps://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/button#command", "attribute": "commandForElement" }, { "kind": "field", "name": "interestForElement", "type": { "text": "HTMLElement" }, "description": "The interestForElement property of the HTMLButtonElement interface gets and sets the id of the element being controlled by this button. For this to have an effect, command must be set.\nhttps://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/button#interest", "attribute": "interestForElement" }, { "kind": "field", "name": "form", "type": { "text": "HTMLFormElement" }, "readonly": true }, { "kind": "field", "name": "formAction", "type": { "text": "string" }, "readonly": true }, { "kind": "field", "name": "formEnctype", "type": { "text": "string" }, "readonly": true }, { "kind": "field", "name": "formMethod", "type": { "text": "string" }, "readonly": true }, { "kind": "field", "name": "formNoValidate", "type": { "text": "boolean" }, "readonly": true }, { "kind": "field", "name": "formTarget", "type": { "text": "string" }, "readonly": true }, { "kind": "field", "name": "labels", "type": { "text": "NodeListOf" }, "readonly": true }, { "kind": "field", "name": "validationMessage", "type": { "text": "string" }, "readonly": true }, { "kind": "field", "name": "validity", "type": { "text": "ValidityState" }, "readonly": true }, { "kind": "field", "name": "willValidate", "type": { "text": "boolean" }, "readonly": true }, { "kind": "field", "name": "checkValidity", "type": { "text": "any" }, "readonly": true }, { "kind": "field", "name": "reportValidity", "type": { "text": "any" }, "readonly": true }, { "kind": "field", "name": "setCustomValidity", "type": { "text": "any" }, "readonly": true }, { "kind": "field", "name": "_internals", "type": { "text": "ElementInternals" }, "readonly": true, "privacy": "private" }, { "kind": "field", "name": "formAssociated", "type": { "text": "boolean" }, "static": true, "default": "true" } ], "attributes": [ { "name": "pressed", "type": { "text": "boolean" }, "description": "turns the button into a toggle button", "fieldName": "pressed" }, { "name": "selected", "type": { "text": "boolean" }, "description": "indicate the current \"selected\" state of various widgets", "fieldName": "selected" }, { "name": "expanded", "type": { "text": "boolean" }, "description": "indicate if a control is expanded or collapsed", "fieldName": "expanded" }, { "name": "readonly", "type": { "text": "boolean" }, "description": "makes the element not mutable, meaning the user can not interact with button", "fieldName": "readonly" }, { "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "determines if element is mutable or focusable", "fieldName": "disabled" }, { "name": "type", "type": { "text": "'button' | 'submit'" }, "description": "default behavior of the button", "fieldName": "type" }, { "name": "name", "type": { "text": "string" }, "description": "represents the name of the current element as a string.", "fieldName": "name" }, { "name": "value", "type": { "text": "string" }, "description": "determines the current value", "fieldName": "value" }, { "name": "popovertargetaction", "type": { "text": "'toggle' | 'show' | 'hide'" }, "description": "The action to perform on the target popover element\nhttps://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/button#popovertargetaction", "fieldName": "popoverTargetAction" }, { "name": "popoverTargetElement", "type": { "text": "HTMLElement" }, "description": "The target element for the popover\nhttps://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/button#popovertarget", "fieldName": "popoverTargetElement" }, { "name": "command", "type": { "text": "string" }, "description": "The command property of the HTMLButtonElement interface gets and sets the action to be performed on an element being controlled by this button. For this to have an effect, commandfor must be set.\nhttps://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/button#command", "fieldName": "command" }, { "name": "commandForElement", "type": { "text": "HTMLElement" }, "description": "The commandForElement property of the HTMLButtonElement interface gets and sets the id of the element being controlled by this button. For this to have an effect, command must be set.\nhttps://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/button#command", "fieldName": "commandForElement" }, { "name": "interestForElement", "type": { "text": "HTMLElement" }, "description": "The interestForElement property of the HTMLButtonElement interface gets and sets the id of the element being controlled by this button. For this to have an effect, command must be set.\nhttps://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/button#interest", "fieldName": "interestForElement" } ], "superclass": { "name": "LitElement", "package": "lit" }, "customElement": true } ], "exports": [ { "kind": "js", "name": "BaseButton", "declaration": { "name": "BaseButton", "module": "internals/components/button.js" } } ] }, { "kind": "javascript-module", "path": "internals/controllers/dynamic-controllers.controller.js", "declarations": [ { "kind": "function", "name": "dynamicControllers", "return": { "type": { "text": "ClassDecorator" } } }, { "kind": "class", "description": "Responsible for dynamically initializing controllers that are added to the static _controllers property of a given element", "name": "DynamicControllers", "members": [ { "kind": "field", "name": "#instances", "privacy": "private", "default": "new Set>()" }, { "kind": "field", "name": "#hostConstructor", "privacy": "private", "readonly": true }, { "kind": "field", "name": "#hostControllers", "privacy": "private", "readonly": true }, { "kind": "method", "name": "hostConnected" }, { "kind": "method", "name": "sync" }, { "kind": "method", "name": "add", "static": true, "parameters": [ { "name": "hostClass", "type": { "text": "any" } }, { "name": "Controller", "type": { "text": "any" } } ] } ] } ], "exports": [ { "kind": "js", "name": "dynamicControllers", "declaration": { "name": "dynamicControllers", "module": "internals/controllers/dynamic-controllers.controller.js" } }, { "kind": "js", "name": "DynamicControllers", "declaration": { "name": "DynamicControllers", "module": "internals/controllers/dynamic-controllers.controller.js" } } ] }, { "kind": "javascript-module", "path": "internals/controllers/i18n.controller.js", "declarations": [ { "kind": "function", "name": "i18n", "return": { "type": { "text": "ClassDecorator" } }, "parameters": [ { "name": "config", "type": { "text": "{ key: keyof I18nStrings }" } } ] }, { "kind": "class", "description": "Responsible for managing the internationalization (i18n) of a LitElement", "name": "I18nController", "members": [ { "kind": "field", "name": "#i18n", "privacy": "private", "type": { "text": "object" }, "default": "{}" }, { "kind": "method", "name": "hostConnected" }, { "kind": "method", "name": "hostUpdated" }, { "kind": "method", "name": "#updateProp", "privacy": "private" }, { "kind": "field", "name": "#updates", "privacy": "private", "type": { "text": "number" }, "default": "0" }, { "kind": "field", "name": "#firstUpdated", "privacy": "private", "readonly": true } ] } ], "exports": [ { "kind": "js", "name": "i18n", "declaration": { "name": "i18n", "module": "internals/controllers/i18n.controller.js" } }, { "kind": "js", "name": "I18nController", "declaration": { "name": "I18nController", "module": "internals/controllers/i18n.controller.js" } } ] }, { "kind": "javascript-module", "path": "internals/controllers/interaction-click.controller.js", "declarations": [ { "kind": "function", "name": "interactionClick", "return": { "type": { "text": "ClassDecorator" } } }, { "kind": "class", "description": "Responsible for managing the click interaction of a LitElement\n- click event\n- space/enter keyup event\n- disabled state\n- readonly state\n- tabindex state", "name": "InteractionClickController", "members": [ { "kind": "method", "name": "hostConnected" }, { "kind": "method", "name": "hostUpdated" }, { "kind": "field", "name": "#clickFn", "privacy": "private" }, { "kind": "field", "name": "#keyUpFn", "privacy": "private" }, { "kind": "method", "name": "#updateEventListeners", "privacy": "private" }, { "kind": "method", "name": "#updateFocus", "privacy": "private" }, { "kind": "method", "name": "#updateReadonly", "privacy": "private" }, { "kind": "method", "name": "#click", "privacy": "private", "parameters": [ { "name": "event", "type": { "text": "Event" } } ] }, { "kind": "method", "name": "#keyup", "privacy": "private", "parameters": [ { "name": "event", "type": { "text": "KeyboardEvent" } } ] } ] } ], "exports": [ { "kind": "js", "name": "interactionClick", "declaration": { "name": "interactionClick", "module": "internals/controllers/interaction-click.controller.js" } }, { "kind": "js", "name": "InteractionClickController", "declaration": { "name": "InteractionClickController", "module": "internals/controllers/interaction-click.controller.js" } } ] }, { "kind": "javascript-module", "path": "internals/controllers/interaction-expand.controller.js", "declarations": [ { "kind": "function", "name": "interactionExpand", "return": { "type": { "text": "ClassDecorator" } }, "parameters": [ { "name": "fn", "optional": true, "type": { "text": "(host: T) => InteractionExpandConfig" } } ] }, { "kind": "class", "description": "", "name": "InteractionExpandController", "members": [ { "kind": "field", "name": "#hasCommandTrigger", "privacy": "private", "type": { "text": "boolean" }, "default": "false" }, { "kind": "method", "name": "hostConnected" }, { "kind": "method", "name": "toggle" }, { "kind": "method", "name": "open" }, { "kind": "method", "name": "close" }, { "kind": "method", "name": "#setupKeynav", "privacy": "private" } ], "events": [ { "name": "open" }, { "description": "responsible for managing the closable behavior of an element", "name": "close" } ] } ], "exports": [ { "kind": "js", "name": "interactionExpand", "declaration": { "name": "interactionExpand", "module": "internals/controllers/interaction-expand.controller.js" } }, { "kind": "js", "name": "InteractionExpandController", "declaration": { "name": "InteractionExpandController", "module": "internals/controllers/interaction-expand.controller.js" } } ] }, { "kind": "javascript-module", "path": "internals/controllers/interaction-range-selection.controller.js", "declarations": [ { "kind": "function", "name": "interactionRangeSelection", "return": { "type": { "text": "ClassDecorator" } }, "parameters": [ { "name": "fn", "optional": true, "type": { "text": "(host: T) => InteractionRangeSelectionConfig" } } ] }, { "kind": "class", "description": "Responsible for handling range selection in a grid of elements", "name": "InteractionRangeSelectionController", "members": [ { "kind": "field", "name": "#selectionActive", "privacy": "private", "type": { "text": "boolean" }, "default": "false" }, { "kind": "field", "name": "#firstCell", "privacy": "private", "type": { "text": "SelectionElement" } }, { "kind": "field", "name": "#activeCell", "privacy": "private", "type": { "text": "SelectionElement" } }, { "kind": "field", "name": "#config", "privacy": "private", "readonly": true }, { "kind": "field", "name": "#cells", "privacy": "private", "readonly": true }, { "kind": "field", "name": "#enabled", "privacy": "private", "readonly": true }, { "kind": "method", "name": "hostConnected" }, { "kind": "method", "name": "#setupMouseEvents", "privacy": "private" }, { "kind": "method", "name": "#setupKeyboardListeners", "privacy": "private" }, { "kind": "method", "name": "#setFirstCell", "privacy": "private", "parameters": [ { "name": "e", "type": { "text": "any" } } ] }, { "kind": "method", "name": "#setActiveCell", "privacy": "private", "parameters": [ { "name": "activeCell", "type": { "text": "SelectionElement" } } ] }, { "kind": "method", "name": "#stopSelection", "privacy": "private" }, { "kind": "method", "name": "#resetAllActiveCells", "privacy": "private" }, { "kind": "method", "name": "#calculateSelection", "privacy": "private" }, { "kind": "method", "name": "#dispatchEvent", "privacy": "private", "parameters": [ { "name": "event", "type": { "text": "string" } } ] }, { "kind": "method", "name": "#addHighlightOutline", "privacy": "private" }, { "kind": "method", "name": "#hasHighlight", "privacy": "private", "parameters": [ { "name": "cell", "type": { "text": "HTMLElement & { _internals?: ElementInternals }" } } ] }, { "kind": "method", "name": "#addHighlight", "privacy": "private", "parameters": [ { "name": "cell", "type": { "text": "HTMLElement & { _internals?: ElementInternals }" } } ] }, { "kind": "method", "name": "#deleteHighlight", "privacy": "private", "parameters": [ { "name": "cell", "type": { "text": "HTMLElement & { _internals?: ElementInternals }" } } ] } ] } ], "exports": [ { "kind": "js", "name": "interactionRangeSelection", "declaration": { "name": "interactionRangeSelection", "module": "internals/controllers/interaction-range-selection.controller.js" } }, { "kind": "js", "name": "InteractionRangeSelectionController", "declaration": { "name": "InteractionRangeSelectionController", "module": "internals/controllers/interaction-range-selection.controller.js" } } ] }, { "kind": "javascript-module", "path": "internals/controllers/interaction-resize-context.controller.js", "declarations": [ { "kind": "function", "name": "resizeContext", "return": { "type": { "text": "ClassDecorator" } }, "parameters": [ { "name": "fn", "optional": true, "type": { "text": "(host: T) => ResizeContextConfig" } } ] }, { "kind": "class", "description": "Responsible for managing the resizing of a LitElement", "name": "InteractionResizeContextController", "members": [ { "kind": "field", "name": "#resizer", "privacy": "private", "type": { "text": "BpButtonResize" } }, { "kind": "field", "name": "#minWidth", "privacy": "private", "type": { "text": "number" }, "default": "36" }, { "kind": "field", "name": "config", "type": { "text": "ResizeContextConfig" }, "privacy": "protected", "readonly": true }, { "kind": "method", "name": "hostConnected" }, { "kind": "method", "name": "hostUpdated" }, { "kind": "method", "name": "#resize", "privacy": "private", "parameters": [ { "name": "width", "type": { "text": "number" } } ] } ] } ], "exports": [ { "kind": "js", "name": "resizeContext", "declaration": { "name": "resizeContext", "module": "internals/controllers/interaction-resize-context.controller.js" } }, { "kind": "js", "name": "InteractionResizeContextController", "declaration": { "name": "InteractionResizeContextController", "module": "internals/controllers/interaction-resize-context.controller.js" } } ] }, { "kind": "javascript-module", "path": "internals/controllers/interaction-responsive.controller.js", "declarations": [ { "kind": "function", "name": "interactionResponsive", "return": { "type": { "text": "ClassDecorator" } }, "parameters": [ { "name": "config", "default": "{ skipFirst: false }", "type": { "text": "ResponsiveConfig" } } ] }, { "kind": "class", "description": "Responsible for managing the responsive behavior of a LitElement. Provides a `resize-layout` event when component dimensions are resized", "name": "InteractionResponsiveController", "members": [ { "kind": "field", "name": "#observer", "privacy": "private", "type": { "text": "ResizeObserver" } }, { "kind": "field", "name": "#resizeElement", "privacy": "private", "type": { "text": "HTMLElement" } }, { "kind": "field", "name": "#skipFirst", "privacy": "private", "type": { "text": "boolean" }, "default": "!!config.skipFirst" }, { "kind": "method", "name": "hostConnected" }, { "kind": "method", "name": "hostDisconnected" } ] } ], "exports": [ { "kind": "js", "name": "interactionResponsive", "declaration": { "name": "interactionResponsive", "module": "internals/controllers/interaction-responsive.controller.js" } }, { "kind": "js", "name": "InteractionResponsiveController", "declaration": { "name": "InteractionResponsiveController", "module": "internals/controllers/interaction-responsive.controller.js" } } ] }, { "kind": "javascript-module", "path": "internals/controllers/interaction-select.controller.js", "declarations": [ { "kind": "function", "name": "interactionSelect", "return": { "type": { "text": "ClassDecorator" } } }, { "kind": "class", "description": "responsible for managing the closable behavior of an element", "name": "InteractionSelectController", "members": [ { "kind": "field", "name": "#hasCommandTrigger", "privacy": "private", "type": { "text": "boolean" }, "default": "false" }, { "kind": "method", "name": "hostConnected" }, { "kind": "method", "name": "toggle" }, { "kind": "method", "name": "select" }, { "kind": "method", "name": "deselect" } ] } ], "exports": [ { "kind": "js", "name": "interactionSelect", "declaration": { "name": "interactionSelect", "module": "internals/controllers/interaction-select.controller.js" } }, { "kind": "js", "name": "InteractionSelectController", "declaration": { "name": "InteractionSelectController", "module": "internals/controllers/interaction-select.controller.js" } } ] }, { "kind": "javascript-module", "path": "internals/controllers/interaction-text-change.controller.js", "declarations": [ { "kind": "function", "name": "interactionTextChange", "return": { "type": { "text": "ClassDecorator" } } }, { "kind": "class", "description": "Responsible for notifying of text node changes of a host element", "name": "InteractionTextChangeController", "members": [ { "kind": "field", "name": "#observer", "privacy": "private", "type": { "text": "MutationObserver" } }, { "kind": "method", "name": "hostConnected" }, { "kind": "method", "name": "hostDisconnected" }, { "kind": "method", "name": "#dispatch", "privacy": "private" } ], "events": [ { "name": "bp-textchange" } ] } ], "exports": [ { "kind": "js", "name": "interactionTextChange", "declaration": { "name": "interactionTextChange", "module": "internals/controllers/interaction-text-change.controller.js" } }, { "kind": "js", "name": "InteractionTextChangeController", "declaration": { "name": "InteractionTextChangeController", "module": "internals/controllers/interaction-text-change.controller.js" } } ] }, { "kind": "javascript-module", "path": "internals/controllers/interaction-touch.controller.js", "declarations": [ { "kind": "class", "description": "", "name": "TouchCoordinate", "members": [ { "kind": "field", "name": "x", "type": { "text": "number" } }, { "kind": "field", "name": "y", "type": { "text": "number" } }, { "kind": "field", "name": "offsetX", "type": { "text": "number" } }, { "kind": "field", "name": "offsetY", "type": { "text": "number" } } ] }, { "kind": "function", "name": "interactionTouch", "return": { "type": { "text": "ClassDecorator" } } }, { "kind": "class", "description": "Responsible for handling touch events on a LitElement", "name": "InteractionTouchController", "members": [ { "kind": "field", "name": "#startPosition", "privacy": "private", "type": { "text": "{ x: number; y: number }" } }, { "kind": "field", "name": "#moveHandler", "privacy": "private" }, { "kind": "field", "name": "#endHandler", "privacy": "private" }, { "kind": "method", "name": "hostConnected" }, { "kind": "method", "name": "#start", "privacy": "private", "parameters": [ { "name": "e", "type": { "text": "PointerEvent & { path: HTMLElement[] }" } } ] }, { "kind": "method", "name": "#move", "privacy": "private", "parameters": [ { "name": "e", "type": { "text": "PointerEvent" } } ] }, { "kind": "method", "name": "#end", "privacy": "private", "parameters": [ { "name": "e", "type": { "text": "PointerEvent" } } ] } ], "events": [ { "name": "bp-touchstart" }, { "name": "bp-touchmove" }, { "name": "bp-touchend" } ] } ], "exports": [ { "kind": "js", "name": "TouchCoordinate", "declaration": { "name": "TouchCoordinate", "module": "internals/controllers/interaction-touch.controller.js" } }, { "kind": "js", "name": "interactionTouch", "declaration": { "name": "interactionTouch", "module": "internals/controllers/interaction-touch.controller.js" } }, { "kind": "js", "name": "InteractionTouchController", "declaration": { "name": "InteractionTouchController", "module": "internals/controllers/interaction-touch.controller.js" } } ] }, { "kind": "javascript-module", "path": "internals/controllers/state-active.controller.js", "declarations": [ { "kind": "function", "name": "stateActive", "return": { "type": { "text": "ClassDecorator" } } }, { "kind": "class", "description": "Responsible for adding an --active state to an element when it is in an active state\nA shim fix for CSS psuedo-selector :active on keydown space/enter for custom elements", "name": "StateActiveController", "members": [ { "kind": "method", "name": "hostConnected" }, { "kind": "method", "name": "#emulateActive", "privacy": "private", "parameters": [ { "name": "event", "type": { "text": "any" } } ] }, { "kind": "method", "name": "#emulateInactive", "privacy": "private" } ] } ], "exports": [ { "kind": "js", "name": "stateActive", "declaration": { "name": "stateActive", "module": "internals/controllers/state-active.controller.js" } }, { "kind": "js", "name": "StateActiveController", "declaration": { "name": "StateActiveController", "module": "internals/controllers/state-active.controller.js" } } ] }, { "kind": "javascript-module", "path": "internals/controllers/state-checked.controller.js", "declarations": [ { "kind": "function", "name": "stateChecked", "return": { "type": { "text": "ClassDecorator" } } }, { "kind": "class", "description": "Responsible for managing the aria-checked attribute and the --checked CSS state", "name": "StateCheckedController", "members": [ { "kind": "method", "name": "hostConnected" }, { "kind": "method", "name": "hostUpdated" } ] } ], "exports": [ { "kind": "js", "name": "stateChecked", "declaration": { "name": "stateChecked", "module": "internals/controllers/state-checked.controller.js" } }, { "kind": "js", "name": "StateCheckedController", "declaration": { "name": "StateCheckedController", "module": "internals/controllers/state-checked.controller.js" } } ] }, { "kind": "javascript-module", "path": "internals/controllers/state-direction.controller.js", "declarations": [ { "kind": "function", "name": "stateDirection", "return": { "type": { "text": "ClassDecorator" } } }, { "kind": "class", "description": "Responsible for setting the direction CSS state of a LitElement based on the dir attribute of the host element or its parent elements.\nShim for CSS dir() behavior https://developer.mozilla.org/en-US/docs/Web/CSS/:dir", "name": "StateDirectionController", "members": [ { "kind": "field", "name": "#observer", "privacy": "private", "type": { "text": "MutationObserver" } }, { "kind": "method", "name": "hostConnected" }, { "kind": "method", "name": "hostUpdated" }, { "kind": "method", "name": "hostDisconnected" }, { "kind": "method", "name": "#updateState", "privacy": "private" } ] } ], "exports": [ { "kind": "js", "name": "stateDirection", "declaration": { "name": "stateDirection", "module": "internals/controllers/state-direction.controller.js" } }, { "kind": "js", "name": "StateDirectionController", "declaration": { "name": "StateDirectionController", "module": "internals/controllers/state-direction.controller.js" } } ] }, { "kind": "javascript-module", "path": "internals/controllers/state-disabled.controller.js", "declarations": [ { "kind": "function", "name": "stateDisabled", "return": { "type": { "text": "ClassDecorator" } } }, { "kind": "class", "description": "Responsible for managing the disabled state of a LitElement.\nProvides all nessesary aria-* attributes to create valid disabled state for interactive components.", "name": "StateDisabledController", "members": [ { "kind": "method", "name": "hostConnected" }, { "kind": "method", "name": "hostUpdated" } ] } ], "exports": [ { "kind": "js", "name": "stateDisabled", "declaration": { "name": "stateDisabled", "module": "internals/controllers/state-disabled.controller.js" } }, { "kind": "js", "name": "StateDisabledController", "declaration": { "name": "StateDisabledController", "module": "internals/controllers/state-disabled.controller.js" } } ] }, { "kind": "javascript-module", "path": "internals/controllers/state-expanded.controller.js", "declarations": [ { "kind": "function", "name": "stateExpanded", "return": { "type": { "text": "ClassDecorator" } } }, { "kind": "class", "description": "Responsible for managing the aria-expanded attribute and the --expanded CSS state of a LitElement", "name": "StateExpandedController", "members": [ { "kind": "method", "name": "hostConnected" }, { "kind": "method", "name": "hostUpdated" } ] } ], "exports": [ { "kind": "js", "name": "stateExpanded", "declaration": { "name": "stateExpanded", "module": "internals/controllers/state-expanded.controller.js" } }, { "kind": "js", "name": "StateExpandedController", "declaration": { "name": "StateExpandedController", "module": "internals/controllers/state-expanded.controller.js" } } ] }, { "kind": "javascript-module", "path": "internals/controllers/state-pressed.controller.js", "declarations": [ { "kind": "function", "name": "statePressed", "return": { "type": { "text": "ClassDecorator" } } }, { "kind": "class", "description": "Responsible for managing the aria-pressed attribute and the --pressed CSS state", "name": "StatePressedController", "members": [ { "kind": "method", "name": "hostConnected" }, { "kind": "method", "name": "hostUpdated" } ] } ], "exports": [ { "kind": "js", "name": "statePressed", "declaration": { "name": "statePressed", "module": "internals/controllers/state-pressed.controller.js" } }, { "kind": "js", "name": "StatePressedController", "declaration": { "name": "StatePressedController", "module": "internals/controllers/state-pressed.controller.js" } } ] }, { "kind": "javascript-module", "path": "internals/controllers/state-readonly.controller.js", "declarations": [ { "kind": "function", "name": "stateReadonly", "return": { "type": { "text": "ClassDecorator" } } }, { "kind": "class", "description": "Responsible for managing the --readonly CSS state", "name": "StateReadonlyController", "members": [ { "kind": "method", "name": "hostConnected" }, { "kind": "method", "name": "hostUpdated" } ] } ], "exports": [ { "kind": "js", "name": "stateReadonly", "declaration": { "name": "stateReadonly", "module": "internals/controllers/state-readonly.controller.js" } }, { "kind": "js", "name": "StateReadonlyController", "declaration": { "name": "StateReadonlyController", "module": "internals/controllers/state-readonly.controller.js" } } ] }, { "kind": "javascript-module", "path": "internals/controllers/state-selected.controller.js", "declarations": [ { "kind": "function", "name": "stateSelected", "return": { "type": { "text": "ClassDecorator" } } }, { "kind": "class", "description": "Responsible for managing the aria-selected attribute and the --selected CSS state of a element", "name": "StateSelectedController", "members": [ { "kind": "method", "name": "hostConnected" }, { "kind": "method", "name": "hostUpdated" } ] } ], "exports": [ { "kind": "js", "name": "stateSelected", "declaration": { "name": "stateSelected", "module": "internals/controllers/state-selected.controller.js" } }, { "kind": "js", "name": "StateSelectedController", "declaration": { "name": "StateSelectedController", "module": "internals/controllers/state-selected.controller.js" } } ] }, { "kind": "javascript-module", "path": "internals/controllers/state-text-content.controller.js", "declarations": [ { "kind": "function", "name": "stateTextContent", "return": { "type": { "text": "ClassDecorator" } } }, { "kind": "class", "description": "Responsible for managing the `--text-content` CSS state based on the text content of the element", "name": "StateTextContentController", "members": [ { "kind": "field", "name": "#observer", "privacy": "private", "type": { "text": "MutationObserver" } }, { "kind": "field", "name": "#charCount", "privacy": "private", "type": { "text": "number" }, "default": "0" }, { "kind": "method", "name": "hostConnected" }, { "kind": "method", "name": "hostDisconnected" }, { "kind": "method", "name": "#updateState", "privacy": "private" } ] } ], "exports": [ { "kind": "js", "name": "stateTextContent", "declaration": { "name": "stateTextContent", "module": "internals/controllers/state-text-content.controller.js" } }, { "kind": "js", "name": "StateTextContentController", "declaration": { "name": "StateTextContentController", "module": "internals/controllers/state-text-content.controller.js" } } ] }, { "kind": "javascript-module", "path": "internals/controllers/type-anchor.controller.js", "declarations": [ { "kind": "function", "name": "typeAnchor", "return": { "type": { "text": "ClassDecorator" } } }, { "kind": "class", "description": "Responsible for managing the behavior of a element that contains an anchor element", "name": "TypeAnchorController", "members": [ { "kind": "field", "name": "#anchor", "privacy": "private", "readonly": true }, { "kind": "method", "name": "hostConnected" } ] } ], "exports": [ { "kind": "js", "name": "typeAnchor", "declaration": { "name": "typeAnchor", "module": "internals/controllers/type-anchor.controller.js" } }, { "kind": "js", "name": "TypeAnchorController", "declaration": { "name": "TypeAnchorController", "module": "internals/controllers/type-anchor.controller.js" } } ] }, { "kind": "javascript-module", "path": "internals/controllers/type-button.controller.js", "declarations": [ { "kind": "function", "name": "typeButton", "return": { "type": { "text": "ClassDecorator" } } }, { "kind": "class", "description": "Responsible for managing the behavior of a element that contains a button.\nProvides nessesary attributes for indicating a non-button element as an accessible button type.", "name": "TypeButtonController", "members": [ { "kind": "method", "name": "hostConnected" }, { "kind": "method", "name": "hostUpdated" }, { "kind": "method", "name": "#updateEventListeners", "privacy": "private" }, { "kind": "method", "name": "#updateRole", "privacy": "private" }, { "kind": "method", "name": "#updateType", "privacy": "private" }, { "kind": "field", "name": "#clickFn", "privacy": "private" }, { "kind": "method", "name": "#click", "privacy": "private" }, { "kind": "field", "name": "#submitter", "privacy": "private", "type": { "text": "HTMLButtonElement | null" }, "default": "null" }, { "kind": "method", "name": "#setupSubmitter", "privacy": "private" } ] } ], "exports": [ { "kind": "js", "name": "typeButton", "declaration": { "name": "typeButton", "module": "internals/controllers/type-button.controller.js" } }, { "kind": "js", "name": "TypeButtonController", "declaration": { "name": "TypeButtonController", "module": "internals/controllers/type-button.controller.js" } } ] }, { "kind": "javascript-module", "path": "internals/controllers/type-closable.controller.js", "declarations": [ { "kind": "function", "name": "typeClosable", "return": { "type": { "text": "ClassDecorator" } } }, { "kind": "class", "description": "Responsible determining if the element is closable", "name": "TypeClosableController", "members": [ { "kind": "field", "name": "#hasCommandTrigger", "privacy": "private", "readonly": true }, { "kind": "method", "name": "hostConnected" }, { "kind": "method", "name": "hostUpdated" }, { "kind": "method", "name": "toggle" }, { "kind": "method", "name": "close" }, { "kind": "method", "name": "open" } ], "events": [ { "name": "close" }, { "name": "open" } ], "cssStates": [ { "name": "open" }, { "name": "close" } ], "commands": [ { "name": "--toggle", "description": "" }, { "name": "--close", "description": "" }, { "name": "--open", "description": "" } ] } ], "exports": [ { "kind": "js", "name": "typeClosable", "declaration": { "name": "typeClosable", "module": "internals/controllers/type-closable.controller.js" } }, { "kind": "js", "name": "TypeClosableController", "declaration": { "name": "TypeClosableController", "module": "internals/controllers/type-closable.controller.js" } } ] }, { "kind": "javascript-module", "path": "internals/controllers/type-command-trigger.controller.js", "declarations": [ { "kind": "function", "name": "typeCommandTrigger", "return": { "type": { "text": "ClassDecorator" } }, "description": "Provides necessary API for Invoker Command support https://developer.mozilla.org/en-US/docs/Web/API/Invoker_Commands_API" }, { "kind": "class", "description": "", "name": "TypeCommandTriggerController", "members": [ { "kind": "field", "name": "#observer", "privacy": "private", "type": { "text": "MutationObserver" }, "default": "new MutationObserver(mutations => { const element = mutations[0].target as HTMLElement; this.host.commandForElement = querySelectorByIdRef(this.host, element.getAttribute('commandfor')); })" }, { "kind": "method", "name": "hostConnected" }, { "kind": "method", "name": "hostDisconnected" } ] } ], "exports": [ { "kind": "js", "name": "typeCommandTrigger", "declaration": { "name": "typeCommandTrigger", "module": "internals/controllers/type-command-trigger.controller.js" } }, { "kind": "js", "name": "TypeCommandTriggerController", "declaration": { "name": "TypeCommandTriggerController", "module": "internals/controllers/type-command-trigger.controller.js" } } ] }, { "kind": "javascript-module", "path": "internals/controllers/type-group.controller.js", "declarations": [ { "kind": "function", "name": "typeGroup", "return": { "type": { "text": "ClassDecorator" } } }, { "kind": "class", "description": "Responsible for setting the role attribute of an element to \"group\" to indicate that the element is a group of related elements", "name": "TypeGroupController", "members": [ { "kind": "method", "name": "hostConnected" } ] } ], "exports": [ { "kind": "js", "name": "typeGroup", "declaration": { "name": "typeGroup", "module": "internals/controllers/type-group.controller.js" } }, { "kind": "js", "name": "TypeGroupController", "declaration": { "name": "TypeGroupController", "module": "internals/controllers/type-group.controller.js" } } ] }, { "kind": "javascript-module", "path": "internals/controllers/type-interest-trigger.controller.js", "declarations": [ { "kind": "function", "name": "typeInterestTrigger", "return": { "type": { "text": "ClassDecorator" } }, "description": "Provides necessary API for Invoker Interest support https://developer.mozilla.org/en-US/docs/Web/API/Invoker_Interests_API" }, { "kind": "class", "description": "", "name": "TypeInterestTriggerController", "members": [ { "kind": "field", "name": "#observer", "privacy": "private", "type": { "text": "MutationObserver" }, "default": "new MutationObserver(mutations => { const element = mutations[0].target as HTMLElement; this.host.interestForElement = querySelectorByIdRef(this.host, element.getAttribute('interestfor')); })" }, { "kind": "method", "name": "hostConnected" }, { "kind": "method", "name": "hostDisconnected" }, { "kind": "field", "name": "#interestFn", "privacy": "private" }, { "kind": "field", "name": "#loseInterestFn", "privacy": "private" } ] } ], "exports": [ { "kind": "js", "name": "typeInterestTrigger", "declaration": { "name": "typeInterestTrigger", "module": "internals/controllers/type-interest-trigger.controller.js" } }, { "kind": "js", "name": "TypeInterestTriggerController", "declaration": { "name": "TypeInterestTriggerController", "module": "internals/controllers/type-interest-trigger.controller.js" } } ] }, { "kind": "javascript-module", "path": "internals/controllers/type-menu.controller.js", "declarations": [ { "kind": "function", "name": "ariaMenu", "return": { "type": { "text": "ClassDecorator" } } }, { "kind": "class", "description": "Responsible for setting the role attribute of an element to \"menu\" to indicate that the element is a menu", "name": "TypeMenuController", "members": [ { "kind": "method", "name": "hostConnected" } ] }, { "kind": "function", "name": "ariaMenuItem", "return": { "type": { "text": "ClassDecorator" } } }, { "kind": "class", "description": "Responsible for setting the role attribute of an element to \"menuitem\" to indicate that the element is a menu item", "name": "AriaMenuItemController", "members": [ { "kind": "method", "name": "hostConnected" }, { "kind": "method", "name": "hostUpdated" } ] } ], "exports": [ { "kind": "js", "name": "ariaMenu", "declaration": { "name": "ariaMenu", "module": "internals/controllers/type-menu.controller.js" } }, { "kind": "js", "name": "TypeMenuController", "declaration": { "name": "TypeMenuController", "module": "internals/controllers/type-menu.controller.js" } }, { "kind": "js", "name": "ariaMenuItem", "declaration": { "name": "ariaMenuItem", "module": "internals/controllers/type-menu.controller.js" } }, { "kind": "js", "name": "AriaMenuItemController", "declaration": { "name": "AriaMenuItemController", "module": "internals/controllers/type-menu.controller.js" } } ] }, { "kind": "javascript-module", "path": "internals/controllers/type-multiselectable.controller.js", "declarations": [ { "kind": "function", "name": "typeMultiSelectable", "return": { "type": { "text": "ClassDecorator" } } }, { "kind": "class", "description": "Responsible for setting the ariaMultiSelectable attribute of an element to indicate whether the element supports multiple selections", "name": "TypeMultiSelectableController", "members": [ { "kind": "method", "name": "hostConnected" }, { "kind": "method", "name": "hostUpdated" } ] } ], "exports": [ { "kind": "js", "name": "typeMultiSelectable", "declaration": { "name": "typeMultiSelectable", "module": "internals/controllers/type-multiselectable.controller.js" } }, { "kind": "js", "name": "TypeMultiSelectableController", "declaration": { "name": "TypeMultiSelectableController", "module": "internals/controllers/type-multiselectable.controller.js" } } ] }, { "kind": "javascript-module", "path": "internals/controllers/type-navigation.controller.js", "declarations": [ { "kind": "function", "name": "typeNavigation", "return": { "type": { "text": "ClassDecorator" } } }, { "kind": "class", "description": "Responsible for setting the role attribute of an element to \"navigation\" to indicate that the element is a navigation landmark", "name": "TypeNavigationController", "members": [ { "kind": "method", "name": "hostConnected" } ] } ], "exports": [ { "kind": "js", "name": "typeNavigation", "declaration": { "name": "typeNavigation", "module": "internals/controllers/type-navigation.controller.js" } }, { "kind": "js", "name": "TypeNavigationController", "declaration": { "name": "TypeNavigationController", "module": "internals/controllers/type-navigation.controller.js" } } ] }, { "kind": "javascript-module", "path": "internals/controllers/type-popover-trigger.controller.js", "declarations": [ { "kind": "function", "name": "typePopoverTrigger", "return": { "type": { "text": "ClassDecorator" } }, "description": "Provides necessary API for popover trigger types https://github.com/whatwg/html/issues/9110" }, { "kind": "class", "description": "", "name": "TypePopoverTriggerController", "members": [ { "kind": "field", "name": "#observer", "privacy": "private", "type": { "text": "MutationObserver" }, "default": "new MutationObserver(mutations => { const element = mutations[0].target as HTMLElement; this.host.popoverTargetElement = querySelectorByIdRef(this.host, element.getAttribute('popovertarget')); })" }, { "kind": "method", "name": "hostConnected" } ] } ], "exports": [ { "kind": "js", "name": "typePopoverTrigger", "declaration": { "name": "typePopoverTrigger", "module": "internals/controllers/type-popover-trigger.controller.js" } }, { "kind": "js", "name": "TypePopoverTriggerController", "declaration": { "name": "TypePopoverTriggerController", "module": "internals/controllers/type-popover-trigger.controller.js" } } ] }, { "kind": "javascript-module", "path": "internals/controllers/type-region.controller.js", "declarations": [ { "kind": "function", "name": "typeRegion", "return": { "type": { "text": "ClassDecorator" } } }, { "kind": "class", "description": "Responsible for setting the role attribute of an element to \"region\" to indicate that the element is a region landmark", "name": "TypeRegionController", "members": [ { "kind": "method", "name": "hostConnected" } ] } ], "exports": [ { "kind": "js", "name": "typeRegion", "declaration": { "name": "typeRegion", "module": "internals/controllers/type-region.controller.js" } }, { "kind": "js", "name": "TypeRegionController", "declaration": { "name": "TypeRegionController", "module": "internals/controllers/type-region.controller.js" } } ] }, { "kind": "javascript-module", "path": "internals/index.js", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "internals/styles/styles.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "internals/components/button.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "internals/controllers/dynamic-controllers.controller.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "internals/controllers/i18n.controller.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "internals/controllers/interaction-click.controller.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "internals/controllers/interaction-expand.controller.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "internals/controllers/interaction-range-selection.controller.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "internals/controllers/interaction-resize-context.controller.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "internals/controllers/interaction-responsive.controller.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "internals/controllers/interaction-select.controller.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "internals/controllers/interaction-text-change.controller.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "internals/controllers/interaction-touch.controller.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "internals/controllers/state-active.controller.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "internals/controllers/state-checked.controller.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "internals/controllers/state-direction.controller.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "internals/controllers/state-disabled.controller.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "internals/controllers/state-expanded.controller.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "internals/controllers/state-pressed.controller.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "internals/controllers/state-readonly.controller.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "internals/controllers/state-selected.controller.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "internals/controllers/state-text-content.controller.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "internals/controllers/type-anchor.controller.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "internals/controllers/type-button.controller.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "internals/controllers/type-command-trigger.controller.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "internals/controllers/type-closable.controller.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "internals/controllers/type-group.controller.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "internals/controllers/type-menu.controller.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "internals/controllers/type-popover-trigger.controller.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "internals/controllers/type-multiselectable.controller.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "internals/controllers/type-navigation.controller.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "internals/controllers/type-region.controller.js" } }, { "kind": "js", "name": "PopoverMixin", "declaration": { "name": "PopoverMixin", "package": "@blueprintui/orbit" } }, { "kind": "js", "name": "PopoverConfig", "declaration": { "name": "PopoverConfig", "package": "@blueprintui/orbit" } }, { "kind": "js", "name": "PopoverMixinInterface", "declaration": { "name": "PopoverMixinInterface", "package": "@blueprintui/orbit" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "internals/types/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "internals/services/global.service.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "internals/services/i18n.service.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "internals/utils/a11y.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "internals/utils/array.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "internals/utils/define.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "internals/utils/dom.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "internals/utils/event-subject.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "internals/utils/events.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "internals/utils/focus.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "internals/utils/i18n.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "internals/utils/responsive.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "internals/utils/string.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "internals/utils/time.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "internals/utils/traversal.js" } } ] }, { "kind": "javascript-module", "path": "internals/services/global.service.js", "declarations": [ { "kind": "class", "description": "", "name": "GlobalState", "members": [ { "kind": "field", "name": "#stateUpdate", "privacy": "private", "default": "new BroadcastSubject<{ type: string; state: Partial }>()" }, { "kind": "field", "name": "#state", "privacy": "private", "type": { "text": "BpState" }, "default": "{ environment: { production: false }, i18nRegistry: {}, elementRegistry: [] }" }, { "kind": "field", "name": "stateUpdate", "readonly": true }, { "kind": "field", "name": "state", "type": { "text": "BpState" }, "readonly": true }, { "kind": "method", "name": "dispatch", "parameters": [ { "name": "type", "type": { "text": "string" } }, { "name": "state", "type": { "text": "Partial" } } ] } ] }, { "kind": "variable", "name": "GlobalStateService" } ], "exports": [ { "kind": "js", "name": "GlobalState", "declaration": { "name": "GlobalState", "module": "internals/services/global.service.js" } }, { "kind": "js", "name": "GlobalStateService", "declaration": { "name": "GlobalStateService", "module": "internals/services/global.service.js" } } ] }, { "kind": "javascript-module", "path": "internals/services/i18n.service.js", "declarations": [ { "kind": "variable", "name": "i18nRegistry", "type": { "text": "I18nStrings" }, "default": "{ actions: { copy: 'copy', sort: 'sort', none: 'none', ascending: 'ascending', descending: 'descending', expand: 'expand', close: 'close', resize: 'resize', filter: 'filter', loading: 'loading', show: 'show', hide: 'hide', previous: 'previous', next: 'next', first: 'first', last: 'last', today: 'today', browse: 'browse', removeFile: 'remove file', files: 'files', resizeColumn: 'resize column', closeDetails: 'close details', noData: 'no results found', action: 'action', dropTarget: 'drop item', firstPage: 'go to first page', previousPage: 'go to previous page', nextPage: 'go to next page', lastPage: 'go to last page', pageSize: 'items per page', pagination: 'pagination', increment: 'increment', decrement: 'decrement' } }" }, { "kind": "class", "description": "", "name": "I18nService", "members": [ { "kind": "field", "name": "keys", "type": { "text": "Readonly" }, "static": true }, { "kind": "field", "name": "keys", "static": true } ] } ], "exports": [ { "kind": "js", "name": "i18nRegistry", "declaration": { "name": "i18nRegistry", "module": "internals/services/i18n.service.js" } }, { "kind": "js", "name": "I18nService", "declaration": { "name": "I18nService", "module": "internals/services/i18n.service.js" } } ] }, { "kind": "javascript-module", "path": "internals/styles/anchor-slot.css", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "internals/styles/base.css", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "internals/styles/indicator.css", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "internals/styles/interaction-slotted.css", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "internals/styles/interaction.css", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "internals/styles/popover.css", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "internals/styles/styles.js", "declarations": [ { "kind": "variable", "name": "interactionStyles", "default": "_interactionStyles" }, { "kind": "variable", "name": "interactionSlottedStyles", "default": "_interactionSlottedStyles" }, { "kind": "variable", "name": "baseStyles", "default": "_baseStyles" }, { "kind": "variable", "name": "indicatorStyles", "default": "_indicatorStyles" }, { "kind": "variable", "name": "anchorSlotStyles", "default": "_anchorSlotStyles" }, { "kind": "variable", "name": "popoverStyles", "default": "_popoverStyles" } ], "exports": [ { "kind": "js", "name": "interactionStyles", "declaration": { "name": "interactionStyles", "module": "internals/styles/styles.js" } }, { "kind": "js", "name": "interactionSlottedStyles", "declaration": { "name": "interactionSlottedStyles", "module": "internals/styles/styles.js" } }, { "kind": "js", "name": "baseStyles", "declaration": { "name": "baseStyles", "module": "internals/styles/styles.js" } }, { "kind": "js", "name": "indicatorStyles", "declaration": { "name": "indicatorStyles", "module": "internals/styles/styles.js" } }, { "kind": "js", "name": "anchorSlotStyles", "declaration": { "name": "anchorSlotStyles", "module": "internals/styles/styles.js" } }, { "kind": "js", "name": "popoverStyles", "declaration": { "name": "popoverStyles", "module": "internals/styles/styles.js" } } ] }, { "kind": "javascript-module", "path": "internals/types/index.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "internals/utils/a11y.js", "declarations": [ { "kind": "function", "name": "attachInternals", "parameters": [ { "name": "element", "type": { "text": "HTMLElement & { _internals?: ElementInternals }" } } ] }, { "kind": "function", "name": "associateAriaDescribedBy", "parameters": [ { "name": "element", "type": { "text": "HTMLElement" } }, { "name": "descriptions", "type": { "text": "HTMLElement[]" } } ] }, { "kind": "function", "name": "associateInputAndLabel", "parameters": [ { "name": "input", "type": { "text": "HTMLInputElement" } }, { "name": "label", "type": { "text": "HTMLLabelElement" } } ] }, { "kind": "function", "name": "associateInputToDatalist", "parameters": [ { "name": "input", "type": { "text": "HTMLInputElement" } }, { "name": "datalist", "type": { "text": "HTMLDataListElement" } } ] }, { "kind": "function", "name": "associateAriaLabel", "parameters": [ { "name": "label", "type": { "text": "HTMLElement" } }, { "name": "element", "type": { "text": "HTMLElement" } } ] }, { "kind": "function", "name": "associateFieldNames", "parameters": [ { "name": "inputs", "type": { "text": "HTMLInputElement[]" } } ] } ], "exports": [ { "kind": "js", "name": "attachInternals", "declaration": { "name": "attachInternals", "module": "internals/utils/a11y.js" } }, { "kind": "js", "name": "associateAriaDescribedBy", "declaration": { "name": "associateAriaDescribedBy", "module": "internals/utils/a11y.js" } }, { "kind": "js", "name": "associateInputAndLabel", "declaration": { "name": "associateInputAndLabel", "module": "internals/utils/a11y.js" } }, { "kind": "js", "name": "associateInputToDatalist", "declaration": { "name": "associateInputToDatalist", "module": "internals/utils/a11y.js" } }, { "kind": "js", "name": "associateAriaLabel", "declaration": { "name": "associateAriaLabel", "module": "internals/utils/a11y.js" } }, { "kind": "js", "name": "associateFieldNames", "declaration": { "name": "associateFieldNames", "module": "internals/utils/a11y.js" } } ] }, { "kind": "javascript-module", "path": "internals/utils/array.js", "declarations": [ { "kind": "function", "name": "group", "parameters": [ { "name": "array", "type": { "text": "any[]" } }, { "name": "n", "type": { "text": "number" } } ] }, { "kind": "function", "name": "selectionStates", "parameters": [ { "name": "items", "type": { "text": "{ selected: boolean }[]" } } ] } ], "exports": [ { "kind": "js", "name": "group", "declaration": { "name": "group", "module": "internals/utils/array.js" } }, { "kind": "js", "name": "selectionStates", "declaration": { "name": "selectionStates", "module": "internals/utils/array.js" } } ] }, { "kind": "javascript-module", "path": "internals/utils/define.js", "declarations": [ { "kind": "variable", "name": "version", "type": { "text": "string" }, "default": "'0.0.0'" }, { "kind": "variable", "name": "scopedRegistriesSupported" }, { "kind": "variable", "name": "blueprintRegistry", "type": { "text": "CustomElementRegistry" } }, { "kind": "function", "name": "defineScopedElement", "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "element", "type": { "text": "typeof HTMLElement & { __meta?: ElementMetadata }" } } ] }, { "kind": "function", "name": "defineElement", "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "element", "type": { "text": "typeof HTMLElement & { __meta?: ElementMetadata }" } } ] } ], "exports": [ { "kind": "js", "name": "version", "declaration": { "name": "version", "module": "internals/utils/define.js" } }, { "kind": "js", "name": "scopedRegistriesSupported", "declaration": { "name": "scopedRegistriesSupported", "module": "internals/utils/define.js" } }, { "kind": "js", "name": "blueprintRegistry", "declaration": { "name": "blueprintRegistry", "module": "internals/utils/define.js" } }, { "kind": "js", "name": "defineScopedElement", "declaration": { "name": "defineScopedElement", "module": "internals/utils/define.js" } }, { "kind": "js", "name": "defineElement", "declaration": { "name": "defineElement", "module": "internals/utils/define.js" } }, { "kind": "custom-element-definition", "name": "name", "declaration": { "name": "element", "module": "internals/utils/define.js" } } ] }, { "kind": "javascript-module", "path": "internals/utils/dom.js", "declarations": [ { "kind": "function", "name": "attachRootNodeStyles", "parameters": [ { "name": "host", "type": { "text": "HTMLElement | Element | ParentNode" } }, { "name": "styles", "type": { "text": "CSSStyleSheet[]" } } ] }, { "kind": "function", "name": "toggleState", "parameters": [ { "name": "internals", "type": { "text": "ElementInternals" } }, { "name": "state", "type": { "text": "string" } }, { "name": "value", "type": { "text": "boolean" } } ] }, { "kind": "function", "name": "getRenderRoot", "parameters": [ { "name": "element", "type": { "text": "HTMLElement" } } ], "description": "Get host render root for a given element. This may be the document or the nearest shadow root." }, { "kind": "function", "name": "querySelectorByIdRef", "parameters": [ { "name": "element", "type": { "text": "HTMLElement" } }, { "name": "idRef", "type": { "text": "string" } } ] }, { "kind": "function", "name": "queryCommandTriggerRef", "parameters": [ { "name": "element", "type": { "text": "HTMLElement" } } ] }, { "kind": "function", "name": "sameRenderRoot", "parameters": [ { "name": "elementOne", "type": { "text": "HTMLElement" } }, { "name": "elementTwo", "type": { "text": "HTMLElement" } } ] }, { "kind": "function", "name": "getOffesetDifference", "parameters": [ { "name": "min", "type": { "text": "number" } }, { "name": "end", "type": { "text": "number" } } ] }, { "kind": "function", "name": "assignedElements", "parameters": [ { "name": "element", "type": { "text": "HTMLElement" } }, { "name": "config", "default": "{ flatten: false }", "type": { "text": "{ name?: string; flatten?: boolean }" } } ] } ], "exports": [ { "kind": "js", "name": "attachRootNodeStyles", "declaration": { "name": "attachRootNodeStyles", "module": "internals/utils/dom.js" } }, { "kind": "js", "name": "toggleState", "declaration": { "name": "toggleState", "module": "internals/utils/dom.js" } }, { "kind": "js", "name": "getRenderRoot", "declaration": { "name": "getRenderRoot", "module": "internals/utils/dom.js" } }, { "kind": "js", "name": "querySelectorByIdRef", "declaration": { "name": "querySelectorByIdRef", "module": "internals/utils/dom.js" } }, { "kind": "js", "name": "queryCommandTriggerRef", "declaration": { "name": "queryCommandTriggerRef", "module": "internals/utils/dom.js" } }, { "kind": "js", "name": "sameRenderRoot", "declaration": { "name": "sameRenderRoot", "module": "internals/utils/dom.js" } }, { "kind": "js", "name": "getOffesetDifference", "declaration": { "name": "getOffesetDifference", "module": "internals/utils/dom.js" } }, { "kind": "js", "name": "assignedElements", "declaration": { "name": "assignedElements", "module": "internals/utils/dom.js" } } ] }, { "kind": "javascript-module", "path": "internals/utils/event-subject.js", "declarations": [ { "kind": "class", "description": "", "name": "BroadcastSubscription", "members": [ { "kind": "field", "name": "#channel", "privacy": "private", "type": { "text": "BroadcastChannel" }, "default": "new BroadcastChannel(channelId)" }, { "kind": "method", "name": "unsubscribe" } ] }, { "kind": "class", "description": "", "name": "BroadcastSubject", "members": [ { "kind": "field", "name": "#id", "privacy": "private" }, { "kind": "field", "name": "#channel", "privacy": "private", "type": { "text": "BroadcastChannel" }, "default": "new BroadcastChannel(this.#id)" }, { "kind": "method", "name": "subscribe", "parameters": [ { "name": "fn", "type": { "text": "(value: T) => void" } } ] }, { "kind": "method", "name": "emit", "parameters": [ { "name": "value", "type": { "text": "T" } } ] }, { "kind": "method", "name": "toEventObservable" } ] } ], "exports": [ { "kind": "js", "name": "BroadcastSubscription", "declaration": { "name": "BroadcastSubscription", "module": "internals/utils/event-subject.js" } }, { "kind": "js", "name": "BroadcastSubject", "declaration": { "name": "BroadcastSubject", "module": "internals/utils/event-subject.js" } } ] }, { "kind": "javascript-module", "path": "internals/utils/events.js", "declarations": [ { "kind": "function", "name": "createCustomEvent", "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ] }, { "kind": "function", "name": "eventWasDefaultPrevented", "parameters": [ { "name": "event", "type": { "text": "Event" } } ] }, { "kind": "function", "name": "stopEvent", "parameters": [ { "name": "event", "type": { "text": "any" } } ] }, { "kind": "function", "name": "onKeys", "parameters": [ { "name": "events", "type": { "text": "string[]" } }, { "name": "event", "type": { "text": "KeyboardEvent" } }, { "name": "fn", "type": { "text": "() => any" } } ] }, { "kind": "function", "name": "getElementUpdates", "return": { "type": { "text": "MutationObserver" } }, "parameters": [ { "name": "element", "type": { "text": "HTMLElement" } }, { "name": "propertyKey", "type": { "text": "string" } }, { "name": "fn", "type": { "text": "(value: any) => void" } } ] }, { "kind": "function", "name": "listenForAttributeChange", "parameters": [ { "name": "element", "type": { "text": "HTMLElement" } }, { "name": "attrName", "type": { "text": "string" } }, { "name": "fn", "type": { "text": "(attrValue: string | null) => void" } } ] }, { "kind": "function", "name": "listenForAttributeListChange", "return": { "type": { "text": "MutationObserver" } }, "parameters": [ { "name": "element", "type": { "text": "HTMLElement" } }, { "name": "attrNames", "type": { "text": "string[]" } }, { "name": "fn", "type": { "text": "(mutation: MutationRecord) => void" } } ] }, { "kind": "function", "name": "onFirstInteraction", "return": { "type": { "text": "Promise" } }, "parameters": [ { "name": "element", "type": { "text": "HTMLElement" } } ] } ], "exports": [ { "kind": "js", "name": "createCustomEvent", "declaration": { "name": "createCustomEvent", "module": "internals/utils/events.js" } }, { "kind": "js", "name": "eventWasDefaultPrevented", "declaration": { "name": "eventWasDefaultPrevented", "module": "internals/utils/events.js" } }, { "kind": "js", "name": "stopEvent", "declaration": { "name": "stopEvent", "module": "internals/utils/events.js" } }, { "kind": "js", "name": "onKeys", "declaration": { "name": "onKeys", "module": "internals/utils/events.js" } }, { "kind": "js", "name": "getElementUpdates", "declaration": { "name": "getElementUpdates", "module": "internals/utils/events.js" } }, { "kind": "js", "name": "listenForAttributeChange", "declaration": { "name": "listenForAttributeChange", "module": "internals/utils/events.js" } }, { "kind": "js", "name": "listenForAttributeListChange", "declaration": { "name": "listenForAttributeListChange", "module": "internals/utils/events.js" } }, { "kind": "js", "name": "onFirstInteraction", "declaration": { "name": "onFirstInteraction", "module": "internals/utils/events.js" } } ] }, { "kind": "javascript-module", "path": "internals/utils/focus.js", "declarations": [ { "kind": "function", "name": "createFocusTrap", "parameters": [ { "name": "element", "type": { "text": "HTMLElement" } } ] }, { "kind": "function", "name": "getFlattenedFocusableItems", "parameters": [ { "name": "element", "type": { "text": "Node" } }, { "name": "depth", "default": "10" } ] }, { "kind": "function", "name": "focusable", "parameters": [ { "name": "element", "type": { "text": "Element" } } ] } ], "exports": [ { "kind": "js", "name": "createFocusTrap", "declaration": { "name": "createFocusTrap", "module": "internals/utils/focus.js" } }, { "kind": "js", "name": "getFlattenedFocusableItems", "declaration": { "name": "getFlattenedFocusableItems", "module": "internals/utils/focus.js" } }, { "kind": "js", "name": "focusable", "declaration": { "name": "focusable", "module": "internals/utils/focus.js" } } ] }, { "kind": "javascript-module", "path": "internals/utils/i18n.js", "declarations": [ { "kind": "function", "name": "matchInterpolate", "parameters": [ { "name": "template", "type": { "text": "string" } }, { "name": "obj", "default": "{}", "type": { "text": "any" } } ] }, { "kind": "function", "name": "getElementLanguageDirection", "parameters": [ { "name": "element", "type": { "text": "HTMLElement" } } ] } ], "exports": [ { "kind": "js", "name": "matchInterpolate", "declaration": { "name": "matchInterpolate", "module": "internals/utils/i18n.js" } }, { "kind": "js", "name": "getElementLanguageDirection", "declaration": { "name": "getElementLanguageDirection", "module": "internals/utils/i18n.js" } } ] }, { "kind": "javascript-module", "path": "internals/utils/responsive.js", "declarations": [ { "kind": "function", "name": "elementVisible", "parameters": [ { "name": "element", "type": { "text": "HTMLElement" } }, { "name": "fn", "type": { "text": "() => void" } } ] }, { "kind": "function", "name": "elementResize", "parameters": [ { "name": "element", "type": { "text": "HTMLElement" } }, { "name": "fn", "type": { "text": "() => void" } }, { "name": "async", "default": "true" } ] }, { "kind": "function", "name": "calculateOptimalLayout", "return": { "type": { "text": "Promise" } }, "parameters": [ { "name": "component", "type": { "text": "ResponsiveComponent" } }, { "name": "layoutConfig", "type": { "text": "LayoutConfig" } } ], "description": "This function loops through a list of layout options and changes the layout\nof ResponsiveComponent until the component layout condition is met." } ], "exports": [ { "kind": "js", "name": "elementVisible", "declaration": { "name": "elementVisible", "module": "internals/utils/responsive.js" } }, { "kind": "js", "name": "elementResize", "declaration": { "name": "elementResize", "module": "internals/utils/responsive.js" } }, { "kind": "js", "name": "calculateOptimalLayout", "declaration": { "name": "calculateOptimalLayout", "module": "internals/utils/responsive.js" } } ] }, { "kind": "javascript-module", "path": "internals/utils/string.js", "declarations": [ { "kind": "function", "name": "camelCaseToKebabCase", "parameters": [ { "name": "value", "type": { "text": "string" } } ] }, { "kind": "function", "name": "isNumericString", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "val", "type": { "text": "string" } } ] }, { "kind": "function", "name": "createId", "parameters": [ { "name": "prefix", "default": "'_'" } ] }, { "kind": "function", "name": "getFromObjectPath", "parameters": [ { "name": "path", "type": { "text": "string" } }, { "name": "dataObj", "type": { "text": "any" } }, { "name": "fallback", "default": "`$\\{${path}}`" } ] }, { "kind": "function", "name": "rgbToHex", "parameters": [ { "name": "red", "type": { "text": "number" } }, { "name": "green", "type": { "text": "number" } }, { "name": "blue", "type": { "text": "number" } } ] }, { "kind": "function", "name": "parseMinimumTouchWidth", "parameters": [ { "name": "width", "type": { "text": "string" } } ] } ], "exports": [ { "kind": "js", "name": "camelCaseToKebabCase", "declaration": { "name": "camelCaseToKebabCase", "module": "internals/utils/string.js" } }, { "kind": "js", "name": "isNumericString", "declaration": { "name": "isNumericString", "module": "internals/utils/string.js" } }, { "kind": "js", "name": "createId", "declaration": { "name": "createId", "module": "internals/utils/string.js" } }, { "kind": "js", "name": "getFromObjectPath", "declaration": { "name": "getFromObjectPath", "module": "internals/utils/string.js" } }, { "kind": "js", "name": "rgbToHex", "declaration": { "name": "rgbToHex", "module": "internals/utils/string.js" } }, { "kind": "js", "name": "parseMinimumTouchWidth", "declaration": { "name": "parseMinimumTouchWidth", "module": "internals/utils/string.js" } } ] }, { "kind": "javascript-module", "path": "internals/utils/time.js", "declarations": [ { "kind": "function", "name": "getMonths", "parameters": [ { "name": "format", "default": "'long'", "type": { "text": "'long' | 'numeric' | '2-digit' | 'short' | 'narrow'" } } ] }, { "kind": "function", "name": "getYearSelection", "parameters": [ { "name": "year", "type": { "text": "number" } } ], "description": "returns next decade of the given year" } ], "exports": [ { "kind": "js", "name": "getMonths", "declaration": { "name": "getMonths", "module": "internals/utils/time.js" } }, { "kind": "js", "name": "getYearSelection", "declaration": { "name": "getYearSelection", "module": "internals/utils/time.js" } } ] }, { "kind": "javascript-module", "path": "internals/utils/traversal.js", "declarations": [ { "kind": "function", "name": "getParents", "return": { "type": { "text": "HTMLElement[]" } }, "parameters": [ { "name": "node", "type": { "text": "Node" } } ] }, { "kind": "function", "name": "getFlattenedDOMTree", "return": { "type": { "text": "HTMLElement[]" } }, "parameters": [ { "name": "node", "type": { "text": "Node" } }, { "name": "depth", "default": "10" } ] }, { "kind": "function", "name": "getChildren", "parameters": [ { "name": "node", "type": { "text": "any" } } ] }, { "kind": "function", "name": "isObject", "parameters": [ { "name": "val", "type": { "text": "any" } } ] }, { "kind": "function", "name": "mergeObjects", "return": { "type": { "text": "object" } }, "parameters": [ { "name": "objs", "type": { "text": "object[]" } } ] } ], "exports": [ { "kind": "js", "name": "getParents", "declaration": { "name": "getParents", "module": "internals/utils/traversal.js" } }, { "kind": "js", "name": "getFlattenedDOMTree", "declaration": { "name": "getFlattenedDOMTree", "module": "internals/utils/traversal.js" } }, { "kind": "js", "name": "getChildren", "declaration": { "name": "getChildren", "module": "internals/utils/traversal.js" } }, { "kind": "js", "name": "isObject", "declaration": { "name": "isObject", "module": "internals/utils/traversal.js" } }, { "kind": "js", "name": "mergeObjects", "declaration": { "name": "mergeObjects", "module": "internals/utils/traversal.js" } } ] }, { "kind": "javascript-module", "path": "menu/element.css", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "menu/element.js", "declarations": [ { "kind": "class", "description": "```typescript\nimport '@blueprintui/components/include/menu.js';\n```\n\n```html\n\n\n\n```", "name": "BpMenu", "cssProperties": [ { "name": "--background" }, { "name": "--color" }, { "name": "--width" } ], "slots": [ { "description": "content", "name": "" } ], "members": [ { "kind": "field", "name": "items", "readonly": true } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "bp-menu", "customElement": true, "summary": "The menu component provides a hierarchical view of available options, allowing users to choose from a variety of actions. Each option should have clear, descriptive text that helps the user understand what the option does.", "metadata": { "since": "1.0.0" } } ], "exports": [ { "kind": "js", "name": "BpMenu", "declaration": { "name": "BpMenu", "module": "menu/element.js" } } ] }, { "kind": "javascript-module", "path": "menu/element.visual.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "menu/index.js", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "menu/element.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "menu/item/element.js" } } ] }, { "kind": "javascript-module", "path": "menu/item/element.css", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "menu/item/element.js", "declarations": [ { "kind": "class", "description": "Menu Item", "name": "BpMenuItem", "cssProperties": [ { "name": "--bp-interaction-outline-offset" }, { "name": "--background" }, { "name": "--color" }, { "name": "--padding" }, { "name": "--border" }, { "name": "--border-inline" }, { "name": "--border-inline-start" } ], "slots": [ { "description": "content", "name": "" } ], "members": [ { "kind": "field", "name": "pressed", "type": { "text": "boolean" }, "description": "turns the button into a toggle button", "attribute": "pressed", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "selected", "type": { "text": "boolean" }, "description": "indicate the current \"selected\" state of various widgets", "attribute": "selected", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "expanded", "type": { "text": "boolean" }, "description": "indicate if a control is expanded or collapsed", "attribute": "expanded", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "readonly", "type": { "text": "boolean" }, "description": "makes the element not mutable, meaning the user can not interact with button", "attribute": "readonly", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "determines if element is mutable or focusable", "attribute": "disabled", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "type", "type": { "text": "'button' | 'submit'" }, "description": "default behavior of the button", "attribute": "type", "reflects": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "name", "type": { "text": "string" }, "description": "represents the name of the current element as a string.", "attribute": "name", "reflects": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "value", "type": { "text": "string" }, "description": "determines the current value", "attribute": "value", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "popoverTargetAction", "type": { "text": "'toggle' | 'show' | 'hide'" }, "description": "The action to perform on the target popover element\nhttps://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/button#popovertargetaction", "attribute": "popovertargetaction", "reflects": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "popoverTargetElement", "type": { "text": "HTMLElement" }, "description": "The target element for the popover\nhttps://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/button#popovertarget", "attribute": "popoverTargetElement", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "command", "type": { "text": "string" }, "description": "The command property of the HTMLButtonElement interface gets and sets the action to be performed on an element being controlled by this button. For this to have an effect, commandfor must be set.\nhttps://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/button#command", "attribute": "command", "reflects": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "commandForElement", "type": { "text": "HTMLElement" }, "description": "The commandForElement property of the HTMLButtonElement interface gets and sets the id of the element being controlled by this button. For this to have an effect, command must be set.\nhttps://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/button#command", "attribute": "commandForElement", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "interestForElement", "type": { "text": "HTMLElement" }, "description": "The interestForElement property of the HTMLButtonElement interface gets and sets the id of the element being controlled by this button. For this to have an effect, command must be set.\nhttps://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/button#interest", "attribute": "interestForElement", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "form", "type": { "text": "HTMLFormElement" }, "readonly": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "formAction", "type": { "text": "string" }, "readonly": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "formEnctype", "type": { "text": "string" }, "readonly": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "formMethod", "type": { "text": "string" }, "readonly": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "formNoValidate", "type": { "text": "boolean" }, "readonly": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "formTarget", "type": { "text": "string" }, "readonly": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "labels", "type": { "text": "NodeListOf" }, "readonly": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "validationMessage", "type": { "text": "string" }, "readonly": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "validity", "type": { "text": "ValidityState" }, "readonly": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "willValidate", "type": { "text": "boolean" }, "readonly": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "checkValidity", "type": { "text": "any" }, "readonly": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "reportValidity", "type": { "text": "any" }, "readonly": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "setCustomValidity", "type": { "text": "any" }, "readonly": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "_internals", "type": { "text": "ElementInternals" }, "readonly": true, "privacy": "private", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "formAssociated", "type": { "text": "boolean" }, "static": true, "default": "true", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } } ], "superclass": { "name": "BaseButton", "package": "@blueprintui/components/internals" }, "tagName": "bp-menu-item", "customElement": true, "metadata": { "since": "1.0.0" }, "attributes": [ { "name": "pressed", "type": { "text": "boolean" }, "description": "turns the button into a toggle button", "fieldName": "pressed", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "name": "selected", "type": { "text": "boolean" }, "description": "indicate the current \"selected\" state of various widgets", "fieldName": "selected", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "name": "expanded", "type": { "text": "boolean" }, "description": "indicate if a control is expanded or collapsed", "fieldName": "expanded", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "name": "readonly", "type": { "text": "boolean" }, "description": "makes the element not mutable, meaning the user can not interact with button", "fieldName": "readonly", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "determines if element is mutable or focusable", "fieldName": "disabled", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "name": "type", "type": { "text": "'button' | 'submit'" }, "description": "default behavior of the button", "fieldName": "type", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "name": "name", "type": { "text": "string" }, "description": "represents the name of the current element as a string.", "fieldName": "name", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "name": "value", "type": { "text": "string" }, "description": "determines the current value", "fieldName": "value", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "name": "popovertargetaction", "type": { "text": "'toggle' | 'show' | 'hide'" }, "description": "The action to perform on the target popover element\nhttps://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/button#popovertargetaction", "fieldName": "popoverTargetAction", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "name": "popoverTargetElement", "type": { "text": "HTMLElement" }, "description": "The target element for the popover\nhttps://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/button#popovertarget", "fieldName": "popoverTargetElement", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "name": "command", "type": { "text": "string" }, "description": "The command property of the HTMLButtonElement interface gets and sets the action to be performed on an element being controlled by this button. For this to have an effect, commandfor must be set.\nhttps://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/button#command", "fieldName": "command", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "name": "commandForElement", "type": { "text": "HTMLElement" }, "description": "The commandForElement property of the HTMLButtonElement interface gets and sets the id of the element being controlled by this button. For this to have an effect, command must be set.\nhttps://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/button#command", "fieldName": "commandForElement", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "name": "interestForElement", "type": { "text": "HTMLElement" }, "description": "The interestForElement property of the HTMLButtonElement interface gets and sets the id of the element being controlled by this button. For this to have an effect, command must be set.\nhttps://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/button#interest", "fieldName": "interestForElement", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } } ] } ], "exports": [ { "kind": "js", "name": "BpMenuItem", "declaration": { "name": "BpMenuItem", "module": "menu/item/element.js" } } ] }, { "kind": "javascript-module", "path": "month/element.css", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "month/element.js", "declarations": [ { "kind": "class", "description": "```typescript\nimport '@blueprintui/components/include/month.js';\n```\n\n```html\n\n \n \n message text\n\n```", "name": "BpMonth", "slots": [ { "description": "slot for prefix text or icons", "name": "prefix", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "description": "slot for suffix text or icons", "name": "suffix", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } } ], "members": [ { "kind": "field", "name": "type", "type": { "text": "string" }, "default": "'month'", "description": "Specifies the input type as month for date selection", "attribute": "type", "reflects": true, "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "kind": "field", "name": "suffixTemplate", "type": { "text": "TemplateResult | null" }, "privacy": "protected", "readonly": true, "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "kind": "field", "name": "prefixTemplate", "type": { "text": "TemplateResult | null" }, "privacy": "protected", "readonly": true, "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "kind": "field", "name": "input", "privacy": "protected", "readonly": true, "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "kind": "method", "name": "showPicker", "privacy": "protected", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } } ], "events": [ { "type": { "text": "InputEvent" }, "description": "occurs when the value changes", "name": "input", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "type": { "text": "InputEvent" }, "description": "occurs when the value changes", "name": "change", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } } ], "attributes": [ { "name": "type", "type": { "text": "string" }, "default": "'month'", "description": "Specifies the input type as month for date selection", "fieldName": "type", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } } ], "superclass": { "name": "BpInput", "package": "@blueprintui/components/input" }, "tagName": "bp-month", "customElement": true, "summary": "The month input component is used to allow the user to select a month from a dropdown menu. It is used as a replacement for traditional text input when selecting a month.", "metadata": { "since": "1.0.0" }, "cssProperties": [ { "name": "--background-size", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "name": "--color", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "name": "--background", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "name": "--border", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "name": "--border-radius", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "name": "--outline", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "name": "--outline-offset", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "name": "--padding", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "name": "--font-size", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "name": "--line-height", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "name": "--height", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "name": "--min-width", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "name": "--width", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "name": "--transition", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "name": "--text-align", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "name": "--cursor", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } } ] } ], "exports": [ { "kind": "js", "name": "BpMonth", "declaration": { "name": "BpMonth", "module": "month/element.js" } } ] }, { "kind": "javascript-module", "path": "month/element.visual.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "month/index.js", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "month/element.js" } } ] }, { "kind": "javascript-module", "path": "nav/element.css", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "nav/element.js", "declarations": [ { "kind": "class", "description": "```typescript\nimport '@blueprintui/components/include/nav.js';\n```\n\n```html\n\n```", "name": "BpNav", "cssProperties": [ { "name": "--background" }, { "name": "--padding" }, { "name": "--width" }, { "name": "--height" }, { "name": "--max-height" } ], "slots": [ { "description": "content", "name": "" } ], "members": [ { "kind": "field", "name": "expanded", "type": { "text": "boolean" }, "default": "false", "description": "Controls whether the navigation is expanded, showing all items and content", "attribute": "expanded" }, { "kind": "field", "name": "expandable", "type": { "text": "boolean" }, "default": "false", "description": "Determines if the navigation can be expanded or collapsed by the user", "attribute": "expandable" }, { "kind": "field", "name": "i18n", "description": "Provides internationalization strings for translated text content", "attribute": "i18n" }, { "kind": "field", "name": "interaction", "type": { "text": "'auto'" }, "description": "Controls whether the component automatically manages expanded state based on user interactions", "attribute": "interaction" }, { "kind": "field", "name": "focusItems", "privacy": "private", "readonly": true }, { "kind": "field", "name": "#items", "privacy": "private", "readonly": true }, { "kind": "field", "name": "#groups", "privacy": "private", "readonly": true }, { "kind": "field", "name": "_internals", "type": { "text": "ElementInternals | undefined" }, "privacy": "private" }, { "kind": "field", "name": "interactionExpandController", "type": { "text": "InteractionExpandController" }, "privacy": "private" }, { "kind": "method", "name": "#syncInteractions", "privacy": "private" }, { "kind": "method", "name": "#change", "privacy": "private" }, { "kind": "method", "name": "#setupScrollPositioning", "privacy": "private" } ], "events": [ { "name": "open" }, { "name": "close" } ], "attributes": [ { "name": "expanded", "type": { "text": "boolean" }, "default": "false", "description": "Controls whether the navigation is expanded, showing all items and content", "fieldName": "expanded" }, { "name": "expandable", "type": { "text": "boolean" }, "default": "false", "description": "Determines if the navigation can be expanded or collapsed by the user", "fieldName": "expandable" }, { "name": "i18n", "description": "Provides internationalization strings for translated text content", "fieldName": "i18n" }, { "name": "interaction", "type": { "text": "'auto'" }, "description": "Controls whether the component automatically manages expanded state based on user interactions", "fieldName": "interaction" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "bp-nav", "customElement": true, "summary": "The Navigation component that allows users to navigate between different sections or pages. The component should contain links to different sections or pages within the application.", "metadata": { "since": "1.0.0" } } ], "exports": [ { "kind": "js", "name": "BpNav", "declaration": { "name": "BpNav", "module": "nav/element.js" } } ] }, { "kind": "javascript-module", "path": "nav/element.visual.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "nav/group/element.css", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "nav/group/element.js", "declarations": [ { "kind": "class", "description": "Button\n\n```typescript\nimport '@blueprintui/components/include/nav.js';\n```\n\n```html\nsubmit\n```", "name": "BpNavGroup", "slots": [ { "description": "bp-nav-item elements", "name": "" } ], "members": [ { "kind": "field", "name": "expanded", "type": { "text": "boolean" }, "default": "false", "description": "determine if element is expanded", "attribute": "expanded" }, { "kind": "field", "name": "interaction", "type": { "text": "'auto'" }, "description": "determine if element should auto manage expanded state", "attribute": "interaction" }, { "kind": "field", "name": "#items", "privacy": "private", "readonly": true }, { "kind": "field", "name": "interactionExpandController", "type": { "text": "InteractionExpandController" }, "privacy": "private" }, { "kind": "field", "name": "_internals", "type": { "text": "ElementInternals | undefined" }, "privacy": "private" }, { "kind": "method", "name": "#toggle", "privacy": "private" }, { "kind": "method", "name": "#updateItems", "privacy": "private" } ], "events": [ { "description": "when element is expanded", "name": "open" }, { "description": "when element is collapsed", "name": "close" } ], "attributes": [ { "name": "expanded", "type": { "text": "boolean" }, "default": "false", "description": "determine if element is expanded", "fieldName": "expanded" }, { "name": "interaction", "type": { "text": "'auto'" }, "description": "determine if element should auto manage expanded state", "fieldName": "interaction" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "bp-nav-group", "customElement": true, "metadata": { "since": "1.0.0" } } ], "exports": [ { "kind": "js", "name": "BpNavGroup", "declaration": { "name": "BpNavGroup", "module": "nav/group/element.js" } } ] }, { "kind": "javascript-module", "path": "nav/index.js", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "nav/element.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "nav/item/element.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "nav/group/element.js" } } ] }, { "kind": "javascript-module", "path": "nav/item/element.css", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "nav/item/element.js", "declarations": [ { "kind": "class", "description": "Nav Item", "name": "BpNavItem", "cssProperties": [ { "name": "--background" }, { "name": "--color" }, { "name": "--padding" }, { "name": "--font-size" }, { "name": "--border" }, { "name": "--border-left" } ], "slots": [ { "description": "content", "name": "" } ], "members": [ { "kind": "field", "name": "#icons", "privacy": "private", "readonly": true }, { "kind": "method", "name": "#updateSlots", "privacy": "private" }, { "kind": "field", "name": "pressed", "type": { "text": "boolean" }, "description": "turns the button into a toggle button", "attribute": "pressed", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "selected", "type": { "text": "boolean" }, "description": "indicate the current \"selected\" state of various widgets", "attribute": "selected", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "expanded", "type": { "text": "boolean" }, "description": "indicate if a control is expanded or collapsed", "attribute": "expanded", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "readonly", "type": { "text": "boolean" }, "description": "makes the element not mutable, meaning the user can not interact with button", "attribute": "readonly", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "determines if element is mutable or focusable", "attribute": "disabled", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "type", "type": { "text": "'button' | 'submit'" }, "description": "default behavior of the button", "attribute": "type", "reflects": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "name", "type": { "text": "string" }, "description": "represents the name of the current element as a string.", "attribute": "name", "reflects": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "value", "type": { "text": "string" }, "description": "determines the current value", "attribute": "value", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "popoverTargetAction", "type": { "text": "'toggle' | 'show' | 'hide'" }, "description": "The action to perform on the target popover element\nhttps://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/button#popovertargetaction", "attribute": "popovertargetaction", "reflects": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "popoverTargetElement", "type": { "text": "HTMLElement" }, "description": "The target element for the popover\nhttps://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/button#popovertarget", "attribute": "popoverTargetElement", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "command", "type": { "text": "string" }, "description": "The command property of the HTMLButtonElement interface gets and sets the action to be performed on an element being controlled by this button. For this to have an effect, commandfor must be set.\nhttps://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/button#command", "attribute": "command", "reflects": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "commandForElement", "type": { "text": "HTMLElement" }, "description": "The commandForElement property of the HTMLButtonElement interface gets and sets the id of the element being controlled by this button. For this to have an effect, command must be set.\nhttps://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/button#command", "attribute": "commandForElement", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "interestForElement", "type": { "text": "HTMLElement" }, "description": "The interestForElement property of the HTMLButtonElement interface gets and sets the id of the element being controlled by this button. For this to have an effect, command must be set.\nhttps://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/button#interest", "attribute": "interestForElement", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "form", "type": { "text": "HTMLFormElement" }, "readonly": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "formAction", "type": { "text": "string" }, "readonly": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "formEnctype", "type": { "text": "string" }, "readonly": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "formMethod", "type": { "text": "string" }, "readonly": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "formNoValidate", "type": { "text": "boolean" }, "readonly": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "formTarget", "type": { "text": "string" }, "readonly": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "labels", "type": { "text": "NodeListOf" }, "readonly": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "validationMessage", "type": { "text": "string" }, "readonly": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "validity", "type": { "text": "ValidityState" }, "readonly": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "willValidate", "type": { "text": "boolean" }, "readonly": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "checkValidity", "type": { "text": "any" }, "readonly": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "reportValidity", "type": { "text": "any" }, "readonly": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "setCustomValidity", "type": { "text": "any" }, "readonly": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "_internals", "type": { "text": "ElementInternals" }, "readonly": true, "privacy": "private", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "formAssociated", "type": { "text": "boolean" }, "static": true, "default": "true", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } } ], "superclass": { "name": "BaseButton", "package": "@blueprintui/components/internals" }, "tagName": "bp-nav-item", "customElement": true, "metadata": { "since": "1.0.0" }, "attributes": [ { "name": "pressed", "type": { "text": "boolean" }, "description": "turns the button into a toggle button", "fieldName": "pressed", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "name": "selected", "type": { "text": "boolean" }, "description": "indicate the current \"selected\" state of various widgets", "fieldName": "selected", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "name": "expanded", "type": { "text": "boolean" }, "description": "indicate if a control is expanded or collapsed", "fieldName": "expanded", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "name": "readonly", "type": { "text": "boolean" }, "description": "makes the element not mutable, meaning the user can not interact with button", "fieldName": "readonly", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "determines if element is mutable or focusable", "fieldName": "disabled", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "name": "type", "type": { "text": "'button' | 'submit'" }, "description": "default behavior of the button", "fieldName": "type", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "name": "name", "type": { "text": "string" }, "description": "represents the name of the current element as a string.", "fieldName": "name", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "name": "value", "type": { "text": "string" }, "description": "determines the current value", "fieldName": "value", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "name": "popovertargetaction", "type": { "text": "'toggle' | 'show' | 'hide'" }, "description": "The action to perform on the target popover element\nhttps://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/button#popovertargetaction", "fieldName": "popoverTargetAction", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "name": "popoverTargetElement", "type": { "text": "HTMLElement" }, "description": "The target element for the popover\nhttps://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/button#popovertarget", "fieldName": "popoverTargetElement", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "name": "command", "type": { "text": "string" }, "description": "The command property of the HTMLButtonElement interface gets and sets the action to be performed on an element being controlled by this button. For this to have an effect, commandfor must be set.\nhttps://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/button#command", "fieldName": "command", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "name": "commandForElement", "type": { "text": "HTMLElement" }, "description": "The commandForElement property of the HTMLButtonElement interface gets and sets the id of the element being controlled by this button. For this to have an effect, command must be set.\nhttps://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/button#command", "fieldName": "commandForElement", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "name": "interestForElement", "type": { "text": "HTMLElement" }, "description": "The interestForElement property of the HTMLButtonElement interface gets and sets the id of the element being controlled by this button. For this to have an effect, command must be set.\nhttps://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/button#interest", "fieldName": "interestForElement", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } } ] } ], "exports": [ { "kind": "js", "name": "BpNavItem", "declaration": { "name": "BpNavItem", "module": "nav/item/element.js" } } ] }, { "kind": "javascript-module", "path": "number-stepper/element.css", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "number-stepper/element.js", "declarations": [ { "kind": "class", "description": "```typescript\nimport '@blueprintui/components/include/number-stepper.js';\n```\n\n```html\n\n \n \n Select quantity\n\n```", "name": "BpNumberStepper", "cssProperties": [ { "description": "Background color of input field", "name": "--background" }, { "description": "Text color", "name": "--color" }, { "description": "Border style", "name": "--border" }, { "description": "Border radius", "name": "--border-radius" }, { "description": "Outline style (focus state)", "name": "--outline" }, { "description": "Outline offset", "name": "--outline-offset" }, { "description": "Input field padding", "name": "--padding" }, { "description": "Font size", "name": "--font-size" }, { "description": "Component height", "name": "--height" }, { "description": "Component width", "name": "--width" }, { "description": "Minimum width", "name": "--min-width" }, { "description": "Gap between elements", "name": "--gap" }, { "description": "Text alignment in input field", "name": "--text-align" } ], "members": [ { "kind": "field", "name": "continuous", "type": { "text": "boolean" }, "default": "false", "description": "enable hold-to-repeat on stepper buttons", "attribute": "continuous" }, { "kind": "field", "name": "continuousDelay", "type": { "text": "number" }, "default": "500", "description": "delay in ms before continuous stepping starts", "attribute": "continuous-delay" }, { "kind": "field", "name": "continuousInterval", "type": { "text": "number" }, "default": "100", "description": "interval in ms for continuous stepping", "attribute": "continuous-interval" }, { "kind": "field", "name": "i18n", "type": { "text": "I18nStrings['actions']" }, "description": "Provides internationalization strings for accessibility labels and screen reader announcements", "attribute": "i18n" }, { "kind": "field", "name": "#stepTimeout", "privacy": "private", "type": { "text": "number | null" }, "default": "null" }, { "kind": "field", "name": "#stepIntervalId", "privacy": "private", "type": { "text": "number | null" }, "default": "null" }, { "kind": "field", "name": "input", "privacy": "protected", "readonly": true }, { "kind": "method", "name": "focus" }, { "kind": "method", "name": "blur" }, { "kind": "method", "name": "stepUp", "parameters": [ { "name": "number", "default": "1" } ], "description": "Increments the value by the step amount" }, { "kind": "method", "name": "stepDown", "parameters": [ { "name": "number", "default": "1" } ], "description": "Decrements the value by the step amount" }, { "kind": "method", "name": "#handleIncrement", "privacy": "private", "parameters": [ { "name": "e", "type": { "text": "Event" } } ] }, { "kind": "method", "name": "#handleDecrement", "privacy": "private", "parameters": [ { "name": "e", "type": { "text": "Event" } } ] }, { "kind": "method", "name": "#handleIncrementStart", "privacy": "private", "parameters": [ { "name": "e", "type": { "text": "Event" } } ] }, { "kind": "method", "name": "#handleDecrementStart", "privacy": "private", "parameters": [ { "name": "e", "type": { "text": "Event" } } ] }, { "kind": "method", "name": "#startContinuousStepping", "privacy": "private", "parameters": [ { "name": "direction", "type": { "text": "'up' | 'down'" } } ] }, { "kind": "method", "name": "#handleStepEnd", "privacy": "private", "parameters": [ { "name": "e", "type": { "text": "Event" } } ] }, { "kind": "method", "name": "#clearStepTimers", "privacy": "private" }, { "kind": "method", "name": "#onChange", "privacy": "private", "parameters": [ { "name": "e", "type": { "text": "InputEvent" } } ] }, { "kind": "method", "name": "#onInput", "privacy": "private", "parameters": [ { "name": "e", "type": { "text": "InputEvent" } } ] }, { "kind": "field", "name": "value", "type": { "text": "number" }, "default": "0" }, { "kind": "field", "name": "step", "type": { "text": "number" }, "default": "1" } ], "events": [ { "type": { "text": "InputEvent" }, "description": "occurs when the value changes (real-time, during typing)", "name": "input" }, { "type": { "text": "InputEvent" }, "description": "occurs when value is committed (blur, enter, or button click)", "name": "change" } ], "attributes": [ { "name": "continuous", "type": { "text": "boolean" }, "default": "false", "description": "enable hold-to-repeat on stepper buttons", "fieldName": "continuous" }, { "name": "continuous-delay", "type": { "text": "number" }, "default": "500", "description": "delay in ms before continuous stepping starts", "fieldName": "continuousDelay" }, { "name": "continuous-interval", "type": { "text": "number" }, "default": "100", "description": "interval in ms for continuous stepping", "fieldName": "continuousInterval" }, { "name": "i18n", "type": { "text": "I18nStrings['actions']" }, "description": "Provides internationalization strings for accessibility labels and screen reader announcements", "fieldName": "i18n" } ], "mixins": [ { "name": "FormControlMixin", "package": "@blueprintui/components/forms" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "bp-number-stepper", "customElement": true, "summary": "A number input with explicit increment/decrement buttons in a horizontal minus-input-plus layout", "metadata": { "since": "2.11.0" } } ], "exports": [ { "kind": "js", "name": "BpNumberStepper", "declaration": { "name": "BpNumberStepper", "module": "number-stepper/element.js" } } ] }, { "kind": "javascript-module", "path": "number-stepper/element.visual.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "number-stepper/index.js", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "number-stepper/element.js" } } ] }, { "kind": "javascript-module", "path": "number/element.css", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "number/element.js", "declarations": [ { "kind": "class", "description": "```typescript\nimport '@blueprintui/components/include/number.js';\n```\n\n```html\n\n \n \n message text\n\n```", "name": "BpNumber", "cssProperties": [ { "name": "--background", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "name": "--color", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "name": "--border", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "name": "--border-radius", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "name": "--outline", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "name": "--outline-offset", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "name": "--padding", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "name": "--font-size", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "name": "--line-height", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "name": "--height", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "name": "--min-width", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "name": "--width", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "name": "--transition", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "name": "--text-align", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "name": "--cursor", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "name": "--background-size", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } } ], "slots": [ { "description": "slot for prefix text or icons (e.g., currency symbols)", "name": "prefix", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "description": "slot for suffix text or icons (e.g., units)", "name": "suffix", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } } ], "members": [ { "kind": "field", "name": "type", "type": { "text": "string" }, "default": "'number'", "description": "Specifies the input type as number for numeric input behavior", "attribute": "type", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "kind": "method", "name": "stepUp", "parameters": [ { "name": "number", "optional": true, "type": { "text": "number" } } ], "description": "Increments the value by the step amount" }, { "kind": "method", "name": "stepDown", "parameters": [ { "name": "number", "optional": true, "type": { "text": "number" } } ], "description": "Decrements the value by the step amount" }, { "kind": "method", "name": "#onChange", "privacy": "private", "parameters": [ { "name": "e", "type": { "text": "InputEvent" } } ] }, { "kind": "method", "name": "#onInput", "privacy": "private", "parameters": [ { "name": "e", "type": { "text": "InputEvent" } } ] }, { "kind": "field", "name": "prefixTemplate", "type": { "text": "TemplateResult | null" }, "privacy": "protected", "readonly": true, "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "kind": "field", "name": "suffixTemplate", "type": { "text": "TemplateResult | null" }, "privacy": "protected", "readonly": true, "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "kind": "field", "name": "input", "privacy": "protected", "readonly": true, "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "kind": "method", "name": "showPicker", "privacy": "protected", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } } ], "events": [ { "type": { "text": "InputEvent" }, "description": "occurs when the value changes", "name": "input", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "type": { "text": "InputEvent" }, "description": "occurs when the value changes", "name": "change", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } } ], "attributes": [ { "name": "type", "type": { "text": "string" }, "default": "'number'", "description": "Specifies the input type as number for numeric input behavior", "fieldName": "type", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } } ], "superclass": { "name": "BpInput", "package": "@blueprintui/components/input" }, "tagName": "bp-number", "customElement": true, "summary": "The number input component is used to allow users to input numeric values with optional min, max, and step constraints.", "metadata": { "since": "2.11.0" } } ], "exports": [ { "kind": "js", "name": "BpNumber", "declaration": { "name": "BpNumber", "module": "number/element.js" } } ] }, { "kind": "javascript-module", "path": "number/element.visual.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "number/index.js", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "number/element.js" } } ] }, { "kind": "javascript-module", "path": "page/element.css", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "page/element.js", "declarations": [ { "kind": "class", "description": "```typescript\nimport '@blueprintui/components/include/page.js';\n```\n\n```html\n\n```", "name": "BpPage", "slots": [ { "description": "slot for content", "name": "" }, { "description": "slot for header", "name": "header" }, { "description": "slot for subheader", "name": "subheader" }, { "description": "slot for aside start", "name": "aside-start" }, { "description": "slot for aside end", "name": "aside-end" }, { "description": "slot for subfooter", "name": "subfooter" }, { "description": "slot for footer", "name": "footer" } ], "members": [], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "bp-page", "customElement": true, "summary": "The page component is for page level layout.", "metadata": { "since": "1.0.0" } } ], "exports": [ { "kind": "js", "name": "BpPage", "declaration": { "name": "BpPage", "module": "page/element.js" } } ] }, { "kind": "javascript-module", "path": "page/element.visual.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "page/index.js", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "page/element.js" } } ] }, { "kind": "javascript-module", "path": "pagination/element.css", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "pagination/element.js", "declarations": [ { "kind": "class", "description": "```typescript\nimport '@blueprintui/components/include/pagination.js';\n```\n\n```html\n\n \n \n 1 / 3\n \n \n\n```", "name": "BpPagination", "cssProperties": [ { "name": "--gap" } ], "slots": [ {}, { "name": "first" }, { "name": "next" }, { "name": "prev" }, { "name": "last" } ], "members": [ { "kind": "field", "name": "i18n", "description": "set default aria/i18n strings", "attribute": "i18n" }, { "kind": "field", "name": "#field", "privacy": "private", "readonly": true }, { "kind": "field", "name": "_internals", "type": { "text": "ElementInternals" }, "privacy": "private" }, { "kind": "method", "name": "#setupButtons", "privacy": "private" }, { "kind": "method", "name": "#setupField", "privacy": "private" } ], "attributes": [ { "name": "i18n", "description": "set default aria/i18n strings", "fieldName": "i18n" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "bp-pagination", "customElement": true, "summary": "The Pagination component is used to navigate through a large number of pages. It allows users to easily switch between pages by clicking on page numbers or navigating to the first, previous, next, or last page.", "metadata": { "since": "1.0.0" } } ], "exports": [ { "kind": "js", "name": "BpPagination", "declaration": { "name": "BpPagination", "module": "pagination/element.js" } } ] }, { "kind": "javascript-module", "path": "pagination/element.visual.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "pagination/index.js", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "pagination/element.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "pagination/input/element.js" } } ] }, { "kind": "javascript-module", "path": "pagination/input/element.css", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "pagination/input/element.js", "declarations": [ { "kind": "class", "description": "Grid Pagination\n\n```typescript\nimport '@blueprintui/components/include/pagination.js';\n```\n\n```html\n\n \n\n```", "name": "BpPaginationInput", "members": [ { "kind": "field", "name": "value", "type": { "text": "number" }, "description": "determines initial value of the control" }, { "kind": "field", "name": "max", "type": { "text": "number" }, "description": "defines the greatest value in the range of permitted values" }, { "kind": "field", "name": "size", "type": { "text": "number" }, "description": "determines the current page size" }, { "kind": "field", "name": "sizeOptions", "type": { "text": "number[]" }, "default": "[]", "attribute": "size-options" }, { "kind": "field", "name": "i18n", "description": "set default aria/i18n strings", "attribute": "i18n" }, { "kind": "method", "name": "#setPage", "privacy": "private", "parameters": [ { "name": "event", "type": { "text": "any" } } ] }, { "kind": "method", "name": "#nextPage", "privacy": "private" }, { "kind": "method", "name": "#prevPage", "privacy": "private" }, { "kind": "method", "name": "#firstPage", "privacy": "private" }, { "kind": "method", "name": "#lastPage", "privacy": "private" }, { "kind": "method", "name": "#pageChange", "privacy": "private", "parameters": [ { "name": "value", "type": { "text": "number" } } ] }, { "kind": "method", "name": "#sizeChange", "privacy": "private", "parameters": [ { "name": "e", "type": { "text": "InputEvent" } } ] } ], "events": [ { "name": "input", "type": { "text": "Event" } }, { "name": "change", "type": { "text": "Event" } } ], "attributes": [ { "name": "size-options", "type": { "text": "number[]" }, "default": "[]", "fieldName": "sizeOptions" }, { "name": "i18n", "description": "set default aria/i18n strings", "fieldName": "i18n" } ], "mixins": [ { "name": "FormControlMixin", "package": "@blueprintui/components/forms" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "bp-pagination-input", "customElement": true, "metadata": { "since": "1.0.0" } } ], "exports": [ { "kind": "js", "name": "BpPaginationInput", "declaration": { "name": "BpPaginationInput", "module": "pagination/input/element.js" } } ] }, { "kind": "javascript-module", "path": "panel/element.css", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "panel/element.global.css", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "panel/element.js", "declarations": [ { "kind": "class", "description": "```typescript\nimport '@blueprintui/components/include/badge.js';\n```\n\n```html\npanel content\n```", "name": "BpPanel", "cssProperties": [ { "name": "--background" }, { "name": "--color" }, { "name": "--border" }, { "name": "--padding" } ], "slots": [ { "description": "content", "name": "" }, { "name": "header" }, { "name": "footer" } ], "members": [ { "kind": "field", "name": "size", "type": { "text": "'sm' | 'md' | 'lg'" }, "description": "Determines the size variant of the panel for different visual hierarchies", "attribute": "size", "reflects": true }, { "kind": "field", "name": "closable", "type": { "text": "boolean" }, "default": "false", "description": "Determines whether a close button is displayed for dismissing the panel", "attribute": "closable" }, { "kind": "field", "name": "hidden", "type": { "text": "boolean" }, "default": "false", "description": "Controls the visibility state of the panel", "attribute": "hidden", "reflects": true }, { "kind": "field", "name": "i18n", "description": "Provides internationalization strings for translated text content", "attribute": "i18n" }, { "kind": "field", "name": "_internals", "type": { "text": "ElementInternals" } }, { "kind": "field", "name": "typeClosableController", "type": { "text": "TypeClosableController" }, "privacy": "private" }, { "kind": "method", "name": "#close", "privacy": "private" } ], "events": [ { "description": "close", "name": "" }, { "description": "open", "name": "" } ], "attributes": [ { "name": "size", "type": { "text": "'sm' | 'md' | 'lg'" }, "description": "Determines the size variant of the panel for different visual hierarchies", "fieldName": "size" }, { "name": "closable", "type": { "text": "boolean" }, "default": "false", "description": "Determines whether a close button is displayed for dismissing the panel", "fieldName": "closable" }, { "name": "hidden", "type": { "text": "boolean" }, "default": "false", "description": "Controls the visibility state of the panel", "fieldName": "hidden" }, { "name": "i18n", "description": "Provides internationalization strings for translated text content", "fieldName": "i18n" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "bp-panel", "customElement": true, "summary": "The panel component is used to display secondary information, commonly navigation or actions.", "metadata": { "since": "1.0.0" }, "commands": [ { "name": "--toggle", "description": "" }, { "name": "--close", "description": "" }, { "name": "--open", "description": "" } ] } ], "exports": [ { "kind": "js", "name": "BpPanel", "declaration": { "name": "BpPanel", "module": "panel/element.js" } } ] }, { "kind": "javascript-module", "path": "panel/element.visual.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "panel/index.js", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "panel/element.js" } } ] }, { "kind": "javascript-module", "path": "password/element.css", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "password/element.js", "declarations": [ { "kind": "class", "description": "```typescript\nimport '@blueprintui/components/include/password.js';\n```\n\n```html\n\n \n \n message text\n\n```", "name": "BpPassword", "slots": [ { "description": "slot for prefix text or icons", "name": "prefix", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "description": "slot for suffic text or icons", "name": "suffix", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } } ], "members": [ { "kind": "field", "name": "type", "type": { "text": "string" }, "default": "'password'", "description": "Specifies the input type as password for secure text entry", "attribute": "type", "reflects": true, "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "kind": "field", "name": "i18n", "description": "Provides internationalization strings for translated text content", "attribute": "i18n" }, { "kind": "field", "name": "showPassword", "type": { "text": "boolean" }, "privacy": "private", "default": "false" }, { "kind": "field", "name": "suffixTemplate", "type": { "text": "TemplateResult | null" }, "privacy": "protected", "readonly": true, "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "kind": "method", "name": "#togglePasswordVisibility", "privacy": "private" }, { "kind": "field", "name": "prefixTemplate", "type": { "text": "TemplateResult | null" }, "privacy": "protected", "readonly": true, "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "kind": "field", "name": "input", "privacy": "protected", "readonly": true, "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "kind": "method", "name": "showPicker", "privacy": "protected", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } } ], "events": [ { "type": { "text": "InputEvent" }, "description": "occurs when the value changes", "name": "input", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "type": { "text": "InputEvent" }, "description": "occurs when the value changes", "name": "change", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } } ], "attributes": [ { "name": "type", "type": { "text": "string" }, "default": "'password'", "description": "Specifies the input type as password for secure text entry", "fieldName": "type", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "name": "i18n", "description": "Provides internationalization strings for translated text content", "fieldName": "i18n" } ], "superclass": { "name": "BpInput", "package": "@blueprintui/components/input" }, "tagName": "bp-password", "customElement": true, "summary": "The password input component is used to accept password input from users. It is a text input field with a toggle button to show or hide the password.", "metadata": { "since": "1.0.0" }, "cssProperties": [ { "name": "--background-size", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "name": "--color", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "name": "--background", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "name": "--border", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "name": "--border-radius", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "name": "--outline", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "name": "--outline-offset", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "name": "--padding", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "name": "--font-size", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "name": "--line-height", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "name": "--height", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "name": "--min-width", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "name": "--width", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "name": "--transition", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "name": "--text-align", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "name": "--cursor", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } } ] } ], "exports": [ { "kind": "js", "name": "BpPassword", "declaration": { "name": "BpPassword", "module": "password/element.js" } } ] }, { "kind": "javascript-module", "path": "password/element.visual.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "password/index.js", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "password/element.js" } } ] }, { "kind": "javascript-module", "path": "pin/element.css", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "pin/element.js", "declarations": [ { "kind": "class", "description": "```typescript\nimport '@blueprintui/components/include/pin.js';\n```\n\n```html\n\n \n \n Enter the 6-digit code sent to your phone\n\n```", "name": "BpPin", "cssProperties": [ { "description": "space between input fields", "name": "--gap" }, { "description": "width of each input field", "name": "--width" }, { "description": "height of each input field", "name": "--height" }, { "description": "font size for input text", "name": "--font-size" }, { "description": "border styling", "name": "--border" }, { "description": "corner rounding", "name": "--border-radius" }, { "description": "background color", "name": "--background" }, { "description": "text color", "name": "--color" } ], "members": [ { "kind": "field", "name": "length", "type": { "text": "number" }, "default": "4", "description": "Number of input fields (typically 4-8)", "attribute": "length" }, { "kind": "field", "name": "type", "type": { "text": "'text' | 'number'" }, "default": "'text'", "description": "Input type for each field", "attribute": "type" }, { "kind": "field", "name": "mask", "type": { "text": "boolean" }, "default": "false", "description": "Obscure input like password fields", "attribute": "mask" }, { "kind": "field", "name": "fields", "type": { "text": "string[]" }, "privacy": "private", "default": "[]" }, { "kind": "field", "name": "value", "type": { "text": "string" }, "description": "Complete pin value" }, { "kind": "field", "name": "inputControls", "type": { "text": "HTMLInputElement[]" }, "privacy": "private", "readonly": true }, { "kind": "method", "name": "focus" }, { "kind": "method", "name": "reset" }, { "kind": "field", "name": "#isInternalUpdate", "privacy": "private", "type": { "text": "boolean" }, "default": "false" }, { "kind": "method", "name": "#initializeFields", "privacy": "private" }, { "kind": "method", "name": "#updateFieldsFromValue", "privacy": "private" }, { "kind": "method", "name": "#onInput", "privacy": "private", "parameters": [ { "name": "e", "type": { "text": "InputEvent" } } ] }, { "kind": "method", "name": "#onKeyDown", "privacy": "private", "parameters": [ { "name": "e", "type": { "text": "KeyboardEvent" } } ] }, { "kind": "method", "name": "#onPaste", "privacy": "private", "parameters": [ { "name": "e", "type": { "text": "ClipboardEvent" } } ] }, { "kind": "method", "name": "#complete", "privacy": "private" }, { "kind": "method", "name": "#onFocus", "privacy": "private", "parameters": [ { "name": "e", "type": { "text": "FocusEvent" } } ] }, { "kind": "method", "name": "#updateValue", "privacy": "private" }, { "kind": "method", "name": "#isComplete", "privacy": "private", "return": { "type": { "text": "boolean" } } } ], "events": [ { "name": "complete", "type": { "text": "CustomEvent<{value: string}>" }, "description": "fires when all fields are filled" }, { "type": { "text": "InputEvent" }, "description": "occurs when any field value changes", "name": "input" }, { "type": { "text": "InputEvent" }, "description": "occurs when the complete value changes", "name": "change" } ], "attributes": [ { "name": "length", "type": { "text": "number" }, "default": "4", "description": "Number of input fields (typically 4-8)", "fieldName": "length" }, { "name": "type", "type": { "text": "'text' | 'number'" }, "default": "'text'", "description": "Input type for each field", "fieldName": "type" }, { "name": "mask", "type": { "text": "boolean" }, "default": "false", "description": "Obscure input like password fields", "fieldName": "mask" } ], "mixins": [ { "name": "FormControlMixin", "package": "@blueprintui/components/forms" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "bp-pin", "customElement": true, "summary": "PIN input component for entering verification codes and PINs with auto-advance and paste support", "metadata": { "since": "2.9.0" } } ], "exports": [ { "kind": "js", "name": "BpPin", "declaration": { "name": "BpPin", "module": "pin/element.js" } } ] }, { "kind": "javascript-module", "path": "pin/element.visual.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "pin/index.js", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "pin/element.js" } } ] }, { "kind": "javascript-module", "path": "progress-bar/element.css", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "progress-bar/element.js", "declarations": [ { "kind": "class", "description": "```typescript\nimport '@blueprintui/components/include/progress-bar.js';\n```\n\n```html\n\n```", "name": "BpProgressBar", "cssProperties": [ { "name": "--color" } ], "members": [ { "kind": "field", "name": "i18n", "description": "Provides internationalization strings for translated text content", "attribute": "i18n" }, { "kind": "field", "name": "min", "type": { "text": "number" }, "default": "0", "description": "Defines the minimum value in the range of permitted values for the progress bar", "attribute": "min" }, { "kind": "field", "name": "max", "type": { "text": "number" }, "default": "100", "description": "Defines the maximum value in the range of permitted values for the progress bar", "attribute": "max" }, { "kind": "field", "name": "value", "type": { "text": "number | null | undefined" }, "default": "null", "description": "Defines the current progress value, or null/undefined for indeterminate state", "attribute": "value" }, { "kind": "field", "name": "status", "type": { "text": "'accent' | 'success' | 'warning' | 'danger'" }, "description": "Defines the visual status type affecting color and semantic meaning", "attribute": "status", "reflects": true }, { "kind": "field", "name": "_internals", "type": { "text": "ElementInternals" } }, { "kind": "method", "name": "#updateAria", "privacy": "private" } ], "attributes": [ { "name": "i18n", "description": "Provides internationalization strings for translated text content", "fieldName": "i18n" }, { "name": "min", "type": { "text": "number" }, "default": "0", "description": "Defines the minimum value in the range of permitted values for the progress bar", "fieldName": "min" }, { "name": "max", "type": { "text": "number" }, "default": "100", "description": "Defines the maximum value in the range of permitted values for the progress bar", "fieldName": "max" }, { "name": "value", "type": { "text": "number | null | undefined" }, "default": "null", "description": "Defines the current progress value, or null/undefined for indeterminate state", "fieldName": "value" }, { "name": "status", "type": { "text": "'accent' | 'success' | 'warning' | 'danger'" }, "description": "Defines the visual status type affecting color and semantic meaning", "fieldName": "status" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "bp-progress-bar", "customElement": true, "summary": "The progress bar component displays the progress of a task, usually on a scale from 0 to 100%. It can be used to show the progress of a download, upload, form completion, or any other process that can be represented as a percentage.", "metadata": { "since": "1.0.0" } } ], "exports": [ { "kind": "js", "name": "BpProgressBar", "declaration": { "name": "BpProgressBar", "module": "progress-bar/element.js" } } ] }, { "kind": "javascript-module", "path": "progress-bar/element.visual.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "progress-bar/index.js", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "progress-bar/element.js" } } ] }, { "kind": "javascript-module", "path": "progress-circle/element.css", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "progress-circle/element.js", "declarations": [ { "kind": "class", "description": "```typescript\nimport '@blueprintui/components/include/progress-circle.js';\n```\n\n```html\n\n```", "name": "BpProgressCircle", "cssProperties": [ { "name": "--ring-opacity" }, { "name": "--ring-color" }, { "name": "--fill-color" }, { "name": "--fill-speed" }, { "name": "--size" } ], "members": [ { "kind": "field", "name": "i18n", "description": "Provides internationalization strings for translated text content", "attribute": "i18n" }, { "kind": "field", "name": "status", "type": { "text": "'accent' | 'success' | 'warning' | 'danger'" }, "description": "Defines the visual status type affecting color and semantic meaning", "attribute": "status", "reflects": true }, { "kind": "field", "name": "value", "type": { "text": "number" }, "description": "Defines the current progress value from 0 to 100", "attribute": "value" }, { "kind": "field", "name": "line", "type": { "text": "number" }, "default": "3", "description": "Controls the stroke width of the progress circle ring", "attribute": "line" }, { "kind": "field", "name": "size", "type": { "text": "'sm' | 'md' | 'lg'" }, "description": "Determines the size variant of the component for different visual hierarchies", "attribute": "size", "reflects": true }, { "kind": "field", "name": "#radius", "privacy": "private", "readonly": true }, { "kind": "field", "name": "#circumference", "privacy": "private", "readonly": true }, { "kind": "field", "name": "#progress", "privacy": "private", "readonly": true }, { "kind": "field", "name": "#progressOffset", "privacy": "private", "readonly": true }, { "kind": "field", "name": "_internals", "type": { "text": "ElementInternals" } }, { "kind": "method", "name": "#updateAria", "privacy": "private" } ], "attributes": [ { "name": "i18n", "description": "Provides internationalization strings for translated text content", "fieldName": "i18n" }, { "name": "status", "type": { "text": "'accent' | 'success' | 'warning' | 'danger'" }, "description": "Defines the visual status type affecting color and semantic meaning", "fieldName": "status" }, { "name": "value", "type": { "text": "number" }, "description": "Defines the current progress value from 0 to 100", "fieldName": "value" }, { "name": "line", "type": { "text": "number" }, "default": "3", "description": "Controls the stroke width of the progress circle ring", "fieldName": "line" }, { "name": "size", "type": { "text": "'sm' | 'md' | 'lg'" }, "description": "Determines the size variant of the component for different visual hierarchies", "fieldName": "size" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "bp-progress-circle", "customElement": true, "summary": "The progress circle component displays a visual representation of progress in the form of a circle. It is useful for showing the progress of a task in a compact, easy-to-understand manner.", "metadata": { "since": "1.0.0" } } ], "exports": [ { "kind": "js", "name": "BpProgressCircle", "declaration": { "name": "BpProgressCircle", "module": "progress-circle/element.js" } } ] }, { "kind": "javascript-module", "path": "progress-circle/element.visual.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "progress-circle/index.js", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "progress-circle/element.js" } } ] }, { "kind": "javascript-module", "path": "progress-dot/element.css", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "progress-dot/element.js", "declarations": [ { "kind": "class", "description": "```typescript\nimport '@blueprintui/components/include/progress-dot.js';\n```\n\n```html\n\n```", "name": "BpProgressDot", "cssProperties": [ { "name": "--color" }, { "name": "--width" }, { "name": "--height" }, { "name": "--animation-duration" } ], "members": [ { "kind": "field", "name": "size", "type": { "text": "'sm' | 'lg'" }, "description": "Determines the size variant of the component for different visual hierarchies", "attribute": "size", "reflects": true }, { "kind": "field", "name": "i18n", "description": "Provides internationalization strings for translated text content", "attribute": "i18n" }, { "kind": "field", "name": "_internals", "type": { "text": "ElementInternals" } } ], "attributes": [ { "name": "size", "type": { "text": "'sm' | 'lg'" }, "description": "Determines the size variant of the component for different visual hierarchies", "fieldName": "size" }, { "name": "i18n", "description": "Provides internationalization strings for translated text content", "fieldName": "i18n" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "bp-progress-dot", "customElement": true, "summary": "The Progress dot component is designed to indicate that a process is ongoing. It gives users feedback that the system is processing the task and that they need to wait.", "metadata": { "since": "1.0.0" } } ], "exports": [ { "kind": "js", "name": "BpProgressDot", "declaration": { "name": "BpProgressDot", "module": "progress-dot/element.js" } } ] }, { "kind": "javascript-module", "path": "progress-dot/element.visual.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "progress-dot/index.js", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "progress-dot/element.js" } } ] }, { "kind": "javascript-module", "path": "radio/element.css", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "radio/element.js", "declarations": [ { "kind": "class", "description": "```typescript\nimport '@blueprintui/components/include/radio.js';\n```\n\n```html\n\n \n\n \n \n\n \n \n\n \n \n\n message text\n\n```", "name": "BpRadio", "members": [], "events": [ { "type": { "text": "InputEvent" }, "description": "occurs when the value changes", "name": "change" } ], "mixins": [ { "name": "RadioFormControlMixin", "package": "@blueprintui/components/forms" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "bp-radio", "customElement": true, "summary": "Use the radio input component when you want the user to select a single option from a list of mutually exclusive options.", "metadata": { "since": "1.0.0" } } ], "exports": [ { "kind": "js", "name": "BpRadio", "declaration": { "name": "BpRadio", "module": "radio/element.js" } } ] }, { "kind": "javascript-module", "path": "radio/element.visual.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "radio/index.js", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "radio/element.js" } } ] }, { "kind": "javascript-module", "path": "range/element.css", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "range/element.js", "declarations": [ { "kind": "class", "description": "```typescript\nimport '@blueprintui/components/include/range.js';\n```\n\n```html\n\n \n \n message text\n\n```", "name": "BpRange", "cssProperties": [ { "name": "--accent-color" }, { "name": "--height" } ], "slots": [ { "description": "slot for prefix text or icons", "name": "prefix" }, { "description": "slot for suffix text or icons", "name": "suffix" }, { "description": "slot for range input", "name": "" } ], "members": [ { "kind": "method", "name": "#stopPropagation", "privacy": "private", "parameters": [ { "name": "e", "type": { "text": "Event" } } ] }, { "kind": "method", "name": "#onChange", "privacy": "private", "parameters": [ { "name": "e", "type": { "text": "InputEvent" } } ] }, { "kind": "method", "name": "#onInput", "privacy": "private", "parameters": [ { "name": "e", "type": { "text": "InputEvent" } } ] } ], "events": [ { "type": { "text": "InputEvent" }, "description": "occurs when the value changes", "name": "input" }, { "type": { "text": "InputEvent" }, "description": "occurs when the value changes", "name": "change" } ], "mixins": [ { "name": "SliderFormControlMixin", "package": "@blueprintui/components/forms" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "bp-range", "customElement": true, "summary": "The range input component is used to allow the user to select a value within a specified range of values.", "metadata": { "since": "1.0.0" } } ], "exports": [ { "kind": "js", "name": "BpRange", "declaration": { "name": "BpRange", "module": "range/element.js" } } ] }, { "kind": "javascript-module", "path": "range/element.visual.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "range/index.js", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "range/element.js" } } ] }, { "kind": "javascript-module", "path": "rating/element.css", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "rating/element.js", "declarations": [ { "kind": "class", "description": "```typescript\nimport '@blueprintui/components/include/rating.js';\n```\n\n```html\n\n \n \n\n```", "name": "BpRating", "cssProperties": [ { "name": "--background" }, { "name": "--selected-background" } ], "members": [ { "kind": "field", "name": "#range", "privacy": "private", "readonly": true }, { "kind": "field", "name": "#icons", "privacy": "private", "readonly": true }, { "kind": "method", "name": "#stopPropagation", "privacy": "private", "parameters": [ { "name": "e", "type": { "text": "Event" } } ] }, { "kind": "method", "name": "#mouseenter", "privacy": "private", "parameters": [ { "name": "e", "type": { "text": "MouseEvent" } } ] }, { "kind": "method", "name": "#mouseleave", "privacy": "private" }, { "kind": "method", "name": "#click", "privacy": "private", "parameters": [ { "name": "e", "type": { "text": "MouseEvent" } } ] }, { "kind": "method", "name": "#onChange", "privacy": "private", "parameters": [ { "name": "e", "type": { "text": "InputEvent" } } ] }, { "kind": "method", "name": "#onInput", "privacy": "private", "parameters": [ { "name": "e", "type": { "text": "InputEvent" } } ] }, { "kind": "method", "name": "#select", "privacy": "private", "parameters": [ { "name": "i", "type": { "text": "number" } } ] }, { "kind": "method", "name": "#updateIcons", "privacy": "private", "parameters": [ { "name": "i", "type": { "text": "number" } } ] } ], "events": [ { "type": { "text": "InputEvent" }, "description": "occurs when the value changes", "name": "input" }, { "type": { "text": "InputEvent" }, "description": "occurs when the value changes", "name": "change" } ], "mixins": [ { "name": "SliderFormControlMixin", "package": "@blueprintui/components/forms" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "bp-rating", "customElement": true, "summary": "The rating input component is used to allow the user to select a rating value within a specified range of values.", "metadata": { "since": "1.0.0" } } ], "exports": [ { "kind": "js", "name": "BpRating", "declaration": { "name": "BpRating", "module": "rating/element.js" } } ] }, { "kind": "javascript-module", "path": "rating/element.visual.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "rating/index.js", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "rating/element.js" } } ] }, { "kind": "javascript-module", "path": "search/element.css", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "search/element.js", "declarations": [ { "kind": "class", "description": "```typescript\nimport '@blueprintui/components/include/time.js';\n```\n\n```html\n\n \n \n message text\n\n```", "name": "BpSearch", "slots": [ { "description": "slot for prefix text or icons", "name": "prefix", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "description": "slot for suffic text or icons", "name": "suffix", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } } ], "members": [ { "kind": "field", "name": "type", "type": { "text": "string" }, "default": "'search'", "description": "Specifies the input type as search for optimized search behavior", "attribute": "type", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "kind": "field", "name": "prefixTemplate", "type": { "text": "TemplateResult | null" }, "privacy": "protected", "readonly": true, "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "kind": "field", "name": "suffixTemplate", "type": { "text": "TemplateResult | null" }, "privacy": "protected", "readonly": true, "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "kind": "field", "name": "input", "privacy": "protected", "readonly": true, "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "kind": "method", "name": "showPicker", "privacy": "protected", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } } ], "events": [ { "type": { "text": "InputEvent" }, "description": "occurs when the value changes", "name": "input", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "type": { "text": "InputEvent" }, "description": "occurs when the value changes", "name": "change", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } } ], "attributes": [ { "name": "type", "type": { "text": "string" }, "default": "'search'", "description": "Specifies the input type as search for optimized search behavior", "fieldName": "type", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } } ], "superclass": { "name": "BpInput", "package": "@blueprintui/components/input" }, "tagName": "bp-search", "customElement": true, "summary": "The Search component is used for searching for specific content within an application.", "metadata": { "since": "1.0.0" }, "cssProperties": [ { "name": "--background-size", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "name": "--color", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "name": "--background", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "name": "--border", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "name": "--border-radius", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "name": "--outline", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "name": "--outline-offset", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "name": "--padding", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "name": "--font-size", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "name": "--line-height", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "name": "--height", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "name": "--min-width", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "name": "--width", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "name": "--transition", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "name": "--text-align", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "name": "--cursor", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } } ] } ], "exports": [ { "kind": "js", "name": "BpSearch", "declaration": { "name": "BpSearch", "module": "search/element.js" } } ] }, { "kind": "javascript-module", "path": "search/element.visual.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "search/index.js", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "search/element.js" } } ] }, { "kind": "javascript-module", "path": "select/element.css", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "select/element.js", "declarations": [ { "kind": "class", "description": "```typescript\nimport '@blueprintui/components/include/select.js';\n```\n\n```html\n\n \n \n option one\n option two\n option three\n \n\n```", "name": "BpSelect", "cssProperties": [ { "name": "--background" }, { "name": "--color" }, { "name": "--border" }, { "name": "--border-radius" }, { "name": "--outline" }, { "name": "--outline-offset" }, { "name": "--padding" }, { "name": "--font-size" }, { "name": "--line-height" }, { "name": "--height" }, { "name": "--min-width" }, { "name": "--cursor" }, { "name": "--width" } ], "slots": [ { "description": "For projecting select and label", "name": "" } ], "members": [ { "kind": "field", "name": "options", "type": { "text": "BpOption[]" }, "readonly": true } ], "events": [ { "type": { "text": "InputEvent" }, "description": "occurs when the value changes", "name": "input" }, { "type": { "text": "InputEvent" }, "description": "occurs when the value changes", "name": "change" } ], "mixins": [ { "name": "SelectFormControlMixin", "package": "@blueprintui/components/forms" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "bp-select", "customElement": true, "summary": "The select input component allows users to select an option from a dropdown list of options. The options are displayed when the user clicks on the select input.", "metadata": { "since": "1.0.0" } }, { "kind": "class", "description": "Option element for use within bp-select.", "name": "BpOption", "mixins": [ { "name": "OptionMixin", "package": "@blueprintui/components/forms" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "bp-option", "customElement": true, "metadata": { "since": "1.0.0" } } ], "exports": [ { "kind": "js", "name": "BpSelect", "declaration": { "name": "BpSelect", "module": "select/element.js" } }, { "kind": "js", "name": "BpOption", "declaration": { "name": "BpOption", "module": "select/element.js" } } ] }, { "kind": "javascript-module", "path": "select/element.visual.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "select/index.js", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "select/element.js" } } ] }, { "kind": "javascript-module", "path": "skeleton/element.css", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "skeleton/element.js", "declarations": [ { "kind": "class", "description": "```typescript\nimport '@blueprintui/components/include/skeleton.js';\n```\n\n```html\n\n```", "name": "BpSkeleton", "cssProperties": [ { "description": "Width of the skeleton (default: 100%)", "name": "--width" }, { "description": "Height of the skeleton (default: 1rem)", "name": "--height" }, { "description": "Background color of the skeleton", "name": "--background" }, { "description": "Border radius (controlled by shape attribute)", "name": "--border-radius" } ], "members": [ { "kind": "field", "name": "effect", "type": { "text": "'pulse' | 'sheen'" }, "description": "Animation effect applied to the skeleton", "attribute": "effect", "reflects": true }, { "kind": "field", "name": "shape", "type": { "text": "'circle'" }, "description": "Shape of the skeleton", "attribute": "shape", "reflects": true }, { "kind": "field", "name": "_internals", "type": { "text": "ElementInternals" } } ], "attributes": [ { "name": "effect", "type": { "text": "'pulse' | 'sheen'" }, "description": "Animation effect applied to the skeleton", "fieldName": "effect" }, { "name": "shape", "type": { "text": "'circle'" }, "description": "Shape of the skeleton", "fieldName": "shape" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "bp-skeleton", "customElement": true, "summary": "Skeleton provides a placeholder representation of content before it loads", "metadata": { "since": "2.9.0" } } ], "exports": [ { "kind": "js", "name": "BpSkeleton", "declaration": { "name": "BpSkeleton", "module": "skeleton/element.js" } } ] }, { "kind": "javascript-module", "path": "skeleton/element.visual.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "skeleton/index.js", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "skeleton/element.js" } } ] }, { "kind": "javascript-module", "path": "stepper/element.css", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "stepper/element.js", "declarations": [ { "kind": "class", "description": "```typescript\nimport '@blueprintui/components/include/stepper.js';\n```\n\n```html\n\n Step 1\n Step 2\n Step 3\n\n```", "name": "BpStepper", "cssProperties": [ { "name": "--font-size" }, { "name": "--font-weight" }, { "name": "--color" }, { "name": "--gap" } ], "slots": [ { "description": "stepper items", "name": "" } ], "members": [ { "kind": "field", "name": "layout", "type": { "text": "'horizontal' | 'vertical'" }, "default": "'horizontal'", "description": "Controls the layout direction of the stepper, either horizontal or vertical", "attribute": "layout", "reflects": true }, { "kind": "field", "name": "_internals", "type": { "text": "ElementInternals" } }, { "kind": "field", "name": "items", "readonly": true }, { "kind": "method", "name": "#updateItems", "privacy": "private" } ], "attributes": [ { "name": "layout", "type": { "text": "'horizontal' | 'vertical'" }, "default": "'horizontal'", "description": "Controls the layout direction of the stepper, either horizontal or vertical", "fieldName": "layout" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "bp-stepper", "customElement": true, "summary": "Stepper components guide users through a multi-step process, breaking it down into manageable parts. This increases understanding, reduces cognitive load, and enhances the overall user experience.", "metadata": { "since": "1.0.0" } } ], "exports": [ { "kind": "js", "name": "BpStepper", "declaration": { "name": "BpStepper", "module": "stepper/element.js" } } ] }, { "kind": "javascript-module", "path": "stepper/element.visual.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "stepper/index.js", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "stepper/element.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "stepper/item/element.js" } } ] }, { "kind": "javascript-module", "path": "stepper/item/element.css", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "stepper/item/element.js", "declarations": [ { "kind": "class", "description": "", "name": "BpStepperItem", "cssProperties": [ { "name": "--background" }, { "name": "--color" }, { "name": "--cursor" }, { "name": "--border-width" }, { "name": "--padding" }, { "name": "--status-color" } ], "cssParts": [ { "name": "icon" }, { "name": "badge" } ], "slots": [ { "description": "item content", "name": "" } ], "members": [ { "kind": "field", "name": "status", "type": { "text": "'accent' | 'success' | 'warning' | 'danger'" }, "description": "determine the visual status state", "attribute": "status", "reflects": true }, { "kind": "field", "name": "selected", "type": { "text": "boolean" }, "default": "false", "description": "selected visual state", "attribute": "selected" }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "determines if element is mutable or focusable", "attribute": "disabled" }, { "kind": "field", "name": "readonly", "type": { "text": "boolean" }, "description": "makes the element not mutable, meaning the user can not interact with button", "attribute": "readonly" }, { "kind": "field", "name": "_layout", "type": { "text": "'horizontal' | 'vertical'" }, "default": "'horizontal'", "privacy": "private" }, { "kind": "field", "name": "_index", "type": { "text": "number" }, "privacy": "private" }, { "kind": "field", "name": "_internals", "type": { "text": "ElementInternals" } } ], "attributes": [ { "name": "status", "type": { "text": "'accent' | 'success' | 'warning' | 'danger'" }, "description": "determine the visual status state", "fieldName": "status" }, { "name": "selected", "type": { "text": "boolean" }, "default": "false", "description": "selected visual state", "fieldName": "selected" }, { "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "determines if element is mutable or focusable", "fieldName": "disabled" }, { "name": "readonly", "type": { "text": "boolean" }, "description": "makes the element not mutable, meaning the user can not interact with button", "fieldName": "readonly" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "bp-stepper-item", "customElement": true, "metadata": { "since": "1.0.0" } } ], "exports": [ { "kind": "js", "name": "BpStepperItem", "declaration": { "name": "BpStepperItem", "module": "stepper/item/element.js" } } ] }, { "kind": "javascript-module", "path": "switch/element.css", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "switch/element.js", "declarations": [ { "kind": "class", "description": "```typescript\nimport '@blueprintui/components/include/switch.js';\n```\n\n```html\n\n \n \n\n```", "name": "BpSwitch", "cssProperties": [ { "name": "--background" }, { "name": "--border" }, { "name": "--border-radius" }, { "name": "--height" }, { "name": "--width" }, { "name": "--anchor-background" }, { "name": "--anchor-border-radius" }, { "name": "--anchor-width" }, { "name": "--anchor-height" }, { "name": "--toggle-speed" } ], "members": [], "events": [ { "type": { "text": "InputEvent" }, "description": "occurs when the value changes", "name": "input" }, { "type": { "text": "InputEvent" }, "description": "occurs when the value changes", "name": "change" } ], "mixins": [ { "name": "CheckboxFormControlMixin", "package": "@blueprintui/components/forms" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "bp-switch", "customElement": true, "summary": "Use the switch input component for boolean-like options, such as enabling/disabling notifications, or for settings that can be toggled between two states.", "metadata": { "since": "1.0.0" } } ], "exports": [ { "kind": "js", "name": "BpSwitch", "declaration": { "name": "BpSwitch", "module": "switch/element.js" } } ] }, { "kind": "javascript-module", "path": "switch/element.visual.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "switch/index.js", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "switch/element.js" } } ] }, { "kind": "javascript-module", "path": "tabs/element.css", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "tabs/element.js", "declarations": [ { "kind": "class", "description": "```typescript\nimport '@blueprintui/components/include/tabs.js';\n```\n\n```html\n\n```", "name": "BpTabs", "cssProperties": [ { "name": "--background" }, { "name": "--color" }, { "name": "--border-radius" }, { "name": "--padding" } ], "slots": [ {} ], "members": [ { "kind": "field", "name": "layout", "type": { "text": "'horizontal' | 'vertical'" }, "default": "'horizontal'", "description": "Controls the layout direction of the tabs, either horizontal or vertical", "attribute": "layout", "reflects": true }, { "kind": "field", "name": "tabs", "privacy": "private", "readonly": true }, { "kind": "field", "name": "#tabPanels", "privacy": "private", "readonly": true }, { "kind": "method", "name": "#updateTabs", "privacy": "private" } ], "attributes": [ { "name": "layout", "type": { "text": "'horizontal' | 'vertical'" }, "default": "'horizontal'", "description": "Controls the layout direction of the tabs, either horizontal or vertical", "fieldName": "layout" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "bp-tabs", "customElement": true, "summary": "The tabs component is used to display a group of related content in a tabbed interface. The tabs component consists of a collection of tabs, where each tab represents a different piece of content.", "metadata": { "since": "1.0.0" } } ], "exports": [ { "kind": "js", "name": "BpTabs", "declaration": { "name": "BpTabs", "module": "tabs/element.js" } } ] }, { "kind": "javascript-module", "path": "tabs/element.visual.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "tabs/index.js", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "tabs/panel/element.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "tabs/list/element.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "tabs/tab/element.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "tabs/element.js" } } ] }, { "kind": "javascript-module", "path": "tabs/list/element.css", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "tabs/list/element.js", "declarations": [ { "kind": "class", "description": "```typescript\nimport '@blueprintui/components/include/tabs.js';\n```\n\n```html\n\n```", "name": "BpTabList", "cssProperties": [ { "name": "--background" } ], "slots": [ {} ], "members": [ { "kind": "field", "name": "_internals", "type": { "text": "ElementInternals" } } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "bp-tab-list", "customElement": true, "metadata": { "since": "1.0.0" } } ], "exports": [ { "kind": "js", "name": "BpTabList", "declaration": { "name": "BpTabList", "module": "tabs/list/element.js" } } ] }, { "kind": "javascript-module", "path": "tabs/panel/element.css", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "tabs/panel/element.js", "declarations": [ { "kind": "class", "description": "```typescript\nimport '@blueprintui/components/include/tabs.js';\n```\n\n```html\n\n```", "name": "BpTabPanel", "cssProperties": [ { "name": "--padding" } ], "slots": [ {} ], "members": [ { "kind": "field", "name": "_internals", "type": { "text": "ElementInternals" } }, { "kind": "field", "name": "tab", "type": { "text": "BpTab" }, "privacy": "private" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "bp-tab-panel", "customElement": true, "metadata": { "since": "1.0.0" } } ], "exports": [ { "kind": "js", "name": "BpTabPanel", "declaration": { "name": "BpTabPanel", "module": "tabs/panel/element.js" } } ] }, { "kind": "javascript-module", "path": "tabs/tab/element.css", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "tabs/tab/element.js", "declarations": [ { "kind": "class", "description": "```typescript\nimport '@blueprintui/components/include/tabs.js';\n```\n\n```html\n\n```", "name": "BpTab", "cssProperties": [ { "name": "--background" } ], "slots": [ {} ], "members": [ { "kind": "field", "name": "selected", "type": { "text": "boolean" }, "description": "selected visual state", "attribute": "selected", "default": "false", "reflects": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "tabPanel", "type": { "text": "BpTabPanel" } }, { "kind": "field", "name": "pressed", "type": { "text": "boolean" }, "description": "turns the button into a toggle button", "attribute": "pressed", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "expanded", "type": { "text": "boolean" }, "description": "indicate if a control is expanded or collapsed", "attribute": "expanded", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "readonly", "type": { "text": "boolean" }, "description": "makes the element not mutable, meaning the user can not interact with button", "attribute": "readonly", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "determines if element is mutable or focusable", "attribute": "disabled", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "type", "type": { "text": "'button' | 'submit'" }, "description": "default behavior of the button", "attribute": "type", "reflects": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "name", "type": { "text": "string" }, "description": "represents the name of the current
element as a string.", "attribute": "name", "reflects": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "value", "type": { "text": "string" }, "description": "determines the current value", "attribute": "value", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "popoverTargetAction", "type": { "text": "'toggle' | 'show' | 'hide'" }, "description": "The action to perform on the target popover element\nhttps://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/button#popovertargetaction", "attribute": "popovertargetaction", "reflects": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "popoverTargetElement", "type": { "text": "HTMLElement" }, "description": "The target element for the popover\nhttps://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/button#popovertarget", "attribute": "popoverTargetElement", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "command", "type": { "text": "string" }, "description": "The command property of the HTMLButtonElement interface gets and sets the action to be performed on an element being controlled by this button. For this to have an effect, commandfor must be set.\nhttps://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/button#command", "attribute": "command", "reflects": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "commandForElement", "type": { "text": "HTMLElement" }, "description": "The commandForElement property of the HTMLButtonElement interface gets and sets the id of the element being controlled by this button. For this to have an effect, command must be set.\nhttps://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/button#command", "attribute": "commandForElement", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "interestForElement", "type": { "text": "HTMLElement" }, "description": "The interestForElement property of the HTMLButtonElement interface gets and sets the id of the element being controlled by this button. For this to have an effect, command must be set.\nhttps://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/button#interest", "attribute": "interestForElement", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "form", "type": { "text": "HTMLFormElement" }, "readonly": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "formAction", "type": { "text": "string" }, "readonly": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "formEnctype", "type": { "text": "string" }, "readonly": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "formMethod", "type": { "text": "string" }, "readonly": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "formNoValidate", "type": { "text": "boolean" }, "readonly": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "formTarget", "type": { "text": "string" }, "readonly": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "labels", "type": { "text": "NodeListOf" }, "readonly": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "validationMessage", "type": { "text": "string" }, "readonly": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "validity", "type": { "text": "ValidityState" }, "readonly": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "willValidate", "type": { "text": "boolean" }, "readonly": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "checkValidity", "type": { "text": "any" }, "readonly": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "reportValidity", "type": { "text": "any" }, "readonly": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "setCustomValidity", "type": { "text": "any" }, "readonly": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "_internals", "type": { "text": "ElementInternals" }, "readonly": true, "privacy": "private", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "formAssociated", "type": { "text": "boolean" }, "static": true, "default": "true", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } } ], "attributes": [ { "name": "selected", "type": { "text": "boolean" }, "description": "selected visual state", "fieldName": "selected", "default": "false", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "name": "pressed", "type": { "text": "boolean" }, "description": "turns the button into a toggle button", "fieldName": "pressed", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "name": "expanded", "type": { "text": "boolean" }, "description": "indicate if a control is expanded or collapsed", "fieldName": "expanded", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "name": "readonly", "type": { "text": "boolean" }, "description": "makes the element not mutable, meaning the user can not interact with button", "fieldName": "readonly", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "determines if element is mutable or focusable", "fieldName": "disabled", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "name": "type", "type": { "text": "'button' | 'submit'" }, "description": "default behavior of the button", "fieldName": "type", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "name": "name", "type": { "text": "string" }, "description": "represents the name of the current element as a string.", "fieldName": "name", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "name": "value", "type": { "text": "string" }, "description": "determines the current value", "fieldName": "value", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "name": "popovertargetaction", "type": { "text": "'toggle' | 'show' | 'hide'" }, "description": "The action to perform on the target popover element\nhttps://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/button#popovertargetaction", "fieldName": "popoverTargetAction", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "name": "popoverTargetElement", "type": { "text": "HTMLElement" }, "description": "The target element for the popover\nhttps://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/button#popovertarget", "fieldName": "popoverTargetElement", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "name": "command", "type": { "text": "string" }, "description": "The command property of the HTMLButtonElement interface gets and sets the action to be performed on an element being controlled by this button. For this to have an effect, commandfor must be set.\nhttps://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/button#command", "fieldName": "command", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "name": "commandForElement", "type": { "text": "HTMLElement" }, "description": "The commandForElement property of the HTMLButtonElement interface gets and sets the id of the element being controlled by this button. For this to have an effect, command must be set.\nhttps://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/button#command", "fieldName": "commandForElement", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "name": "interestForElement", "type": { "text": "HTMLElement" }, "description": "The interestForElement property of the HTMLButtonElement interface gets and sets the id of the element being controlled by this button. For this to have an effect, command must be set.\nhttps://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/button#interest", "fieldName": "interestForElement", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } } ], "superclass": { "name": "BaseButton", "package": "@blueprintui/components/internals" }, "tagName": "bp-tab", "customElement": true, "metadata": { "since": "1.0.0" } } ], "exports": [ { "kind": "js", "name": "BpTab", "declaration": { "name": "BpTab", "module": "tabs/tab/element.js" } } ] }, { "kind": "javascript-module", "path": "tag/element.css", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "tag/element.js", "declarations": [ { "kind": "class", "description": "```typescript\nimport '@blueprintui/components/include/tag.js';\n```\n\n```html\nitem\n```", "name": "BpTag", "cssProperties": [ { "name": "--background" }, { "name": "--color" }, { "name": "--border" }, { "name": "--padding" }, { "name": "--font-size" }, { "name": "--border-radius" }, { "name": "--line-height" } ], "slots": [ { "description": "badge content", "name": "" } ], "members": [ { "kind": "field", "name": "status", "type": { "text": "'accent' | 'success' | 'warning' | 'danger'" }, "description": "Defines the visual status type affecting color and semantic meaning", "attribute": "status", "reflects": true }, { "kind": "field", "name": "pressed", "type": { "text": "boolean" }, "description": "turns the button into a toggle button", "attribute": "pressed", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "selected", "type": { "text": "boolean" }, "description": "indicate the current \"selected\" state of various widgets", "attribute": "selected", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "expanded", "type": { "text": "boolean" }, "description": "indicate if a control is expanded or collapsed", "attribute": "expanded", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "readonly", "type": { "text": "boolean" }, "description": "makes the element not mutable, meaning the user can not interact with button", "attribute": "readonly", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "determines if element is mutable or focusable", "attribute": "disabled", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "type", "type": { "text": "'button' | 'submit'" }, "description": "default behavior of the button", "attribute": "type", "reflects": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "name", "type": { "text": "string" }, "description": "represents the name of the current element as a string.", "attribute": "name", "reflects": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "value", "type": { "text": "string" }, "description": "determines the current value", "attribute": "value", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "popoverTargetAction", "type": { "text": "'toggle' | 'show' | 'hide'" }, "description": "The action to perform on the target popover element\nhttps://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/button#popovertargetaction", "attribute": "popovertargetaction", "reflects": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "popoverTargetElement", "type": { "text": "HTMLElement" }, "description": "The target element for the popover\nhttps://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/button#popovertarget", "attribute": "popoverTargetElement", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "command", "type": { "text": "string" }, "description": "The command property of the HTMLButtonElement interface gets and sets the action to be performed on an element being controlled by this button. For this to have an effect, commandfor must be set.\nhttps://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/button#command", "attribute": "command", "reflects": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "commandForElement", "type": { "text": "HTMLElement" }, "description": "The commandForElement property of the HTMLButtonElement interface gets and sets the id of the element being controlled by this button. For this to have an effect, command must be set.\nhttps://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/button#command", "attribute": "commandForElement", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "interestForElement", "type": { "text": "HTMLElement" }, "description": "The interestForElement property of the HTMLButtonElement interface gets and sets the id of the element being controlled by this button. For this to have an effect, command must be set.\nhttps://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/button#interest", "attribute": "interestForElement", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "form", "type": { "text": "HTMLFormElement" }, "readonly": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "formAction", "type": { "text": "string" }, "readonly": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "formEnctype", "type": { "text": "string" }, "readonly": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "formMethod", "type": { "text": "string" }, "readonly": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "formNoValidate", "type": { "text": "boolean" }, "readonly": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "formTarget", "type": { "text": "string" }, "readonly": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "labels", "type": { "text": "NodeListOf" }, "readonly": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "validationMessage", "type": { "text": "string" }, "readonly": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "validity", "type": { "text": "ValidityState" }, "readonly": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "willValidate", "type": { "text": "boolean" }, "readonly": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "checkValidity", "type": { "text": "any" }, "readonly": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "reportValidity", "type": { "text": "any" }, "readonly": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "setCustomValidity", "type": { "text": "any" }, "readonly": true, "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "_internals", "type": { "text": "ElementInternals" }, "readonly": true, "privacy": "private", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "kind": "field", "name": "formAssociated", "type": { "text": "boolean" }, "static": true, "default": "true", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } } ], "attributes": [ { "name": "status", "type": { "text": "'accent' | 'success' | 'warning' | 'danger'" }, "description": "Defines the visual status type affecting color and semantic meaning", "fieldName": "status" }, { "name": "pressed", "type": { "text": "boolean" }, "description": "turns the button into a toggle button", "fieldName": "pressed", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "name": "selected", "type": { "text": "boolean" }, "description": "indicate the current \"selected\" state of various widgets", "fieldName": "selected", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "name": "expanded", "type": { "text": "boolean" }, "description": "indicate if a control is expanded or collapsed", "fieldName": "expanded", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "name": "readonly", "type": { "text": "boolean" }, "description": "makes the element not mutable, meaning the user can not interact with button", "fieldName": "readonly", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "determines if element is mutable or focusable", "fieldName": "disabled", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "name": "type", "type": { "text": "'button' | 'submit'" }, "description": "default behavior of the button", "fieldName": "type", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "name": "name", "type": { "text": "string" }, "description": "represents the name of the current element as a string.", "fieldName": "name", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "name": "value", "type": { "text": "string" }, "description": "determines the current value", "fieldName": "value", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "name": "popovertargetaction", "type": { "text": "'toggle' | 'show' | 'hide'" }, "description": "The action to perform on the target popover element\nhttps://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/button#popovertargetaction", "fieldName": "popoverTargetAction", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "name": "popoverTargetElement", "type": { "text": "HTMLElement" }, "description": "The target element for the popover\nhttps://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/button#popovertarget", "fieldName": "popoverTargetElement", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "name": "command", "type": { "text": "string" }, "description": "The command property of the HTMLButtonElement interface gets and sets the action to be performed on an element being controlled by this button. For this to have an effect, commandfor must be set.\nhttps://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/button#command", "fieldName": "command", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "name": "commandForElement", "type": { "text": "HTMLElement" }, "description": "The commandForElement property of the HTMLButtonElement interface gets and sets the id of the element being controlled by this button. For this to have an effect, command must be set.\nhttps://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/button#command", "fieldName": "commandForElement", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } }, { "name": "interestForElement", "type": { "text": "HTMLElement" }, "description": "The interestForElement property of the HTMLButtonElement interface gets and sets the id of the element being controlled by this button. For this to have an effect, command must be set.\nhttps://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/button#interest", "fieldName": "interestForElement", "inheritedFrom": { "name": "BaseButton", "module": "internals/components/button.js" } } ], "superclass": { "name": "BaseButton", "package": "@blueprintui/components/internals" }, "tagName": "bp-tag", "customElement": true, "summary": "The tag component is used to display labels or categories of information. It can be used to group and categorize similar items, or to label content with a certain type or status.", "metadata": { "since": "1.0.0" } } ], "exports": [ { "kind": "js", "name": "BpTag", "declaration": { "name": "BpTag", "module": "tag/element.js" } } ] }, { "kind": "javascript-module", "path": "tag/element.visual.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "tag/index.js", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "tag/element.js" } } ] }, { "kind": "javascript-module", "path": "telephone/element.css", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "telephone/element.js", "declarations": [ { "kind": "class", "description": "```typescript\nimport '@blueprintui/components/include/telephone.js';\n```\n\n```html\n\n \n \n Enter your contact number\n\n```", "name": "BpTelephone", "cssProperties": [ { "name": "--background-size", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "name": "--color", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "name": "--background", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "name": "--border", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "name": "--border-radius", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "name": "--outline", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "name": "--outline-offset", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "name": "--padding", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "name": "--font-size", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "name": "--line-height", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "name": "--height", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "name": "--min-width", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "name": "--width", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "name": "--transition", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "name": "--text-align", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "name": "--cursor", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } } ], "slots": [ { "description": "slot for prefix text or icons", "name": "prefix", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "description": "slot for suffix text or icons", "name": "suffix", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } } ], "members": [ { "kind": "field", "name": "type", "type": { "text": "string" }, "default": "'tel'", "description": "Specifies the input type, affecting behavior and validation", "attribute": "type", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "kind": "field", "name": "prefixTemplate", "type": { "text": "TemplateResult | null" }, "privacy": "protected", "readonly": true, "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "kind": "field", "name": "suffixTemplate", "type": { "text": "TemplateResult | null" }, "privacy": "protected", "readonly": true, "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "kind": "field", "name": "input", "privacy": "protected", "readonly": true, "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "kind": "method", "name": "showPicker", "privacy": "protected", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } } ], "events": [ { "type": { "text": "InputEvent" }, "description": "occurs when the value changes", "name": "input", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "type": { "text": "InputEvent" }, "description": "occurs when the value changes", "name": "change", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } } ], "attributes": [ { "name": "type", "type": { "text": "string" }, "default": "'tel'", "description": "Specifies the input type, affecting behavior and validation", "fieldName": "type", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } } ], "superclass": { "name": "BpInput", "package": "@blueprintui/components/input" }, "tagName": "bp-telephone", "customElement": true, "summary": "The telephone input component allows users to input and edit telephone numbers. Uses native `` internally for proper mobile keyboard support and native validation.", "metadata": { "since": "2.10.0" } } ], "exports": [ { "kind": "js", "name": "BpTelephone", "declaration": { "name": "BpTelephone", "module": "telephone/element.js" } } ] }, { "kind": "javascript-module", "path": "telephone/element.visual.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "telephone/index.js", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "telephone/element.js" } } ] }, { "kind": "javascript-module", "path": "textarea/element.css", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "textarea/element.js", "declarations": [ { "kind": "class", "description": "```typescript\nimport '@blueprintui/components/include/textarea.js';\n```\n\n```html\n\n \n \n message text\n\n```", "name": "BpTextarea", "cssProperties": [ { "name": "--background" }, { "name": "--border" }, { "name": "--padding" }, { "name": "--font-size" }, { "name": "--color" }, { "name": "--border-radius" }, { "name": "--min-height" } ], "members": [], "events": [ { "type": { "text": "InputEvent" }, "description": "occurs when the value changes", "name": "input" }, { "type": { "text": "InputEvent" }, "description": "occurs when the value changes", "name": "change" } ], "mixins": [ { "name": "FormControlMixin", "package": "@blueprintui/components/forms" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "bp-textarea", "customElement": true, "summary": "The textarea component is used to capture multi-line text input from the user.", "metadata": { "since": "1.0.0" } } ], "exports": [ { "kind": "js", "name": "BpTextarea", "declaration": { "name": "BpTextarea", "module": "textarea/element.js" } } ] }, { "kind": "javascript-module", "path": "textarea/element.visual.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "textarea/index.js", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "textarea/element.js" } } ] }, { "kind": "javascript-module", "path": "time/element.css", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "time/element.js", "declarations": [ { "kind": "class", "description": "```typescript\nimport '@blueprintui/components/include/time.js';\n```\n\n```html\n\n \n \n message text\n\n```", "name": "BpTime", "slots": [ { "description": "slot for prefix text or icons", "name": "prefix", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "description": "slot for suffic text or icons", "name": "suffix", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "description": "slot for time input", "name": "" } ], "members": [ { "kind": "field", "name": "type", "type": { "text": "string" }, "default": "'time'", "description": "Specifies the input type as time for time selection", "attribute": "type", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "kind": "field", "name": "i18n", "description": "Provides internationalization strings for translated text content", "attribute": "i18n" }, { "kind": "field", "name": "min", "type": { "text": "string | null" }, "description": "Override min to preserve string time values (HH:MM format)" }, { "kind": "field", "name": "max", "type": { "text": "string | null" }, "description": "Override max to preserve string time values (HH:MM format)" }, { "kind": "field", "name": "suffixTemplate", "type": { "text": "TemplateResult | null" }, "privacy": "protected", "readonly": true, "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "kind": "field", "name": "prefixTemplate", "type": { "text": "TemplateResult | null" }, "privacy": "protected", "readonly": true, "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "kind": "field", "name": "input", "privacy": "protected", "readonly": true, "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "kind": "method", "name": "showPicker", "privacy": "protected", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } } ], "events": [ { "type": { "text": "InputEvent" }, "description": "occurs when the value changes", "name": "input", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "type": { "text": "InputEvent" }, "description": "occurs when the value changes", "name": "change", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } } ], "attributes": [ { "name": "type", "type": { "text": "string" }, "default": "'time'", "description": "Specifies the input type as time for time selection", "fieldName": "type", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "name": "i18n", "description": "Provides internationalization strings for translated text content", "fieldName": "i18n" } ], "superclass": { "name": "BpInput", "package": "@blueprintui/components/input" }, "tagName": "bp-time", "customElement": true, "summary": "The time input component is used to collect a specific time value from the user. It can be used as a standalone component or as part of a form.", "metadata": { "since": "1.0.0" }, "cssProperties": [ { "name": "--background-size", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "name": "--color", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "name": "--background", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "name": "--border", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "name": "--border-radius", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "name": "--outline", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "name": "--outline-offset", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "name": "--padding", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "name": "--font-size", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "name": "--line-height", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "name": "--height", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "name": "--min-width", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "name": "--width", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "name": "--transition", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "name": "--text-align", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } }, { "name": "--cursor", "inheritedFrom": { "name": "BpInput", "module": "input/element.js" } } ] } ], "exports": [ { "kind": "js", "name": "BpTime", "declaration": { "name": "BpTime", "module": "time/element.js" } } ] }, { "kind": "javascript-module", "path": "time/element.visual.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "time/index.js", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "time/element.js" } } ] }, { "kind": "javascript-module", "path": "toast/element.css", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "toast/element.js", "declarations": [ { "kind": "class", "description": "```typescript\nimport '@blueprintui/components/include/toast.js';\n```\n\n```html\n\n```", "name": "BpToast", "cssProperties": [ { "name": "--padding" }, { "name": "--filter" }, { "name": "--background" }, { "name": "--color" }, { "name": "--width" }, { "name": "--height" }, { "name": "--min-width" }, { "name": "--min-height" }, { "name": "--font-size" } ], "slots": [ { "description": "content", "name": "" } ], "members": [ { "kind": "field", "name": "closable", "type": { "text": "boolean" }, "default": "false", "description": "Determines whether a close button is displayed for dismissing the toast", "attribute": "closable" }, { "kind": "field", "name": "position", "type": { "text": "Position" }, "default": "'top'", "description": "Specifies the position of the toast relative to its anchor or viewport", "attribute": "position", "reflects": true }, { "kind": "field", "name": "i18n", "description": "Provides internationalization strings for translated text content", "attribute": "i18n" }, { "kind": "field", "name": "status", "type": { "text": "'accent' | 'success' | 'warning' | 'danger'" }, "description": "Defines the visual status type affecting color, icon, and semantic meaning", "attribute": "status", "reflects": true }, { "kind": "field", "name": "popoverConfig", "readonly": true } ], "events": [ { "description": "dispatched when the toast is opened", "name": "open" }, { "description": "dispatched when the toast is closed", "name": "close" } ], "attributes": [ { "name": "closable", "type": { "text": "boolean" }, "default": "false", "description": "Determines whether a close button is displayed for dismissing the toast", "fieldName": "closable" }, { "name": "position", "type": { "text": "Position" }, "default": "'top'", "description": "Specifies the position of the toast relative to its anchor or viewport", "fieldName": "position" }, { "name": "i18n", "description": "Provides internationalization strings for translated text content", "fieldName": "i18n" }, { "name": "status", "type": { "text": "'accent' | 'success' | 'warning' | 'danger'" }, "description": "Defines the visual status type affecting color, icon, and semantic meaning", "fieldName": "status" } ], "mixins": [ { "name": "PopoverMixin", "package": "@blueprintui/components/internals" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "bp-toast", "customElement": true, "summary": "A Toast component is a notification that appears on the screen for a short period of time and provides feedback about an action performed by the user. A Toast should be used for short, non-interruptive notifications that are meant to supplement the current screen.", "metadata": { "since": "1.0.0" }, "commands": [ { "name": "--toggle-popover", "description": "" }, { "name": "--show-popover", "description": "" }, { "name": "--hide-popover", "description": "" } ] } ], "exports": [ { "kind": "js", "name": "BpToast", "declaration": { "name": "BpToast", "module": "toast/element.js" } } ] }, { "kind": "javascript-module", "path": "toast/element.visual.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "toast/index.js", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "toast/element.js" } } ] }, { "kind": "javascript-module", "path": "toggletip/element.css", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "toggletip/element.global.css", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "toggletip/element.js", "declarations": [ { "kind": "class", "description": "```typescript\nimport '@blueprintui/components/include/toggletip.js';\n```\n\n```html\n\n```", "name": "BpToggletip", "cssProperties": [ { "name": "--padding" }, { "name": "--filter" }, { "name": "--background" }, { "name": "--color" }, { "name": "--width" }, { "name": "--height" }, { "name": "--min-width" }, { "name": "--min-height" }, { "name": "--font-size" } ], "slots": [ { "description": "content", "name": "" } ], "members": [ { "kind": "field", "name": "closable", "type": { "text": "boolean" }, "default": "false", "description": "Determines whether a close button is displayed for dismissing the toggletip", "attribute": "closable" }, { "kind": "field", "name": "position", "type": { "text": "Position" }, "default": "'top'", "description": "Specifies the position of the toggletip relative to its anchor element", "attribute": "position", "reflects": true }, { "kind": "field", "name": "i18n", "description": "Provides internationalization strings for translated text content", "attribute": "i18n" }, { "kind": "field", "name": "popoverConfig", "readonly": true } ], "events": [ { "description": "dispatched when the toggletip is opened", "name": "open" }, { "description": "dispatched when the toggletip is closed", "name": "close" } ], "attributes": [ { "name": "closable", "type": { "text": "boolean" }, "default": "false", "description": "Determines whether a close button is displayed for dismissing the toggletip", "fieldName": "closable" }, { "name": "position", "type": { "text": "Position" }, "default": "'top'", "description": "Specifies the position of the toggletip relative to its anchor element", "fieldName": "position" }, { "name": "i18n", "description": "Provides internationalization strings for translated text content", "fieldName": "i18n" } ], "mixins": [ { "name": "PopoverMixin", "package": "@blueprintui/components/internals" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "bp-toggletip", "customElement": true, "summary": "The toggletip component is used to provide explanations, definitions, or supplementary interactions for a given element. It should be used to provide additional information or actions that are not essential to the user's understanding of the content, but that may be helpful or informative.", "metadata": { "since": "1.0.0" }, "commands": [ { "name": "--toggle-popover", "description": "" }, { "name": "--show-popover", "description": "" }, { "name": "--hide-popover", "description": "" } ] } ], "exports": [ { "kind": "js", "name": "BpToggletip", "declaration": { "name": "BpToggletip", "module": "toggletip/element.js" } } ] }, { "kind": "javascript-module", "path": "toggletip/element.visual.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "toggletip/index.js", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "toggletip/element.js" } } ] }, { "kind": "javascript-module", "path": "tooltip/element.css", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "tooltip/element.js", "declarations": [ { "kind": "class", "description": "```typescript\nimport '@blueprintui/components/include/tooltip.js';\n```\n\n```html\n\n```", "name": "BpTooltip", "cssProperties": [ { "name": "--padding" }, { "name": "--filter" }, { "name": "--background" }, { "name": "--color" }, { "name": "--width" }, { "name": "--height" }, { "name": "--min-width" }, { "name": "--min-height" }, { "name": "--font-size" } ], "slots": [ { "description": "content", "name": "" } ], "members": [ { "kind": "field", "name": "closable", "type": { "text": "boolean" }, "default": "false", "description": "Determines whether a close button is displayed for dismissing the tooltip", "attribute": "closable" }, { "kind": "field", "name": "position", "type": { "text": "Position" }, "default": "'top'", "description": "Specifies the position of the tooltip relative to its anchor element", "attribute": "position", "reflects": true }, { "kind": "field", "name": "i18n", "description": "Provides internationalization strings for translated text content", "attribute": "i18n" }, { "kind": "field", "name": "popoverConfig", "readonly": true } ], "events": [ { "description": "dispatched when the tooltip is opened", "name": "open" }, { "description": "dispatched when the tooltip is closed", "name": "close" } ], "attributes": [ { "name": "closable", "type": { "text": "boolean" }, "default": "false", "description": "Determines whether a close button is displayed for dismissing the tooltip", "fieldName": "closable" }, { "name": "position", "type": { "text": "Position" }, "default": "'top'", "description": "Specifies the position of the tooltip relative to its anchor element", "fieldName": "position" }, { "name": "i18n", "description": "Provides internationalization strings for translated text content", "fieldName": "i18n" } ], "mixins": [ { "name": "PopoverMixin", "package": "@blueprintui/components/internals" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "bp-tooltip", "customElement": true, "summary": "The tooltip component is used to provide additional information to the user when they hover over a specific element. It can be used to provide explanations, definitions, or supplementary information that is not critical to the main content.", "metadata": { "since": "1.0.0" }, "commands": [ { "name": "--toggle-popover", "description": "" }, { "name": "--show-popover", "description": "" }, { "name": "--hide-popover", "description": "" } ] } ], "exports": [ { "kind": "js", "name": "BpTooltip", "declaration": { "name": "BpTooltip", "module": "tooltip/element.js" } } ] }, { "kind": "javascript-module", "path": "tooltip/element.visual.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "tooltip/index.js", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "tooltip/element.js" } } ] }, { "kind": "javascript-module", "path": "tree/element.css", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "tree/element.js", "declarations": [ { "kind": "class", "description": "```typescript\nimport '@blueprintui/components/include/tree.js';\n```\n\n```html\n\n```", "name": "BpTree", "cssProperties": [ { "name": "--background" } ], "slots": [ { "description": "tree items", "name": "" } ], "members": [ { "kind": "field", "name": "interaction", "type": { "text": "'auto'" }, "description": "Controls whether the component automatically manages item expansion and selection based on user interactions", "attribute": "interaction", "reflects": true }, { "kind": "field", "name": "selectable", "type": { "text": "'multi' | 'single'" }, "description": "Determines the selection mode for tree items, allowing single or multiple selections", "attribute": "selectable" }, { "kind": "field", "name": "openItems", "privacy": "private", "readonly": true }, { "kind": "field", "name": "#items", "privacy": "private", "readonly": true }, { "kind": "field", "name": "_internals", "type": { "text": "ElementInternals" } }, { "kind": "method", "name": "#slotchange", "privacy": "private" } ], "attributes": [ { "name": "interaction", "type": { "text": "'auto'" }, "description": "Controls whether the component automatically manages item expansion and selection based on user interactions", "fieldName": "interaction" }, { "name": "selectable", "type": { "text": "'multi' | 'single'" }, "description": "Determines the selection mode for tree items, allowing single or multiple selections", "fieldName": "selectable" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "bp-tree", "customElement": true, "summary": "The tree component enables hierarchical data organization, offering a collapsible and expandable tree structure. Users can easily navigate through parent and child nodes, expanding or collapsing branches as needed. The component supports for the highlighting of selected nodes.", "metadata": { "since": "1.0.0" } }, { "kind": "function", "name": "updateSelection", "parameters": [ { "name": "item", "type": { "text": "BpTreeItem" } } ] } ], "exports": [ { "kind": "js", "name": "BpTree", "declaration": { "name": "BpTree", "module": "tree/element.js" } }, { "kind": "js", "name": "updateSelection", "declaration": { "name": "updateSelection", "module": "tree/element.js" } } ] }, { "kind": "javascript-module", "path": "tree/element.visual.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "tree/index.js", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "tree/element.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "tree/item/element.js" } } ] }, { "kind": "javascript-module", "path": "tree/item/element.css", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "tree/item/element.js", "declarations": [ { "kind": "class", "description": "", "name": "BpTreeItem", "cssProperties": [ { "name": "--background" }, { "name": "--padding" }, { "name": "--gap" }, { "name": "--height" }, { "name": "--cursor" } ], "slots": [ { "description": "content", "name": "" } ], "members": [ { "kind": "field", "name": "expanded", "type": { "text": "boolean" }, "description": "indicate if a control is expanded or collapsed", "attribute": "expanded" }, { "kind": "field", "name": "selected", "type": { "text": "boolean" }, "default": "false", "description": "selected visual state", "attribute": "selected" }, { "kind": "field", "name": "indeterminate", "type": { "text": "boolean" }, "default": "false", "description": "determines if node has some selected child nodes", "attribute": "indeterminate" }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "description": "determines if element is mutable or focusable", "attribute": "disabled" }, { "kind": "field", "name": "readonly", "type": { "text": "boolean" }, "description": "makes the element not mutable, meaning the user can not interact with button", "attribute": "readonly" }, { "kind": "field", "name": "selectable", "type": { "text": "'multi' | 'single'" }, "privacy": "private", "attribute": "selectable", "reflects": true }, { "kind": "field", "name": "interaction", "type": { "text": "'auto'" }, "privacy": "private" }, { "kind": "field", "name": "#items", "privacy": "private", "readonly": true }, { "kind": "field", "name": "_internals", "type": { "text": "ElementInternals" } }, { "kind": "field", "name": "interactionExpandController", "type": { "text": "InteractionExpandController" }, "privacy": "private" }, { "kind": "field", "name": "interactionSelectController", "type": { "text": "InteractionSelectController" }, "privacy": "private" }, { "kind": "method", "name": "#stopEvent", "privacy": "private", "parameters": [ { "name": "e", "type": { "text": "Event" } } ] }, { "kind": "method", "name": "#toggleExpand", "privacy": "private", "parameters": [ { "name": "e", "type": { "text": "Event" } } ] } ], "attributes": [ { "name": "expanded", "type": { "text": "boolean" }, "description": "indicate if a control is expanded or collapsed", "fieldName": "expanded" }, { "name": "selected", "type": { "text": "boolean" }, "default": "false", "description": "selected visual state", "fieldName": "selected" }, { "name": "indeterminate", "type": { "text": "boolean" }, "default": "false", "description": "determines if node has some selected child nodes", "fieldName": "indeterminate" }, { "name": "disabled", "type": { "text": "boolean" }, "description": "determines if element is mutable or focusable", "fieldName": "disabled" }, { "name": "readonly", "type": { "text": "boolean" }, "description": "makes the element not mutable, meaning the user can not interact with button", "fieldName": "readonly" }, { "name": "selectable", "type": { "text": "'multi' | 'single'" }, "fieldName": "selectable" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "bp-tree-item", "customElement": true, "metadata": { "since": "1.0.0" }, "commands": [ { "name": "--toggle", "description": "toggle the tree node" }, { "name": "--open", "description": "open the tree node" }, { "name": "--close", "description": "close the tree node" } ] } ], "exports": [ { "kind": "js", "name": "BpTreeItem", "declaration": { "name": "BpTreeItem", "module": "tree/item/element.js" } } ] } ] }