{ "schemaVersion": "1.0.0", "readme": "", "modules": [ { "kind": "javascript-module", "path": "src/components/alert/alert-base.ts", "declarations": [ { "kind": "class", "description": "", "name": "AlertBase", "members": [ { "kind": "field", "name": "open", "type": { "text": "boolean" }, "default": "false", "description": "Indicates whether or not the alert is open. You can use this in lieu of the show/hide methods.", "attribute": "open" }, { "kind": "field", "name": "closable", "type": { "text": "boolean" }, "default": "false", "description": "Makes the alert closable.", "attribute": "closable" }, { "kind": "field", "name": "duration", "default": "Infinity", "description": "The length of time, in milliseconds, the alert will show before closing itself. If the user interacts with the alert before it closes (e.g. moves the mouse over it), the timer will restart. Defaults to Infinity.", "attribute": "duration" }, { "kind": "field", "name": "color", "type": { "text": "| 'primary'\n | 'secondary'\n | 'success'\n | 'warning'\n | 'info'\n | 'error'\n | string" }, "default": "'primary'", "description": "Sets the button color as one of the color variants.", "attribute": "color" }, { "kind": "method", "name": "emitShowHandler" }, { "kind": "method", "name": "emitAfterShowHandler" }, { "kind": "method", "name": "emitHideHandler" }, { "kind": "method", "name": "emitAfterHideHandler" }, { "kind": "method", "name": "getRenderClasses" }, { "kind": "method", "name": "show", "description": "Shows the alert." }, { "kind": "method", "name": "hide", "description": "Hides the alert" }, { "kind": "method", "name": "toast", "return": { "type": { "text": "Promise" } }, "description": "Displays the alert as a toast notification. This will move the alert out of its position in the DOM and, when\ndismissed, it will be removed from the DOM completely. By storing a reference to the alert, you can reuse it by\ncalling this method again. The returned promise will resolve after the alert is hidden." } ], "attributes": [ { "name": "open", "type": { "text": "boolean" }, "default": "false", "description": "Indicates whether or not the alert is open. You can use this in lieu of the show/hide methods.", "fieldName": "open" }, { "name": "closable", "type": { "text": "boolean" }, "default": "false", "description": "Makes the alert closable.", "fieldName": "closable" }, { "name": "duration", "default": "Infinity", "description": "The length of time, in milliseconds, the alert will show before closing itself. If the user interacts with the alert before it closes (e.g. moves the mouse over it), the timer will restart. Defaults to Infinity.", "resolveInitializer": { "module": "src/components/alert/alert-base.ts" }, "fieldName": "duration" }, { "name": "color", "type": { "text": "| 'primary'\n | 'secondary'\n | 'success'\n | 'warning'\n | 'info'\n | 'error'\n | string" }, "default": "'primary'", "description": "Sets the button color as one of the color variants.", "fieldName": "color" } ], "superclass": { "name": "SlAlert", "package": "@shoelace-style/shoelace/dist/components/alert/alert" } } ], "exports": [ { "kind": "js", "name": "AlertBase", "declaration": { "name": "AlertBase", "module": "src/components/alert/alert-base.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/alert/alert.ts", "declarations": [ { "kind": "class", "description": "", "name": "Alert", "slots": [ { "description": "The alert's content.", "name": "" }, { "description": "-\tAn icon to show in the alert.", "name": "icon" } ], "members": [ { "kind": "field", "name": "open", "type": { "text": "boolean" }, "default": "false", "description": "Indicates whether or not the alert is open. You can use this in lieu of the show/hide methods.", "attribute": "open", "inheritedFrom": { "name": "AlertBase", "module": "src/components/alert/alert-base.ts" } }, { "kind": "field", "name": "closable", "type": { "text": "boolean" }, "default": "false", "description": "Makes the alert closable.", "attribute": "closable", "inheritedFrom": { "name": "AlertBase", "module": "src/components/alert/alert-base.ts" } }, { "kind": "field", "name": "duration", "default": "Infinity", "description": "The length of time, in milliseconds, the alert will show before closing itself. If the user interacts with the alert before it closes (e.g. moves the mouse over it), the timer will restart. Defaults to Infinity.", "attribute": "duration", "inheritedFrom": { "name": "AlertBase", "module": "src/components/alert/alert-base.ts" } }, { "kind": "field", "name": "color", "type": { "text": "| 'primary'\n | 'secondary'\n | 'success'\n | 'warning'\n | 'info'\n | 'error'\n | string" }, "default": "'primary'", "description": "Sets the button color as one of the color variants.", "attribute": "color", "inheritedFrom": { "name": "AlertBase", "module": "src/components/alert/alert-base.ts" } }, { "kind": "method", "name": "emitShowHandler", "inheritedFrom": { "name": "AlertBase", "module": "src/components/alert/alert-base.ts" } }, { "kind": "method", "name": "emitAfterShowHandler", "inheritedFrom": { "name": "AlertBase", "module": "src/components/alert/alert-base.ts" } }, { "kind": "method", "name": "emitHideHandler", "inheritedFrom": { "name": "AlertBase", "module": "src/components/alert/alert-base.ts" } }, { "kind": "method", "name": "emitAfterHideHandler", "inheritedFrom": { "name": "AlertBase", "module": "src/components/alert/alert-base.ts" } }, { "kind": "method", "name": "getRenderClasses", "inheritedFrom": { "name": "AlertBase", "module": "src/components/alert/alert-base.ts" } }, { "kind": "method", "name": "show", "description": "Shows the alert.", "inheritedFrom": { "name": "AlertBase", "module": "src/components/alert/alert-base.ts" } }, { "kind": "method", "name": "hide", "description": "Hides the alert", "inheritedFrom": { "name": "AlertBase", "module": "src/components/alert/alert-base.ts" } }, { "kind": "method", "name": "toast", "return": { "type": { "text": "Promise" } }, "description": "Displays the alert as a toast notification. This will move the alert out of its position in the DOM and, when\ndismissed, it will be removed from the DOM completely. By storing a reference to the alert, you can reuse it by\ncalling this method again. The returned promise will resolve after the alert is hidden.", "inheritedFrom": { "name": "AlertBase", "module": "src/components/alert/alert-base.ts" } } ], "events": [ { "description": "Emitted when the alert opens.", "name": "bp-alert-show", "reactName": "onBpAlertShow" }, { "description": "Emitted after the alert opens and all animations are complete.", "name": "bp-alert-after-show", "reactName": "onBpAlertAfterShow" }, { "description": "Emitted when the alert closes.", "name": "bp-alert-hide", "reactName": "onBpAlertHide" }, { "description": "Emitted after the alert closes and all animations are complete.", "name": "bp-alert-after-hide", "reactName": "onBpAlertAfterHide" } ], "superclass": { "name": "AlertBase", "module": "/src/components/alert/alert-base.js" }, "since": "0.1.1-beta.1", "status": "beta", "dependencies": [ "bp-icon" ], "tagName": "bp-alert", "customElement": true, "attributes": [ { "name": "open", "type": { "text": "boolean" }, "default": "false", "description": "Indicates whether or not the alert is open. You can use this in lieu of the show/hide methods.", "fieldName": "open", "inheritedFrom": { "name": "AlertBase", "module": "src/components/alert/alert-base.ts" } }, { "name": "closable", "type": { "text": "boolean" }, "default": "false", "description": "Makes the alert closable.", "fieldName": "closable", "inheritedFrom": { "name": "AlertBase", "module": "src/components/alert/alert-base.ts" } }, { "name": "duration", "default": "Infinity", "description": "The length of time, in milliseconds, the alert will show before closing itself. If the user interacts with the alert before it closes (e.g. moves the mouse over it), the timer will restart. Defaults to Infinity.", "resolveInitializer": { "module": "src/components/alert/alert-base.ts" }, "fieldName": "duration", "inheritedFrom": { "name": "AlertBase", "module": "src/components/alert/alert-base.ts" } }, { "name": "color", "type": { "text": "| 'primary'\n | 'secondary'\n | 'success'\n | 'warning'\n | 'info'\n | 'error'\n | string" }, "default": "'primary'", "description": "Sets the button color as one of the color variants.", "fieldName": "color", "inheritedFrom": { "name": "AlertBase", "module": "src/components/alert/alert-base.ts" } } ] } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "Alert", "module": "src/components/alert/alert.ts" } }, { "kind": "custom-element-definition", "name": "bp-alert", "declaration": { "name": "Alert", "module": "src/components/alert/alert.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/autocomplete/autocomplete-base.ts", "declarations": [ { "kind": "class", "description": "", "name": "AutocompleteBase", "members": [ { "kind": "field", "name": "items", "type": { "text": "Items" }, "default": "[]", "description": "Items to be used in the autocomplete.", "attribute": "items" }, { "kind": "field", "name": "value", "type": { "text": "number" }, "default": "-1", "description": "The autocomplete's value - holds the selected item's index.", "attribute": "value" }, { "kind": "field", "name": "inputValue", "type": { "text": "string" }, "default": "''", "description": "The textfield's value. Independant from the autocomplete's value.", "attribute": "input-value" }, { "kind": "field", "name": "hideActionsOnResults", "type": { "text": "boolean" }, "default": "false", "description": "If true, will show action buttons only when there are results.", "attribute": "hide-actions-on-results" }, { "kind": "field", "name": "textfieldWidth", "type": { "text": "string" }, "default": "'250px'", "description": "The width of the textfield.", "attribute": "textfield-width" }, { "kind": "field", "name": "listWidth", "type": { "text": "string" }, "default": "''", "description": "The width of the list - defaults to textfield width, if not set.", "attribute": "list-width" }, { "kind": "field", "name": "dropdownPosition", "type": { "text": "Placement" }, "default": "'bottom-start'", "description": "The placement of the list's dropdown.", "attribute": "dropdown-position" }, { "kind": "field", "name": "maxHeight", "type": { "text": "string" }, "default": "'304px'", "description": "Maximum aheight of the list dropdown, before the container overflows. Defaults to fit 6 bp-list-items without overflowing.", "attribute": "max-height" }, { "kind": "field", "name": "highlightFirstItem", "type": { "text": "boolean" }, "default": "false", "description": "Will always highlight the first item if true.", "attribute": "highlight-first-item" }, { "kind": "field", "name": "clearInputAfterSelection", "type": { "text": "boolean" }, "default": "false", "description": "If true, clears the input textfield after an item is selected.", "attribute": "clear-input-after-selection" }, { "kind": "field", "name": "minQueryLength", "type": { "text": "number" }, "default": "0", "description": "The length of the query string required to do a search.", "attribute": "min-query-length" }, { "kind": "field", "name": "type", "type": { "text": "TextFieldType" }, "default": "'text'", "description": "A string specifying the type of control to render.", "attribute": "type" }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "Sets floating label value.", "attribute": "label" }, { "kind": "field", "name": "placeholder", "type": { "text": "string" }, "default": "''", "description": "Sets disappearing input placeholder.", "attribute": "placeholder" }, { "kind": "field", "name": "prefix", "type": { "text": "string" }, "default": "''", "description": "Prefix text to display before the input.", "attribute": "prefix" }, { "kind": "field", "name": "suffix", "type": { "text": "string" }, "default": "''", "description": "Suffix text to display after the input.", "attribute": "suffix" }, { "kind": "field", "name": "icon", "type": { "text": "string" }, "default": "''", "description": "Leading icon to display in input. See bp-icon.", "attribute": "icon" }, { "kind": "field", "name": "iconTrailing", "type": { "text": "string" }, "default": "''", "description": "Trailing icon to display in input. See bp-icon.", "attribute": "iconTrailing" }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Whether or not the input should be disabled.", "attribute": "disabled" }, { "kind": "field", "name": "required", "type": { "text": "boolean" }, "default": "false", "description": "Displays error state if value is empty and input is blurred.", "attribute": "required" }, { "kind": "field", "name": "maxLength", "type": { "text": "number" }, "default": "-1", "description": "Maximum length to accept input.", "attribute": "maxLength" }, { "kind": "field", "name": "outlined", "type": { "text": "boolean" }, "default": "false", "description": "Whether or not to show the material outlined variant.", "attribute": "outlined" }, { "kind": "field", "name": "validationMessage", "type": { "text": "string" }, "default": "''", "description": "HTMLInputElement.prototype.pattern (empty string will unset attribute)", "attribute": "validationMessage" }, { "kind": "field", "name": "size", "type": { "text": "number | null" }, "default": "null", "description": "HTMLInputElement.prototype.size (null will unset attribute)", "attribute": "size" }, { "kind": "field", "name": "name", "type": { "text": "string" }, "default": "''", "description": "HTMLInputElement.prototype.name", "attribute": "name" }, { "kind": "field", "name": "inputEllipsis", "type": { "text": "boolean" }, "default": "false", "description": "Whether to show ellipsis on input field or not.", "attribute": "input-ellipsis" }, { "kind": "field", "name": "defaultValue", "type": { "text": "number" }, "default": "-1" }, { "kind": "field", "name": "displayedItems", "type": { "text": "Items" }, "default": "[]" }, { "kind": "field", "name": "textfield", "type": { "text": "Textfield" } }, { "kind": "field", "name": "list", "type": { "text": "List" } }, { "kind": "field", "name": "listContainer", "type": { "text": "HTMLDivElement" } }, { "kind": "field", "name": "displayedItemsElements", "type": { "text": "HTMLElementWithValueAndActivated[]" }, "default": "[]" }, { "kind": "field", "name": "loading", "type": { "text": "boolean" }, "default": "false" }, { "kind": "field", "name": "activeIndex", "type": { "text": "number" }, "default": "-1" }, { "kind": "field", "name": "showActionSlot", "type": { "text": "boolean" }, "default": "false" }, { "kind": "field", "name": "formSubmitController", "type": { "text": "FormSubmitController" }, "default": "new FormSubmitController(this, {\n setValue: async (control: AutocompleteBase) => {\n if (typeof this.items[0] === 'string') {\n this.inputValue = this.items[control.defaultValue] as string;\n } else {\n const item = this.items[control.defaultValue] as ItemObject;\n this.inputValue = item.label;\n }\n control.value = control.defaultValue;\n await control.updateComplete;\n control.hideList();\n },\n })" }, { "kind": "method", "name": "checkComposedPath", "parameters": [ { "name": "e", "type": { "text": "MouseEvent" } } ] }, { "kind": "method", "name": "setItems", "privacy": "public", "parameters": [ { "name": "items", "type": { "text": "Items" } } ], "description": "Sets the items." }, { "kind": "method", "name": "setSearchFunction", "privacy": "public", "parameters": [ { "name": "newFunction", "type": { "text": "(\n query: string,\n items: Item[]\n ) => Promise" } } ], "description": "Overrides the search function." }, { "kind": "method", "name": "setRenderItem", "privacy": "public", "parameters": [ { "name": "newFunction", "type": { "text": "(\n item: Item,\n index: number,\n activated: boolean\n ) => TemplateResult<1>" } } ], "description": "Overrides the renderer for each item." }, { "kind": "method", "name": "forceRequery", "privacy": "public", "parameters": [ { "name": "query", "default": "this.inputValue" } ] }, { "kind": "method", "name": "showList", "privacy": "public", "description": "Shows the list of results." }, { "kind": "method", "name": "hideList", "privacy": "public", "description": "Hides the list of results." }, { "kind": "method", "name": "focus", "privacy": "public", "description": "Focuses the textfield of the autocomplete." }, { "kind": "method", "name": "blur", "privacy": "public", "description": "Blurs the focus of the textfield." }, { "kind": "method", "name": "clear", "privacy": "public", "description": "Clears the inputValue, value and all items of the autocomplete." }, { "kind": "method", "name": "selectItem", "privacy": "public", "parameters": [ { "name": "index", "type": { "text": "number" } } ], "description": "Selects an item by index." }, { "kind": "method", "name": "activateFirstItem", "privacy": "public", "description": "Activates the first item." }, { "kind": "method", "name": "activatePreviousItem", "privacy": "public", "description": "Activates the previous item." }, { "kind": "method", "name": "activateNextItem", "privacy": "public", "description": "Activates the next item." }, { "kind": "method", "name": "selectActivatedItem", "privacy": "public", "description": "Selects the activated item." }, { "kind": "method", "name": "computeListPosition", "privacy": "public", "description": "Refreshes the position of the list's dropdown." }, { "kind": "method", "name": "searchFunction", "privacy": "public", "parameters": [ { "name": "query", "type": { "text": "string" } }, { "name": "items", "type": { "text": "Item[]" } } ], "description": "The search function, that can be overriden." }, { "kind": "method", "name": "renderItem", "privacy": "public", "parameters": [ { "name": "item", "type": { "text": "Item" } }, { "name": "index", "type": { "text": "number" } }, { "name": "activated", "type": { "text": "boolean" } } ], "description": "Renderer for each item." }, { "kind": "method", "name": "findItemIndexByLabel", "privacy": "public", "return": { "type": { "text": "number" } }, "parameters": [ { "name": "label", "type": { "text": "string" } } ], "description": "Gets the index of the item by the label if items are objects or a string, if items are strings." }, { "kind": "method", "name": "deactivateAllItems", "privacy": "public", "description": "Deactivates all items." }, { "kind": "method", "name": "scrollActiveItemIntoView", "privacy": "public", "description": "Scrolls current activated item into view." }, { "kind": "method", "name": "getcurrentDisplayedItemIndex", "privacy": "public", "parameters": [ { "name": "itemElements", "type": { "text": "HTMLElementWithValueAndActivated[]" } } ], "description": "Gets the activated item's relative index in an array of list item Elements." }, { "kind": "method", "name": "getListItems", "privacy": "public", "description": "Gets the currently displayed list item HTML elements." }, { "kind": "method", "name": "emitChanged", "privacy": "protected", "parameters": [ { "name": "query", "type": { "text": "string" } } ] }, { "kind": "method", "name": "emitSelected", "privacy": "protected", "parameters": [ { "name": "item", "type": { "text": "Item" } }, { "name": "index", "type": { "text": "number" } } ] }, { "kind": "method", "name": "findStringItemIndex", "privacy": "protected", "parameters": [ { "name": "item", "type": { "text": "Item" } } ] }, { "kind": "method", "name": "findObjectItemIndex", "privacy": "protected", "parameters": [ { "name": "_item", "type": { "text": "Item" } } ] }, { "kind": "method", "name": "getItemLabel", "privacy": "protected", "return": { "type": { "text": "string" } }, "parameters": [ { "name": "item", "type": { "text": "Item" } } ] }, { "kind": "method", "name": "searchList", "privacy": "protected", "parameters": [ { "name": "query", "type": { "text": "string" } } ] }, { "kind": "method", "name": "handleFocus", "privacy": "protected" }, { "kind": "method", "name": "handleInput", "privacy": "protected", "parameters": [ { "name": "e", "type": { "text": "InputEvent" } } ] }, { "kind": "method", "name": "handleKeydown", "privacy": "protected", "parameters": [ { "name": "e", "type": { "text": "KeyboardEvent" } } ] }, { "kind": "method", "name": "handleListSelected", "privacy": "protected", "parameters": [ { "name": "e", "type": { "text": "CustomEvent<{index: number}>" } } ] }, { "kind": "method", "name": "renderActionSlot", "privacy": "protected" }, { "kind": "method", "name": "renderResults", "privacy": "protected" } ], "attributes": [ { "name": "items", "type": { "text": "Items" }, "default": "[]", "description": "Items to be used in the autocomplete.", "fieldName": "items" }, { "name": "value", "type": { "text": "number" }, "default": "-1", "description": "The autocomplete's value - holds the selected item's index.", "fieldName": "value" }, { "name": "input-value", "type": { "text": "string" }, "default": "''", "description": "The textfield's value. Independant from the autocomplete's value.", "fieldName": "inputValue" }, { "name": "hide-actions-on-results", "type": { "text": "boolean" }, "default": "false", "description": "If true, will show action buttons only when there are results.", "fieldName": "hideActionsOnResults" }, { "name": "textfield-width", "type": { "text": "string" }, "default": "'250px'", "description": "The width of the textfield.", "fieldName": "textfieldWidth" }, { "name": "list-width", "type": { "text": "string" }, "default": "''", "description": "The width of the list - defaults to textfield width, if not set.", "fieldName": "listWidth" }, { "name": "dropdown-position", "type": { "text": "Placement" }, "default": "'bottom-start'", "description": "The placement of the list's dropdown.", "fieldName": "dropdownPosition" }, { "name": "max-height", "type": { "text": "string" }, "default": "'304px'", "description": "Maximum aheight of the list dropdown, before the container overflows. Defaults to fit 6 bp-list-items without overflowing.", "fieldName": "maxHeight" }, { "name": "highlight-first-item", "type": { "text": "boolean" }, "default": "false", "description": "Will always highlight the first item if true.", "fieldName": "highlightFirstItem" }, { "name": "clear-input-after-selection", "type": { "text": "boolean" }, "default": "false", "description": "If true, clears the input textfield after an item is selected.", "fieldName": "clearInputAfterSelection" }, { "name": "min-query-length", "type": { "text": "number" }, "default": "0", "description": "The length of the query string required to do a search.", "fieldName": "minQueryLength" }, { "name": "type", "type": { "text": "TextFieldType" }, "default": "'text'", "description": "A string specifying the type of control to render.", "fieldName": "type" }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "Sets floating label value.", "fieldName": "label" }, { "name": "placeholder", "type": { "text": "string" }, "default": "''", "description": "Sets disappearing input placeholder.", "fieldName": "placeholder" }, { "name": "prefix", "type": { "text": "string" }, "default": "''", "description": "Prefix text to display before the input.", "fieldName": "prefix" }, { "name": "suffix", "type": { "text": "string" }, "default": "''", "description": "Suffix text to display after the input.", "fieldName": "suffix" }, { "name": "icon", "type": { "text": "string" }, "default": "''", "description": "Leading icon to display in input. See bp-icon.", "fieldName": "icon" }, { "name": "iconTrailing", "type": { "text": "string" }, "default": "''", "description": "Trailing icon to display in input. See bp-icon.", "fieldName": "iconTrailing" }, { "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Whether or not the input should be disabled.", "fieldName": "disabled" }, { "name": "required", "type": { "text": "boolean" }, "default": "false", "description": "Displays error state if value is empty and input is blurred.", "fieldName": "required" }, { "name": "maxLength", "type": { "text": "number" }, "default": "-1", "description": "Maximum length to accept input.", "fieldName": "maxLength" }, { "name": "outlined", "type": { "text": "boolean" }, "default": "false", "description": "Whether or not to show the material outlined variant.", "fieldName": "outlined" }, { "name": "validationMessage", "type": { "text": "string" }, "default": "''", "description": "HTMLInputElement.prototype.pattern (empty string will unset attribute)", "fieldName": "validationMessage" }, { "name": "size", "type": { "text": "number | null" }, "default": "null", "description": "HTMLInputElement.prototype.size (null will unset attribute)", "fieldName": "size" }, { "name": "name", "type": { "text": "string" }, "default": "''", "description": "HTMLInputElement.prototype.name", "fieldName": "name" }, { "name": "input-ellipsis", "type": { "text": "boolean" }, "default": "false", "description": "Whether to show ellipsis on input field or not.", "fieldName": "inputEllipsis" } ], "superclass": { "name": "LitElement", "package": "lit" }, "customElement": true } ], "exports": [ { "kind": "js", "name": "AutocompleteBase", "declaration": { "name": "AutocompleteBase", "module": "src/components/autocomplete/autocomplete-base.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/autocomplete/autocomplete.ts", "declarations": [ { "kind": "class", "description": "", "name": "Autocomplete", "members": [ { "kind": "field", "name": "items", "type": { "text": "Items" }, "default": "[]", "description": "Items to be used in the autocomplete.", "attribute": "items", "inheritedFrom": { "name": "AutocompleteBase", "module": "src/components/autocomplete/autocomplete-base.ts" } }, { "kind": "field", "name": "value", "type": { "text": "number" }, "default": "-1", "description": "The autocomplete's value - holds the selected item's index.", "attribute": "value", "inheritedFrom": { "name": "AutocompleteBase", "module": "src/components/autocomplete/autocomplete-base.ts" } }, { "kind": "field", "name": "inputValue", "type": { "text": "string" }, "default": "''", "description": "The textfield's value. Independant from the autocomplete's value.", "attribute": "input-value", "inheritedFrom": { "name": "AutocompleteBase", "module": "src/components/autocomplete/autocomplete-base.ts" } }, { "kind": "field", "name": "hideActionsOnResults", "type": { "text": "boolean" }, "default": "false", "description": "If true, will show action buttons only when there are results.", "attribute": "hide-actions-on-results", "inheritedFrom": { "name": "AutocompleteBase", "module": "src/components/autocomplete/autocomplete-base.ts" } }, { "kind": "field", "name": "textfieldWidth", "type": { "text": "string" }, "default": "'250px'", "description": "The width of the textfield.", "attribute": "textfield-width", "inheritedFrom": { "name": "AutocompleteBase", "module": "src/components/autocomplete/autocomplete-base.ts" } }, { "kind": "field", "name": "listWidth", "type": { "text": "string" }, "default": "''", "description": "The width of the list - defaults to textfield width, if not set.", "attribute": "list-width", "inheritedFrom": { "name": "AutocompleteBase", "module": "src/components/autocomplete/autocomplete-base.ts" } }, { "kind": "field", "name": "dropdownPosition", "type": { "text": "Placement" }, "default": "'bottom-start'", "description": "The placement of the list's dropdown.", "attribute": "dropdown-position", "inheritedFrom": { "name": "AutocompleteBase", "module": "src/components/autocomplete/autocomplete-base.ts" } }, { "kind": "field", "name": "maxHeight", "type": { "text": "string" }, "default": "'304px'", "description": "Maximum aheight of the list dropdown, before the container overflows. Defaults to fit 6 bp-list-items without overflowing.", "attribute": "max-height", "inheritedFrom": { "name": "AutocompleteBase", "module": "src/components/autocomplete/autocomplete-base.ts" } }, { "kind": "field", "name": "highlightFirstItem", "type": { "text": "boolean" }, "default": "false", "description": "Will always highlight the first item if true.", "attribute": "highlight-first-item", "inheritedFrom": { "name": "AutocompleteBase", "module": "src/components/autocomplete/autocomplete-base.ts" } }, { "kind": "field", "name": "clearInputAfterSelection", "type": { "text": "boolean" }, "default": "false", "description": "If true, clears the input textfield after an item is selected.", "attribute": "clear-input-after-selection", "inheritedFrom": { "name": "AutocompleteBase", "module": "src/components/autocomplete/autocomplete-base.ts" } }, { "kind": "field", "name": "minQueryLength", "type": { "text": "number" }, "default": "0", "description": "The length of the query string required to do a search.", "attribute": "min-query-length", "inheritedFrom": { "name": "AutocompleteBase", "module": "src/components/autocomplete/autocomplete-base.ts" } }, { "kind": "field", "name": "type", "type": { "text": "TextFieldType" }, "default": "'text'", "description": "A string specifying the type of control to render.", "attribute": "type", "inheritedFrom": { "name": "AutocompleteBase", "module": "src/components/autocomplete/autocomplete-base.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "Sets floating label value.", "attribute": "label", "inheritedFrom": { "name": "AutocompleteBase", "module": "src/components/autocomplete/autocomplete-base.ts" } }, { "kind": "field", "name": "placeholder", "type": { "text": "string" }, "default": "''", "description": "Sets disappearing input placeholder.", "attribute": "placeholder", "inheritedFrom": { "name": "AutocompleteBase", "module": "src/components/autocomplete/autocomplete-base.ts" } }, { "kind": "field", "name": "prefix", "type": { "text": "string" }, "default": "''", "description": "Prefix text to display before the input.", "attribute": "prefix", "inheritedFrom": { "name": "AutocompleteBase", "module": "src/components/autocomplete/autocomplete-base.ts" } }, { "kind": "field", "name": "suffix", "type": { "text": "string" }, "default": "''", "description": "Suffix text to display after the input.", "attribute": "suffix", "inheritedFrom": { "name": "AutocompleteBase", "module": "src/components/autocomplete/autocomplete-base.ts" } }, { "kind": "field", "name": "icon", "type": { "text": "string" }, "default": "''", "description": "Leading icon to display in input. See bp-icon.", "attribute": "icon", "inheritedFrom": { "name": "AutocompleteBase", "module": "src/components/autocomplete/autocomplete-base.ts" } }, { "kind": "field", "name": "iconTrailing", "type": { "text": "string" }, "default": "''", "description": "Trailing icon to display in input. See bp-icon.", "attribute": "iconTrailing", "inheritedFrom": { "name": "AutocompleteBase", "module": "src/components/autocomplete/autocomplete-base.ts" } }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Whether or not the input should be disabled.", "attribute": "disabled", "inheritedFrom": { "name": "AutocompleteBase", "module": "src/components/autocomplete/autocomplete-base.ts" } }, { "kind": "field", "name": "required", "type": { "text": "boolean" }, "default": "false", "description": "Displays error state if value is empty and input is blurred.", "attribute": "required", "inheritedFrom": { "name": "AutocompleteBase", "module": "src/components/autocomplete/autocomplete-base.ts" } }, { "kind": "field", "name": "maxLength", "type": { "text": "number" }, "default": "-1", "description": "Maximum length to accept input.", "attribute": "maxLength", "inheritedFrom": { "name": "AutocompleteBase", "module": "src/components/autocomplete/autocomplete-base.ts" } }, { "kind": "field", "name": "outlined", "type": { "text": "boolean" }, "default": "false", "description": "Whether or not to show the material outlined variant.", "attribute": "outlined", "inheritedFrom": { "name": "AutocompleteBase", "module": "src/components/autocomplete/autocomplete-base.ts" } }, { "kind": "field", "name": "validationMessage", "type": { "text": "string" }, "default": "''", "description": "HTMLInputElement.prototype.pattern (empty string will unset attribute)", "attribute": "validationMessage", "inheritedFrom": { "name": "AutocompleteBase", "module": "src/components/autocomplete/autocomplete-base.ts" } }, { "kind": "field", "name": "size", "type": { "text": "number | null" }, "default": "null", "description": "HTMLInputElement.prototype.size (null will unset attribute)", "attribute": "size", "inheritedFrom": { "name": "AutocompleteBase", "module": "src/components/autocomplete/autocomplete-base.ts" } }, { "kind": "field", "name": "name", "type": { "text": "string" }, "default": "''", "description": "HTMLInputElement.prototype.name", "attribute": "name", "inheritedFrom": { "name": "AutocompleteBase", "module": "src/components/autocomplete/autocomplete-base.ts" } }, { "kind": "field", "name": "inputEllipsis", "type": { "text": "boolean" }, "default": "false", "description": "Whether to show ellipsis on input field or not.", "attribute": "input-ellipsis", "inheritedFrom": { "name": "AutocompleteBase", "module": "src/components/autocomplete/autocomplete-base.ts" } }, { "kind": "field", "name": "defaultValue", "type": { "text": "number" }, "default": "-1", "inheritedFrom": { "name": "AutocompleteBase", "module": "src/components/autocomplete/autocomplete-base.ts" } }, { "kind": "field", "name": "displayedItems", "type": { "text": "Items" }, "default": "[]", "inheritedFrom": { "name": "AutocompleteBase", "module": "src/components/autocomplete/autocomplete-base.ts" } }, { "kind": "field", "name": "textfield", "type": { "text": "Textfield" }, "inheritedFrom": { "name": "AutocompleteBase", "module": "src/components/autocomplete/autocomplete-base.ts" } }, { "kind": "field", "name": "list", "type": { "text": "List" }, "inheritedFrom": { "name": "AutocompleteBase", "module": "src/components/autocomplete/autocomplete-base.ts" } }, { "kind": "field", "name": "listContainer", "type": { "text": "HTMLDivElement" }, "inheritedFrom": { "name": "AutocompleteBase", "module": "src/components/autocomplete/autocomplete-base.ts" } }, { "kind": "field", "name": "displayedItemsElements", "type": { "text": "HTMLElementWithValueAndActivated[]" }, "default": "[]", "inheritedFrom": { "name": "AutocompleteBase", "module": "src/components/autocomplete/autocomplete-base.ts" } }, { "kind": "field", "name": "loading", "type": { "text": "boolean" }, "default": "false", "inheritedFrom": { "name": "AutocompleteBase", "module": "src/components/autocomplete/autocomplete-base.ts" } }, { "kind": "field", "name": "activeIndex", "type": { "text": "number" }, "default": "-1", "inheritedFrom": { "name": "AutocompleteBase", "module": "src/components/autocomplete/autocomplete-base.ts" } }, { "kind": "field", "name": "showActionSlot", "type": { "text": "boolean" }, "default": "false", "inheritedFrom": { "name": "AutocompleteBase", "module": "src/components/autocomplete/autocomplete-base.ts" } }, { "kind": "field", "name": "formSubmitController", "type": { "text": "FormSubmitController" }, "default": "new FormSubmitController(this, {\n setValue: async (control: AutocompleteBase) => {\n if (typeof this.items[0] === 'string') {\n this.inputValue = this.items[control.defaultValue] as string;\n } else {\n const item = this.items[control.defaultValue] as ItemObject;\n this.inputValue = item.label;\n }\n control.value = control.defaultValue;\n await control.updateComplete;\n control.hideList();\n },\n })", "inheritedFrom": { "name": "AutocompleteBase", "module": "src/components/autocomplete/autocomplete-base.ts" } }, { "kind": "method", "name": "checkComposedPath", "parameters": [ { "name": "e", "type": { "text": "MouseEvent" } } ], "inheritedFrom": { "name": "AutocompleteBase", "module": "src/components/autocomplete/autocomplete-base.ts" } }, { "kind": "method", "name": "setItems", "privacy": "public", "parameters": [ { "name": "items", "type": { "text": "Items" } } ], "description": "Sets the items.", "inheritedFrom": { "name": "AutocompleteBase", "module": "src/components/autocomplete/autocomplete-base.ts" } }, { "kind": "method", "name": "setSearchFunction", "privacy": "public", "parameters": [ { "name": "newFunction", "type": { "text": "(\n query: string,\n items: Item[]\n ) => Promise" } } ], "description": "Overrides the search function.", "inheritedFrom": { "name": "AutocompleteBase", "module": "src/components/autocomplete/autocomplete-base.ts" } }, { "kind": "method", "name": "setRenderItem", "privacy": "public", "parameters": [ { "name": "newFunction", "type": { "text": "(\n item: Item,\n index: number,\n activated: boolean\n ) => TemplateResult<1>" } } ], "description": "Overrides the renderer for each item.", "inheritedFrom": { "name": "AutocompleteBase", "module": "src/components/autocomplete/autocomplete-base.ts" } }, { "kind": "method", "name": "forceRequery", "privacy": "public", "parameters": [ { "name": "query", "default": "this.inputValue" } ], "inheritedFrom": { "name": "AutocompleteBase", "module": "src/components/autocomplete/autocomplete-base.ts" } }, { "kind": "method", "name": "showList", "privacy": "public", "description": "Shows the list of results.", "inheritedFrom": { "name": "AutocompleteBase", "module": "src/components/autocomplete/autocomplete-base.ts" } }, { "kind": "method", "name": "hideList", "privacy": "public", "description": "Hides the list of results.", "inheritedFrom": { "name": "AutocompleteBase", "module": "src/components/autocomplete/autocomplete-base.ts" } }, { "kind": "method", "name": "focus", "privacy": "public", "description": "Focuses the textfield of the autocomplete.", "inheritedFrom": { "name": "AutocompleteBase", "module": "src/components/autocomplete/autocomplete-base.ts" } }, { "kind": "method", "name": "blur", "privacy": "public", "description": "Blurs the focus of the textfield.", "inheritedFrom": { "name": "AutocompleteBase", "module": "src/components/autocomplete/autocomplete-base.ts" } }, { "kind": "method", "name": "clear", "privacy": "public", "description": "Clears the inputValue, value and all items of the autocomplete.", "inheritedFrom": { "name": "AutocompleteBase", "module": "src/components/autocomplete/autocomplete-base.ts" } }, { "kind": "method", "name": "selectItem", "privacy": "public", "parameters": [ { "name": "index", "type": { "text": "number" } } ], "description": "Selects an item by index.", "inheritedFrom": { "name": "AutocompleteBase", "module": "src/components/autocomplete/autocomplete-base.ts" } }, { "kind": "method", "name": "activateFirstItem", "privacy": "public", "description": "Activates the first item.", "inheritedFrom": { "name": "AutocompleteBase", "module": "src/components/autocomplete/autocomplete-base.ts" } }, { "kind": "method", "name": "activatePreviousItem", "privacy": "public", "description": "Activates the previous item.", "inheritedFrom": { "name": "AutocompleteBase", "module": "src/components/autocomplete/autocomplete-base.ts" } }, { "kind": "method", "name": "activateNextItem", "privacy": "public", "description": "Activates the next item.", "inheritedFrom": { "name": "AutocompleteBase", "module": "src/components/autocomplete/autocomplete-base.ts" } }, { "kind": "method", "name": "selectActivatedItem", "privacy": "public", "description": "Selects the activated item.", "inheritedFrom": { "name": "AutocompleteBase", "module": "src/components/autocomplete/autocomplete-base.ts" } }, { "kind": "method", "name": "computeListPosition", "privacy": "public", "description": "Refreshes the position of the list's dropdown.", "inheritedFrom": { "name": "AutocompleteBase", "module": "src/components/autocomplete/autocomplete-base.ts" } }, { "kind": "method", "name": "searchFunction", "privacy": "public", "parameters": [ { "name": "query", "type": { "text": "string" } }, { "name": "items", "type": { "text": "Item[]" } } ], "description": "The search function, that can be overriden.", "inheritedFrom": { "name": "AutocompleteBase", "module": "src/components/autocomplete/autocomplete-base.ts" } }, { "kind": "method", "name": "renderItem", "privacy": "public", "parameters": [ { "name": "item", "type": { "text": "Item" } }, { "name": "index", "type": { "text": "number" } }, { "name": "activated", "type": { "text": "boolean" } } ], "description": "Renderer for each item.", "inheritedFrom": { "name": "AutocompleteBase", "module": "src/components/autocomplete/autocomplete-base.ts" } }, { "kind": "method", "name": "findItemIndexByLabel", "privacy": "public", "return": { "type": { "text": "number" } }, "parameters": [ { "name": "label", "type": { "text": "string" } } ], "description": "Gets the index of the item by the label if items are objects or a string, if items are strings.", "inheritedFrom": { "name": "AutocompleteBase", "module": "src/components/autocomplete/autocomplete-base.ts" } }, { "kind": "method", "name": "deactivateAllItems", "privacy": "public", "description": "Deactivates all items.", "inheritedFrom": { "name": "AutocompleteBase", "module": "src/components/autocomplete/autocomplete-base.ts" } }, { "kind": "method", "name": "scrollActiveItemIntoView", "privacy": "public", "description": "Scrolls current activated item into view.", "inheritedFrom": { "name": "AutocompleteBase", "module": "src/components/autocomplete/autocomplete-base.ts" } }, { "kind": "method", "name": "getcurrentDisplayedItemIndex", "privacy": "public", "parameters": [ { "name": "itemElements", "type": { "text": "HTMLElementWithValueAndActivated[]" } } ], "description": "Gets the activated item's relative index in an array of list item Elements.", "inheritedFrom": { "name": "AutocompleteBase", "module": "src/components/autocomplete/autocomplete-base.ts" } }, { "kind": "method", "name": "getListItems", "privacy": "public", "description": "Gets the currently displayed list item HTML elements.", "inheritedFrom": { "name": "AutocompleteBase", "module": "src/components/autocomplete/autocomplete-base.ts" } }, { "kind": "method", "name": "emitChanged", "privacy": "protected", "parameters": [ { "name": "query", "type": { "text": "string" } } ], "inheritedFrom": { "name": "AutocompleteBase", "module": "src/components/autocomplete/autocomplete-base.ts" } }, { "kind": "method", "name": "emitSelected", "privacy": "protected", "parameters": [ { "name": "item", "type": { "text": "Item" } }, { "name": "index", "type": { "text": "number" } } ], "inheritedFrom": { "name": "AutocompleteBase", "module": "src/components/autocomplete/autocomplete-base.ts" } }, { "kind": "method", "name": "findStringItemIndex", "privacy": "protected", "parameters": [ { "name": "item", "type": { "text": "Item" } } ], "inheritedFrom": { "name": "AutocompleteBase", "module": "src/components/autocomplete/autocomplete-base.ts" } }, { "kind": "method", "name": "findObjectItemIndex", "privacy": "protected", "parameters": [ { "name": "_item", "type": { "text": "Item" } } ], "inheritedFrom": { "name": "AutocompleteBase", "module": "src/components/autocomplete/autocomplete-base.ts" } }, { "kind": "method", "name": "getItemLabel", "privacy": "protected", "return": { "type": { "text": "string" } }, "parameters": [ { "name": "item", "type": { "text": "Item" } } ], "inheritedFrom": { "name": "AutocompleteBase", "module": "src/components/autocomplete/autocomplete-base.ts" } }, { "kind": "method", "name": "searchList", "privacy": "protected", "parameters": [ { "name": "query", "type": { "text": "string" } } ], "inheritedFrom": { "name": "AutocompleteBase", "module": "src/components/autocomplete/autocomplete-base.ts" } }, { "kind": "method", "name": "handleFocus", "privacy": "protected", "inheritedFrom": { "name": "AutocompleteBase", "module": "src/components/autocomplete/autocomplete-base.ts" } }, { "kind": "method", "name": "handleInput", "privacy": "protected", "parameters": [ { "name": "e", "type": { "text": "InputEvent" } } ], "inheritedFrom": { "name": "AutocompleteBase", "module": "src/components/autocomplete/autocomplete-base.ts" } }, { "kind": "method", "name": "handleKeydown", "privacy": "protected", "parameters": [ { "name": "e", "type": { "text": "KeyboardEvent" } } ], "inheritedFrom": { "name": "AutocompleteBase", "module": "src/components/autocomplete/autocomplete-base.ts" } }, { "kind": "method", "name": "handleListSelected", "privacy": "protected", "parameters": [ { "name": "e", "type": { "text": "CustomEvent<{index: number}>" } } ], "inheritedFrom": { "name": "AutocompleteBase", "module": "src/components/autocomplete/autocomplete-base.ts" } }, { "kind": "method", "name": "renderActionSlot", "privacy": "protected", "inheritedFrom": { "name": "AutocompleteBase", "module": "src/components/autocomplete/autocomplete-base.ts" } }, { "kind": "method", "name": "renderResults", "privacy": "protected", "inheritedFrom": { "name": "AutocompleteBase", "module": "src/components/autocomplete/autocomplete-base.ts" } } ], "events": [ { "type": { "text": "{item: Item, index: number}" }, "description": "Emits when an item is selected.", "name": "bp-autocomplete-selected", "reactName": "onBpAutocompleteSelected" }, { "type": { "text": "string" }, "description": "Emits when the query changes.", "name": "bp-autocomplete-changed", "reactName": "onBpAutocompleteChanged" } ], "superclass": { "name": "AutocompleteBase", "module": "/src/components/autocomplete/autocomplete-base.js" }, "since": "0.1.1-beta.1", "status": "beta", "tagName": "bp-autocomplete", "customElement": true, "attributes": [ { "name": "items", "type": { "text": "Items" }, "default": "[]", "description": "Items to be used in the autocomplete.", "fieldName": "items", "inheritedFrom": { "name": "AutocompleteBase", "module": "src/components/autocomplete/autocomplete-base.ts" } }, { "name": "value", "type": { "text": "number" }, "default": "-1", "description": "The autocomplete's value - holds the selected item's index.", "fieldName": "value", "inheritedFrom": { "name": "AutocompleteBase", "module": "src/components/autocomplete/autocomplete-base.ts" } }, { "name": "input-value", "type": { "text": "string" }, "default": "''", "description": "The textfield's value. Independant from the autocomplete's value.", "fieldName": "inputValue", "inheritedFrom": { "name": "AutocompleteBase", "module": "src/components/autocomplete/autocomplete-base.ts" } }, { "name": "hide-actions-on-results", "type": { "text": "boolean" }, "default": "false", "description": "If true, will show action buttons only when there are results.", "fieldName": "hideActionsOnResults", "inheritedFrom": { "name": "AutocompleteBase", "module": "src/components/autocomplete/autocomplete-base.ts" } }, { "name": "textfield-width", "type": { "text": "string" }, "default": "'250px'", "description": "The width of the textfield.", "fieldName": "textfieldWidth", "inheritedFrom": { "name": "AutocompleteBase", "module": "src/components/autocomplete/autocomplete-base.ts" } }, { "name": "list-width", "type": { "text": "string" }, "default": "''", "description": "The width of the list - defaults to textfield width, if not set.", "fieldName": "listWidth", "inheritedFrom": { "name": "AutocompleteBase", "module": "src/components/autocomplete/autocomplete-base.ts" } }, { "name": "dropdown-position", "type": { "text": "Placement" }, "default": "'bottom-start'", "description": "The placement of the list's dropdown.", "fieldName": "dropdownPosition", "inheritedFrom": { "name": "AutocompleteBase", "module": "src/components/autocomplete/autocomplete-base.ts" } }, { "name": "max-height", "type": { "text": "string" }, "default": "'304px'", "description": "Maximum aheight of the list dropdown, before the container overflows. Defaults to fit 6 bp-list-items without overflowing.", "fieldName": "maxHeight", "inheritedFrom": { "name": "AutocompleteBase", "module": "src/components/autocomplete/autocomplete-base.ts" } }, { "name": "highlight-first-item", "type": { "text": "boolean" }, "default": "false", "description": "Will always highlight the first item if true.", "fieldName": "highlightFirstItem", "inheritedFrom": { "name": "AutocompleteBase", "module": "src/components/autocomplete/autocomplete-base.ts" } }, { "name": "clear-input-after-selection", "type": { "text": "boolean" }, "default": "false", "description": "If true, clears the input textfield after an item is selected.", "fieldName": "clearInputAfterSelection", "inheritedFrom": { "name": "AutocompleteBase", "module": "src/components/autocomplete/autocomplete-base.ts" } }, { "name": "min-query-length", "type": { "text": "number" }, "default": "0", "description": "The length of the query string required to do a search.", "fieldName": "minQueryLength", "inheritedFrom": { "name": "AutocompleteBase", "module": "src/components/autocomplete/autocomplete-base.ts" } }, { "name": "type", "type": { "text": "TextFieldType" }, "default": "'text'", "description": "A string specifying the type of control to render.", "fieldName": "type", "inheritedFrom": { "name": "AutocompleteBase", "module": "src/components/autocomplete/autocomplete-base.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "Sets floating label value.", "fieldName": "label", "inheritedFrom": { "name": "AutocompleteBase", "module": "src/components/autocomplete/autocomplete-base.ts" } }, { "name": "placeholder", "type": { "text": "string" }, "default": "''", "description": "Sets disappearing input placeholder.", "fieldName": "placeholder", "inheritedFrom": { "name": "AutocompleteBase", "module": "src/components/autocomplete/autocomplete-base.ts" } }, { "name": "prefix", "type": { "text": "string" }, "default": "''", "description": "Prefix text to display before the input.", "fieldName": "prefix", "inheritedFrom": { "name": "AutocompleteBase", "module": "src/components/autocomplete/autocomplete-base.ts" } }, { "name": "suffix", "type": { "text": "string" }, "default": "''", "description": "Suffix text to display after the input.", "fieldName": "suffix", "inheritedFrom": { "name": "AutocompleteBase", "module": "src/components/autocomplete/autocomplete-base.ts" } }, { "name": "icon", "type": { "text": "string" }, "default": "''", "description": "Leading icon to display in input. See bp-icon.", "fieldName": "icon", "inheritedFrom": { "name": "AutocompleteBase", "module": "src/components/autocomplete/autocomplete-base.ts" } }, { "name": "iconTrailing", "type": { "text": "string" }, "default": "''", "description": "Trailing icon to display in input. See bp-icon.", "fieldName": "iconTrailing", "inheritedFrom": { "name": "AutocompleteBase", "module": "src/components/autocomplete/autocomplete-base.ts" } }, { "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Whether or not the input should be disabled.", "fieldName": "disabled", "inheritedFrom": { "name": "AutocompleteBase", "module": "src/components/autocomplete/autocomplete-base.ts" } }, { "name": "required", "type": { "text": "boolean" }, "default": "false", "description": "Displays error state if value is empty and input is blurred.", "fieldName": "required", "inheritedFrom": { "name": "AutocompleteBase", "module": "src/components/autocomplete/autocomplete-base.ts" } }, { "name": "maxLength", "type": { "text": "number" }, "default": "-1", "description": "Maximum length to accept input.", "fieldName": "maxLength", "inheritedFrom": { "name": "AutocompleteBase", "module": "src/components/autocomplete/autocomplete-base.ts" } }, { "name": "outlined", "type": { "text": "boolean" }, "default": "false", "description": "Whether or not to show the material outlined variant.", "fieldName": "outlined", "inheritedFrom": { "name": "AutocompleteBase", "module": "src/components/autocomplete/autocomplete-base.ts" } }, { "name": "validationMessage", "type": { "text": "string" }, "default": "''", "description": "HTMLInputElement.prototype.pattern (empty string will unset attribute)", "fieldName": "validationMessage", "inheritedFrom": { "name": "AutocompleteBase", "module": "src/components/autocomplete/autocomplete-base.ts" } }, { "name": "size", "type": { "text": "number | null" }, "default": "null", "description": "HTMLInputElement.prototype.size (null will unset attribute)", "fieldName": "size", "inheritedFrom": { "name": "AutocompleteBase", "module": "src/components/autocomplete/autocomplete-base.ts" } }, { "name": "name", "type": { "text": "string" }, "default": "''", "description": "HTMLInputElement.prototype.name", "fieldName": "name", "inheritedFrom": { "name": "AutocompleteBase", "module": "src/components/autocomplete/autocomplete-base.ts" } }, { "name": "input-ellipsis", "type": { "text": "boolean" }, "default": "false", "description": "Whether to show ellipsis on input field or not.", "fieldName": "inputEllipsis", "inheritedFrom": { "name": "AutocompleteBase", "module": "src/components/autocomplete/autocomplete-base.ts" } } ] } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "Autocomplete", "module": "src/components/autocomplete/autocomplete.ts" } }, { "kind": "custom-element-definition", "name": "bp-autocomplete", "declaration": { "name": "Autocomplete", "module": "src/components/autocomplete/autocomplete.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/badge/badge-base.ts", "declarations": [ { "kind": "class", "description": "", "name": "BadgeBase", "members": [ { "kind": "field", "name": "color", "type": { "text": "| 'primary'\n | 'secondary'\n | 'success'\n | 'warning'\n | 'error'\n | 'info'" }, "default": "'primary'", "description": "The color of the badge.", "attribute": "color" }, { "kind": "field", "name": "pill", "type": { "text": "boolean" }, "default": "false", "description": "Makes the badge rounded.", "attribute": "pill" }, { "kind": "field", "name": "pulse", "type": { "text": "boolean" }, "default": "false", "description": "Makes the badge pulse.", "attribute": "pulse" }, { "kind": "field", "name": "size", "type": { "text": "string" }, "default": "'11px'", "description": "The size of the badge.", "attribute": "size" }, { "kind": "field", "name": "circular", "type": { "text": "boolean" }, "default": "false" } ], "attributes": [ { "name": "color", "type": { "text": "| 'primary'\n | 'secondary'\n | 'success'\n | 'warning'\n | 'error'\n | 'info'" }, "default": "'primary'", "description": "The color of the badge.", "fieldName": "color" }, { "name": "pill", "type": { "text": "boolean" }, "default": "false", "description": "Makes the badge rounded.", "fieldName": "pill" }, { "name": "pulse", "type": { "text": "boolean" }, "default": "false", "description": "Makes the badge pulse.", "fieldName": "pulse" }, { "name": "size", "type": { "text": "string" }, "default": "'11px'", "description": "The size of the badge.", "fieldName": "size" } ], "superclass": { "name": "LitElement", "package": "lit" }, "customElement": true } ], "exports": [ { "kind": "js", "name": "BadgeBase", "declaration": { "name": "BadgeBase", "module": "src/components/badge/badge-base.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/badge/badge.ts", "declarations": [ { "kind": "class", "description": "", "name": "Badge", "cssParts": [ { "description": "The component's internal wrapper.", "name": "base" } ], "slots": [ { "description": "The badge's content.", "name": "" } ], "members": [ { "kind": "field", "name": "color", "type": { "text": "| 'primary'\n | 'secondary'\n | 'success'\n | 'warning'\n | 'error'\n | 'info'" }, "default": "'primary'", "description": "The color of the badge.", "attribute": "color", "inheritedFrom": { "name": "BadgeBase", "module": "src/components/badge/badge-base.ts" } }, { "kind": "field", "name": "pill", "type": { "text": "boolean" }, "default": "false", "description": "Makes the badge rounded.", "attribute": "pill", "inheritedFrom": { "name": "BadgeBase", "module": "src/components/badge/badge-base.ts" } }, { "kind": "field", "name": "pulse", "type": { "text": "boolean" }, "default": "false", "description": "Makes the badge pulse.", "attribute": "pulse", "inheritedFrom": { "name": "BadgeBase", "module": "src/components/badge/badge-base.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string" }, "default": "'11px'", "description": "The size of the badge.", "attribute": "size", "inheritedFrom": { "name": "BadgeBase", "module": "src/components/badge/badge-base.ts" } }, { "kind": "field", "name": "circular", "type": { "text": "boolean" }, "default": "false", "inheritedFrom": { "name": "BadgeBase", "module": "src/components/badge/badge-base.ts" } } ], "superclass": { "name": "BadgeBase", "module": "/src/components/badge/badge-base.js" }, "since": "0.1.1-beta.1", "status": "beta", "tagName": "bp-badge", "customElement": true, "attributes": [ { "name": "color", "type": { "text": "| 'primary'\n | 'secondary'\n | 'success'\n | 'warning'\n | 'error'\n | 'info'" }, "default": "'primary'", "description": "The color of the badge.", "fieldName": "color", "inheritedFrom": { "name": "BadgeBase", "module": "src/components/badge/badge-base.ts" } }, { "name": "pill", "type": { "text": "boolean" }, "default": "false", "description": "Makes the badge rounded.", "fieldName": "pill", "inheritedFrom": { "name": "BadgeBase", "module": "src/components/badge/badge-base.ts" } }, { "name": "pulse", "type": { "text": "boolean" }, "default": "false", "description": "Makes the badge pulse.", "fieldName": "pulse", "inheritedFrom": { "name": "BadgeBase", "module": "src/components/badge/badge-base.ts" } }, { "name": "size", "type": { "text": "string" }, "default": "'11px'", "description": "The size of the badge.", "fieldName": "size", "inheritedFrom": { "name": "BadgeBase", "module": "src/components/badge/badge-base.ts" } } ] } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "Badge", "module": "src/components/badge/badge.ts" } }, { "kind": "custom-element-definition", "name": "bp-badge", "declaration": { "name": "Badge", "module": "src/components/badge/badge.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/breadcrumb/breadcrumb-base.ts", "declarations": [ { "kind": "class", "description": "", "name": "BreadcrumbBase", "members": [ { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "'Breadcrumb'", "description": "The label to use for the breadcrumb control. This will not be shown, but it will be announced by screen readers and other assistive devices.", "attribute": "label" }, { "kind": "method", "name": "getSeparator_" }, { "kind": "method", "name": "handleSlotChange" } ], "attributes": [ { "name": "label", "type": { "text": "string" }, "default": "'Breadcrumb'", "description": "The label to use for the breadcrumb control. This will not be shown, but it will be announced by screen readers and other assistive devices.", "fieldName": "label" } ], "superclass": { "name": "SlBreadcrumb", "package": "@shoelace-style/shoelace/dist/components/breadcrumb/breadcrumb.js" } } ], "exports": [ { "kind": "js", "name": "BreadcrumbBase", "declaration": { "name": "BreadcrumbBase", "module": "src/components/breadcrumb/breadcrumb-base.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/breadcrumb/breadcrumb.ts", "declarations": [ { "kind": "class", "description": "", "name": "Breadcrumb", "cssParts": [ { "description": "The component's internal wrapper.", "name": "base" } ], "slots": [ { "description": "One or more breadcrumb items to display.", "name": "" }, { "description": "The separator to use between breadcrumb items.", "name": "separator" } ], "members": [ { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "'Breadcrumb'", "description": "The label to use for the breadcrumb control. This will not be shown, but it will be announced by screen readers and other assistive devices.", "attribute": "label", "inheritedFrom": { "name": "BreadcrumbBase", "module": "src/components/breadcrumb/breadcrumb-base.ts" } }, { "kind": "method", "name": "getSeparator_", "inheritedFrom": { "name": "BreadcrumbBase", "module": "src/components/breadcrumb/breadcrumb-base.ts" } }, { "kind": "method", "name": "handleSlotChange", "inheritedFrom": { "name": "BreadcrumbBase", "module": "src/components/breadcrumb/breadcrumb-base.ts" } } ], "superclass": { "name": "BreadcrumbBase", "module": "/src/components/breadcrumb/breadcrumb-base.js" }, "since": "0.1.1-beta.1", "status": "beta", "dependencies": [ "bp-icon" ], "tagName": "bp-breadcrumb", "customElement": true, "attributes": [ { "name": "label", "type": { "text": "string" }, "default": "'Breadcrumb'", "description": "The label to use for the breadcrumb control. This will not be shown, but it will be announced by screen readers and other assistive devices.", "fieldName": "label", "inheritedFrom": { "name": "BreadcrumbBase", "module": "src/components/breadcrumb/breadcrumb-base.ts" } } ] } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "Breadcrumb", "module": "src/components/breadcrumb/breadcrumb.ts" } }, { "kind": "custom-element-definition", "name": "bp-breadcrumb", "declaration": { "name": "Breadcrumb", "module": "src/components/breadcrumb/breadcrumb.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/breadcrumb-item/breadcrumb-item-base.ts", "declarations": [ { "kind": "class", "description": "", "name": "BreadcrumbItemBase", "members": [ { "kind": "field", "name": "href", "type": { "text": "string | undefined" }, "default": "undefined", "description": "Optional URL to direct the user to when the breadcrumb item is activated. When set, a link will be rendered internally. When unset, a button will be rendered instead.", "attribute": "href" }, { "kind": "field", "name": "target", "type": { "text": "'_blank' | '_parent' | '_self' | '_top' | undefined" }, "default": "undefined", "description": "Tells the browser where to open the link. Only used when `href` is set.", "attribute": "target" }, { "kind": "field", "name": "rel", "type": { "text": "string" }, "default": "'noreferrer noopener'", "description": "The rel attribute to use on the link. Only used when `href` is set.", "attribute": "rel" } ], "attributes": [ { "name": "href", "type": { "text": "string | undefined" }, "default": "undefined", "description": "Optional URL to direct the user to when the breadcrumb item is activated. When set, a link will be rendered internally. When unset, a button will be rendered instead.", "resolveInitializer": { "module": "src/components/breadcrumb-item/breadcrumb-item-base.ts" }, "fieldName": "href" }, { "name": "target", "type": { "text": "'_blank' | '_parent' | '_self' | '_top' | undefined" }, "default": "undefined", "description": "Tells the browser where to open the link. Only used when `href` is set.", "resolveInitializer": { "module": "src/components/breadcrumb-item/breadcrumb-item-base.ts" }, "fieldName": "target" }, { "name": "rel", "type": { "text": "string" }, "default": "'noreferrer noopener'", "description": "The rel attribute to use on the link. Only used when `href` is set.", "fieldName": "rel" } ], "superclass": { "name": "SlBreadcrumbItem", "package": "@shoelace-style/shoelace/dist/components/breadcrumb-item/breadcrumb-item.js" } } ], "exports": [ { "kind": "js", "name": "BreadcrumbItemBase", "declaration": { "name": "BreadcrumbItemBase", "module": "src/components/breadcrumb-item/breadcrumb-item-base.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/breadcrumb-item/breadcrumb-item.ts", "declarations": [ { "kind": "class", "description": "", "name": "BreadcrumbItem", "slots": [ { "description": "The breadcrumb item's label.", "name": "" }, { "description": "Used to prepend an icon or similar element to the button.", "name": "prefix" }, { "description": "Used to append an icon or similar element to the button.", "name": "suffix" }, { "description": "The separator to use for the breadcrumb item. This will only change the separator for this item. If you want to change it for all items in the group, set the separator on instead.", "name": "separator" } ], "members": [ { "kind": "field", "name": "href", "type": { "text": "string | undefined" }, "default": "undefined", "description": "Optional URL to direct the user to when the breadcrumb item is activated. When set, a link will be rendered internally. When unset, a button will be rendered instead.", "attribute": "href", "inheritedFrom": { "name": "BreadcrumbItemBase", "module": "src/components/breadcrumb-item/breadcrumb-item-base.ts" } }, { "kind": "field", "name": "target", "type": { "text": "'_blank' | '_parent' | '_self' | '_top' | undefined" }, "default": "undefined", "description": "Tells the browser where to open the link. Only used when `href` is set.", "attribute": "target", "inheritedFrom": { "name": "BreadcrumbItemBase", "module": "src/components/breadcrumb-item/breadcrumb-item-base.ts" } }, { "kind": "field", "name": "rel", "type": { "text": "string" }, "default": "'noreferrer noopener'", "description": "The rel attribute to use on the link. Only used when `href` is set.", "attribute": "rel", "inheritedFrom": { "name": "BreadcrumbItemBase", "module": "src/components/breadcrumb-item/breadcrumb-item-base.ts" } } ], "superclass": { "name": "BreadcrumbItemBase", "module": "/src/components/breadcrumb-item/breadcrumb-item-base.js" }, "since": "0.1.1-beta.1", "status": "beta", "tagName": "bp-breadcrumb-item", "customElement": true, "attributes": [ { "name": "href", "type": { "text": "string | undefined" }, "default": "undefined", "description": "Optional URL to direct the user to when the breadcrumb item is activated. When set, a link will be rendered internally. When unset, a button will be rendered instead.", "resolveInitializer": { "module": "src/components/breadcrumb-item/breadcrumb-item-base.ts" }, "fieldName": "href", "inheritedFrom": { "name": "BreadcrumbItemBase", "module": "src/components/breadcrumb-item/breadcrumb-item-base.ts" } }, { "name": "target", "type": { "text": "'_blank' | '_parent' | '_self' | '_top' | undefined" }, "default": "undefined", "description": "Tells the browser where to open the link. Only used when `href` is set.", "resolveInitializer": { "module": "src/components/breadcrumb-item/breadcrumb-item-base.ts" }, "fieldName": "target", "inheritedFrom": { "name": "BreadcrumbItemBase", "module": "src/components/breadcrumb-item/breadcrumb-item-base.ts" } }, { "name": "rel", "type": { "text": "string" }, "default": "'noreferrer noopener'", "description": "The rel attribute to use on the link. Only used when `href` is set.", "fieldName": "rel", "inheritedFrom": { "name": "BreadcrumbItemBase", "module": "src/components/breadcrumb-item/breadcrumb-item-base.ts" } } ] } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "BreadcrumbItem", "module": "src/components/breadcrumb-item/breadcrumb-item.ts" } }, { "kind": "custom-element-definition", "name": "bp-breadcrumb-item", "declaration": { "name": "BreadcrumbItem", "module": "src/components/breadcrumb-item/breadcrumb-item.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/button/button-base.ts", "declarations": [ { "kind": "class", "description": "", "name": "ButtonBase", "members": [ { "kind": "field", "name": "icon", "type": { "text": "string" }, "default": "''", "description": "Adds a bp-icon to button", "attribute": "icon" }, { "kind": "field", "name": "raised", "type": { "text": "boolean" }, "default": "false", "description": "Creates a contained button that is elevated above the surface.", "attribute": "raised" }, { "kind": "field", "name": "unelevated", "type": { "text": "boolean" }, "default": "false", "description": "Creates a contained button that is flush with the surface.", "attribute": "unelevated" }, { "kind": "field", "name": "outlined", "type": { "text": "boolean" }, "default": "false", "description": "Creates an outlined button that is flush with the surface.", "attribute": "outlined" }, { "kind": "field", "name": "dense", "type": { "text": "boolean" }, "default": "false", "description": "Makes the button text and container slightly smaller.", "attribute": "dense" }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Makes the button disabled", "attribute": "disabled" }, { "kind": "field", "name": "trailingIcon", "type": { "text": "boolean" }, "default": "false", "description": "Makes the icon appear at the end - requires icon prop to be set", "attribute": "trailingIcon" }, { "kind": "field", "name": "fullwidth", "type": { "text": "boolean" }, "default": "false", "description": "Makes button take up the full width of its container", "attribute": "fullwidth" }, { "kind": "field", "name": "expandContent", "type": { "text": "boolean" }, "default": "false", "description": "When true, the space after the label and before any trailing icon, where default slotted content is rendered, is expanded to fit the available space inside the button.", "attribute": "expandContent" }, { "kind": "field", "name": "color", "type": { "text": "| 'primary'\n | 'secondary'\n | 'success'\n | 'warning'\n | 'info'\n | 'error'\n | string" }, "default": "'primary'", "description": "Sets the button color as one of the color variants.", "attribute": "color" }, { "kind": "field", "name": "type", "type": { "text": "'button' | 'submit' | 'reset' | 'menu'" }, "default": "'button'", "description": "Type of button.", "attribute": "type" }, { "kind": "method", "name": "emitClickHandler" }, { "kind": "method", "name": "getRenderClasses" } ], "attributes": [ { "name": "icon", "type": { "text": "string" }, "default": "''", "description": "Adds a bp-icon to button", "fieldName": "icon" }, { "name": "raised", "type": { "text": "boolean" }, "default": "false", "description": "Creates a contained button that is elevated above the surface.", "fieldName": "raised" }, { "name": "unelevated", "type": { "text": "boolean" }, "default": "false", "description": "Creates a contained button that is flush with the surface.", "fieldName": "unelevated" }, { "name": "outlined", "type": { "text": "boolean" }, "default": "false", "description": "Creates an outlined button that is flush with the surface.", "fieldName": "outlined" }, { "name": "dense", "type": { "text": "boolean" }, "default": "false", "description": "Makes the button text and container slightly smaller.", "fieldName": "dense" }, { "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Makes the button disabled", "fieldName": "disabled" }, { "name": "trailingIcon", "type": { "text": "boolean" }, "default": "false", "description": "Makes the icon appear at the end - requires icon prop to be set", "fieldName": "trailingIcon" }, { "name": "fullwidth", "type": { "text": "boolean" }, "default": "false", "description": "Makes button take up the full width of its container", "fieldName": "fullwidth" }, { "name": "expandContent", "type": { "text": "boolean" }, "default": "false", "description": "When true, the space after the label and before any trailing icon, where default slotted content is rendered, is expanded to fit the available space inside the button.", "fieldName": "expandContent" }, { "name": "color", "type": { "text": "| 'primary'\n | 'secondary'\n | 'success'\n | 'warning'\n | 'info'\n | 'error'\n | string" }, "default": "'primary'", "description": "Sets the button color as one of the color variants.", "fieldName": "color" }, { "name": "type", "type": { "text": "'button' | 'submit' | 'reset' | 'menu'" }, "default": "'button'", "description": "Type of button.", "fieldName": "type" } ], "superclass": { "name": "_ButtonBase", "package": "@material/mwc-button/mwc-button-base" } } ], "exports": [ { "kind": "js", "name": "ButtonBase", "declaration": { "name": "ButtonBase", "module": "src/components/button/button-base.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/button/button.ts", "declarations": [ { "kind": "class", "description": "", "name": "Button", "cssProperties": [ { "description": "The base color you want to use", "name": "--bp-theme-primary" } ], "slots": [ { "description": "Text inside the button.", "name": "" } ], "members": [ { "kind": "field", "name": "icon", "type": { "text": "string" }, "default": "''", "description": "Adds a bp-icon to button", "attribute": "icon", "inheritedFrom": { "name": "ButtonBase", "module": "src/components/button/button-base.ts" } }, { "kind": "field", "name": "raised", "type": { "text": "boolean" }, "default": "false", "description": "Creates a contained button that is elevated above the surface.", "attribute": "raised", "inheritedFrom": { "name": "ButtonBase", "module": "src/components/button/button-base.ts" } }, { "kind": "field", "name": "unelevated", "type": { "text": "boolean" }, "default": "false", "description": "Creates a contained button that is flush with the surface.", "attribute": "unelevated", "inheritedFrom": { "name": "ButtonBase", "module": "src/components/button/button-base.ts" } }, { "kind": "field", "name": "outlined", "type": { "text": "boolean" }, "default": "false", "description": "Creates an outlined button that is flush with the surface.", "attribute": "outlined", "inheritedFrom": { "name": "ButtonBase", "module": "src/components/button/button-base.ts" } }, { "kind": "field", "name": "dense", "type": { "text": "boolean" }, "default": "false", "description": "Makes the button text and container slightly smaller.", "attribute": "dense", "inheritedFrom": { "name": "ButtonBase", "module": "src/components/button/button-base.ts" } }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Makes the button disabled", "attribute": "disabled", "inheritedFrom": { "name": "ButtonBase", "module": "src/components/button/button-base.ts" } }, { "kind": "field", "name": "trailingIcon", "type": { "text": "boolean" }, "default": "false", "description": "Makes the icon appear at the end - requires icon prop to be set", "attribute": "trailingIcon", "inheritedFrom": { "name": "ButtonBase", "module": "src/components/button/button-base.ts" } }, { "kind": "field", "name": "fullwidth", "type": { "text": "boolean" }, "default": "false", "description": "Makes button take up the full width of its container", "attribute": "fullwidth", "inheritedFrom": { "name": "ButtonBase", "module": "src/components/button/button-base.ts" } }, { "kind": "field", "name": "expandContent", "type": { "text": "boolean" }, "default": "false", "description": "When true, the space after the label and before any trailing icon, where default slotted content is rendered, is expanded to fit the available space inside the button.", "attribute": "expandContent", "inheritedFrom": { "name": "ButtonBase", "module": "src/components/button/button-base.ts" } }, { "kind": "field", "name": "color", "type": { "text": "| 'primary'\n | 'secondary'\n | 'success'\n | 'warning'\n | 'info'\n | 'error'\n | string" }, "default": "'primary'", "description": "Sets the button color as one of the color variants.", "attribute": "color", "inheritedFrom": { "name": "ButtonBase", "module": "src/components/button/button-base.ts" } }, { "kind": "field", "name": "type", "type": { "text": "'button' | 'submit' | 'reset' | 'menu'" }, "default": "'button'", "description": "Type of button.", "attribute": "type", "inheritedFrom": { "name": "ButtonBase", "module": "src/components/button/button-base.ts" } }, { "kind": "method", "name": "emitClickHandler", "inheritedFrom": { "name": "ButtonBase", "module": "src/components/button/button-base.ts" } }, { "kind": "method", "name": "getRenderClasses", "inheritedFrom": { "name": "ButtonBase", "module": "src/components/button/button-base.ts" } } ], "events": [ { "description": "Emitted when the button is clicked.", "name": "bp-button-clicked", "reactName": "onBpButtonClicked" } ], "superclass": { "name": "ButtonBase", "module": "/src/components/button/button-base.js" }, "since": "0.1.1-beta.1", "status": "beta", "dependencies": [ "bp-icon" ], "tagName": "bp-button", "customElement": true, "attributes": [ { "name": "icon", "type": { "text": "string" }, "default": "''", "description": "Adds a bp-icon to button", "fieldName": "icon", "inheritedFrom": { "name": "ButtonBase", "module": "src/components/button/button-base.ts" } }, { "name": "raised", "type": { "text": "boolean" }, "default": "false", "description": "Creates a contained button that is elevated above the surface.", "fieldName": "raised", "inheritedFrom": { "name": "ButtonBase", "module": "src/components/button/button-base.ts" } }, { "name": "unelevated", "type": { "text": "boolean" }, "default": "false", "description": "Creates a contained button that is flush with the surface.", "fieldName": "unelevated", "inheritedFrom": { "name": "ButtonBase", "module": "src/components/button/button-base.ts" } }, { "name": "outlined", "type": { "text": "boolean" }, "default": "false", "description": "Creates an outlined button that is flush with the surface.", "fieldName": "outlined", "inheritedFrom": { "name": "ButtonBase", "module": "src/components/button/button-base.ts" } }, { "name": "dense", "type": { "text": "boolean" }, "default": "false", "description": "Makes the button text and container slightly smaller.", "fieldName": "dense", "inheritedFrom": { "name": "ButtonBase", "module": "src/components/button/button-base.ts" } }, { "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Makes the button disabled", "fieldName": "disabled", "inheritedFrom": { "name": "ButtonBase", "module": "src/components/button/button-base.ts" } }, { "name": "trailingIcon", "type": { "text": "boolean" }, "default": "false", "description": "Makes the icon appear at the end - requires icon prop to be set", "fieldName": "trailingIcon", "inheritedFrom": { "name": "ButtonBase", "module": "src/components/button/button-base.ts" } }, { "name": "fullwidth", "type": { "text": "boolean" }, "default": "false", "description": "Makes button take up the full width of its container", "fieldName": "fullwidth", "inheritedFrom": { "name": "ButtonBase", "module": "src/components/button/button-base.ts" } }, { "name": "expandContent", "type": { "text": "boolean" }, "default": "false", "description": "When true, the space after the label and before any trailing icon, where default slotted content is rendered, is expanded to fit the available space inside the button.", "fieldName": "expandContent", "inheritedFrom": { "name": "ButtonBase", "module": "src/components/button/button-base.ts" } }, { "name": "color", "type": { "text": "| 'primary'\n | 'secondary'\n | 'success'\n | 'warning'\n | 'info'\n | 'error'\n | string" }, "default": "'primary'", "description": "Sets the button color as one of the color variants.", "fieldName": "color", "inheritedFrom": { "name": "ButtonBase", "module": "src/components/button/button-base.ts" } }, { "name": "type", "type": { "text": "'button' | 'submit' | 'reset' | 'menu'" }, "default": "'button'", "description": "Type of button.", "fieldName": "type", "inheritedFrom": { "name": "ButtonBase", "module": "src/components/button/button-base.ts" } } ] } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "Button", "module": "src/components/button/button.ts" } }, { "kind": "custom-element-definition", "name": "bp-button", "declaration": { "name": "Button", "module": "src/components/button/button.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/card/card-base.ts", "declarations": [ { "kind": "class", "description": "", "name": "CardBase", "members": [ { "kind": "field", "name": "outlined", "type": { "text": "boolean" }, "default": "false", "description": "Whether to show the material outlined variant.", "attribute": "outlined" }, { "kind": "field", "name": "elevated", "type": { "text": "boolean" }, "default": "false", "description": "Whether to show the material elevated variant.", "attribute": "elevated" }, { "kind": "field", "name": "fullBleed", "type": { "text": "boolean" }, "default": "false", "description": "Whether to make a single action button take up the entire width of the action row.", "attribute": "fullBleed" }, { "kind": "method", "name": "onButtonSlotChanged", "privacy": "protected" }, { "kind": "method", "name": "onIconSlotChanged", "privacy": "protected" }, { "kind": "method", "name": "renderActions", "privacy": "protected" }, { "kind": "method", "name": "wrapButtonSlot", "privacy": "protected", "parameters": [ { "name": "buttonSlotTemplate", "type": { "text": "TemplateResult | string" } } ] }, { "kind": "method", "name": "wrapIconSlot", "privacy": "protected", "parameters": [ { "name": "iconSlotTemplate", "type": { "text": "TemplateResult | string" } } ] } ], "attributes": [ { "name": "outlined", "type": { "text": "boolean" }, "default": "false", "description": "Whether to show the material outlined variant.", "fieldName": "outlined" }, { "name": "elevated", "type": { "text": "boolean" }, "default": "false", "description": "Whether to show the material elevated variant.", "fieldName": "elevated" }, { "name": "fullBleed", "type": { "text": "boolean" }, "default": "false", "description": "Whether to make a single action button take up the entire width of the action row.", "fieldName": "fullBleed" } ], "superclass": { "name": "LitElement", "package": "lit" }, "customElement": true } ], "exports": [ { "kind": "js", "name": "CardBase", "declaration": { "name": "CardBase", "module": "src/components/card/card-base.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/card/card.ts", "declarations": [ { "kind": "class", "description": "", "name": "Card", "cssProperties": [ { "description": "The padding for the default-slotted content of the card. Note: this works on the entirety of the slotted content - if, for example, you're passing in media into the slot along with card text, the padding will affect the media as well.", "name": "--bp-card-padding" }, { "description": "Width of the card", "name": "--bp-card-width" }, { "description": "Height of the card", "name": "--bp-card-height" }, { "description": "Margin of the card", "name": "--bp-card-margin" }, { "description": "Border radius of the card", "name": "--bp-card-border-radius" } ], "slots": [ { "description": "The card content slot", "name": "" }, { "description": "A slot for the action buttons", "name": "button" }, { "description": "A slot for the icons", "name": "icon" } ], "members": [ { "kind": "field", "name": "outlined", "type": { "text": "boolean" }, "default": "false", "description": "Whether to show the material outlined variant.", "attribute": "outlined", "inheritedFrom": { "name": "CardBase", "module": "src/components/card/card-base.ts" } }, { "kind": "field", "name": "elevated", "type": { "text": "boolean" }, "default": "false", "description": "Whether to show the material elevated variant.", "attribute": "elevated", "inheritedFrom": { "name": "CardBase", "module": "src/components/card/card-base.ts" } }, { "kind": "field", "name": "fullBleed", "type": { "text": "boolean" }, "default": "false", "description": "Whether to make a single action button take up the entire width of the action row.", "attribute": "fullBleed", "inheritedFrom": { "name": "CardBase", "module": "src/components/card/card-base.ts" } }, { "kind": "method", "name": "onButtonSlotChanged", "privacy": "protected", "inheritedFrom": { "name": "CardBase", "module": "src/components/card/card-base.ts" } }, { "kind": "method", "name": "onIconSlotChanged", "privacy": "protected", "inheritedFrom": { "name": "CardBase", "module": "src/components/card/card-base.ts" } }, { "kind": "method", "name": "renderActions", "privacy": "protected", "inheritedFrom": { "name": "CardBase", "module": "src/components/card/card-base.ts" } }, { "kind": "method", "name": "wrapButtonSlot", "privacy": "protected", "parameters": [ { "name": "buttonSlotTemplate", "type": { "text": "TemplateResult | string" } } ], "inheritedFrom": { "name": "CardBase", "module": "src/components/card/card-base.ts" } }, { "kind": "method", "name": "wrapIconSlot", "privacy": "protected", "parameters": [ { "name": "iconSlotTemplate", "type": { "text": "TemplateResult | string" } } ], "inheritedFrom": { "name": "CardBase", "module": "src/components/card/card-base.ts" } } ], "superclass": { "name": "CardBase", "module": "/src/components/card/card-base" }, "since": "0.1.1-beta.1", "status": "beta", "tagName": "bp-card", "customElement": true, "attributes": [ { "name": "outlined", "type": { "text": "boolean" }, "default": "false", "description": "Whether to show the material outlined variant.", "fieldName": "outlined", "inheritedFrom": { "name": "CardBase", "module": "src/components/card/card-base.ts" } }, { "name": "elevated", "type": { "text": "boolean" }, "default": "false", "description": "Whether to show the material elevated variant.", "fieldName": "elevated", "inheritedFrom": { "name": "CardBase", "module": "src/components/card/card-base.ts" } }, { "name": "fullBleed", "type": { "text": "boolean" }, "default": "false", "description": "Whether to make a single action button take up the entire width of the action row.", "fieldName": "fullBleed", "inheritedFrom": { "name": "CardBase", "module": "src/components/card/card-base.ts" } } ] } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "Card", "module": "src/components/card/card.ts" } }, { "kind": "custom-element-definition", "name": "bp-card", "declaration": { "name": "Card", "module": "src/components/card/card.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/checkbox/checkbox-base.ts", "declarations": [ { "kind": "class", "description": "", "name": "CheckboxBase", "members": [ { "kind": "method", "name": "setFormData", "privacy": "protected", "return": { "type": { "text": "void" } } }, { "kind": "field", "name": "rippleHandlers", "type": { "text": "{\n startPress: (ev?: Event) => void;\n endPress: () => void;\n startFocus: () => void;\n endFocus: () => void;\n startHover: () => void;\n endHover: () => void;\n }" }, "privacy": "protected", "description": "Type declaration for rippleHandlers so TS knows it exists.\nIt comes from MWC's Rippleable mixin." }, { "kind": "field", "name": "formSubmitController", "privacy": "private", "default": "new FormSubmitController(this, {\n value: (control: CheckboxBase) =>\n control.checked ? control.value || 'on' : undefined,\n defaultValue: (control: CheckboxBase) => control.defaultChecked,\n setValue: (control: CheckboxBase, checked: boolean) =>\n (control.checked = checked),\n })" }, { "kind": "field", "name": "defaultChecked" }, { "kind": "field", "name": "checked", "type": { "text": "boolean" }, "description": "Whether the checkbox is checked.", "attribute": "checked" }, { "kind": "field", "name": "indeterminate", "type": { "text": "boolean" }, "description": "When a checkbox is the parent of a set of child checkboxes, the indeterminate state is used on the parent to indicate that some but not all of its children are checked.", "attribute": "indeterminate" }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "description": "When true, the checkbox cannot be interacted with, and renders in muted colors.", "attribute": "disabled" }, { "kind": "field", "name": "value", "type": { "text": "string" }, "description": "The value that will be included if the checkbox is submitted in a form.", "attribute": "value" }, { "kind": "field", "name": "name", "type": { "text": "string" }, "description": "Basic HTML name attribute", "attribute": "name" }, { "kind": "field", "name": "color", "type": { "text": "'primary' | 'secondary' | 'success' | 'warning' | 'info' | 'error'" }, "default": "'secondary'", "description": "The checkbox color.", "attribute": "color" }, { "kind": "method", "name": "emitClickHandler" }, { "kind": "method", "name": "getRenderClasses" }, { "kind": "method", "name": "setCustomValidity", "privacy": "public", "parameters": [ { "name": "message", "type": { "text": "string" } } ], "description": "HTMLObjectElement setCustomValidity." }, { "kind": "method", "name": "reportValidity", "privacy": "public", "description": "HTMLObjectElement reportValidity." } ], "attributes": [ { "name": "checked", "type": { "text": "boolean" }, "description": "Whether the checkbox is checked.", "fieldName": "checked" }, { "name": "indeterminate", "type": { "text": "boolean" }, "description": "When a checkbox is the parent of a set of child checkboxes, the indeterminate state is used on the parent to indicate that some but not all of its children are checked.", "fieldName": "indeterminate" }, { "name": "disabled", "type": { "text": "boolean" }, "description": "When true, the checkbox cannot be interacted with, and renders in muted colors.", "fieldName": "disabled" }, { "name": "value", "type": { "text": "string" }, "description": "The value that will be included if the checkbox is submitted in a form.", "fieldName": "value" }, { "name": "name", "type": { "text": "string" }, "description": "Basic HTML name attribute", "fieldName": "name" }, { "name": "color", "type": { "text": "'primary' | 'secondary' | 'success' | 'warning' | 'info' | 'error'" }, "default": "'secondary'", "description": "The checkbox color.", "fieldName": "color" } ], "superclass": { "name": "_CheckboxBase", "package": "@material/mwc-checkbox/mwc-checkbox-base" } } ], "exports": [ { "kind": "js", "name": "CheckboxBase", "declaration": { "name": "CheckboxBase", "module": "src/components/checkbox/checkbox-base.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/checkbox/checkbox.ts", "declarations": [ { "kind": "class", "description": "", "name": "Checkbox", "members": [ { "kind": "method", "name": "setFormData", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "CheckboxBase", "module": "src/components/checkbox/checkbox-base.ts" } }, { "kind": "field", "name": "rippleHandlers", "type": { "text": "{\n startPress: (ev?: Event) => void;\n endPress: () => void;\n startFocus: () => void;\n endFocus: () => void;\n startHover: () => void;\n endHover: () => void;\n }" }, "privacy": "protected", "description": "Type declaration for rippleHandlers so TS knows it exists.\nIt comes from MWC's Rippleable mixin.", "inheritedFrom": { "name": "CheckboxBase", "module": "src/components/checkbox/checkbox-base.ts" } }, { "kind": "field", "name": "formSubmitController", "privacy": "private", "default": "new FormSubmitController(this, {\n value: (control: CheckboxBase) =>\n control.checked ? control.value || 'on' : undefined,\n defaultValue: (control: CheckboxBase) => control.defaultChecked,\n setValue: (control: CheckboxBase, checked: boolean) =>\n (control.checked = checked),\n })", "inheritedFrom": { "name": "CheckboxBase", "module": "src/components/checkbox/checkbox-base.ts" } }, { "kind": "field", "name": "defaultChecked", "inheritedFrom": { "name": "CheckboxBase", "module": "src/components/checkbox/checkbox-base.ts" } }, { "kind": "field", "name": "checked", "type": { "text": "boolean" }, "description": "Whether the checkbox is checked.", "attribute": "checked", "inheritedFrom": { "name": "CheckboxBase", "module": "src/components/checkbox/checkbox-base.ts" } }, { "kind": "field", "name": "indeterminate", "type": { "text": "boolean" }, "description": "When a checkbox is the parent of a set of child checkboxes, the indeterminate state is used on the parent to indicate that some but not all of its children are checked.", "attribute": "indeterminate", "inheritedFrom": { "name": "CheckboxBase", "module": "src/components/checkbox/checkbox-base.ts" } }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "description": "When true, the checkbox cannot be interacted with, and renders in muted colors.", "attribute": "disabled", "inheritedFrom": { "name": "CheckboxBase", "module": "src/components/checkbox/checkbox-base.ts" } }, { "kind": "field", "name": "value", "type": { "text": "string" }, "description": "The value that will be included if the checkbox is submitted in a form.", "attribute": "value", "inheritedFrom": { "name": "CheckboxBase", "module": "src/components/checkbox/checkbox-base.ts" } }, { "kind": "field", "name": "name", "type": { "text": "string" }, "description": "Basic HTML name attribute", "attribute": "name", "inheritedFrom": { "name": "CheckboxBase", "module": "src/components/checkbox/checkbox-base.ts" } }, { "kind": "field", "name": "color", "type": { "text": "'primary' | 'secondary' | 'success' | 'warning' | 'info' | 'error'" }, "default": "'secondary'", "description": "The checkbox color.", "attribute": "color", "inheritedFrom": { "name": "CheckboxBase", "module": "src/components/checkbox/checkbox-base.ts" } }, { "kind": "method", "name": "emitClickHandler", "inheritedFrom": { "name": "CheckboxBase", "module": "src/components/checkbox/checkbox-base.ts" } }, { "kind": "method", "name": "getRenderClasses", "inheritedFrom": { "name": "CheckboxBase", "module": "src/components/checkbox/checkbox-base.ts" } }, { "kind": "method", "name": "setCustomValidity", "privacy": "public", "parameters": [ { "name": "message", "type": { "text": "string" } } ], "description": "HTMLObjectElement setCustomValidity.", "inheritedFrom": { "name": "CheckboxBase", "module": "src/components/checkbox/checkbox-base.ts" } }, { "kind": "method", "name": "reportValidity", "privacy": "public", "description": "HTMLObjectElement reportValidity.", "inheritedFrom": { "name": "CheckboxBase", "module": "src/components/checkbox/checkbox-base.ts" } } ], "events": [ { "description": "Emitted when a checkbox is changed.", "name": "bp-checkbox-changed", "reactName": "onBpCheckboxChanged" }, { "description": "Emitted when a checkbox is checked.", "name": "bp-checkbox-checked", "reactName": "onBpCheckboxChecked" }, { "description": "Emitted when a checkbox is unchecked.", "name": "bp-checkbox-unchecked", "reactName": "onBpCheckboxUnchecked" } ], "superclass": { "name": "CheckboxBase", "module": "/src/components/checkbox/checkbox-base.js" }, "since": "0.1.1-beta.1", "status": "beta", "tagName": "bp-checkbox", "customElement": true, "attributes": [ { "name": "checked", "type": { "text": "boolean" }, "description": "Whether the checkbox is checked.", "fieldName": "checked", "inheritedFrom": { "name": "CheckboxBase", "module": "src/components/checkbox/checkbox-base.ts" } }, { "name": "indeterminate", "type": { "text": "boolean" }, "description": "When a checkbox is the parent of a set of child checkboxes, the indeterminate state is used on the parent to indicate that some but not all of its children are checked.", "fieldName": "indeterminate", "inheritedFrom": { "name": "CheckboxBase", "module": "src/components/checkbox/checkbox-base.ts" } }, { "name": "disabled", "type": { "text": "boolean" }, "description": "When true, the checkbox cannot be interacted with, and renders in muted colors.", "fieldName": "disabled", "inheritedFrom": { "name": "CheckboxBase", "module": "src/components/checkbox/checkbox-base.ts" } }, { "name": "value", "type": { "text": "string" }, "description": "The value that will be included if the checkbox is submitted in a form.", "fieldName": "value", "inheritedFrom": { "name": "CheckboxBase", "module": "src/components/checkbox/checkbox-base.ts" } }, { "name": "name", "type": { "text": "string" }, "description": "Basic HTML name attribute", "fieldName": "name", "inheritedFrom": { "name": "CheckboxBase", "module": "src/components/checkbox/checkbox-base.ts" } }, { "name": "color", "type": { "text": "'primary' | 'secondary' | 'success' | 'warning' | 'info' | 'error'" }, "default": "'secondary'", "description": "The checkbox color.", "fieldName": "color", "inheritedFrom": { "name": "CheckboxBase", "module": "src/components/checkbox/checkbox-base.ts" } } ] } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "Checkbox", "module": "src/components/checkbox/checkbox.ts" } }, { "kind": "custom-element-definition", "name": "bp-checkbox", "declaration": { "name": "Checkbox", "module": "src/components/checkbox/checkbox.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/chip/chip-base.ts", "declarations": [ { "kind": "class", "description": "", "name": "ChipBase", "members": [ { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Makes chip non-interactive.", "attribute": "disabled" }, { "kind": "field", "name": "selected", "type": { "text": "boolean" }, "default": "false", "description": "Makes chip appear selected. Note: selectable must be true for this to work.", "attribute": "selected" }, { "kind": "field", "name": "hidden", "type": { "text": "boolean" }, "default": "false", "description": "Hides the chip.", "attribute": "hidden", "reflects": true }, { "kind": "field", "name": "closable", "type": { "text": "boolean" }, "default": "false", "description": "Whether to make this chip closable or not.", "attribute": "closable" }, { "kind": "field", "name": "selectable", "type": { "text": "boolean" }, "default": "false", "description": "Whether to make this chip selectable or not", "attribute": "selectable" }, { "kind": "field", "name": "color", "type": { "text": "| 'primary'\n | 'success'\n | 'warning'\n | 'error'\n | 'info'\n | undefined" }, "default": "undefined", "description": "Color of the chip if the chip is not selectable and color of a selected chip if it is.", "attribute": "color" }, { "kind": "field", "name": "outlined", "type": { "text": "boolean" }, "default": "false", "description": "Show an outlined chip instead of a default filled one", "attribute": "outlined" }, { "kind": "field", "name": "index", "type": { "text": "number | undefined" }, "default": "undefined", "attribute": "index" }, { "kind": "method", "name": "hide", "description": "Hides the chip" }, { "kind": "method", "name": "show", "description": "Shows the chip" }, { "kind": "method", "name": "toggleSelected", "description": "Toggles selection" }, { "kind": "method", "name": "select", "description": "Selects the chip" }, { "kind": "method", "name": "deselect", "description": "Deselects the chip" }, { "kind": "field", "name": "emitEvents", "privacy": "protected" }, { "kind": "field", "name": "handleChipSelection", "privacy": "protected" }, { "kind": "field", "name": "handleChipClose", "privacy": "protected" }, { "kind": "field", "name": "icon", "type": { "text": "Icon | null" }, "default": "null" } ], "attributes": [ { "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Makes chip non-interactive.", "fieldName": "disabled" }, { "name": "selected", "type": { "text": "boolean" }, "default": "false", "description": "Makes chip appear selected. Note: selectable must be true for this to work.", "fieldName": "selected" }, { "name": "hidden", "type": { "text": "boolean" }, "default": "false", "description": "Hides the chip.", "fieldName": "hidden" }, { "name": "closable", "type": { "text": "boolean" }, "default": "false", "description": "Whether to make this chip closable or not.", "fieldName": "closable" }, { "name": "selectable", "type": { "text": "boolean" }, "default": "false", "description": "Whether to make this chip selectable or not", "fieldName": "selectable" }, { "name": "color", "type": { "text": "| 'primary'\n | 'success'\n | 'warning'\n | 'error'\n | 'info'\n | undefined" }, "default": "undefined", "description": "Color of the chip if the chip is not selectable and color of a selected chip if it is.", "resolveInitializer": { "module": "src/components/chip/chip-base.ts" }, "fieldName": "color" }, { "name": "outlined", "type": { "text": "boolean" }, "default": "false", "description": "Show an outlined chip instead of a default filled one", "fieldName": "outlined" }, { "name": "index", "type": { "text": "number | undefined" }, "default": "undefined", "resolveInitializer": { "module": "src/components/chip/chip-base.ts" }, "fieldName": "index" } ], "superclass": { "name": "LitElement", "package": "lit" }, "customElement": true } ], "exports": [ { "kind": "js", "name": "ChipBase", "declaration": { "name": "ChipBase", "module": "src/components/chip/chip-base.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/chip/chip.ts", "declarations": [ { "kind": "class", "description": "", "name": "Chip", "cssParts": [ { "description": "the background color of the chip", "name": "--bp-chip-background-color" } ], "slots": [ { "description": "The chip's label.", "name": "" }, { "description": "The chip's icon.", "name": "icon" } ], "members": [ { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Makes chip non-interactive.", "attribute": "disabled", "inheritedFrom": { "name": "ChipBase", "module": "src/components/chip/chip-base.ts" } }, { "kind": "field", "name": "selected", "type": { "text": "boolean" }, "default": "false", "description": "Makes chip appear selected. Note: selectable must be true for this to work.", "attribute": "selected", "inheritedFrom": { "name": "ChipBase", "module": "src/components/chip/chip-base.ts" } }, { "kind": "field", "name": "hidden", "type": { "text": "boolean" }, "default": "false", "description": "Hides the chip.", "attribute": "hidden", "reflects": true, "inheritedFrom": { "name": "ChipBase", "module": "src/components/chip/chip-base.ts" } }, { "kind": "field", "name": "closable", "type": { "text": "boolean" }, "default": "false", "description": "Whether to make this chip closable or not.", "attribute": "closable", "inheritedFrom": { "name": "ChipBase", "module": "src/components/chip/chip-base.ts" } }, { "kind": "field", "name": "selectable", "type": { "text": "boolean" }, "default": "false", "description": "Whether to make this chip selectable or not", "attribute": "selectable", "inheritedFrom": { "name": "ChipBase", "module": "src/components/chip/chip-base.ts" } }, { "kind": "field", "name": "color", "type": { "text": "| 'primary'\n | 'success'\n | 'warning'\n | 'error'\n | 'info'\n | undefined" }, "default": "undefined", "description": "Color of the chip if the chip is not selectable and color of a selected chip if it is.", "attribute": "color", "inheritedFrom": { "name": "ChipBase", "module": "src/components/chip/chip-base.ts" } }, { "kind": "field", "name": "outlined", "type": { "text": "boolean" }, "default": "false", "description": "Show an outlined chip instead of a default filled one", "attribute": "outlined", "inheritedFrom": { "name": "ChipBase", "module": "src/components/chip/chip-base.ts" } }, { "kind": "field", "name": "index", "type": { "text": "number | undefined" }, "default": "undefined", "attribute": "index", "inheritedFrom": { "name": "ChipBase", "module": "src/components/chip/chip-base.ts" } }, { "kind": "method", "name": "hide", "description": "Hides the chip", "inheritedFrom": { "name": "ChipBase", "module": "src/components/chip/chip-base.ts" } }, { "kind": "method", "name": "show", "description": "Shows the chip", "inheritedFrom": { "name": "ChipBase", "module": "src/components/chip/chip-base.ts" } }, { "kind": "method", "name": "toggleSelected", "description": "Toggles selection", "inheritedFrom": { "name": "ChipBase", "module": "src/components/chip/chip-base.ts" } }, { "kind": "method", "name": "select", "description": "Selects the chip", "inheritedFrom": { "name": "ChipBase", "module": "src/components/chip/chip-base.ts" } }, { "kind": "method", "name": "deselect", "description": "Deselects the chip", "inheritedFrom": { "name": "ChipBase", "module": "src/components/chip/chip-base.ts" } }, { "kind": "field", "name": "emitEvents", "privacy": "protected", "inheritedFrom": { "name": "ChipBase", "module": "src/components/chip/chip-base.ts" } }, { "kind": "field", "name": "handleChipSelection", "privacy": "protected", "inheritedFrom": { "name": "ChipBase", "module": "src/components/chip/chip-base.ts" } }, { "kind": "field", "name": "handleChipClose", "privacy": "protected", "inheritedFrom": { "name": "ChipBase", "module": "src/components/chip/chip-base.ts" } }, { "kind": "field", "name": "icon", "type": { "text": "Icon | null" }, "default": "null", "inheritedFrom": { "name": "ChipBase", "module": "src/components/chip/chip-base.ts" } } ], "events": [ { "description": "A global event, that is emitted when a change occurs in the chip.", "name": "bp-chip-changed", "reactName": "onBpChipChanged" }, { "description": "Emitted when the chip is being hidden.", "name": "bp-chip-closed", "reactName": "onBpChipClosed" }, { "description": "Emitted when the chip is being shown.", "name": "bp-chip-shown", "reactName": "onBpChipShown" }, { "description": "Emitted when the chip is selected.", "name": "bp-chip-selected", "reactName": "onBpChipSelected" }, { "description": "Emitted when the chip is deselected.", "name": "bp-chip-deselected", "reactName": "onBpChipDeselected" } ], "superclass": { "name": "ChipBase", "module": "/src/components/chip/chip-base.js" }, "since": "0.1.1-beta.1", "status": "beta", "dependencies": [ "bp-typography", "bp-icon-button", "bp-icon" ], "tagName": "bp-chip", "customElement": true, "attributes": [ { "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Makes chip non-interactive.", "fieldName": "disabled", "inheritedFrom": { "name": "ChipBase", "module": "src/components/chip/chip-base.ts" } }, { "name": "selected", "type": { "text": "boolean" }, "default": "false", "description": "Makes chip appear selected. Note: selectable must be true for this to work.", "fieldName": "selected", "inheritedFrom": { "name": "ChipBase", "module": "src/components/chip/chip-base.ts" } }, { "name": "hidden", "type": { "text": "boolean" }, "default": "false", "description": "Hides the chip.", "fieldName": "hidden", "inheritedFrom": { "name": "ChipBase", "module": "src/components/chip/chip-base.ts" } }, { "name": "closable", "type": { "text": "boolean" }, "default": "false", "description": "Whether to make this chip closable or not.", "fieldName": "closable", "inheritedFrom": { "name": "ChipBase", "module": "src/components/chip/chip-base.ts" } }, { "name": "selectable", "type": { "text": "boolean" }, "default": "false", "description": "Whether to make this chip selectable or not", "fieldName": "selectable", "inheritedFrom": { "name": "ChipBase", "module": "src/components/chip/chip-base.ts" } }, { "name": "color", "type": { "text": "| 'primary'\n | 'success'\n | 'warning'\n | 'error'\n | 'info'\n | undefined" }, "default": "undefined", "description": "Color of the chip if the chip is not selectable and color of a selected chip if it is.", "resolveInitializer": { "module": "src/components/chip/chip-base.ts" }, "fieldName": "color", "inheritedFrom": { "name": "ChipBase", "module": "src/components/chip/chip-base.ts" } }, { "name": "outlined", "type": { "text": "boolean" }, "default": "false", "description": "Show an outlined chip instead of a default filled one", "fieldName": "outlined", "inheritedFrom": { "name": "ChipBase", "module": "src/components/chip/chip-base.ts" } }, { "name": "index", "type": { "text": "number | undefined" }, "default": "undefined", "resolveInitializer": { "module": "src/components/chip/chip-base.ts" }, "fieldName": "index", "inheritedFrom": { "name": "ChipBase", "module": "src/components/chip/chip-base.ts" } } ] } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "Chip", "module": "src/components/chip/chip.ts" } }, { "kind": "custom-element-definition", "name": "bp-chip", "declaration": { "name": "Chip", "module": "src/components/chip/chip.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/chip-set/chip-set-base.ts", "declarations": [ { "kind": "class", "description": "", "name": "ChipSetBase", "members": [ { "kind": "field", "name": "formSubmitController", "type": { "text": "FormSubmitController" }, "default": "new FormSubmitController(this, {\n value: (control: ChipSetBase) => JSON.stringify(control.value),\n defaultValue: (control: ChipSetBase) => {\n if (typeof control.defaultValue === 'string') {\n return control.defaultValue;\n }\n return JSON.stringify(control.defaultValue);\n },\n setValue: (control: ChipSetBase, value: string) => {\n // the chips' state needs to be reset and retoggled manually,\n // since it is not directly connected to the value\n // and will not trigger any updates to the chips\n const defVal = JSON.parse(value) as IChipSetValue;\n control.chips?.forEach((chip) => {\n chip.show();\n chip.deselect();\n if (!defVal?.available.includes(chip.index!)) {\n chip.hide();\n }\n if (defVal?.selected.includes(chip.index!)) {\n chip.select();\n }\n });\n control.value = defVal;\n },\n })" }, { "kind": "field", "name": "selectable", "type": { "text": "boolean" }, "default": "false", "description": "Whether to make chips in chip set selectable", "attribute": "selectable" }, { "kind": "field", "name": "multi", "type": { "text": "boolean" }, "default": "false", "description": "Whether to enable multiple chip selection. Note: selectable, must be true for this to work.", "attribute": "multi" }, { "kind": "field", "name": "closable", "type": { "text": "boolean" }, "default": "false", "description": "Whether to make chips in chip set closable", "attribute": "closable" }, { "kind": "field", "name": "color", "type": { "text": "| 'primary'\n | 'success'\n | 'warning'\n | 'error'\n | 'info'\n | undefined | undefined" }, "default": "undefined", "description": "Color of all of the chips. Note: This property is optional, and if passed in, it will override the color on all of the chips. If you want different colors for different chips - set the property on the `bp-chip` component instead.", "attribute": "color" }, { "kind": "field", "name": "outlined", "type": { "text": "boolean" }, "default": "false", "description": "Wheter to make all chips outlined or not", "attribute": "outlined" }, { "kind": "field", "name": "value", "type": { "text": "IChipSetValue" }, "default": "{\n available: [],\n selected: [],\n }", "description": "The value of the chipset is an object that consists of an \"available\" (shown/not closed) array of chip indexes and a \"selected\" array of chip indexes. Updates on every change.", "attribute": "value" }, { "kind": "field", "name": "name", "type": { "text": "string" }, "default": "''", "description": "The name of the element, to work with form data", "attribute": "name" }, { "kind": "field", "name": "defaultValue", "type": { "text": "string" }, "default": "''" }, { "kind": "field", "name": "chips", "type": { "text": "Chip[] | null" }, "attribute": "chips" }, { "kind": "field", "name": "availableChips", "type": { "text": "Chip[] | null" }, "attribute": "availableChips" }, { "kind": "field", "name": "selectedChips", "type": { "text": "Chip[] | null" }, "attribute": "selectedChips" }, { "kind": "field", "name": "emitEvents", "privacy": "protected" }, { "kind": "field", "name": "selectChip", "privacy": "protected" }, { "kind": "field", "name": "deselectChip", "privacy": "protected" }, { "kind": "field", "name": "closeChip", "privacy": "protected" }, { "kind": "field", "name": "showChip", "privacy": "protected" }, { "kind": "method", "name": "deriveArrays" }, { "kind": "method", "name": "generateValue", "return": { "type": { "text": "IChipSetValue" } } }, { "kind": "field", "name": "updateAllChips" }, { "kind": "field", "name": "parseFirstValue", "privacy": "protected" }, { "kind": "field", "name": "setupSlotChangeListener", "privacy": "protected" } ], "attributes": [ { "name": "selectable", "type": { "text": "boolean" }, "default": "false", "description": "Whether to make chips in chip set selectable", "fieldName": "selectable" }, { "name": "multi", "type": { "text": "boolean" }, "default": "false", "description": "Whether to enable multiple chip selection. Note: selectable, must be true for this to work.", "fieldName": "multi" }, { "name": "closable", "type": { "text": "boolean" }, "default": "false", "description": "Whether to make chips in chip set closable", "fieldName": "closable" }, { "name": "color", "type": { "text": "| 'primary'\n | 'success'\n | 'warning'\n | 'error'\n | 'info'\n | undefined | undefined" }, "default": "undefined", "description": "Color of all of the chips. Note: This property is optional, and if passed in, it will override the color on all of the chips. If you want different colors for different chips - set the property on the `bp-chip` component instead.", "resolveInitializer": { "module": "src/components/chip-set/chip-set-base.ts" }, "fieldName": "color" }, { "name": "outlined", "type": { "text": "boolean" }, "default": "false", "description": "Wheter to make all chips outlined or not", "fieldName": "outlined" }, { "name": "value", "type": { "text": "IChipSetValue" }, "default": "{\n available: [],\n selected: [],\n }", "description": "The value of the chipset is an object that consists of an \"available\" (shown/not closed) array of chip indexes and a \"selected\" array of chip indexes. Updates on every change.", "fieldName": "value" }, { "name": "name", "type": { "text": "string" }, "default": "''", "description": "The name of the element, to work with form data", "fieldName": "name" }, { "name": "chips", "type": { "text": "Chip[] | null" }, "fieldName": "chips" }, { "name": "availableChips", "type": { "text": "Chip[] | null" }, "fieldName": "availableChips" }, { "name": "selectedChips", "type": { "text": "Chip[] | null" }, "fieldName": "selectedChips" } ], "superclass": { "name": "LitElement", "package": "lit" }, "customElement": true } ], "exports": [ { "kind": "js", "name": "ChipSetBase", "declaration": { "name": "ChipSetBase", "module": "src/components/chip-set/chip-set-base.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/chip-set/chip-set.ts", "declarations": [ { "kind": "class", "description": "", "name": "ChipSet", "slots": [ { "description": "Slot for chips.", "name": "" } ], "members": [ { "kind": "field", "name": "formSubmitController", "type": { "text": "FormSubmitController" }, "default": "new FormSubmitController(this, {\n value: (control: ChipSetBase) => JSON.stringify(control.value),\n defaultValue: (control: ChipSetBase) => {\n if (typeof control.defaultValue === 'string') {\n return control.defaultValue;\n }\n return JSON.stringify(control.defaultValue);\n },\n setValue: (control: ChipSetBase, value: string) => {\n // the chips' state needs to be reset and retoggled manually,\n // since it is not directly connected to the value\n // and will not trigger any updates to the chips\n const defVal = JSON.parse(value) as IChipSetValue;\n control.chips?.forEach((chip) => {\n chip.show();\n chip.deselect();\n if (!defVal?.available.includes(chip.index!)) {\n chip.hide();\n }\n if (defVal?.selected.includes(chip.index!)) {\n chip.select();\n }\n });\n control.value = defVal;\n },\n })", "inheritedFrom": { "name": "ChipSetBase", "module": "src/components/chip-set/chip-set-base.ts" } }, { "kind": "field", "name": "selectable", "type": { "text": "boolean" }, "default": "false", "description": "Whether to make chips in chip set selectable", "attribute": "selectable", "inheritedFrom": { "name": "ChipSetBase", "module": "src/components/chip-set/chip-set-base.ts" } }, { "kind": "field", "name": "multi", "type": { "text": "boolean" }, "default": "false", "description": "Whether to enable multiple chip selection. Note: selectable, must be true for this to work.", "attribute": "multi", "inheritedFrom": { "name": "ChipSetBase", "module": "src/components/chip-set/chip-set-base.ts" } }, { "kind": "field", "name": "closable", "type": { "text": "boolean" }, "default": "false", "description": "Whether to make chips in chip set closable", "attribute": "closable", "inheritedFrom": { "name": "ChipSetBase", "module": "src/components/chip-set/chip-set-base.ts" } }, { "kind": "field", "name": "color", "type": { "text": "| 'primary'\n | 'success'\n | 'warning'\n | 'error'\n | 'info'\n | undefined | undefined" }, "default": "undefined", "description": "Color of all of the chips. Note: This property is optional, and if passed in, it will override the color on all of the chips. If you want different colors for different chips - set the property on the `bp-chip` component instead.", "attribute": "color", "inheritedFrom": { "name": "ChipSetBase", "module": "src/components/chip-set/chip-set-base.ts" } }, { "kind": "field", "name": "outlined", "type": { "text": "boolean" }, "default": "false", "description": "Wheter to make all chips outlined or not", "attribute": "outlined", "inheritedFrom": { "name": "ChipSetBase", "module": "src/components/chip-set/chip-set-base.ts" } }, { "kind": "field", "name": "value", "type": { "text": "IChipSetValue" }, "default": "{\n available: [],\n selected: [],\n }", "description": "The value of the chipset is an object that consists of an \"available\" (shown/not closed) array of chip indexes and a \"selected\" array of chip indexes. Updates on every change.", "attribute": "value", "inheritedFrom": { "name": "ChipSetBase", "module": "src/components/chip-set/chip-set-base.ts" } }, { "kind": "field", "name": "name", "type": { "text": "string" }, "default": "''", "description": "The name of the element, to work with form data", "attribute": "name", "inheritedFrom": { "name": "ChipSetBase", "module": "src/components/chip-set/chip-set-base.ts" } }, { "kind": "field", "name": "defaultValue", "type": { "text": "string" }, "default": "''", "inheritedFrom": { "name": "ChipSetBase", "module": "src/components/chip-set/chip-set-base.ts" } }, { "kind": "field", "name": "chips", "type": { "text": "Chip[] | null" }, "attribute": "chips", "inheritedFrom": { "name": "ChipSetBase", "module": "src/components/chip-set/chip-set-base.ts" } }, { "kind": "field", "name": "availableChips", "type": { "text": "Chip[] | null" }, "attribute": "availableChips", "inheritedFrom": { "name": "ChipSetBase", "module": "src/components/chip-set/chip-set-base.ts" } }, { "kind": "field", "name": "selectedChips", "type": { "text": "Chip[] | null" }, "attribute": "selectedChips", "inheritedFrom": { "name": "ChipSetBase", "module": "src/components/chip-set/chip-set-base.ts" } }, { "kind": "field", "name": "emitEvents", "privacy": "protected", "inheritedFrom": { "name": "ChipSetBase", "module": "src/components/chip-set/chip-set-base.ts" } }, { "kind": "field", "name": "selectChip", "privacy": "protected", "inheritedFrom": { "name": "ChipSetBase", "module": "src/components/chip-set/chip-set-base.ts" } }, { "kind": "field", "name": "deselectChip", "privacy": "protected", "inheritedFrom": { "name": "ChipSetBase", "module": "src/components/chip-set/chip-set-base.ts" } }, { "kind": "field", "name": "closeChip", "privacy": "protected", "inheritedFrom": { "name": "ChipSetBase", "module": "src/components/chip-set/chip-set-base.ts" } }, { "kind": "field", "name": "showChip", "privacy": "protected", "inheritedFrom": { "name": "ChipSetBase", "module": "src/components/chip-set/chip-set-base.ts" } }, { "kind": "method", "name": "deriveArrays", "inheritedFrom": { "name": "ChipSetBase", "module": "src/components/chip-set/chip-set-base.ts" } }, { "kind": "method", "name": "generateValue", "return": { "type": { "text": "IChipSetValue" } }, "inheritedFrom": { "name": "ChipSetBase", "module": "src/components/chip-set/chip-set-base.ts" } }, { "kind": "field", "name": "updateAllChips", "inheritedFrom": { "name": "ChipSetBase", "module": "src/components/chip-set/chip-set-base.ts" } }, { "kind": "field", "name": "parseFirstValue", "privacy": "protected", "inheritedFrom": { "name": "ChipSetBase", "module": "src/components/chip-set/chip-set-base.ts" } }, { "kind": "field", "name": "setupSlotChangeListener", "privacy": "protected", "inheritedFrom": { "name": "ChipSetBase", "module": "src/components/chip-set/chip-set-base.ts" } } ], "events": [ { "type": { "text": "{available: number[], selected: number[]}" }, "description": "A global event, that is emitted whenever a change occurs in the chip-set.", "name": "bp-chip-set-chip-changed", "reactName": "onBpChipSetChipChanged" }, { "type": { "text": "{available: number[], selected: number[]}" }, "description": "Emitted when a chip in the chip-set is being hidden.", "name": "bp-chip-set-chip-closed", "reactName": "onBpChipSetChipClosed" }, { "type": { "text": "{available: number[], selected: number[]}" }, "description": "Emitted when a chip in the chip-set is being shown.", "name": "bp-chip-set-chip-shown", "reactName": "onBpChipSetChipShown" }, { "type": { "text": "{available: number[], selected: number[]}" }, "description": "Emitted when a chip in the chip-set is being selected.", "name": "bp-chip-set-chip-selected", "reactName": "onBpChipSetChipSelected" }, { "type": { "text": "{available: number[], selected: number[]}" }, "description": "Emitted when a chip in the chip-set is being deselected.", "name": "bp-chip-set-chip-deselected", "reactName": "onBpChipSetChipDeselected" }, { "type": { "text": "{available: number[], selected: number[]}" }, "description": "Emitted when a chip node is added to the slot of the chip set.", "name": "bp-chip-set-slot-content-changed", "reactName": "onBpChipSetSlotContentChanged" } ], "superclass": { "name": "ChipSetBase", "module": "/src/components/chip-set/chip-set-base.js" }, "since": "0.1.1-beta.1", "status": "beta", "dependencies": [ "bp-chip" ], "tagName": "bp-chip-set", "customElement": true, "attributes": [ { "name": "selectable", "type": { "text": "boolean" }, "default": "false", "description": "Whether to make chips in chip set selectable", "fieldName": "selectable", "inheritedFrom": { "name": "ChipSetBase", "module": "src/components/chip-set/chip-set-base.ts" } }, { "name": "multi", "type": { "text": "boolean" }, "default": "false", "description": "Whether to enable multiple chip selection. Note: selectable, must be true for this to work.", "fieldName": "multi", "inheritedFrom": { "name": "ChipSetBase", "module": "src/components/chip-set/chip-set-base.ts" } }, { "name": "closable", "type": { "text": "boolean" }, "default": "false", "description": "Whether to make chips in chip set closable", "fieldName": "closable", "inheritedFrom": { "name": "ChipSetBase", "module": "src/components/chip-set/chip-set-base.ts" } }, { "name": "color", "type": { "text": "| 'primary'\n | 'success'\n | 'warning'\n | 'error'\n | 'info'\n | undefined | undefined" }, "default": "undefined", "description": "Color of all of the chips. Note: This property is optional, and if passed in, it will override the color on all of the chips. If you want different colors for different chips - set the property on the `bp-chip` component instead.", "resolveInitializer": { "module": "src/components/chip-set/chip-set-base.ts" }, "fieldName": "color", "inheritedFrom": { "name": "ChipSetBase", "module": "src/components/chip-set/chip-set-base.ts" } }, { "name": "outlined", "type": { "text": "boolean" }, "default": "false", "description": "Wheter to make all chips outlined or not", "fieldName": "outlined", "inheritedFrom": { "name": "ChipSetBase", "module": "src/components/chip-set/chip-set-base.ts" } }, { "name": "value", "type": { "text": "IChipSetValue" }, "default": "{\n available: [],\n selected: [],\n }", "description": "The value of the chipset is an object that consists of an \"available\" (shown/not closed) array of chip indexes and a \"selected\" array of chip indexes. Updates on every change.", "fieldName": "value", "inheritedFrom": { "name": "ChipSetBase", "module": "src/components/chip-set/chip-set-base.ts" } }, { "name": "name", "type": { "text": "string" }, "default": "''", "description": "The name of the element, to work with form data", "fieldName": "name", "inheritedFrom": { "name": "ChipSetBase", "module": "src/components/chip-set/chip-set-base.ts" } }, { "name": "chips", "type": { "text": "Chip[] | null" }, "fieldName": "chips", "inheritedFrom": { "name": "ChipSetBase", "module": "src/components/chip-set/chip-set-base.ts" } }, { "name": "availableChips", "type": { "text": "Chip[] | null" }, "fieldName": "availableChips", "inheritedFrom": { "name": "ChipSetBase", "module": "src/components/chip-set/chip-set-base.ts" } }, { "name": "selectedChips", "type": { "text": "Chip[] | null" }, "fieldName": "selectedChips", "inheritedFrom": { "name": "ChipSetBase", "module": "src/components/chip-set/chip-set-base.ts" } } ] } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "ChipSet", "module": "src/components/chip-set/chip-set.ts" } }, { "kind": "custom-element-definition", "name": "bp-chip-set", "declaration": { "name": "ChipSet", "module": "src/components/chip-set/chip-set.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/circular-progress/circular-progress-base.ts", "declarations": [ { "kind": "class", "description": "", "name": "CircularProgressBase", "members": [ { "kind": "field", "name": "indeterminate", "type": { "text": "boolean" }, "default": "false", "description": "Sets the circular-progress into its indeterminate state.", "attribute": "indeterminate" }, { "kind": "field", "name": "progress", "type": { "text": "number" }, "default": "0", "description": "Sets the progress bar's value. Value should be between [0, 1].", "attribute": "progress" }, { "kind": "field", "name": "density", "type": { "text": "number" }, "default": "0", "description": "Sets the progress indicator's sizing based on density scale. Minimum value is -8. Each unit change in density scale corresponds to 4px change in side dimensions. The stroke width adjusts automatically.", "attribute": "density" }, { "kind": "field", "name": "closed", "type": { "text": "boolean" }, "default": "false", "description": "Sets the progress indicator to the closed state. Sets content opacity to 0. Typically should be set to true when loading has finished.", "attribute": "closed" }, { "kind": "method", "name": "open", "description": "Sets CircularProgress.closed to true." }, { "kind": "method", "name": "close", "description": "Sets CircularProgress.closed to false." } ], "attributes": [ { "name": "indeterminate", "type": { "text": "boolean" }, "default": "false", "description": "Sets the circular-progress into its indeterminate state.", "fieldName": "indeterminate" }, { "name": "progress", "type": { "text": "number" }, "default": "0", "description": "Sets the progress bar's value. Value should be between [0, 1].", "fieldName": "progress" }, { "name": "density", "type": { "text": "number" }, "default": "0", "description": "Sets the progress indicator's sizing based on density scale. Minimum value is -8. Each unit change in density scale corresponds to 4px change in side dimensions. The stroke width adjusts automatically.", "fieldName": "density" }, { "name": "closed", "type": { "text": "boolean" }, "default": "false", "description": "Sets the progress indicator to the closed state. Sets content opacity to 0. Typically should be set to true when loading has finished.", "fieldName": "closed" } ], "superclass": { "name": "CircularProgressFourColorBase", "package": "@material/mwc-circular-progress-four-color/mwc-circular-progress-four-color-base" } } ], "exports": [ { "kind": "js", "name": "CircularProgressBase", "declaration": { "name": "CircularProgressBase", "module": "src/components/circular-progress/circular-progress-base.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/circular-progress/circular-progress.ts", "declarations": [ { "kind": "class", "description": "", "name": "CircularProgress", "cssProperties": [ { "description": "Sets the first of the four rotating colors. (default --mdc-theme-primary)", "name": "--mdc-circular-progress-bar-color-1" }, { "description": "Sets the second of the four rotating colors. (default --mdc-theme-primary)", "name": "--mdc-circular-progress-bar-color-2" }, { "description": "Sets the third of the four rotating colors. (default --mdc-theme-primary)", "name": "--mdc-circular-progress-bar-color-3" }, { "description": "Sets the last of the four rotating colors. (default --mdc-theme-primary)", "name": "--mdc-circular-progress-bar-color-4" }, { "description": "Sets the track color of the determinate progress bar. (default transparent)", "name": "--mdc-circular-progress-track-color" }, { "description": "Sets the color of determinate progress bar. If the indeterminate four colors are unset, sets the color for indeterminate state as well.", "name": "--mdc-theme-primary" } ], "members": [ { "kind": "field", "name": "indeterminate", "type": { "text": "boolean" }, "default": "false", "description": "Sets the circular-progress into its indeterminate state.", "attribute": "indeterminate", "inheritedFrom": { "name": "CircularProgressBase", "module": "src/components/circular-progress/circular-progress-base.ts" } }, { "kind": "field", "name": "progress", "type": { "text": "number" }, "default": "0", "description": "Sets the progress bar's value. Value should be between [0, 1].", "attribute": "progress", "inheritedFrom": { "name": "CircularProgressBase", "module": "src/components/circular-progress/circular-progress-base.ts" } }, { "kind": "field", "name": "density", "type": { "text": "number" }, "default": "0", "description": "Sets the progress indicator's sizing based on density scale. Minimum value is -8. Each unit change in density scale corresponds to 4px change in side dimensions. The stroke width adjusts automatically.", "attribute": "density", "inheritedFrom": { "name": "CircularProgressBase", "module": "src/components/circular-progress/circular-progress-base.ts" } }, { "kind": "field", "name": "closed", "type": { "text": "boolean" }, "default": "false", "description": "Sets the progress indicator to the closed state. Sets content opacity to 0. Typically should be set to true when loading has finished.", "attribute": "closed", "inheritedFrom": { "name": "CircularProgressBase", "module": "src/components/circular-progress/circular-progress-base.ts" } }, { "kind": "method", "name": "open", "description": "Sets CircularProgress.closed to true.", "inheritedFrom": { "name": "CircularProgressBase", "module": "src/components/circular-progress/circular-progress-base.ts" } }, { "kind": "method", "name": "close", "description": "Sets CircularProgress.closed to false.", "inheritedFrom": { "name": "CircularProgressBase", "module": "src/components/circular-progress/circular-progress-base.ts" } } ], "superclass": { "name": "CircularProgressBase", "module": "/src/components/circular-progress/circular-progress-base.js" }, "since": "0.1.1-beta.10", "status": "beta", "tagName": "bp-circular-progress", "customElement": true, "attributes": [ { "name": "indeterminate", "type": { "text": "boolean" }, "default": "false", "description": "Sets the circular-progress into its indeterminate state.", "fieldName": "indeterminate", "inheritedFrom": { "name": "CircularProgressBase", "module": "src/components/circular-progress/circular-progress-base.ts" } }, { "name": "progress", "type": { "text": "number" }, "default": "0", "description": "Sets the progress bar's value. Value should be between [0, 1].", "fieldName": "progress", "inheritedFrom": { "name": "CircularProgressBase", "module": "src/components/circular-progress/circular-progress-base.ts" } }, { "name": "density", "type": { "text": "number" }, "default": "0", "description": "Sets the progress indicator's sizing based on density scale. Minimum value is -8. Each unit change in density scale corresponds to 4px change in side dimensions. The stroke width adjusts automatically.", "fieldName": "density", "inheritedFrom": { "name": "CircularProgressBase", "module": "src/components/circular-progress/circular-progress-base.ts" } }, { "name": "closed", "type": { "text": "boolean" }, "default": "false", "description": "Sets the progress indicator to the closed state. Sets content opacity to 0. Typically should be set to true when loading has finished.", "fieldName": "closed", "inheritedFrom": { "name": "CircularProgressBase", "module": "src/components/circular-progress/circular-progress-base.ts" } } ] } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "CircularProgress", "module": "src/components/circular-progress/circular-progress.ts" } }, { "kind": "custom-element-definition", "name": "bp-circular-progress", "declaration": { "name": "CircularProgress", "module": "src/components/circular-progress/circular-progress.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/container/container-base.ts", "declarations": [ { "kind": "class", "description": "", "name": "ContainerBase", "members": [ { "kind": "field", "name": "disableGutters", "type": { "text": "boolean" }, "default": "false", "description": "Disable gutters", "attribute": "disableGutters" }, { "kind": "field", "name": "fixed", "type": { "text": "boolean" }, "default": "false", "description": "Set the width to be fixed", "attribute": "fixed" }, { "kind": "field", "name": "maxWidth", "type": { "text": "| 'xs'\n | 'sm'\n | 'md'\n | 'lg'\n | 'xl'\n | string" }, "default": "'xs'", "description": "Maximum width for container", "attribute": "maxWidth" } ], "attributes": [ { "name": "disableGutters", "type": { "text": "boolean" }, "default": "false", "description": "Disable gutters", "fieldName": "disableGutters" }, { "name": "fixed", "type": { "text": "boolean" }, "default": "false", "description": "Set the width to be fixed", "fieldName": "fixed" }, { "name": "maxWidth", "type": { "text": "| 'xs'\n | 'sm'\n | 'md'\n | 'lg'\n | 'xl'\n | string" }, "default": "'xs'", "description": "Maximum width for container", "fieldName": "maxWidth" } ], "superclass": { "name": "LitElement", "package": "lit" }, "customElement": true } ], "exports": [ { "kind": "js", "name": "ContainerBase", "declaration": { "name": "ContainerBase", "module": "src/components/container/container-base.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/container/container.ts", "declarations": [ { "kind": "class", "description": "", "name": "Container", "cssProperties": [ { "description": "Use to override the container max-width", "name": "--bp-container--max-width" } ], "cssParts": [ { "description": "The container element", "name": "container" } ], "slots": [ { "description": "The Container's content", "name": "" } ], "members": [ { "kind": "field", "name": "disableGutters", "type": { "text": "boolean" }, "default": "false", "description": "Disable gutters", "attribute": "disableGutters", "inheritedFrom": { "name": "ContainerBase", "module": "src/components/container/container-base.ts" } }, { "kind": "field", "name": "fixed", "type": { "text": "boolean" }, "default": "false", "description": "Set the width to be fixed", "attribute": "fixed", "inheritedFrom": { "name": "ContainerBase", "module": "src/components/container/container-base.ts" } }, { "kind": "field", "name": "maxWidth", "type": { "text": "| 'xs'\n | 'sm'\n | 'md'\n | 'lg'\n | 'xl'\n | string" }, "default": "'xs'", "description": "Maximum width for container", "attribute": "maxWidth", "inheritedFrom": { "name": "ContainerBase", "module": "src/components/container/container-base.ts" } } ], "superclass": { "name": "ContainerBase", "module": "/src/components/container/container-base.js" }, "since": "0.1.1-beta.1", "status": "beta", "tagName": "bp-container", "customElement": true, "attributes": [ { "name": "disableGutters", "type": { "text": "boolean" }, "default": "false", "description": "Disable gutters", "fieldName": "disableGutters", "inheritedFrom": { "name": "ContainerBase", "module": "src/components/container/container-base.ts" } }, { "name": "fixed", "type": { "text": "boolean" }, "default": "false", "description": "Set the width to be fixed", "fieldName": "fixed", "inheritedFrom": { "name": "ContainerBase", "module": "src/components/container/container-base.ts" } }, { "name": "maxWidth", "type": { "text": "| 'xs'\n | 'sm'\n | 'md'\n | 'lg'\n | 'xl'\n | string" }, "default": "'xs'", "description": "Maximum width for container", "fieldName": "maxWidth", "inheritedFrom": { "name": "ContainerBase", "module": "src/components/container/container-base.ts" } } ] } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "Container", "module": "src/components/container/container.ts" } }, { "kind": "custom-element-definition", "name": "bp-container", "declaration": { "name": "Container", "module": "src/components/container/container.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/data-table/data-table-base.ts", "declarations": [ { "kind": "class", "description": "", "name": "DataTableBase", "members": [ { "kind": "field", "name": "columns", "type": { "text": "ColumnDef[]" }, "default": "[]", "description": "Tanstack column definitions. https://tanstack.com/table/v8/docs/guide/column-defs", "attribute": "columns" }, { "kind": "field", "name": "rows", "type": { "text": "Row[]" }, "default": "[]", "description": "Rows for the table.", "attribute": "rows" }, { "kind": "field", "name": "sortable", "type": { "text": "boolean" }, "default": "false", "description": "Allows table data sorting by columns.", "attribute": "sortable" }, { "kind": "field", "name": "selectable", "type": { "text": "boolean" }, "default": "false", "description": "Allows the selection of table rows.", "attribute": "selectable" }, { "kind": "field", "name": "resizable", "type": { "text": "boolean" }, "default": "false", "description": "Allows row resizing.", "attribute": "resizable" }, { "kind": "field", "name": "paginate", "type": { "text": "boolean" }, "default": "false", "description": "Allows result pagination.", "attribute": "paginate" }, { "kind": "field", "name": "paginateExpanded", "type": { "text": "boolean" }, "default": "false", "description": "Whether to treat expanded rows as paginatable rows or not.", "attribute": "paginate-expanded" }, { "kind": "field", "name": "rowsPerPage", "type": { "text": "number" }, "default": "6", "description": "Amount of table rows to show per page.", "attribute": "rows-per-page" }, { "kind": "field", "name": "expandable", "type": { "text": "boolean" }, "default": "false", "description": "Allows row expansion.", "attribute": "expandable" }, { "kind": "field", "name": "expandAll", "type": { "text": "boolean" }, "default": "false", "description": "Expands all expandable rows (if row expansion is enabled).", "attribute": "expand-all" }, { "kind": "field", "name": "table", "type": { "text": "Table" } }, { "kind": "method", "name": "setColumns", "privacy": "public", "parameters": [ { "name": "colDef", "type": { "text": "ColumnDef[]" } } ], "description": "Public method for setting the col defs programmatically instead of with an attribute." }, { "kind": "method", "name": "setRows", "privacy": "public", "parameters": [ { "name": "data", "type": { "text": "Row[]" } } ], "description": "Public method for setting the data programmatically instead of with an attribute." }, { "kind": "method", "name": "derivePaginationState", "privacy": "private" }, { "kind": "method", "name": "buildTable", "privacy": "public", "description": "Builds/rebuilds the table from its rows and cols." }, { "kind": "method", "name": "handleAnyTableStateChange", "privacy": "private", "parameters": [ { "name": "updater", "type": { "text": "Updater" } }, { "name": "key", "type": { "text": "keyof TableState" } } ], "description": "Method for handling any table state change." }, { "kind": "method", "name": "updateTableStateByKey", "privacy": "private", "parameters": [ { "name": "key", "type": { "text": "keyof TableState" } }, { "name": "value", "type": { "text": "T" } } ], "description": "Method for updating any table state by its key." }, { "kind": "method", "name": "emitStateChangeEvent", "privacy": "private", "parameters": [ { "name": "key", "type": { "text": "keyof TableState" } } ], "description": "Method for emiting state change events by key." }, { "kind": "method", "name": "handleSortingButtonClick", "privacy": "private", "parameters": [ { "name": "e", "type": { "text": "Event" } }, { "name": "header", "type": { "text": "Header" } } ] }, { "kind": "method", "name": "handleRowClick", "privacy": "private", "parameters": [ { "name": "e", "type": { "text": "Event" } }, { "name": "row", "type": { "text": "TanstackRow" } } ] }, { "kind": "method", "name": "renderSortableColumnHeader", "privacy": "private", "return": { "type": { "text": "TemplateResult" } }, "parameters": [ { "name": "header", "type": { "text": "Header" } } ] }, { "kind": "method", "name": "renderColumnHeader", "privacy": "private", "return": { "type": { "text": "TemplateResult" } }, "parameters": [ { "name": "header", "type": { "text": "Header" } } ] } ], "events": [ { "name": "bp-data-table-changed", "type": { "text": "CustomEvent" }, "reactName": "onBpDataTableChanged" }, { "name": "eventName", "type": { "text": "CustomEvent" }, "reactName": "onEventName" } ], "attributes": [ { "name": "columns", "type": { "text": "ColumnDef[]" }, "default": "[]", "description": "Tanstack column definitions. https://tanstack.com/table/v8/docs/guide/column-defs", "fieldName": "columns" }, { "name": "rows", "type": { "text": "Row[]" }, "default": "[]", "description": "Rows for the table.", "fieldName": "rows" }, { "name": "sortable", "type": { "text": "boolean" }, "default": "false", "description": "Allows table data sorting by columns.", "fieldName": "sortable" }, { "name": "selectable", "type": { "text": "boolean" }, "default": "false", "description": "Allows the selection of table rows.", "fieldName": "selectable" }, { "name": "resizable", "type": { "text": "boolean" }, "default": "false", "description": "Allows row resizing.", "fieldName": "resizable" }, { "name": "paginate", "type": { "text": "boolean" }, "default": "false", "description": "Allows result pagination.", "fieldName": "paginate" }, { "name": "paginate-expanded", "type": { "text": "boolean" }, "default": "false", "description": "Whether to treat expanded rows as paginatable rows or not.", "fieldName": "paginateExpanded" }, { "name": "rows-per-page", "type": { "text": "number" }, "default": "6", "description": "Amount of table rows to show per page.", "fieldName": "rowsPerPage" }, { "name": "expandable", "type": { "text": "boolean" }, "default": "false", "description": "Allows row expansion.", "fieldName": "expandable" }, { "name": "expand-all", "type": { "text": "boolean" }, "default": "false", "description": "Expands all expandable rows (if row expansion is enabled).", "fieldName": "expandAll" } ], "superclass": { "name": "LitElement", "package": "lit" }, "customElement": true } ], "exports": [ { "kind": "js", "name": "DataTableBase", "declaration": { "name": "DataTableBase", "module": "src/components/data-table/data-table-base.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/data-table/data-table.ts", "declarations": [ { "kind": "class", "description": "", "name": "DataTable", "cssParts": [ { "description": "css var for wrapping text inside of cells (default `normal`).", "name": "--bp-table-cell-white-space" }, { "description": "table width (default `auto`).", "name": "--bp-data-table-width" }, { "description": "table height (default `auto`).", "name": "--bp-data-table-height" }, { "description": "table overflow for the x axis (default `auto`).", "name": "--bp-data-table-overflow-x" }, { "description": "table overflow for the y axis (default `auto`).", "name": "--bp-data-table-overflow-y" } ], "members": [ { "kind": "field", "name": "columns", "type": { "text": "ColumnDef[]" }, "default": "[]", "description": "Tanstack column definitions. https://tanstack.com/table/v8/docs/guide/column-defs", "attribute": "columns", "inheritedFrom": { "name": "DataTableBase", "module": "src/components/data-table/data-table-base.ts" } }, { "kind": "field", "name": "rows", "type": { "text": "Row[]" }, "default": "[]", "description": "Rows for the table.", "attribute": "rows", "inheritedFrom": { "name": "DataTableBase", "module": "src/components/data-table/data-table-base.ts" } }, { "kind": "field", "name": "sortable", "type": { "text": "boolean" }, "default": "false", "description": "Allows table data sorting by columns.", "attribute": "sortable", "inheritedFrom": { "name": "DataTableBase", "module": "src/components/data-table/data-table-base.ts" } }, { "kind": "field", "name": "selectable", "type": { "text": "boolean" }, "default": "false", "description": "Allows the selection of table rows.", "attribute": "selectable", "inheritedFrom": { "name": "DataTableBase", "module": "src/components/data-table/data-table-base.ts" } }, { "kind": "field", "name": "resizable", "type": { "text": "boolean" }, "default": "false", "description": "Allows row resizing.", "attribute": "resizable", "inheritedFrom": { "name": "DataTableBase", "module": "src/components/data-table/data-table-base.ts" } }, { "kind": "field", "name": "paginate", "type": { "text": "boolean" }, "default": "false", "description": "Allows result pagination.", "attribute": "paginate", "inheritedFrom": { "name": "DataTableBase", "module": "src/components/data-table/data-table-base.ts" } }, { "kind": "field", "name": "paginateExpanded", "type": { "text": "boolean" }, "default": "false", "description": "Whether to treat expanded rows as paginatable rows or not.", "attribute": "paginate-expanded", "inheritedFrom": { "name": "DataTableBase", "module": "src/components/data-table/data-table-base.ts" } }, { "kind": "field", "name": "rowsPerPage", "type": { "text": "number" }, "default": "6", "description": "Amount of table rows to show per page.", "attribute": "rows-per-page", "inheritedFrom": { "name": "DataTableBase", "module": "src/components/data-table/data-table-base.ts" } }, { "kind": "field", "name": "expandable", "type": { "text": "boolean" }, "default": "false", "description": "Allows row expansion.", "attribute": "expandable", "inheritedFrom": { "name": "DataTableBase", "module": "src/components/data-table/data-table-base.ts" } }, { "kind": "field", "name": "expandAll", "type": { "text": "boolean" }, "default": "false", "description": "Expands all expandable rows (if row expansion is enabled).", "attribute": "expand-all", "inheritedFrom": { "name": "DataTableBase", "module": "src/components/data-table/data-table-base.ts" } }, { "kind": "field", "name": "table", "type": { "text": "Table" }, "inheritedFrom": { "name": "DataTableBase", "module": "src/components/data-table/data-table-base.ts" } }, { "kind": "method", "name": "setColumns", "privacy": "public", "parameters": [ { "name": "colDef", "type": { "text": "ColumnDef[]" } } ], "description": "Public method for setting the col defs programmatically instead of with an attribute.", "inheritedFrom": { "name": "DataTableBase", "module": "src/components/data-table/data-table-base.ts" } }, { "kind": "method", "name": "setRows", "privacy": "public", "parameters": [ { "name": "data", "type": { "text": "Row[]" } } ], "description": "Public method for setting the data programmatically instead of with an attribute.", "inheritedFrom": { "name": "DataTableBase", "module": "src/components/data-table/data-table-base.ts" } }, { "kind": "method", "name": "derivePaginationState", "privacy": "private", "inheritedFrom": { "name": "DataTableBase", "module": "src/components/data-table/data-table-base.ts" } }, { "kind": "method", "name": "buildTable", "privacy": "public", "description": "Builds/rebuilds the table from its rows and cols.", "inheritedFrom": { "name": "DataTableBase", "module": "src/components/data-table/data-table-base.ts" } }, { "kind": "method", "name": "handleAnyTableStateChange", "privacy": "private", "parameters": [ { "name": "updater", "type": { "text": "Updater" } }, { "name": "key", "type": { "text": "keyof TableState" } } ], "description": "Method for handling any table state change.", "inheritedFrom": { "name": "DataTableBase", "module": "src/components/data-table/data-table-base.ts" } }, { "kind": "method", "name": "updateTableStateByKey", "privacy": "private", "parameters": [ { "name": "key", "type": { "text": "keyof TableState" } }, { "name": "value", "type": { "text": "T" } } ], "description": "Method for updating any table state by its key.", "inheritedFrom": { "name": "DataTableBase", "module": "src/components/data-table/data-table-base.ts" } }, { "kind": "method", "name": "emitStateChangeEvent", "privacy": "private", "parameters": [ { "name": "key", "type": { "text": "keyof TableState" } } ], "description": "Method for emiting state change events by key.", "inheritedFrom": { "name": "DataTableBase", "module": "src/components/data-table/data-table-base.ts" } }, { "kind": "method", "name": "handleSortingButtonClick", "privacy": "private", "parameters": [ { "name": "e", "type": { "text": "Event" } }, { "name": "header", "type": { "text": "Header" } } ], "inheritedFrom": { "name": "DataTableBase", "module": "src/components/data-table/data-table-base.ts" } }, { "kind": "method", "name": "handleRowClick", "privacy": "private", "parameters": [ { "name": "e", "type": { "text": "Event" } }, { "name": "row", "type": { "text": "TanstackRow" } } ], "inheritedFrom": { "name": "DataTableBase", "module": "src/components/data-table/data-table-base.ts" } }, { "kind": "method", "name": "renderSortableColumnHeader", "privacy": "private", "return": { "type": { "text": "TemplateResult" } }, "parameters": [ { "name": "header", "type": { "text": "Header" } } ], "inheritedFrom": { "name": "DataTableBase", "module": "src/components/data-table/data-table-base.ts" } }, { "kind": "method", "name": "renderColumnHeader", "privacy": "private", "return": { "type": { "text": "TemplateResult" } }, "parameters": [ { "name": "header", "type": { "text": "Header" } } ], "inheritedFrom": { "name": "DataTableBase", "module": "src/components/data-table/data-table-base.ts" } } ], "events": [ { "name": "bp-data-table-changed", "type": { "text": "CustomEvent" }, "reactName": "onBpDataTableChanged", "description": "Emits when the actual table changes (does not trigger on expansion and row selection, it appears).", "inheritedFrom": { "name": "DataTableBase", "module": "src/components/data-table/data-table-base.ts" } }, { "type": { "text": "detail: SortingState" }, "description": "Emits when a column is sorted.", "name": "bp-data-table-sorting", "reactName": "onBpDataTableSorting" }, { "type": { "text": "detail: RowSelectionState" }, "description": "Emits a row is selected.", "name": "bp-data-table-rowSelection", "reactName": "onBpDataTableRowSelection" }, { "type": { "text": "detail: ExpandedState" }, "description": "Emits when a row is expanded.", "name": "bp-data-table-expanded", "reactName": "onBpDataTableExpanded" }, { "type": { "text": "detail: PaginationState" }, "description": "Emits when table's pagination state changed.", "name": "bp-data-table-pagination", "reactName": "onBpDataTablePagination" }, { "type": { "text": "detail: ColumnSizingState" }, "description": "Emits when a table is resized.", "name": "bp-data-table-columnSizing", "reactName": "onBpDataTableColumnSizing" }, { "type": { "text": "detail: ColumnSizingInfoState" }, "description": "Emits when a table is resized and wtf?.", "name": "bp-data-table-columnSizingInfo", "reactName": "onBpDataTableColumnSizingInfo" }, { "name": "eventName", "type": { "text": "CustomEvent" }, "reactName": "onEventName", "inheritedFrom": { "name": "DataTableBase", "module": "src/components/data-table/data-table-base.ts" } } ], "superclass": { "name": "DataTableBase", "module": "/src/components/data-table/data-table-base.js" }, "since": "1.0", "status": "Experimental", "dependencies": [ "bp-component" ], "tagName": "bp-data-table", "customElement": true, "attributes": [ { "name": "columns", "type": { "text": "ColumnDef[]" }, "default": "[]", "description": "Tanstack column definitions. https://tanstack.com/table/v8/docs/guide/column-defs", "fieldName": "columns", "inheritedFrom": { "name": "DataTableBase", "module": "src/components/data-table/data-table-base.ts" } }, { "name": "rows", "type": { "text": "Row[]" }, "default": "[]", "description": "Rows for the table.", "fieldName": "rows", "inheritedFrom": { "name": "DataTableBase", "module": "src/components/data-table/data-table-base.ts" } }, { "name": "sortable", "type": { "text": "boolean" }, "default": "false", "description": "Allows table data sorting by columns.", "fieldName": "sortable", "inheritedFrom": { "name": "DataTableBase", "module": "src/components/data-table/data-table-base.ts" } }, { "name": "selectable", "type": { "text": "boolean" }, "default": "false", "description": "Allows the selection of table rows.", "fieldName": "selectable", "inheritedFrom": { "name": "DataTableBase", "module": "src/components/data-table/data-table-base.ts" } }, { "name": "resizable", "type": { "text": "boolean" }, "default": "false", "description": "Allows row resizing.", "fieldName": "resizable", "inheritedFrom": { "name": "DataTableBase", "module": "src/components/data-table/data-table-base.ts" } }, { "name": "paginate", "type": { "text": "boolean" }, "default": "false", "description": "Allows result pagination.", "fieldName": "paginate", "inheritedFrom": { "name": "DataTableBase", "module": "src/components/data-table/data-table-base.ts" } }, { "name": "paginate-expanded", "type": { "text": "boolean" }, "default": "false", "description": "Whether to treat expanded rows as paginatable rows or not.", "fieldName": "paginateExpanded", "inheritedFrom": { "name": "DataTableBase", "module": "src/components/data-table/data-table-base.ts" } }, { "name": "rows-per-page", "type": { "text": "number" }, "default": "6", "description": "Amount of table rows to show per page.", "fieldName": "rowsPerPage", "inheritedFrom": { "name": "DataTableBase", "module": "src/components/data-table/data-table-base.ts" } }, { "name": "expandable", "type": { "text": "boolean" }, "default": "false", "description": "Allows row expansion.", "fieldName": "expandable", "inheritedFrom": { "name": "DataTableBase", "module": "src/components/data-table/data-table-base.ts" } }, { "name": "expand-all", "type": { "text": "boolean" }, "default": "false", "description": "Expands all expandable rows (if row expansion is enabled).", "fieldName": "expandAll", "inheritedFrom": { "name": "DataTableBase", "module": "src/components/data-table/data-table-base.ts" } } ] } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "DataTable", "module": "src/components/data-table/data-table.ts" } }, { "kind": "custom-element-definition", "name": "bp-data-table", "declaration": { "name": "DataTable", "module": "src/components/data-table/data-table.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/date-picker/date-picker-base.ts", "declarations": [ { "kind": "class", "description": "", "name": "DatePickerBase", "members": [ { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "The label of the textfield", "attribute": "label", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "kind": "field", "name": "enableTime", "type": { "text": "boolean" }, "default": "false", "description": "Allows the user to specify time.", "attribute": "enable-time", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "kind": "field", "name": "allowInput", "type": { "text": "boolean" }, "default": "false", "description": "Allows input.", "attribute": "allow-input", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "kind": "field", "name": "enableSeconds", "type": { "text": "boolean" }, "default": "false", "description": "Allows the user to specify seconds, if time is enabled.", "attribute": "enable-seconds", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "kind": "field", "name": "minDate", "type": { "text": "DateOption" }, "default": "''", "description": "The minimum date that a user can start picking from (inclusive).", "attribute": "min-date", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "kind": "field", "name": "maxDate", "type": { "text": "DateOption" }, "default": "''", "description": "The maximum date that a user can pick to (inclusive).", "attribute": "max-date", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "kind": "field", "name": "defaultDate", "type": { "text": "DateOption" }, "default": "''", "description": "Sets the initial selected date(s).", "attribute": "default-date", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "kind": "field", "name": "placeholder", "type": { "text": "string" }, "default": "''", "description": "Sets disappearing input placeholder.", "attribute": "placeholder", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "kind": "field", "name": "prefix", "type": { "text": "string" }, "default": "''", "description": "Prefix text to display before the input.", "attribute": "prefix", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "kind": "field", "name": "suffix", "type": { "text": "string" }, "default": "''", "description": "Suffix text to display after the input.", "attribute": "suffix", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "kind": "field", "name": "icon", "type": { "text": "string" }, "default": "''", "description": "Leading icon to display in input. See bp-icon.", "attribute": "icon", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "kind": "field", "name": "iconTrailing", "type": { "text": "string" }, "default": "''", "description": "Trailing icon to display in input. See bp-icon.", "attribute": "iconTrailing", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Whether or not the input should be disabled.", "attribute": "disabled", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "kind": "field", "name": "required", "type": { "text": "boolean" }, "default": "false", "description": "Displays error state if value is empty and input is blurred.", "attribute": "required", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "kind": "field", "name": "outlined", "type": { "text": "boolean" }, "default": "false", "description": "Whether or not to show the material outlined variant.", "attribute": "outlined", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "kind": "field", "name": "helper", "type": { "text": "string" }, "default": "''", "description": "Helper text to display below the input. Display default only when focused.", "attribute": "helper", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "kind": "field", "name": "validateOnInitialRender", "type": { "text": "boolean" }, "default": "false", "description": "Runs validation check on initial render.", "attribute": "validateOnInitialRender", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "kind": "field", "name": "validationMessage", "type": { "text": "string" }, "default": "''", "description": "HTMLInputElement.prototype.pattern (empty string will unset attribute)", "attribute": "validationMessage", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "kind": "field", "name": "dateFormat", "type": { "text": "string" }, "default": "'Y-m-d'", "description": "A string of characters which are used to define how the date will be displayed in the input box.", "attribute": "date-format", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "kind": "field", "name": "size", "type": { "text": "number | null" }, "default": "null", "description": "HTMLInputElement.prototype.size (null will unset attribute)", "attribute": "size", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "kind": "field", "name": "name", "type": { "text": "string" }, "default": "''", "description": "HTML name attribute.", "attribute": "name", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "kind": "field", "name": "value", "type": { "text": "string | string[]" }, "default": "''", "description": "The ISO string value of the date-picker.", "attribute": "value", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "kind": "method", "name": "setDate", "privacy": "public", "parameters": [ { "name": "date", "type": { "text": "DateOption" } } ], "description": "Exposed method to set the date on the date-picker", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "kind": "field", "name": "mode", "type": { "text": "'single' | 'range'" }, "default": "'single'", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "kind": "method", "name": "onChange", "privacy": "protected", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "kind": "method", "name": "emit", "privacy": "protected", "parameters": [ { "name": "detail", "type": { "text": "string" } } ], "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "kind": "field", "name": "formSubmitController", "type": { "text": "FormSubmitController" }, "default": "new FormSubmitController(this, {\n value: (control: DatePickerFoundation) => control.value,\n defaultValue: (control: DatePickerFoundation) =>\n JSON.stringify(control.defaultDate),\n setValue: (control: DatePickerFoundation, value: string) => {\n if (!control.defaultDate) {\n control.value = value;\n control.displayValue = control.defaultDisplayValue;\n control.flatpickr?.clear();\n return;\n }\n\n const date = new Date(this.defaultDate).toISOString();\n control.value = date;\n control.displayValue = control.defaultDisplayValue;\n control.flatpickr?.setDate(date, false, control.defaultDisplayValue);\n },\n })", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "kind": "field", "name": "displayValue", "type": { "text": "string" }, "default": "''", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "kind": "field", "name": "defaultValue", "type": { "text": "string | string[]" }, "default": "''", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "kind": "field", "name": "defaultDisplayValue", "type": { "text": "string" }, "default": "''", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "kind": "field", "name": "textfield", "type": { "text": "Textfield | null" }, "default": "null", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "kind": "field", "name": "flatpickr", "type": { "text": "flatpickr.Instance | null" }, "default": "null", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "kind": "method", "name": "instantiateFlatpickr", "privacy": "protected", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "kind": "method", "name": "propChangedIsInFlatpickrConfig", "parameters": [ { "name": "_changedProps", "type": { "text": "PropertyValueMap | Map" } } ], "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } } ], "attributes": [ { "name": "label", "type": { "text": "string" }, "default": "''", "description": "The label of the textfield", "fieldName": "label", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "name": "enable-time", "type": { "text": "boolean" }, "default": "false", "description": "Allows the user to specify time.", "fieldName": "enableTime", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "name": "allow-input", "type": { "text": "boolean" }, "default": "false", "description": "Allows input.", "fieldName": "allowInput", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "name": "enable-seconds", "type": { "text": "boolean" }, "default": "false", "description": "Allows the user to specify seconds, if time is enabled.", "fieldName": "enableSeconds", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "name": "min-date", "type": { "text": "DateOption" }, "default": "''", "description": "The minimum date that a user can start picking from (inclusive).", "fieldName": "minDate", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "name": "max-date", "type": { "text": "DateOption" }, "default": "''", "description": "The maximum date that a user can pick to (inclusive).", "fieldName": "maxDate", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "name": "default-date", "type": { "text": "DateOption" }, "default": "''", "description": "Sets the initial selected date(s).", "fieldName": "defaultDate", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "name": "placeholder", "type": { "text": "string" }, "default": "''", "description": "Sets disappearing input placeholder.", "fieldName": "placeholder", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "name": "prefix", "type": { "text": "string" }, "default": "''", "description": "Prefix text to display before the input.", "fieldName": "prefix", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "name": "suffix", "type": { "text": "string" }, "default": "''", "description": "Suffix text to display after the input.", "fieldName": "suffix", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "name": "icon", "type": { "text": "string" }, "default": "''", "description": "Leading icon to display in input. See bp-icon.", "fieldName": "icon", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "name": "iconTrailing", "type": { "text": "string" }, "default": "''", "description": "Trailing icon to display in input. See bp-icon.", "fieldName": "iconTrailing", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Whether or not the input should be disabled.", "fieldName": "disabled", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "name": "required", "type": { "text": "boolean" }, "default": "false", "description": "Displays error state if value is empty and input is blurred.", "fieldName": "required", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "name": "outlined", "type": { "text": "boolean" }, "default": "false", "description": "Whether or not to show the material outlined variant.", "fieldName": "outlined", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "name": "helper", "type": { "text": "string" }, "default": "''", "description": "Helper text to display below the input. Display default only when focused.", "fieldName": "helper", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "name": "validateOnInitialRender", "type": { "text": "boolean" }, "default": "false", "description": "Runs validation check on initial render.", "fieldName": "validateOnInitialRender", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "name": "validationMessage", "type": { "text": "string" }, "default": "''", "description": "HTMLInputElement.prototype.pattern (empty string will unset attribute)", "fieldName": "validationMessage", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "name": "date-format", "type": { "text": "string" }, "default": "'Y-m-d'", "description": "A string of characters which are used to define how the date will be displayed in the input box.", "fieldName": "dateFormat", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "name": "size", "type": { "text": "number | null" }, "default": "null", "description": "HTMLInputElement.prototype.size (null will unset attribute)", "fieldName": "size", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "name": "name", "type": { "text": "string" }, "default": "''", "description": "HTML name attribute.", "fieldName": "name", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "name": "value", "type": { "text": "string | string[]" }, "default": "''", "description": "The ISO string value of the date-picker.", "fieldName": "value", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } } ], "superclass": { "name": "DatePickerFoundation", "module": "/src/components/date-picker-foundation/date-picker-foundation" } } ], "exports": [ { "kind": "js", "name": "DatePickerBase", "declaration": { "name": "DatePickerBase", "module": "src/components/date-picker/date-picker-base.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/date-picker/date-picker.ts", "declarations": [ { "kind": "class", "description": "", "name": "DatePicker", "cssParts": [ { "description": "CSS variable for the main color of the date-picker.", "name": "--bp-date-picker-color" } ], "events": [ { "type": { "text": "detail: string" }, "description": "Gets triggered when the user selects a date, or changes the time on a selected date.", "name": "bp-date-picker-changed", "reactName": "onBpDatePickerChanged" } ], "superclass": { "name": "DatePickerBase", "module": "/src/components/date-picker/date-picker-base.js" }, "since": "0.1.1-beta.1", "status": "beta", "tagName": "bp-date-picker", "customElement": true, "attributes": [ { "name": "label", "type": { "text": "string" }, "default": "''", "description": "The label of the textfield", "fieldName": "label", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "name": "enable-time", "type": { "text": "boolean" }, "default": "false", "description": "Allows the user to specify time.", "fieldName": "enableTime", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "name": "allow-input", "type": { "text": "boolean" }, "default": "false", "description": "Allows input.", "fieldName": "allowInput", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "name": "enable-seconds", "type": { "text": "boolean" }, "default": "false", "description": "Allows the user to specify seconds, if time is enabled.", "fieldName": "enableSeconds", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "name": "min-date", "type": { "text": "DateOption" }, "default": "''", "description": "The minimum date that a user can start picking from (inclusive).", "fieldName": "minDate", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "name": "max-date", "type": { "text": "DateOption" }, "default": "''", "description": "The maximum date that a user can pick to (inclusive).", "fieldName": "maxDate", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "name": "default-date", "type": { "text": "DateOption" }, "default": "''", "description": "Sets the initial selected date(s).", "fieldName": "defaultDate", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "name": "placeholder", "type": { "text": "string" }, "default": "''", "description": "Sets disappearing input placeholder.", "fieldName": "placeholder", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "name": "prefix", "type": { "text": "string" }, "default": "''", "description": "Prefix text to display before the input.", "fieldName": "prefix", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "name": "suffix", "type": { "text": "string" }, "default": "''", "description": "Suffix text to display after the input.", "fieldName": "suffix", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "name": "icon", "type": { "text": "string" }, "default": "''", "description": "Leading icon to display in input. See bp-icon.", "fieldName": "icon", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "name": "iconTrailing", "type": { "text": "string" }, "default": "''", "description": "Trailing icon to display in input. See bp-icon.", "fieldName": "iconTrailing", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Whether or not the input should be disabled.", "fieldName": "disabled", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "name": "required", "type": { "text": "boolean" }, "default": "false", "description": "Displays error state if value is empty and input is blurred.", "fieldName": "required", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "name": "outlined", "type": { "text": "boolean" }, "default": "false", "description": "Whether or not to show the material outlined variant.", "fieldName": "outlined", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "name": "helper", "type": { "text": "string" }, "default": "''", "description": "Helper text to display below the input. Display default only when focused.", "fieldName": "helper", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "name": "validateOnInitialRender", "type": { "text": "boolean" }, "default": "false", "description": "Runs validation check on initial render.", "fieldName": "validateOnInitialRender", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "name": "validationMessage", "type": { "text": "string" }, "default": "''", "description": "HTMLInputElement.prototype.pattern (empty string will unset attribute)", "fieldName": "validationMessage", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "name": "date-format", "type": { "text": "string" }, "default": "'Y-m-d'", "description": "A string of characters which are used to define how the date will be displayed in the input box.", "fieldName": "dateFormat", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "name": "size", "type": { "text": "number | null" }, "default": "null", "description": "HTMLInputElement.prototype.size (null will unset attribute)", "fieldName": "size", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "name": "name", "type": { "text": "string" }, "default": "''", "description": "HTML name attribute.", "fieldName": "name", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "name": "value", "type": { "text": "string | string[]" }, "default": "''", "description": "The ISO string value of the date-picker.", "fieldName": "value", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } } ], "members": [ { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "The label of the textfield", "attribute": "label", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "kind": "field", "name": "enableTime", "type": { "text": "boolean" }, "default": "false", "description": "Allows the user to specify time.", "attribute": "enable-time", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "kind": "field", "name": "allowInput", "type": { "text": "boolean" }, "default": "false", "description": "Allows input.", "attribute": "allow-input", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "kind": "field", "name": "enableSeconds", "type": { "text": "boolean" }, "default": "false", "description": "Allows the user to specify seconds, if time is enabled.", "attribute": "enable-seconds", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "kind": "field", "name": "minDate", "type": { "text": "DateOption" }, "default": "''", "description": "The minimum date that a user can start picking from (inclusive).", "attribute": "min-date", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "kind": "field", "name": "maxDate", "type": { "text": "DateOption" }, "default": "''", "description": "The maximum date that a user can pick to (inclusive).", "attribute": "max-date", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "kind": "field", "name": "defaultDate", "type": { "text": "DateOption" }, "default": "''", "description": "Sets the initial selected date(s).", "attribute": "default-date", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "kind": "field", "name": "placeholder", "type": { "text": "string" }, "default": "''", "description": "Sets disappearing input placeholder.", "attribute": "placeholder", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "kind": "field", "name": "prefix", "type": { "text": "string" }, "default": "''", "description": "Prefix text to display before the input.", "attribute": "prefix", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "kind": "field", "name": "suffix", "type": { "text": "string" }, "default": "''", "description": "Suffix text to display after the input.", "attribute": "suffix", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "kind": "field", "name": "icon", "type": { "text": "string" }, "default": "''", "description": "Leading icon to display in input. See bp-icon.", "attribute": "icon", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "kind": "field", "name": "iconTrailing", "type": { "text": "string" }, "default": "''", "description": "Trailing icon to display in input. See bp-icon.", "attribute": "iconTrailing", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Whether or not the input should be disabled.", "attribute": "disabled", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "kind": "field", "name": "required", "type": { "text": "boolean" }, "default": "false", "description": "Displays error state if value is empty and input is blurred.", "attribute": "required", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "kind": "field", "name": "outlined", "type": { "text": "boolean" }, "default": "false", "description": "Whether or not to show the material outlined variant.", "attribute": "outlined", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "kind": "field", "name": "helper", "type": { "text": "string" }, "default": "''", "description": "Helper text to display below the input. Display default only when focused.", "attribute": "helper", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "kind": "field", "name": "validateOnInitialRender", "type": { "text": "boolean" }, "default": "false", "description": "Runs validation check on initial render.", "attribute": "validateOnInitialRender", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "kind": "field", "name": "validationMessage", "type": { "text": "string" }, "default": "''", "description": "HTMLInputElement.prototype.pattern (empty string will unset attribute)", "attribute": "validationMessage", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "kind": "field", "name": "dateFormat", "type": { "text": "string" }, "default": "'Y-m-d'", "description": "A string of characters which are used to define how the date will be displayed in the input box.", "attribute": "date-format", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "kind": "field", "name": "size", "type": { "text": "number | null" }, "default": "null", "description": "HTMLInputElement.prototype.size (null will unset attribute)", "attribute": "size", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "kind": "field", "name": "name", "type": { "text": "string" }, "default": "''", "description": "HTML name attribute.", "attribute": "name", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "kind": "field", "name": "value", "type": { "text": "string | string[]" }, "default": "''", "description": "The ISO string value of the date-picker.", "attribute": "value", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "kind": "method", "name": "setDate", "privacy": "public", "parameters": [ { "name": "date", "type": { "text": "DateOption" } } ], "description": "Exposed method to set the date on the date-picker", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "kind": "field", "name": "mode", "type": { "text": "'single' | 'range'" }, "default": "'single'", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "kind": "method", "name": "onChange", "privacy": "protected", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "kind": "method", "name": "emit", "privacy": "protected", "parameters": [ { "name": "detail", "type": { "text": "string" } } ], "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "kind": "field", "name": "formSubmitController", "type": { "text": "FormSubmitController" }, "default": "new FormSubmitController(this, {\n value: (control: DatePickerFoundation) => control.value,\n defaultValue: (control: DatePickerFoundation) =>\n JSON.stringify(control.defaultDate),\n setValue: (control: DatePickerFoundation, value: string) => {\n if (!control.defaultDate) {\n control.value = value;\n control.displayValue = control.defaultDisplayValue;\n control.flatpickr?.clear();\n return;\n }\n\n const date = new Date(this.defaultDate).toISOString();\n control.value = date;\n control.displayValue = control.defaultDisplayValue;\n control.flatpickr?.setDate(date, false, control.defaultDisplayValue);\n },\n })", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "kind": "field", "name": "displayValue", "type": { "text": "string" }, "default": "''", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "kind": "field", "name": "defaultValue", "type": { "text": "string | string[]" }, "default": "''", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "kind": "field", "name": "defaultDisplayValue", "type": { "text": "string" }, "default": "''", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "kind": "field", "name": "textfield", "type": { "text": "Textfield | null" }, "default": "null", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "kind": "field", "name": "flatpickr", "type": { "text": "flatpickr.Instance | null" }, "default": "null", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "kind": "method", "name": "instantiateFlatpickr", "privacy": "protected", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "kind": "method", "name": "propChangedIsInFlatpickrConfig", "parameters": [ { "name": "_changedProps", "type": { "text": "PropertyValueMap | Map" } } ], "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } } ] } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "DatePicker", "module": "src/components/date-picker/date-picker.ts" } }, { "kind": "custom-element-definition", "name": "bp-date-picker", "declaration": { "name": "DatePicker", "module": "src/components/date-picker/date-picker.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/date-picker-foundation/date-picker-foundation.ts", "declarations": [ { "kind": "class", "description": "", "name": "DatePickerFoundation", "members": [ { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "The label of the textfield", "attribute": "label" }, { "kind": "field", "name": "enableTime", "type": { "text": "boolean" }, "default": "false", "description": "Allows the user to specify time.", "attribute": "enable-time" }, { "kind": "field", "name": "allowInput", "type": { "text": "boolean" }, "default": "false", "description": "Allows input.", "attribute": "allow-input" }, { "kind": "field", "name": "enableSeconds", "type": { "text": "boolean" }, "default": "false", "description": "Allows the user to specify seconds, if time is enabled.", "attribute": "enable-seconds" }, { "kind": "field", "name": "minDate", "type": { "text": "DateOption" }, "default": "''", "description": "The minimum date that a user can start picking from (inclusive).", "attribute": "min-date" }, { "kind": "field", "name": "maxDate", "type": { "text": "DateOption" }, "default": "''", "description": "The maximum date that a user can pick to (inclusive).", "attribute": "max-date" }, { "kind": "field", "name": "defaultDate", "type": { "text": "DateOption" }, "default": "''", "description": "Sets the initial selected date(s).", "attribute": "default-date" }, { "kind": "field", "name": "placeholder", "type": { "text": "string" }, "default": "''", "description": "Sets disappearing input placeholder.", "attribute": "placeholder" }, { "kind": "field", "name": "prefix", "type": { "text": "string" }, "default": "''", "description": "Prefix text to display before the input.", "attribute": "prefix" }, { "kind": "field", "name": "suffix", "type": { "text": "string" }, "default": "''", "description": "Suffix text to display after the input.", "attribute": "suffix" }, { "kind": "field", "name": "icon", "type": { "text": "string" }, "default": "''", "description": "Leading icon to display in input. See bp-icon.", "attribute": "icon" }, { "kind": "field", "name": "iconTrailing", "type": { "text": "string" }, "default": "''", "description": "Trailing icon to display in input. See bp-icon.", "attribute": "iconTrailing" }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Whether or not the input should be disabled.", "attribute": "disabled" }, { "kind": "field", "name": "required", "type": { "text": "boolean" }, "default": "false", "description": "Displays error state if value is empty and input is blurred.", "attribute": "required" }, { "kind": "field", "name": "outlined", "type": { "text": "boolean" }, "default": "false", "description": "Whether or not to show the material outlined variant.", "attribute": "outlined" }, { "kind": "field", "name": "helper", "type": { "text": "string" }, "default": "''", "description": "Helper text to display below the input. Display default only when focused.", "attribute": "helper" }, { "kind": "field", "name": "validateOnInitialRender", "type": { "text": "boolean" }, "default": "false", "description": "Runs validation check on initial render.", "attribute": "validateOnInitialRender" }, { "kind": "field", "name": "validationMessage", "type": { "text": "string" }, "default": "''", "description": "HTMLInputElement.prototype.pattern (empty string will unset attribute)", "attribute": "validationMessage" }, { "kind": "field", "name": "dateFormat", "type": { "text": "string" }, "default": "'Y-m-d'", "description": "A string of characters which are used to define how the date will be displayed in the input box.", "attribute": "date-format" }, { "kind": "field", "name": "size", "type": { "text": "number | null" }, "default": "null", "description": "HTMLInputElement.prototype.size (null will unset attribute)", "attribute": "size" }, { "kind": "field", "name": "formSubmitController", "type": { "text": "FormSubmitController" }, "default": "new FormSubmitController(this, {\n value: (control: DatePickerFoundation) => control.value,\n defaultValue: (control: DatePickerFoundation) =>\n JSON.stringify(control.defaultDate),\n setValue: (control: DatePickerFoundation, value: string) => {\n if (!control.defaultDate) {\n control.value = value;\n control.displayValue = control.defaultDisplayValue;\n control.flatpickr?.clear();\n return;\n }\n\n const date = new Date(this.defaultDate).toISOString();\n control.value = date;\n control.displayValue = control.defaultDisplayValue;\n control.flatpickr?.setDate(date, false, control.defaultDisplayValue);\n },\n })" }, { "kind": "field", "name": "mode", "type": { "text": "'single' | 'range'" }, "default": "'single'" }, { "kind": "field", "name": "name", "type": { "text": "string" }, "default": "''", "description": "HTML name attribute.", "attribute": "name" }, { "kind": "field", "name": "value", "type": { "text": "string | string[]" }, "default": "''", "description": "The ISO string(s) value of the date picker.", "attribute": "value" }, { "kind": "field", "name": "displayValue", "type": { "text": "string" }, "default": "''" }, { "kind": "field", "name": "defaultValue", "type": { "text": "string | string[]" }, "default": "''" }, { "kind": "field", "name": "defaultDisplayValue", "type": { "text": "string" }, "default": "''" }, { "kind": "field", "name": "textfield", "type": { "text": "Textfield | null" }, "default": "null" }, { "kind": "field", "name": "flatpickr", "type": { "text": "flatpickr.Instance | null" }, "default": "null" }, { "kind": "method", "name": "instantiateFlatpickr", "privacy": "protected" }, { "kind": "method", "name": "onChange", "privacy": "protected" }, { "kind": "method", "name": "emit", "privacy": "protected", "parameters": [ { "name": "detail", "type": { "text": "string | string[]" } } ] }, { "kind": "method", "name": "setDate", "privacy": "public", "parameters": [ { "name": "date", "type": { "text": "DateOption | DateOption[]" } } ], "description": "Exposed method to set the date on the date-picker" }, { "kind": "method", "name": "propChangedIsInFlatpickrConfig", "parameters": [ { "name": "_changedProps", "type": { "text": "PropertyValueMap | Map" } } ] } ], "attributes": [ { "name": "label", "type": { "text": "string" }, "default": "''", "description": "The label of the textfield", "fieldName": "label" }, { "name": "enable-time", "type": { "text": "boolean" }, "default": "false", "description": "Allows the user to specify time.", "fieldName": "enableTime" }, { "name": "allow-input", "type": { "text": "boolean" }, "default": "false", "description": "Allows input.", "fieldName": "allowInput" }, { "name": "enable-seconds", "type": { "text": "boolean" }, "default": "false", "description": "Allows the user to specify seconds, if time is enabled.", "fieldName": "enableSeconds" }, { "name": "min-date", "type": { "text": "DateOption" }, "default": "''", "description": "The minimum date that a user can start picking from (inclusive).", "fieldName": "minDate" }, { "name": "max-date", "type": { "text": "DateOption" }, "default": "''", "description": "The maximum date that a user can pick to (inclusive).", "fieldName": "maxDate" }, { "name": "default-date", "type": { "text": "DateOption" }, "default": "''", "description": "Sets the initial selected date(s).", "fieldName": "defaultDate" }, { "name": "placeholder", "type": { "text": "string" }, "default": "''", "description": "Sets disappearing input placeholder.", "fieldName": "placeholder" }, { "name": "prefix", "type": { "text": "string" }, "default": "''", "description": "Prefix text to display before the input.", "fieldName": "prefix" }, { "name": "suffix", "type": { "text": "string" }, "default": "''", "description": "Suffix text to display after the input.", "fieldName": "suffix" }, { "name": "icon", "type": { "text": "string" }, "default": "''", "description": "Leading icon to display in input. See bp-icon.", "fieldName": "icon" }, { "name": "iconTrailing", "type": { "text": "string" }, "default": "''", "description": "Trailing icon to display in input. See bp-icon.", "fieldName": "iconTrailing" }, { "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Whether or not the input should be disabled.", "fieldName": "disabled" }, { "name": "required", "type": { "text": "boolean" }, "default": "false", "description": "Displays error state if value is empty and input is blurred.", "fieldName": "required" }, { "name": "outlined", "type": { "text": "boolean" }, "default": "false", "description": "Whether or not to show the material outlined variant.", "fieldName": "outlined" }, { "name": "helper", "type": { "text": "string" }, "default": "''", "description": "Helper text to display below the input. Display default only when focused.", "fieldName": "helper" }, { "name": "validateOnInitialRender", "type": { "text": "boolean" }, "default": "false", "description": "Runs validation check on initial render.", "fieldName": "validateOnInitialRender" }, { "name": "validationMessage", "type": { "text": "string" }, "default": "''", "description": "HTMLInputElement.prototype.pattern (empty string will unset attribute)", "fieldName": "validationMessage" }, { "name": "date-format", "type": { "text": "string" }, "default": "'Y-m-d'", "description": "A string of characters which are used to define how the date will be displayed in the input box.", "fieldName": "dateFormat" }, { "name": "size", "type": { "text": "number | null" }, "default": "null", "description": "HTMLInputElement.prototype.size (null will unset attribute)", "fieldName": "size" }, { "name": "name", "type": { "text": "string" }, "default": "''", "description": "HTML name attribute.", "fieldName": "name" }, { "name": "value", "type": { "text": "string | string[]" }, "default": "''", "description": "The ISO string(s) value of the date picker.", "fieldName": "value" } ], "superclass": { "name": "LitElement", "package": "lit" }, "customElement": true } ], "exports": [ { "kind": "js", "name": "DatePickerFoundation", "declaration": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/date-range-picker/date-range-picker-base.ts", "declarations": [ { "kind": "class", "description": "", "name": "DateRangePickerBase", "members": [ { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "The label of the textfield", "attribute": "label", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "kind": "field", "name": "enableTime", "type": { "text": "boolean" }, "default": "false", "description": "Allows the user to specify time.", "attribute": "enable-time", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "kind": "field", "name": "enableSeconds", "type": { "text": "boolean" }, "default": "false", "description": "Allows the user to specify seconds, if time is enabled.", "attribute": "enable-seconds", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "kind": "field", "name": "minDate", "type": { "text": "DateOption" }, "default": "''", "description": "The minimum date that a user can start picking from (inclusive).", "attribute": "min-date", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "kind": "field", "name": "maxDate", "type": { "text": "DateOption" }, "default": "''", "description": "The maximum date that a user can pick to (inclusive).", "attribute": "max-date", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "kind": "field", "name": "defaultDate", "type": { "text": "DateOption" }, "default": "''", "description": "Sets the initial selected date(s).", "attribute": "default-date", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "kind": "field", "name": "placeholder", "type": { "text": "string" }, "default": "''", "description": "Sets disappearing input placeholder.", "attribute": "placeholder", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "kind": "field", "name": "prefix", "type": { "text": "string" }, "default": "''", "description": "Prefix text to display before the input.", "attribute": "prefix", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "kind": "field", "name": "suffix", "type": { "text": "string" }, "default": "''", "description": "Suffix text to display after the input.", "attribute": "suffix", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "kind": "field", "name": "icon", "type": { "text": "string" }, "default": "''", "description": "Leading icon to display in input. See bp-icon.", "attribute": "icon", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "kind": "field", "name": "iconTrailing", "type": { "text": "string" }, "default": "''", "description": "Trailing icon to display in input. See bp-icon.", "attribute": "iconTrailing", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Whether or not the input should be disabled.", "attribute": "disabled", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "kind": "field", "name": "required", "type": { "text": "boolean" }, "default": "false", "description": "Displays error state if value is empty and input is blurred.", "attribute": "required", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "kind": "field", "name": "outlined", "type": { "text": "boolean" }, "default": "false", "description": "Whether or not to show the material outlined variant.", "attribute": "outlined", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "kind": "field", "name": "helper", "type": { "text": "string" }, "default": "''", "description": "Helper text to display below the input. Display default only when focused.", "attribute": "helper", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "kind": "field", "name": "validateOnInitialRender", "type": { "text": "boolean" }, "default": "false", "description": "Runs validation check on initial render.", "attribute": "validateOnInitialRender", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "kind": "field", "name": "validationMessage", "type": { "text": "string" }, "default": "''", "description": "HTMLInputElement.prototype.pattern (empty string will unset attribute)", "attribute": "validationMessage", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "kind": "field", "name": "dateFormat", "type": { "text": "string" }, "default": "'Y-m-d'", "description": "A string of characters which are used to define how the date will be displayed in the input box.", "attribute": "date-format", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "kind": "field", "name": "size", "type": { "text": "number | null" }, "default": "null", "description": "HTMLInputElement.prototype.size (null will unset attribute)", "attribute": "size", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "kind": "field", "name": "name", "type": { "text": "string" }, "default": "''", "description": "HTML name attribute.", "attribute": "name", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "kind": "field", "name": "value", "type": { "text": "string | string[]" }, "default": "''", "description": "The ISO strings array value of the date-range-picker in JSON format.", "attribute": "value", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "kind": "method", "name": "setDate", "privacy": "public", "parameters": [ { "name": "date", "type": { "text": "DateOption[]" } } ], "description": "Exposed method to set the date on the date-range-picker", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "kind": "field", "name": "mode", "type": { "text": "'single' | 'range'" }, "default": "'range'", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "kind": "method", "name": "onChange", "privacy": "protected", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "kind": "method", "name": "emit", "privacy": "protected", "parameters": [ { "name": "detail", "type": { "text": "string[]" } } ], "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "kind": "field", "name": "allowInput", "type": { "text": "boolean" }, "default": "false", "description": "Allows input.", "attribute": "allow-input", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "kind": "field", "name": "formSubmitController", "type": { "text": "FormSubmitController" }, "default": "new FormSubmitController(this, {\n value: (control: DatePickerFoundation) => control.value,\n defaultValue: (control: DatePickerFoundation) =>\n JSON.stringify(control.defaultDate),\n setValue: (control: DatePickerFoundation, value: string) => {\n if (!control.defaultDate) {\n control.value = value;\n control.displayValue = control.defaultDisplayValue;\n control.flatpickr?.clear();\n return;\n }\n\n const date = new Date(this.defaultDate).toISOString();\n control.value = date;\n control.displayValue = control.defaultDisplayValue;\n control.flatpickr?.setDate(date, false, control.defaultDisplayValue);\n },\n })", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "kind": "field", "name": "displayValue", "type": { "text": "string" }, "default": "''", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "kind": "field", "name": "defaultValue", "type": { "text": "string | string[]" }, "default": "''", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "kind": "field", "name": "defaultDisplayValue", "type": { "text": "string" }, "default": "''", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "kind": "field", "name": "textfield", "type": { "text": "Textfield | null" }, "default": "null", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "kind": "field", "name": "flatpickr", "type": { "text": "flatpickr.Instance | null" }, "default": "null", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "kind": "method", "name": "instantiateFlatpickr", "privacy": "protected", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "kind": "method", "name": "propChangedIsInFlatpickrConfig", "parameters": [ { "name": "_changedProps", "type": { "text": "PropertyValueMap | Map" } } ], "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } } ], "attributes": [ { "name": "label", "type": { "text": "string" }, "default": "''", "description": "The label of the textfield", "fieldName": "label", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "name": "enable-time", "type": { "text": "boolean" }, "default": "false", "description": "Allows the user to specify time.", "fieldName": "enableTime", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "name": "enable-seconds", "type": { "text": "boolean" }, "default": "false", "description": "Allows the user to specify seconds, if time is enabled.", "fieldName": "enableSeconds", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "name": "min-date", "type": { "text": "DateOption" }, "default": "''", "description": "The minimum date that a user can start picking from (inclusive).", "fieldName": "minDate", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "name": "max-date", "type": { "text": "DateOption" }, "default": "''", "description": "The maximum date that a user can pick to (inclusive).", "fieldName": "maxDate", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "name": "default-date", "type": { "text": "DateOption" }, "default": "''", "description": "Sets the initial selected date(s).", "fieldName": "defaultDate", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "name": "placeholder", "type": { "text": "string" }, "default": "''", "description": "Sets disappearing input placeholder.", "fieldName": "placeholder", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "name": "prefix", "type": { "text": "string" }, "default": "''", "description": "Prefix text to display before the input.", "fieldName": "prefix", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "name": "suffix", "type": { "text": "string" }, "default": "''", "description": "Suffix text to display after the input.", "fieldName": "suffix", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "name": "icon", "type": { "text": "string" }, "default": "''", "description": "Leading icon to display in input. See bp-icon.", "fieldName": "icon", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "name": "iconTrailing", "type": { "text": "string" }, "default": "''", "description": "Trailing icon to display in input. See bp-icon.", "fieldName": "iconTrailing", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Whether or not the input should be disabled.", "fieldName": "disabled", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "name": "required", "type": { "text": "boolean" }, "default": "false", "description": "Displays error state if value is empty and input is blurred.", "fieldName": "required", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "name": "outlined", "type": { "text": "boolean" }, "default": "false", "description": "Whether or not to show the material outlined variant.", "fieldName": "outlined", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "name": "helper", "type": { "text": "string" }, "default": "''", "description": "Helper text to display below the input. Display default only when focused.", "fieldName": "helper", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "name": "validateOnInitialRender", "type": { "text": "boolean" }, "default": "false", "description": "Runs validation check on initial render.", "fieldName": "validateOnInitialRender", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "name": "validationMessage", "type": { "text": "string" }, "default": "''", "description": "HTMLInputElement.prototype.pattern (empty string will unset attribute)", "fieldName": "validationMessage", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "name": "date-format", "type": { "text": "string" }, "default": "'Y-m-d'", "description": "A string of characters which are used to define how the date will be displayed in the input box.", "fieldName": "dateFormat", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "name": "size", "type": { "text": "number | null" }, "default": "null", "description": "HTMLInputElement.prototype.size (null will unset attribute)", "fieldName": "size", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "name": "name", "type": { "text": "string" }, "default": "''", "description": "HTML name attribute.", "fieldName": "name", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "name": "value", "type": { "text": "string | string[]" }, "default": "''", "description": "The ISO strings array value of the date-range-picker in JSON format.", "fieldName": "value", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "name": "allow-input", "type": { "text": "boolean" }, "default": "false", "description": "Allows input.", "fieldName": "allowInput", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } } ], "superclass": { "name": "DatePickerFoundation", "module": "/src/components/date-picker-foundation/date-picker-foundation" } } ], "exports": [ { "kind": "js", "name": "DateRangePickerBase", "declaration": { "name": "DateRangePickerBase", "module": "src/components/date-range-picker/date-range-picker-base.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/date-range-picker/date-range-picker.ts", "declarations": [ { "kind": "class", "description": "", "name": "DateRangePicker", "cssParts": [ { "description": "CSS variable for the main color of the date-picker.", "name": "--bp-date-picker-color" } ], "events": [ { "type": { "text": "detail: string[]" }, "description": "Gets triggered when the user selects a date, or changes the time on a selected date.", "name": "bp-date-range-picker-changed", "reactName": "onBpDateRangePickerChanged" } ], "superclass": { "name": "DateRangePickerBase", "module": "/src/components/date-range-picker/date-range-picker-base" }, "since": "0.1.1-beta.1", "status": "beta", "tagName": "bp-date-range-picker", "customElement": true, "attributes": [ { "name": "label", "type": { "text": "string" }, "default": "''", "description": "The label of the textfield", "fieldName": "label", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "name": "enable-time", "type": { "text": "boolean" }, "default": "false", "description": "Allows the user to specify time.", "fieldName": "enableTime", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "name": "enable-seconds", "type": { "text": "boolean" }, "default": "false", "description": "Allows the user to specify seconds, if time is enabled.", "fieldName": "enableSeconds", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "name": "min-date", "type": { "text": "DateOption" }, "default": "''", "description": "The minimum date that a user can start picking from (inclusive).", "fieldName": "minDate", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "name": "max-date", "type": { "text": "DateOption" }, "default": "''", "description": "The maximum date that a user can pick to (inclusive).", "fieldName": "maxDate", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "name": "default-date", "type": { "text": "DateOption" }, "default": "''", "description": "Sets the initial selected date(s).", "fieldName": "defaultDate", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "name": "placeholder", "type": { "text": "string" }, "default": "''", "description": "Sets disappearing input placeholder.", "fieldName": "placeholder", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "name": "prefix", "type": { "text": "string" }, "default": "''", "description": "Prefix text to display before the input.", "fieldName": "prefix", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "name": "suffix", "type": { "text": "string" }, "default": "''", "description": "Suffix text to display after the input.", "fieldName": "suffix", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "name": "icon", "type": { "text": "string" }, "default": "''", "description": "Leading icon to display in input. See bp-icon.", "fieldName": "icon", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "name": "iconTrailing", "type": { "text": "string" }, "default": "''", "description": "Trailing icon to display in input. See bp-icon.", "fieldName": "iconTrailing", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Whether or not the input should be disabled.", "fieldName": "disabled", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "name": "required", "type": { "text": "boolean" }, "default": "false", "description": "Displays error state if value is empty and input is blurred.", "fieldName": "required", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "name": "outlined", "type": { "text": "boolean" }, "default": "false", "description": "Whether or not to show the material outlined variant.", "fieldName": "outlined", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "name": "helper", "type": { "text": "string" }, "default": "''", "description": "Helper text to display below the input. Display default only when focused.", "fieldName": "helper", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "name": "validateOnInitialRender", "type": { "text": "boolean" }, "default": "false", "description": "Runs validation check on initial render.", "fieldName": "validateOnInitialRender", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "name": "validationMessage", "type": { "text": "string" }, "default": "''", "description": "HTMLInputElement.prototype.pattern (empty string will unset attribute)", "fieldName": "validationMessage", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "name": "date-format", "type": { "text": "string" }, "default": "'Y-m-d'", "description": "A string of characters which are used to define how the date will be displayed in the input box.", "fieldName": "dateFormat", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "name": "size", "type": { "text": "number | null" }, "default": "null", "description": "HTMLInputElement.prototype.size (null will unset attribute)", "fieldName": "size", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "name": "name", "type": { "text": "string" }, "default": "''", "description": "HTML name attribute.", "fieldName": "name", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "name": "value", "type": { "text": "string | string[]" }, "default": "''", "description": "The ISO strings array value of the date-range-picker in JSON format.", "fieldName": "value", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "name": "allow-input", "type": { "text": "boolean" }, "default": "false", "description": "Allows input.", "fieldName": "allowInput", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } } ], "members": [ { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "The label of the textfield", "attribute": "label", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "kind": "field", "name": "enableTime", "type": { "text": "boolean" }, "default": "false", "description": "Allows the user to specify time.", "attribute": "enable-time", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "kind": "field", "name": "enableSeconds", "type": { "text": "boolean" }, "default": "false", "description": "Allows the user to specify seconds, if time is enabled.", "attribute": "enable-seconds", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "kind": "field", "name": "minDate", "type": { "text": "DateOption" }, "default": "''", "description": "The minimum date that a user can start picking from (inclusive).", "attribute": "min-date", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "kind": "field", "name": "maxDate", "type": { "text": "DateOption" }, "default": "''", "description": "The maximum date that a user can pick to (inclusive).", "attribute": "max-date", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "kind": "field", "name": "defaultDate", "type": { "text": "DateOption" }, "default": "''", "description": "Sets the initial selected date(s).", "attribute": "default-date", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "kind": "field", "name": "placeholder", "type": { "text": "string" }, "default": "''", "description": "Sets disappearing input placeholder.", "attribute": "placeholder", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "kind": "field", "name": "prefix", "type": { "text": "string" }, "default": "''", "description": "Prefix text to display before the input.", "attribute": "prefix", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "kind": "field", "name": "suffix", "type": { "text": "string" }, "default": "''", "description": "Suffix text to display after the input.", "attribute": "suffix", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "kind": "field", "name": "icon", "type": { "text": "string" }, "default": "''", "description": "Leading icon to display in input. See bp-icon.", "attribute": "icon", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "kind": "field", "name": "iconTrailing", "type": { "text": "string" }, "default": "''", "description": "Trailing icon to display in input. See bp-icon.", "attribute": "iconTrailing", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Whether or not the input should be disabled.", "attribute": "disabled", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "kind": "field", "name": "required", "type": { "text": "boolean" }, "default": "false", "description": "Displays error state if value is empty and input is blurred.", "attribute": "required", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "kind": "field", "name": "outlined", "type": { "text": "boolean" }, "default": "false", "description": "Whether or not to show the material outlined variant.", "attribute": "outlined", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "kind": "field", "name": "helper", "type": { "text": "string" }, "default": "''", "description": "Helper text to display below the input. Display default only when focused.", "attribute": "helper", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "kind": "field", "name": "validateOnInitialRender", "type": { "text": "boolean" }, "default": "false", "description": "Runs validation check on initial render.", "attribute": "validateOnInitialRender", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "kind": "field", "name": "validationMessage", "type": { "text": "string" }, "default": "''", "description": "HTMLInputElement.prototype.pattern (empty string will unset attribute)", "attribute": "validationMessage", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "kind": "field", "name": "dateFormat", "type": { "text": "string" }, "default": "'Y-m-d'", "description": "A string of characters which are used to define how the date will be displayed in the input box.", "attribute": "date-format", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "kind": "field", "name": "size", "type": { "text": "number | null" }, "default": "null", "description": "HTMLInputElement.prototype.size (null will unset attribute)", "attribute": "size", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "kind": "field", "name": "name", "type": { "text": "string" }, "default": "''", "description": "HTML name attribute.", "attribute": "name", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "kind": "field", "name": "value", "type": { "text": "string | string[]" }, "default": "''", "description": "The ISO strings array value of the date-range-picker in JSON format.", "attribute": "value", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "kind": "method", "name": "setDate", "privacy": "public", "parameters": [ { "name": "date", "type": { "text": "DateOption[]" } } ], "description": "Exposed method to set the date on the date-range-picker", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "kind": "field", "name": "mode", "type": { "text": "'single' | 'range'" }, "default": "'range'", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "kind": "method", "name": "onChange", "privacy": "protected", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "kind": "method", "name": "emit", "privacy": "protected", "parameters": [ { "name": "detail", "type": { "text": "string[]" } } ], "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "kind": "field", "name": "allowInput", "type": { "text": "boolean" }, "default": "false", "description": "Allows input.", "attribute": "allow-input", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "kind": "field", "name": "formSubmitController", "type": { "text": "FormSubmitController" }, "default": "new FormSubmitController(this, {\n value: (control: DatePickerFoundation) => control.value,\n defaultValue: (control: DatePickerFoundation) =>\n JSON.stringify(control.defaultDate),\n setValue: (control: DatePickerFoundation, value: string) => {\n if (!control.defaultDate) {\n control.value = value;\n control.displayValue = control.defaultDisplayValue;\n control.flatpickr?.clear();\n return;\n }\n\n const date = new Date(this.defaultDate).toISOString();\n control.value = date;\n control.displayValue = control.defaultDisplayValue;\n control.flatpickr?.setDate(date, false, control.defaultDisplayValue);\n },\n })", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "kind": "field", "name": "displayValue", "type": { "text": "string" }, "default": "''", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "kind": "field", "name": "defaultValue", "type": { "text": "string | string[]" }, "default": "''", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "kind": "field", "name": "defaultDisplayValue", "type": { "text": "string" }, "default": "''", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "kind": "field", "name": "textfield", "type": { "text": "Textfield | null" }, "default": "null", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "kind": "field", "name": "flatpickr", "type": { "text": "flatpickr.Instance | null" }, "default": "null", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "kind": "method", "name": "instantiateFlatpickr", "privacy": "protected", "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } }, { "kind": "method", "name": "propChangedIsInFlatpickrConfig", "parameters": [ { "name": "_changedProps", "type": { "text": "PropertyValueMap | Map" } } ], "inheritedFrom": { "name": "DatePickerFoundation", "module": "src/components/date-picker-foundation/date-picker-foundation.ts" } } ] } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "DateRangePicker", "module": "src/components/date-range-picker/date-range-picker.ts" } }, { "kind": "custom-element-definition", "name": "bp-date-range-picker", "declaration": { "name": "DateRangePicker", "module": "src/components/date-range-picker/date-range-picker.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/dialog/dialog-base.ts", "declarations": [ { "kind": "class", "description": "", "name": "DialogBase", "members": [ { "kind": "method", "name": "emitOpenedHandler", "parameters": [ { "name": "e", "type": { "text": "Event" } } ] }, { "kind": "method", "name": "emitClosedHandler", "parameters": [ { "name": "e", "type": { "text": "CustomEvent<{action: string}>" } } ] }, { "kind": "method", "name": "emitOpeningHandler", "parameters": [ { "name": "e", "type": { "text": "Event" } } ] }, { "kind": "method", "name": "emitClosingHandler", "parameters": [ { "name": "e", "type": { "text": "CustomEvent<{action: string}>" } } ] }, { "kind": "field", "name": "open", "type": { "text": "boolean" }, "default": "false", "description": "Whether the dialog should open.", "attribute": "open" }, { "kind": "field", "name": "hideActions", "type": { "text": "boolean" }, "default": "false", "description": "Hides the actions footer of the dialog. Needed to remove excess padding when no actions are slotted in.", "attribute": "hideActions" }, { "kind": "field", "name": "stacked", "type": { "text": "boolean" }, "default": "false", "description": "Whether to stack the action buttons.", "attribute": "stacked" }, { "kind": "field", "name": "heading", "type": { "text": "string" }, "default": "''", "description": "Heading text of the dialog.", "attribute": "heading" }, { "kind": "field", "name": "scrimClickAction", "type": { "text": "string" }, "default": "'close'", "description": "Action to be emitted with the closing and closed events when the dialog closes because the scrim was clicked. Setting this attribute to an empty string \"\" will prevent clicks outside the dialog from closing the dialog.", "attribute": "scrimClickAction" }, { "kind": "field", "name": "escapeKeyAction", "type": { "text": "string" }, "default": "'close'", "description": "Action to be emitted with the closing and closed events when the dialog closes because the escape key was pressed. Setting this attribute to an empty string \"\" will prevent the escape key from closing the dialog.", "attribute": "escapeKeyAction" }, { "kind": "field", "name": "defaultAction", "type": { "text": "string" }, "default": "'close'", "description": "Action to be emitted with the closing and closed events when .open is toggled.", "attribute": "defaultAction" }, { "kind": "field", "name": "actionAttribute", "type": { "text": "string" }, "default": "'dialogAction'", "description": "Attribute to read in light dom of dialog for closing action value.", "attribute": "actionAttribute" }, { "kind": "field", "name": "initialFocusAttribute", "type": { "text": "string" }, "default": "'dialogInitialFocus'", "description": "Attribute to search for in light dom for initial focus on dialog open.", "attribute": "initialFocusAttribute" }, { "kind": "field", "name": "showCloseButton", "type": { "text": "boolean" }, "default": "false", "description": "Will show a close button in the top right of the dialog's heading.", "attribute": "show-close-button" }, { "kind": "field", "name": "closeButtonPosition", "type": { "text": "'auto' | 'body' | 'heading'" }, "default": "'auto'", "description": "Specifies whether to render the close button in the dialog's body or heading. Auto will render the button in the body if there's no heading.", "attribute": "close-button-position" }, { "kind": "method", "name": "show", "description": "Shows the alert." }, { "kind": "method", "name": "close", "description": "Closes the alert" }, { "kind": "method", "name": "renderCloseButton" }, { "kind": "method", "name": "renderHeading" }, { "kind": "field", "name": "blockingElements", "type": { "text": "BlockingElements" } }, { "kind": "method", "name": "createAdapter", "return": { "type": { "text": "MDCDialogAdapter" } } } ], "attributes": [ { "name": "open", "type": { "text": "boolean" }, "default": "false", "description": "Whether the dialog should open.", "fieldName": "open" }, { "name": "hideActions", "type": { "text": "boolean" }, "default": "false", "description": "Hides the actions footer of the dialog. Needed to remove excess padding when no actions are slotted in.", "fieldName": "hideActions" }, { "name": "stacked", "type": { "text": "boolean" }, "default": "false", "description": "Whether to stack the action buttons.", "fieldName": "stacked" }, { "name": "heading", "type": { "text": "string" }, "default": "''", "description": "Heading text of the dialog.", "fieldName": "heading" }, { "name": "scrimClickAction", "type": { "text": "string" }, "default": "'close'", "description": "Action to be emitted with the closing and closed events when the dialog closes because the scrim was clicked. Setting this attribute to an empty string \"\" will prevent clicks outside the dialog from closing the dialog.", "fieldName": "scrimClickAction" }, { "name": "escapeKeyAction", "type": { "text": "string" }, "default": "'close'", "description": "Action to be emitted with the closing and closed events when the dialog closes because the escape key was pressed. Setting this attribute to an empty string \"\" will prevent the escape key from closing the dialog.", "fieldName": "escapeKeyAction" }, { "name": "defaultAction", "type": { "text": "string" }, "default": "'close'", "description": "Action to be emitted with the closing and closed events when .open is toggled.", "fieldName": "defaultAction" }, { "name": "actionAttribute", "type": { "text": "string" }, "default": "'dialogAction'", "description": "Attribute to read in light dom of dialog for closing action value.", "fieldName": "actionAttribute" }, { "name": "initialFocusAttribute", "type": { "text": "string" }, "default": "'dialogInitialFocus'", "description": "Attribute to search for in light dom for initial focus on dialog open.", "fieldName": "initialFocusAttribute" }, { "name": "show-close-button", "type": { "text": "boolean" }, "default": "false", "description": "Will show a close button in the top right of the dialog's heading.", "fieldName": "showCloseButton" }, { "name": "close-button-position", "type": { "text": "'auto' | 'body' | 'heading'" }, "default": "'auto'", "description": "Specifies whether to render the close button in the dialog's body or heading. Auto will render the button in the body if there's no heading.", "fieldName": "closeButtonPosition" } ], "superclass": { "name": "_DialogBase", "package": "@material/mwc-dialog/mwc-dialog-base" } } ], "exports": [ { "kind": "js", "name": "DialogBase", "declaration": { "name": "DialogBase", "module": "src/components/dialog/dialog-base.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/dialog/dialog.ts", "declarations": [ { "kind": "class", "description": "", "name": "Dialog", "slots": [ { "description": "Primary content area. May contain a list, a form, or prose.", "name": "default" }, { "description": "Footer area containing the dialog's primary action button.", "name": "primaryAction" }, { "description": "Footer area containing the dialog's secondary action button.", "name": "secondaryAction" } ], "members": [ { "kind": "method", "name": "emitOpenedHandler", "parameters": [ { "name": "e", "type": { "text": "Event" } } ], "inheritedFrom": { "name": "DialogBase", "module": "src/components/dialog/dialog-base.ts" } }, { "kind": "method", "name": "emitClosedHandler", "parameters": [ { "name": "e", "type": { "text": "CustomEvent<{action: string}>" } } ], "inheritedFrom": { "name": "DialogBase", "module": "src/components/dialog/dialog-base.ts" } }, { "kind": "method", "name": "emitOpeningHandler", "parameters": [ { "name": "e", "type": { "text": "Event" } } ], "inheritedFrom": { "name": "DialogBase", "module": "src/components/dialog/dialog-base.ts" } }, { "kind": "method", "name": "emitClosingHandler", "parameters": [ { "name": "e", "type": { "text": "CustomEvent<{action: string}>" } } ], "inheritedFrom": { "name": "DialogBase", "module": "src/components/dialog/dialog-base.ts" } }, { "kind": "field", "name": "open", "type": { "text": "boolean" }, "default": "false", "description": "Whether the dialog should open.", "attribute": "open", "inheritedFrom": { "name": "DialogBase", "module": "src/components/dialog/dialog-base.ts" } }, { "kind": "field", "name": "hideActions", "type": { "text": "boolean" }, "default": "false", "description": "Hides the actions footer of the dialog. Needed to remove excess padding when no actions are slotted in.", "attribute": "hideActions", "inheritedFrom": { "name": "DialogBase", "module": "src/components/dialog/dialog-base.ts" } }, { "kind": "field", "name": "stacked", "type": { "text": "boolean" }, "default": "false", "description": "Whether to stack the action buttons.", "attribute": "stacked", "inheritedFrom": { "name": "DialogBase", "module": "src/components/dialog/dialog-base.ts" } }, { "kind": "field", "name": "heading", "type": { "text": "string" }, "default": "''", "description": "Heading text of the dialog.", "attribute": "heading", "inheritedFrom": { "name": "DialogBase", "module": "src/components/dialog/dialog-base.ts" } }, { "kind": "field", "name": "scrimClickAction", "type": { "text": "string" }, "default": "'close'", "description": "Action to be emitted with the closing and closed events when the dialog closes because the scrim was clicked. Setting this attribute to an empty string \"\" will prevent clicks outside the dialog from closing the dialog.", "attribute": "scrimClickAction", "inheritedFrom": { "name": "DialogBase", "module": "src/components/dialog/dialog-base.ts" } }, { "kind": "field", "name": "escapeKeyAction", "type": { "text": "string" }, "default": "'close'", "description": "Action to be emitted with the closing and closed events when the dialog closes because the escape key was pressed. Setting this attribute to an empty string \"\" will prevent the escape key from closing the dialog.", "attribute": "escapeKeyAction", "inheritedFrom": { "name": "DialogBase", "module": "src/components/dialog/dialog-base.ts" } }, { "kind": "field", "name": "defaultAction", "type": { "text": "string" }, "default": "'close'", "description": "Action to be emitted with the closing and closed events when .open is toggled.", "attribute": "defaultAction", "inheritedFrom": { "name": "DialogBase", "module": "src/components/dialog/dialog-base.ts" } }, { "kind": "field", "name": "actionAttribute", "type": { "text": "string" }, "default": "'dialogAction'", "description": "Attribute to read in light dom of dialog for closing action value.", "attribute": "actionAttribute", "inheritedFrom": { "name": "DialogBase", "module": "src/components/dialog/dialog-base.ts" } }, { "kind": "field", "name": "initialFocusAttribute", "type": { "text": "string" }, "default": "'dialogInitialFocus'", "description": "Attribute to search for in light dom for initial focus on dialog open.", "attribute": "initialFocusAttribute", "inheritedFrom": { "name": "DialogBase", "module": "src/components/dialog/dialog-base.ts" } }, { "kind": "field", "name": "showCloseButton", "type": { "text": "boolean" }, "default": "false", "description": "Will show a close button in the top right of the dialog's heading.", "attribute": "show-close-button", "inheritedFrom": { "name": "DialogBase", "module": "src/components/dialog/dialog-base.ts" } }, { "kind": "field", "name": "closeButtonPosition", "type": { "text": "'auto' | 'body' | 'heading'" }, "default": "'auto'", "description": "Specifies whether to render the close button in the dialog's body or heading. Auto will render the button in the body if there's no heading.", "attribute": "close-button-position", "inheritedFrom": { "name": "DialogBase", "module": "src/components/dialog/dialog-base.ts" } }, { "kind": "method", "name": "show", "description": "Shows the alert.", "inheritedFrom": { "name": "DialogBase", "module": "src/components/dialog/dialog-base.ts" } }, { "kind": "method", "name": "close", "description": "Closes the alert", "inheritedFrom": { "name": "DialogBase", "module": "src/components/dialog/dialog-base.ts" } }, { "kind": "method", "name": "renderCloseButton", "inheritedFrom": { "name": "DialogBase", "module": "src/components/dialog/dialog-base.ts" } }, { "kind": "method", "name": "renderHeading", "inheritedFrom": { "name": "DialogBase", "module": "src/components/dialog/dialog-base.ts" } }, { "kind": "field", "name": "blockingElements", "type": { "text": "BlockingElements" }, "inheritedFrom": { "name": "DialogBase", "module": "src/components/dialog/dialog-base.ts" } }, { "kind": "method", "name": "createAdapter", "return": { "type": { "text": "MDCDialogAdapter" } }, "inheritedFrom": { "name": "DialogBase", "module": "src/components/dialog/dialog-base.ts" } } ], "events": [ { "description": "Fired when the dialog is beginning to open.", "name": "bp-dialog-opening", "reactName": "onBpDialogOpening" }, { "description": "Fired once the dialog is finished opening (after animation).", "name": "bp-dialog-opened", "reactName": "onBpDialogOpened" }, { "type": { "text": "{action: string}" }, "description": "Fired when the dialog is is beginning to close. Detail is the action that closed the dialog.", "name": "bp-dialog-closing", "reactName": "onBpDialogClosing" }, { "type": { "text": "{action: string}" }, "description": "Fired once the dialog is finished closing (after animation). Detail is the action that closed the dialog.", "name": "bp-dialog-closed", "reactName": "onBpDialogClosed" } ], "superclass": { "name": "DialogBase", "module": "/src/components/dialog/dialog-base.js" }, "since": "0.1.1-beta.1", "status": "beta", "dependencies": [ "bp-typography" ], "tagName": "bp-dialog", "customElement": true, "attributes": [ { "name": "open", "type": { "text": "boolean" }, "default": "false", "description": "Whether the dialog should open.", "fieldName": "open", "inheritedFrom": { "name": "DialogBase", "module": "src/components/dialog/dialog-base.ts" } }, { "name": "hideActions", "type": { "text": "boolean" }, "default": "false", "description": "Hides the actions footer of the dialog. Needed to remove excess padding when no actions are slotted in.", "fieldName": "hideActions", "inheritedFrom": { "name": "DialogBase", "module": "src/components/dialog/dialog-base.ts" } }, { "name": "stacked", "type": { "text": "boolean" }, "default": "false", "description": "Whether to stack the action buttons.", "fieldName": "stacked", "inheritedFrom": { "name": "DialogBase", "module": "src/components/dialog/dialog-base.ts" } }, { "name": "heading", "type": { "text": "string" }, "default": "''", "description": "Heading text of the dialog.", "fieldName": "heading", "inheritedFrom": { "name": "DialogBase", "module": "src/components/dialog/dialog-base.ts" } }, { "name": "scrimClickAction", "type": { "text": "string" }, "default": "'close'", "description": "Action to be emitted with the closing and closed events when the dialog closes because the scrim was clicked. Setting this attribute to an empty string \"\" will prevent clicks outside the dialog from closing the dialog.", "fieldName": "scrimClickAction", "inheritedFrom": { "name": "DialogBase", "module": "src/components/dialog/dialog-base.ts" } }, { "name": "escapeKeyAction", "type": { "text": "string" }, "default": "'close'", "description": "Action to be emitted with the closing and closed events when the dialog closes because the escape key was pressed. Setting this attribute to an empty string \"\" will prevent the escape key from closing the dialog.", "fieldName": "escapeKeyAction", "inheritedFrom": { "name": "DialogBase", "module": "src/components/dialog/dialog-base.ts" } }, { "name": "defaultAction", "type": { "text": "string" }, "default": "'close'", "description": "Action to be emitted with the closing and closed events when .open is toggled.", "fieldName": "defaultAction", "inheritedFrom": { "name": "DialogBase", "module": "src/components/dialog/dialog-base.ts" } }, { "name": "actionAttribute", "type": { "text": "string" }, "default": "'dialogAction'", "description": "Attribute to read in light dom of dialog for closing action value.", "fieldName": "actionAttribute", "inheritedFrom": { "name": "DialogBase", "module": "src/components/dialog/dialog-base.ts" } }, { "name": "initialFocusAttribute", "type": { "text": "string" }, "default": "'dialogInitialFocus'", "description": "Attribute to search for in light dom for initial focus on dialog open.", "fieldName": "initialFocusAttribute", "inheritedFrom": { "name": "DialogBase", "module": "src/components/dialog/dialog-base.ts" } }, { "name": "show-close-button", "type": { "text": "boolean" }, "default": "false", "description": "Will show a close button in the top right of the dialog's heading.", "fieldName": "showCloseButton", "inheritedFrom": { "name": "DialogBase", "module": "src/components/dialog/dialog-base.ts" } }, { "name": "close-button-position", "type": { "text": "'auto' | 'body' | 'heading'" }, "default": "'auto'", "description": "Specifies whether to render the close button in the dialog's body or heading. Auto will render the button in the body if there's no heading.", "fieldName": "closeButtonPosition", "inheritedFrom": { "name": "DialogBase", "module": "src/components/dialog/dialog-base.ts" } } ] } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "Dialog", "module": "src/components/dialog/dialog.ts" } }, { "kind": "custom-element-definition", "name": "bp-dialog", "declaration": { "name": "Dialog", "module": "src/components/dialog/dialog.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/divider/divider-base.ts", "declarations": [ { "kind": "class", "description": "", "name": "DividerBase", "members": [ { "kind": "field", "name": "vertical", "type": { "text": "boolean" }, "default": "false", "description": "Draws the divider in a vertical orientation.", "attribute": "vertical" } ], "attributes": [ { "name": "vertical", "type": { "text": "boolean" }, "default": "false", "description": "Draws the divider in a vertical orientation.", "fieldName": "vertical" } ], "superclass": { "name": "SlDivider", "package": "@shoelace-style/shoelace/dist/components/divider/divider" } } ], "exports": [ { "kind": "js", "name": "DividerBase", "declaration": { "name": "DividerBase", "module": "src/components/divider/divider-base.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/divider/divider.ts", "declarations": [ { "kind": "class", "description": "", "name": "Divider", "cssProperties": [ { "description": "The width of the divider.", "name": "--width" }, { "description": "The color of the divider.", "name": "--color" }, { "description": "The amount of space between the divider and it's neighboring elements.", "name": "--spacing" } ], "superclass": { "name": "DividerBase", "module": "/src/components/divider/divider-base.js" }, "since": "0.1.1-beta.1", "status": "beta", "tagName": "bp-divider", "customElement": true, "attributes": [ { "name": "vertical", "type": { "text": "boolean" }, "default": "false", "description": "Draws the divider in a vertical orientation.", "fieldName": "vertical", "inheritedFrom": { "name": "DividerBase", "module": "src/components/divider/divider-base.ts" } } ], "members": [ { "kind": "field", "name": "vertical", "type": { "text": "boolean" }, "default": "false", "description": "Draws the divider in a vertical orientation.", "attribute": "vertical", "inheritedFrom": { "name": "DividerBase", "module": "src/components/divider/divider-base.ts" } } ] } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "Divider", "module": "src/components/divider/divider.ts" } }, { "kind": "custom-element-definition", "name": "bp-divider", "declaration": { "name": "Divider", "module": "src/components/divider/divider.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/drawer/drawer-base.ts", "declarations": [ { "kind": "class", "description": "", "name": "DrawerBase", "members": [ { "kind": "field", "name": "open", "type": { "text": "boolean" }, "default": "false", "description": "Whether the dialog is open or not.", "attribute": "open" }, { "kind": "field", "name": "hasHeader", "type": { "text": "boolean" }, "default": "false", "description": "Enables the title, subtitle, and header slots.", "attribute": "hasHeader" }, { "kind": "field", "name": "type", "type": { "text": "'' | 'dismissible' | 'modal'" }, "default": "''", "description": "When set to 'dismissible', overlays the drawer on the content. When set to 'modal', also adds a scrim when the drawer is open. When set to empty string, it is inlined with the page and displaces app content.", "attribute": "type" }, { "kind": "field", "name": "placement", "type": { "text": "'right' | 'left' | 'bottom' | 'top'" }, "default": "'left'", "description": "Sets the position of the drawer.", "attribute": "placement" }, { "kind": "field", "name": "addBackdrop", "type": { "text": "boolean" }, "default": "false", "description": "Adds a backdrop to a dismissible drawer if true.", "attribute": "add-backdrop" }, { "kind": "field", "name": "dropShadow", "type": { "text": "boolean" }, "default": "false", "description": "Adds a shadow to the drawer.", "attribute": "drop-shadow" }, { "kind": "field", "name": "roundCorners", "type": { "text": "boolean" }, "default": "false", "description": "Adds a blur radius to the drawer to round its corners.", "attribute": "round-corners" }, { "kind": "field", "name": "disableBorders", "type": { "text": "boolean" }, "default": "false", "description": "Disables the border between the drawer and appContent.", "attribute": "disable-borders" }, { "kind": "method", "name": "emitOpenedHandler", "parameters": [ { "name": "e", "type": { "text": "Event" } } ] }, { "kind": "method", "name": "emitClosedHandler", "parameters": [ { "name": "e", "type": { "text": "Event" } } ] }, { "kind": "method", "name": "hide", "privacy": "public", "description": "Hides the drawer." }, { "kind": "method", "name": "show", "privacy": "public", "description": "Shows the drawer." }, { "kind": "method", "name": "_handleScrimClick", "privacy": "protected", "return": { "type": { "text": "void" } } }, { "kind": "field", "name": "blockingElements", "type": { "text": "BlockingElements" } }, { "kind": "method", "name": "createAdapter", "return": { "type": { "text": "MDCDrawerAdapter" } } } ], "attributes": [ { "name": "open", "type": { "text": "boolean" }, "default": "false", "description": "Whether the dialog is open or not.", "fieldName": "open" }, { "name": "hasHeader", "type": { "text": "boolean" }, "default": "false", "description": "Enables the title, subtitle, and header slots.", "fieldName": "hasHeader" }, { "name": "type", "type": { "text": "'' | 'dismissible' | 'modal'" }, "default": "''", "description": "When set to 'dismissible', overlays the drawer on the content. When set to 'modal', also adds a scrim when the drawer is open. When set to empty string, it is inlined with the page and displaces app content.", "fieldName": "type" }, { "name": "placement", "type": { "text": "'right' | 'left' | 'bottom' | 'top'" }, "default": "'left'", "description": "Sets the position of the drawer.", "fieldName": "placement" }, { "name": "add-backdrop", "type": { "text": "boolean" }, "default": "false", "description": "Adds a backdrop to a dismissible drawer if true.", "fieldName": "addBackdrop" }, { "name": "drop-shadow", "type": { "text": "boolean" }, "default": "false", "description": "Adds a shadow to the drawer.", "fieldName": "dropShadow" }, { "name": "round-corners", "type": { "text": "boolean" }, "default": "false", "description": "Adds a blur radius to the drawer to round its corners.", "fieldName": "roundCorners" }, { "name": "disable-borders", "type": { "text": "boolean" }, "default": "false", "description": "Disables the border between the drawer and appContent.", "fieldName": "disableBorders" } ], "superclass": { "name": "_DrawerBase", "package": "@material/mwc-drawer/mwc-drawer-base" } } ], "exports": [ { "kind": "js", "name": "DrawerBase", "declaration": { "name": "DrawerBase", "module": "src/components/drawer/drawer-base.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/drawer/drawer.ts", "declarations": [ { "kind": "class", "description": "", "name": "Drawer", "cssProperties": [ { "description": "Width of the left/right drawer when opened.", "name": "--bp-drawer-width", "default": "256px" }, { "description": "Height of the top/bottom drawer when opened.", "name": "--bp-drawer-height", "default": "100%" }, { "description": "The z-index of the drawer.", "name": "--bp-drawer-z-index", "default": "6" }, { "description": "The border radius of the drawer.", "name": "--bp-drawer-border-radius", "default": "4px" } ], "slots": [ { "description": "Elements to display under the header in drawer.", "name": "default" }, { "description": "Header title to display in the drawer when hasHeader is true.", "name": "title" }, { "description": "Header subtitle to display in the drawer when hasHeader is true.", "name": "subtitle" }, { "description": "Additional header elements to display in the drawer.", "name": "header" }, { "description": "Elements to display in the \"app content\" apart from the drawer.", "name": "appContent" } ], "members": [ { "kind": "field", "name": "open", "type": { "text": "boolean" }, "default": "false", "description": "Whether the dialog is open or not.", "attribute": "open", "inheritedFrom": { "name": "DrawerBase", "module": "src/components/drawer/drawer-base.ts" } }, { "kind": "field", "name": "hasHeader", "type": { "text": "boolean" }, "default": "false", "description": "Enables the title, subtitle, and header slots.", "attribute": "hasHeader", "inheritedFrom": { "name": "DrawerBase", "module": "src/components/drawer/drawer-base.ts" } }, { "kind": "field", "name": "type", "type": { "text": "'' | 'dismissible' | 'modal'" }, "default": "''", "description": "When set to 'dismissible', overlays the drawer on the content. When set to 'modal', also adds a scrim when the drawer is open. When set to empty string, it is inlined with the page and displaces app content.", "attribute": "type", "inheritedFrom": { "name": "DrawerBase", "module": "src/components/drawer/drawer-base.ts" } }, { "kind": "field", "name": "placement", "type": { "text": "'right' | 'left' | 'bottom' | 'top'" }, "default": "'left'", "description": "Sets the position of the drawer.", "attribute": "placement", "inheritedFrom": { "name": "DrawerBase", "module": "src/components/drawer/drawer-base.ts" } }, { "kind": "field", "name": "addBackdrop", "type": { "text": "boolean" }, "default": "false", "description": "Adds a backdrop to a dismissible drawer if true.", "attribute": "add-backdrop", "inheritedFrom": { "name": "DrawerBase", "module": "src/components/drawer/drawer-base.ts" } }, { "kind": "field", "name": "dropShadow", "type": { "text": "boolean" }, "default": "false", "description": "Adds a shadow to the drawer.", "attribute": "drop-shadow", "inheritedFrom": { "name": "DrawerBase", "module": "src/components/drawer/drawer-base.ts" } }, { "kind": "field", "name": "roundCorners", "type": { "text": "boolean" }, "default": "false", "description": "Adds a blur radius to the drawer to round its corners.", "attribute": "round-corners", "inheritedFrom": { "name": "DrawerBase", "module": "src/components/drawer/drawer-base.ts" } }, { "kind": "field", "name": "disableBorders", "type": { "text": "boolean" }, "default": "false", "description": "Disables the border between the drawer and appContent.", "attribute": "disable-borders", "inheritedFrom": { "name": "DrawerBase", "module": "src/components/drawer/drawer-base.ts" } }, { "kind": "method", "name": "emitOpenedHandler", "parameters": [ { "name": "e", "type": { "text": "Event" } } ], "inheritedFrom": { "name": "DrawerBase", "module": "src/components/drawer/drawer-base.ts" } }, { "kind": "method", "name": "emitClosedHandler", "parameters": [ { "name": "e", "type": { "text": "Event" } } ], "inheritedFrom": { "name": "DrawerBase", "module": "src/components/drawer/drawer-base.ts" } }, { "kind": "method", "name": "hide", "privacy": "public", "description": "Hides the drawer.", "inheritedFrom": { "name": "DrawerBase", "module": "src/components/drawer/drawer-base.ts" } }, { "kind": "method", "name": "show", "privacy": "public", "description": "Shows the drawer.", "inheritedFrom": { "name": "DrawerBase", "module": "src/components/drawer/drawer-base.ts" } }, { "kind": "method", "name": "_handleScrimClick", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "DrawerBase", "module": "src/components/drawer/drawer-base.ts" } }, { "kind": "field", "name": "blockingElements", "type": { "text": "BlockingElements" }, "inheritedFrom": { "name": "DrawerBase", "module": "src/components/drawer/drawer-base.ts" } }, { "kind": "method", "name": "createAdapter", "return": { "type": { "text": "MDCDrawerAdapter" } }, "inheritedFrom": { "name": "DrawerBase", "module": "src/components/drawer/drawer-base.ts" } } ], "events": [ { "description": "Fired when the drawer has opened.", "name": "bp-drawer-opened", "reactName": "onBpDrawerOpened" }, { "description": "Fired when the dialog has closed.", "name": "bp-drawer-closed", "reactName": "onBpDrawerClosed" } ], "superclass": { "name": "DrawerBase", "module": "/src/components/drawer/drawer-base.js" }, "since": "0.1.1-beta.1", "status": "beta", "tagName": "bp-drawer", "customElement": true, "attributes": [ { "name": "open", "type": { "text": "boolean" }, "default": "false", "description": "Whether the dialog is open or not.", "fieldName": "open", "inheritedFrom": { "name": "DrawerBase", "module": "src/components/drawer/drawer-base.ts" } }, { "name": "hasHeader", "type": { "text": "boolean" }, "default": "false", "description": "Enables the title, subtitle, and header slots.", "fieldName": "hasHeader", "inheritedFrom": { "name": "DrawerBase", "module": "src/components/drawer/drawer-base.ts" } }, { "name": "type", "type": { "text": "'' | 'dismissible' | 'modal'" }, "default": "''", "description": "When set to 'dismissible', overlays the drawer on the content. When set to 'modal', also adds a scrim when the drawer is open. When set to empty string, it is inlined with the page and displaces app content.", "fieldName": "type", "inheritedFrom": { "name": "DrawerBase", "module": "src/components/drawer/drawer-base.ts" } }, { "name": "placement", "type": { "text": "'right' | 'left' | 'bottom' | 'top'" }, "default": "'left'", "description": "Sets the position of the drawer.", "fieldName": "placement", "inheritedFrom": { "name": "DrawerBase", "module": "src/components/drawer/drawer-base.ts" } }, { "name": "add-backdrop", "type": { "text": "boolean" }, "default": "false", "description": "Adds a backdrop to a dismissible drawer if true.", "fieldName": "addBackdrop", "inheritedFrom": { "name": "DrawerBase", "module": "src/components/drawer/drawer-base.ts" } }, { "name": "drop-shadow", "type": { "text": "boolean" }, "default": "false", "description": "Adds a shadow to the drawer.", "fieldName": "dropShadow", "inheritedFrom": { "name": "DrawerBase", "module": "src/components/drawer/drawer-base.ts" } }, { "name": "round-corners", "type": { "text": "boolean" }, "default": "false", "description": "Adds a blur radius to the drawer to round its corners.", "fieldName": "roundCorners", "inheritedFrom": { "name": "DrawerBase", "module": "src/components/drawer/drawer-base.ts" } }, { "name": "disable-borders", "type": { "text": "boolean" }, "default": "false", "description": "Disables the border between the drawer and appContent.", "fieldName": "disableBorders", "inheritedFrom": { "name": "DrawerBase", "module": "src/components/drawer/drawer-base.ts" } } ] } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "Drawer", "module": "src/components/drawer/drawer.ts" } }, { "kind": "custom-element-definition", "name": "bp-drawer", "declaration": { "name": "Drawer", "module": "src/components/drawer/drawer.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/dual-listbox/dual-listbox-base.ts", "declarations": [ { "kind": "class", "description": "", "name": "DualListboxBase", "members": [ { "kind": "field", "name": "formSubmitController", "type": { "text": "FormSubmitController" }, "default": "new FormSubmitController(this)" }, { "kind": "field", "name": "options", "type": { "text": "{value: string; label: string}[]" }, "default": "[]", "description": "An array of all options. Note: dual-listbox expects values to be unique.", "attribute": "options" }, { "kind": "field", "name": "value", "type": { "text": "string[]" }, "default": "[]", "description": "An array of option values that need to be selected", "attribute": "value" }, { "kind": "field", "name": "width", "type": { "text": "string" }, "default": "'100%'", "description": "The width of the dual listbox", "attribute": "width" }, { "kind": "field", "name": "height", "type": { "text": "string" }, "default": "'400px'", "description": "The height of the dual listbox", "attribute": "height" }, { "kind": "field", "name": "name", "type": { "text": "string" }, "default": "''", "description": "HTML name attribute - defines the name of the control", "attribute": "name" }, { "kind": "field", "name": "availableList", "type": { "text": "List" } }, { "kind": "field", "name": "selectedList", "type": { "text": "List" } }, { "kind": "field", "name": "defaultValue", "type": { "text": "string[]" }, "default": "[]" }, { "kind": "field", "name": "handleAddOption" }, { "kind": "field", "name": "handleRemoveOption" }, { "kind": "field", "name": "handleChevronLeft" }, { "kind": "field", "name": "handleChevronRight" }, { "kind": "method", "name": "getAvailableSelected", "return": { "type": { "text": "Set" } } }, { "kind": "method", "name": "getSelectedSelected", "return": { "type": { "text": "Set" } } }, { "kind": "field", "name": "deselectAllFromSelected" }, { "kind": "field", "name": "deselectAllFromAvailable" }, { "kind": "field", "name": "sortSetWithReverse" }, { "kind": "field", "name": "getShiftedOptions" }, { "kind": "field", "name": "handleMoveToTop" }, { "kind": "field", "name": "handleMoveUp" }, { "kind": "field", "name": "handleMoveDown" }, { "kind": "field", "name": "handleMoveToBottom" }, { "kind": "field", "name": "handleDispatch" } ], "attributes": [ { "name": "options", "type": { "text": "{value: string; label: string}[]" }, "default": "[]", "description": "An array of all options. Note: dual-listbox expects values to be unique.", "fieldName": "options" }, { "name": "value", "type": { "text": "string[]" }, "default": "[]", "description": "An array of option values that need to be selected", "fieldName": "value" }, { "name": "width", "type": { "text": "string" }, "default": "'100%'", "description": "The width of the dual listbox", "fieldName": "width" }, { "name": "height", "type": { "text": "string" }, "default": "'400px'", "description": "The height of the dual listbox", "fieldName": "height" }, { "name": "name", "type": { "text": "string" }, "default": "''", "description": "HTML name attribute - defines the name of the control", "fieldName": "name" } ], "superclass": { "name": "LitElement", "package": "lit" }, "customElement": true } ], "exports": [ { "kind": "js", "name": "DualListboxBase", "declaration": { "name": "DualListboxBase", "module": "src/components/dual-listbox/dual-listbox-base.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/dual-listbox/dual-listbox.ts", "declarations": [ { "kind": "class", "description": "", "name": "DualListbox", "slots": [ { "description": "A slot for the heading of the available list box.", "name": "availableHeading" }, { "description": "A slot for the heading of the selected list box.", "name": "selectedHeading" } ], "members": [ { "kind": "field", "name": "formSubmitController", "type": { "text": "FormSubmitController" }, "default": "new FormSubmitController(this)", "inheritedFrom": { "name": "DualListboxBase", "module": "src/components/dual-listbox/dual-listbox-base.ts" } }, { "kind": "field", "name": "options", "type": { "text": "{value: string; label: string}[]" }, "default": "[]", "description": "An array of all options. Note: dual-listbox expects values to be unique.", "attribute": "options", "inheritedFrom": { "name": "DualListboxBase", "module": "src/components/dual-listbox/dual-listbox-base.ts" } }, { "kind": "field", "name": "value", "type": { "text": "string[]" }, "default": "[]", "description": "An array of option values that need to be selected", "attribute": "value", "inheritedFrom": { "name": "DualListboxBase", "module": "src/components/dual-listbox/dual-listbox-base.ts" } }, { "kind": "field", "name": "width", "type": { "text": "string" }, "default": "'100%'", "description": "The width of the dual listbox", "attribute": "width", "inheritedFrom": { "name": "DualListboxBase", "module": "src/components/dual-listbox/dual-listbox-base.ts" } }, { "kind": "field", "name": "height", "type": { "text": "string" }, "default": "'400px'", "description": "The height of the dual listbox", "attribute": "height", "inheritedFrom": { "name": "DualListboxBase", "module": "src/components/dual-listbox/dual-listbox-base.ts" } }, { "kind": "field", "name": "name", "type": { "text": "string" }, "default": "''", "description": "HTML name attribute - defines the name of the control", "attribute": "name", "inheritedFrom": { "name": "DualListboxBase", "module": "src/components/dual-listbox/dual-listbox-base.ts" } }, { "kind": "field", "name": "availableList", "type": { "text": "List" }, "inheritedFrom": { "name": "DualListboxBase", "module": "src/components/dual-listbox/dual-listbox-base.ts" } }, { "kind": "field", "name": "selectedList", "type": { "text": "List" }, "inheritedFrom": { "name": "DualListboxBase", "module": "src/components/dual-listbox/dual-listbox-base.ts" } }, { "kind": "field", "name": "defaultValue", "type": { "text": "string[]" }, "default": "[]", "inheritedFrom": { "name": "DualListboxBase", "module": "src/components/dual-listbox/dual-listbox-base.ts" } }, { "kind": "field", "name": "handleAddOption", "inheritedFrom": { "name": "DualListboxBase", "module": "src/components/dual-listbox/dual-listbox-base.ts" } }, { "kind": "field", "name": "handleRemoveOption", "inheritedFrom": { "name": "DualListboxBase", "module": "src/components/dual-listbox/dual-listbox-base.ts" } }, { "kind": "field", "name": "handleChevronLeft", "inheritedFrom": { "name": "DualListboxBase", "module": "src/components/dual-listbox/dual-listbox-base.ts" } }, { "kind": "field", "name": "handleChevronRight", "inheritedFrom": { "name": "DualListboxBase", "module": "src/components/dual-listbox/dual-listbox-base.ts" } }, { "kind": "method", "name": "getAvailableSelected", "return": { "type": { "text": "Set" } }, "inheritedFrom": { "name": "DualListboxBase", "module": "src/components/dual-listbox/dual-listbox-base.ts" } }, { "kind": "method", "name": "getSelectedSelected", "return": { "type": { "text": "Set" } }, "inheritedFrom": { "name": "DualListboxBase", "module": "src/components/dual-listbox/dual-listbox-base.ts" } }, { "kind": "field", "name": "deselectAllFromSelected", "inheritedFrom": { "name": "DualListboxBase", "module": "src/components/dual-listbox/dual-listbox-base.ts" } }, { "kind": "field", "name": "deselectAllFromAvailable", "inheritedFrom": { "name": "DualListboxBase", "module": "src/components/dual-listbox/dual-listbox-base.ts" } }, { "kind": "field", "name": "sortSetWithReverse", "inheritedFrom": { "name": "DualListboxBase", "module": "src/components/dual-listbox/dual-listbox-base.ts" } }, { "kind": "field", "name": "getShiftedOptions", "inheritedFrom": { "name": "DualListboxBase", "module": "src/components/dual-listbox/dual-listbox-base.ts" } }, { "kind": "field", "name": "handleMoveToTop", "inheritedFrom": { "name": "DualListboxBase", "module": "src/components/dual-listbox/dual-listbox-base.ts" } }, { "kind": "field", "name": "handleMoveUp", "inheritedFrom": { "name": "DualListboxBase", "module": "src/components/dual-listbox/dual-listbox-base.ts" } }, { "kind": "field", "name": "handleMoveDown", "inheritedFrom": { "name": "DualListboxBase", "module": "src/components/dual-listbox/dual-listbox-base.ts" } }, { "kind": "field", "name": "handleMoveToBottom", "inheritedFrom": { "name": "DualListboxBase", "module": "src/components/dual-listbox/dual-listbox-base.ts" } }, { "kind": "field", "name": "handleDispatch", "inheritedFrom": { "name": "DualListboxBase", "module": "src/components/dual-listbox/dual-listbox-base.ts" } } ], "events": [ { "type": { "text": "string[]" }, "description": "A global event, that is always emitted on any change or reorder.", "name": "bp-dual-listbox-changed-and-ordered", "reactName": "onBpDualListboxChangedAndOrdered" }, { "type": { "text": "string[]" }, "description": "Emitted when something is added to the selected list box.", "name": "bp-dual-listbox-items-selected", "reactName": "onBpDualListboxItemsSelected" }, { "type": { "text": "string[]" }, "description": "Emitted when something is removed from the selected list box.", "name": "bp-dual-listbox-items-deselected", "reactName": "onBpDualListboxItemsDeselected" }, { "type": { "text": "string[]" }, "description": "Emitted when something is reordered in the selected list box.", "name": "bp-dual-listbox-items-reordered", "reactName": "onBpDualListboxItemsReordered" } ], "superclass": { "name": "DualListboxBase", "module": "/src/components/dual-listbox/dual-listbox-base.js" }, "since": "0.1.1-beta.1", "status": "beta", "dependencies": [ "bp-list", "bp-list-item", "bp-icon-button" ], "tagName": "bp-dual-listbox", "customElement": true, "attributes": [ { "name": "options", "type": { "text": "{value: string; label: string}[]" }, "default": "[]", "description": "An array of all options. Note: dual-listbox expects values to be unique.", "fieldName": "options", "inheritedFrom": { "name": "DualListboxBase", "module": "src/components/dual-listbox/dual-listbox-base.ts" } }, { "name": "value", "type": { "text": "string[]" }, "default": "[]", "description": "An array of option values that need to be selected", "fieldName": "value", "inheritedFrom": { "name": "DualListboxBase", "module": "src/components/dual-listbox/dual-listbox-base.ts" } }, { "name": "width", "type": { "text": "string" }, "default": "'100%'", "description": "The width of the dual listbox", "fieldName": "width", "inheritedFrom": { "name": "DualListboxBase", "module": "src/components/dual-listbox/dual-listbox-base.ts" } }, { "name": "height", "type": { "text": "string" }, "default": "'400px'", "description": "The height of the dual listbox", "fieldName": "height", "inheritedFrom": { "name": "DualListboxBase", "module": "src/components/dual-listbox/dual-listbox-base.ts" } }, { "name": "name", "type": { "text": "string" }, "default": "''", "description": "HTML name attribute - defines the name of the control", "fieldName": "name", "inheritedFrom": { "name": "DualListboxBase", "module": "src/components/dual-listbox/dual-listbox-base.ts" } } ] } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "DualListbox", "module": "src/components/dual-listbox/dual-listbox.ts" } }, { "kind": "custom-element-definition", "name": "bp-dual-listbox", "declaration": { "name": "DualListbox", "module": "src/components/dual-listbox/dual-listbox.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/fab/fab-base.ts", "declarations": [ { "kind": "class", "description": "", "name": "FabBase", "members": [ { "kind": "field", "name": "icon", "type": { "text": "string" }, "default": "''", "description": "The icon to display.", "attribute": "icon" }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "The label to display when using the extended layout, and the aria-label attribute in all layouts.", "attribute": "label" }, { "kind": "field", "name": "mini", "type": { "text": "boolean" }, "default": "false", "description": "Modifies the FAB to be a smaller size, for use on smaller screens. Defaults to false.", "attribute": "mini" }, { "kind": "field", "name": "reducedTouchTarget", "type": { "text": "boolean" }, "default": "false", "description": "Sets the minimum touch target of the default-sized mini fab to recommended 48x48px.", "attribute": "reducedTouchTarget" }, { "kind": "field", "name": "extended", "type": { "text": "boolean" }, "default": "false", "description": "Enable the extended layout which includes a text label. Defaults to false.", "attribute": "extended" }, { "kind": "field", "name": "showIconAtEnd", "type": { "text": "boolean" }, "default": "false", "description": "When in the extended layout, position the icon after the label, instead of before. Defaults to false.", "attribute": "showIconAtEnd" }, { "kind": "field", "name": "color", "type": { "text": "| 'primary'\n | 'secondary'\n | 'success'\n | 'warning'\n | 'info'\n | 'error'\n | string" }, "default": "'secondary'", "description": "The color of the button.", "attribute": "color" }, { "kind": "method", "name": "emitClickHandler", "parameters": [ { "name": "e", "type": { "text": "Event" } } ] }, { "kind": "method", "name": "getRenderClasses" } ], "attributes": [ { "name": "icon", "type": { "text": "string" }, "default": "''", "description": "The icon to display.", "fieldName": "icon" }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "The label to display when using the extended layout, and the aria-label attribute in all layouts.", "fieldName": "label" }, { "name": "mini", "type": { "text": "boolean" }, "default": "false", "description": "Modifies the FAB to be a smaller size, for use on smaller screens. Defaults to false.", "fieldName": "mini" }, { "name": "reducedTouchTarget", "type": { "text": "boolean" }, "default": "false", "description": "Sets the minimum touch target of the default-sized mini fab to recommended 48x48px.", "fieldName": "reducedTouchTarget" }, { "name": "extended", "type": { "text": "boolean" }, "default": "false", "description": "Enable the extended layout which includes a text label. Defaults to false.", "fieldName": "extended" }, { "name": "showIconAtEnd", "type": { "text": "boolean" }, "default": "false", "description": "When in the extended layout, position the icon after the label, instead of before. Defaults to false.", "fieldName": "showIconAtEnd" }, { "name": "color", "type": { "text": "| 'primary'\n | 'secondary'\n | 'success'\n | 'warning'\n | 'info'\n | 'error'\n | string" }, "default": "'secondary'", "description": "The color of the button.", "fieldName": "color" } ], "superclass": { "name": "_FabBase", "package": "@material/mwc-fab/mwc-fab-base" } } ], "exports": [ { "kind": "js", "name": "FabBase", "declaration": { "name": "FabBase", "module": "src/components/fab/fab-base.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/fab/fab.ts", "declarations": [ { "kind": "class", "description": "", "name": "Fab", "members": [ { "kind": "field", "name": "icon", "type": { "text": "string" }, "default": "''", "description": "The icon to display.", "attribute": "icon", "inheritedFrom": { "name": "FabBase", "module": "src/components/fab/fab-base.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "The label to display when using the extended layout, and the aria-label attribute in all layouts.", "attribute": "label", "inheritedFrom": { "name": "FabBase", "module": "src/components/fab/fab-base.ts" } }, { "kind": "field", "name": "mini", "type": { "text": "boolean" }, "default": "false", "description": "Modifies the FAB to be a smaller size, for use on smaller screens. Defaults to false.", "attribute": "mini", "inheritedFrom": { "name": "FabBase", "module": "src/components/fab/fab-base.ts" } }, { "kind": "field", "name": "reducedTouchTarget", "type": { "text": "boolean" }, "default": "false", "description": "Sets the minimum touch target of the default-sized mini fab to recommended 48x48px.", "attribute": "reducedTouchTarget", "inheritedFrom": { "name": "FabBase", "module": "src/components/fab/fab-base.ts" } }, { "kind": "field", "name": "extended", "type": { "text": "boolean" }, "default": "false", "description": "Enable the extended layout which includes a text label. Defaults to false.", "attribute": "extended", "inheritedFrom": { "name": "FabBase", "module": "src/components/fab/fab-base.ts" } }, { "kind": "field", "name": "showIconAtEnd", "type": { "text": "boolean" }, "default": "false", "description": "When in the extended layout, position the icon after the label, instead of before. Defaults to false.", "attribute": "showIconAtEnd", "inheritedFrom": { "name": "FabBase", "module": "src/components/fab/fab-base.ts" } }, { "kind": "field", "name": "color", "type": { "text": "| 'primary'\n | 'secondary'\n | 'success'\n | 'warning'\n | 'info'\n | 'error'\n | string" }, "default": "'secondary'", "description": "The color of the button.", "attribute": "color", "inheritedFrom": { "name": "FabBase", "module": "src/components/fab/fab-base.ts" } }, { "kind": "method", "name": "emitClickHandler", "parameters": [ { "name": "e", "type": { "text": "Event" } } ], "inheritedFrom": { "name": "FabBase", "module": "src/components/fab/fab-base.ts" } }, { "kind": "method", "name": "getRenderClasses", "inheritedFrom": { "name": "FabBase", "module": "src/components/fab/fab-base.ts" } } ], "events": [ { "description": "Fires when the fab is clicked.", "name": "bp-fab-clicked", "reactName": "onBpFabClicked" } ], "superclass": { "name": "FabBase", "module": "/src/components/fab/fab-base.js" }, "since": "0.1.1-beta.1", "status": "beta", "tagName": "bp-fab", "customElement": true, "attributes": [ { "name": "icon", "type": { "text": "string" }, "default": "''", "description": "The icon to display.", "fieldName": "icon", "inheritedFrom": { "name": "FabBase", "module": "src/components/fab/fab-base.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "The label to display when using the extended layout, and the aria-label attribute in all layouts.", "fieldName": "label", "inheritedFrom": { "name": "FabBase", "module": "src/components/fab/fab-base.ts" } }, { "name": "mini", "type": { "text": "boolean" }, "default": "false", "description": "Modifies the FAB to be a smaller size, for use on smaller screens. Defaults to false.", "fieldName": "mini", "inheritedFrom": { "name": "FabBase", "module": "src/components/fab/fab-base.ts" } }, { "name": "reducedTouchTarget", "type": { "text": "boolean" }, "default": "false", "description": "Sets the minimum touch target of the default-sized mini fab to recommended 48x48px.", "fieldName": "reducedTouchTarget", "inheritedFrom": { "name": "FabBase", "module": "src/components/fab/fab-base.ts" } }, { "name": "extended", "type": { "text": "boolean" }, "default": "false", "description": "Enable the extended layout which includes a text label. Defaults to false.", "fieldName": "extended", "inheritedFrom": { "name": "FabBase", "module": "src/components/fab/fab-base.ts" } }, { "name": "showIconAtEnd", "type": { "text": "boolean" }, "default": "false", "description": "When in the extended layout, position the icon after the label, instead of before. Defaults to false.", "fieldName": "showIconAtEnd", "inheritedFrom": { "name": "FabBase", "module": "src/components/fab/fab-base.ts" } }, { "name": "color", "type": { "text": "| 'primary'\n | 'secondary'\n | 'success'\n | 'warning'\n | 'info'\n | 'error'\n | string" }, "default": "'secondary'", "description": "The color of the button.", "fieldName": "color", "inheritedFrom": { "name": "FabBase", "module": "src/components/fab/fab-base.ts" } } ] } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "Fab", "module": "src/components/fab/fab.ts" } }, { "kind": "custom-element-definition", "name": "bp-fab", "declaration": { "name": "Fab", "module": "src/components/fab/fab.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/form-field/form-field-base.ts", "declarations": [ { "kind": "class", "description": "", "name": "FormFieldBase", "members": [ { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "The text to display for the label and sets a11y label on input. Visually overriden by slotted label.", "attribute": "label" }, { "kind": "field", "name": "alignEnd", "type": { "text": "boolean" }, "default": "false", "description": "Align the component at the end of the label.", "attribute": "alignEnd" }, { "kind": "field", "name": "spaceBetween", "type": { "text": "boolean" }, "default": "false", "description": "Add space between the component and the label as the formfield grows.", "attribute": "spaceBetween" }, { "kind": "field", "name": "nowrap", "type": { "text": "boolean" }, "default": "false", "description": "Prevents the label from wrapping and overflow text is ellipsed.", "attribute": "nowrap" } ], "attributes": [ { "name": "label", "type": { "text": "string" }, "default": "''", "description": "The text to display for the label and sets a11y label on input. Visually overriden by slotted label.", "fieldName": "label" }, { "name": "alignEnd", "type": { "text": "boolean" }, "default": "false", "description": "Align the component at the end of the label.", "fieldName": "alignEnd" }, { "name": "spaceBetween", "type": { "text": "boolean" }, "default": "false", "description": "Add space between the component and the label as the formfield grows.", "fieldName": "spaceBetween" }, { "name": "nowrap", "type": { "text": "boolean" }, "default": "false", "description": "Prevents the label from wrapping and overflow text is ellipsed.", "fieldName": "nowrap" } ], "superclass": { "name": "_FormFieldBase", "package": "@material/mwc-formfield/mwc-formfield-base" } } ], "exports": [ { "kind": "js", "name": "FormFieldBase", "declaration": { "name": "FormFieldBase", "module": "src/components/form-field/form-field-base.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/form-field/form-field.ts", "declarations": [ { "kind": "class", "description": "", "name": "FormField", "slots": [ { "description": "The input element that this form field provides a label for.", "name": "" } ], "members": [ { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "The text to display for the label and sets a11y label on input. Visually overriden by slotted label.", "attribute": "label", "inheritedFrom": { "name": "FormFieldBase", "module": "src/components/form-field/form-field-base.ts" } }, { "kind": "field", "name": "alignEnd", "type": { "text": "boolean" }, "default": "false", "description": "Align the component at the end of the label.", "attribute": "alignEnd", "inheritedFrom": { "name": "FormFieldBase", "module": "src/components/form-field/form-field-base.ts" } }, { "kind": "field", "name": "spaceBetween", "type": { "text": "boolean" }, "default": "false", "description": "Add space between the component and the label as the formfield grows.", "attribute": "spaceBetween", "inheritedFrom": { "name": "FormFieldBase", "module": "src/components/form-field/form-field-base.ts" } }, { "kind": "field", "name": "nowrap", "type": { "text": "boolean" }, "default": "false", "description": "Prevents the label from wrapping and overflow text is ellipsed.", "attribute": "nowrap", "inheritedFrom": { "name": "FormFieldBase", "module": "src/components/form-field/form-field-base.ts" } } ], "superclass": { "name": "FormFieldBase", "module": "/src/components/form-field/form-field-base.js" }, "since": "0.1.1-beta.1", "status": "beta", "tagName": "bp-form-field", "customElement": true, "attributes": [ { "name": "label", "type": { "text": "string" }, "default": "''", "description": "The text to display for the label and sets a11y label on input. Visually overriden by slotted label.", "fieldName": "label", "inheritedFrom": { "name": "FormFieldBase", "module": "src/components/form-field/form-field-base.ts" } }, { "name": "alignEnd", "type": { "text": "boolean" }, "default": "false", "description": "Align the component at the end of the label.", "fieldName": "alignEnd", "inheritedFrom": { "name": "FormFieldBase", "module": "src/components/form-field/form-field-base.ts" } }, { "name": "spaceBetween", "type": { "text": "boolean" }, "default": "false", "description": "Add space between the component and the label as the formfield grows.", "fieldName": "spaceBetween", "inheritedFrom": { "name": "FormFieldBase", "module": "src/components/form-field/form-field-base.ts" } }, { "name": "nowrap", "type": { "text": "boolean" }, "default": "false", "description": "Prevents the label from wrapping and overflow text is ellipsed.", "fieldName": "nowrap", "inheritedFrom": { "name": "FormFieldBase", "module": "src/components/form-field/form-field-base.ts" } } ] } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "FormField", "module": "src/components/form-field/form-field.ts" } }, { "kind": "custom-element-definition", "name": "bp-form-field", "declaration": { "name": "FormField", "module": "src/components/form-field/form-field.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/format-date/format-date-base.ts", "declarations": [ { "kind": "class", "description": "", "name": "FormatDateBase", "members": [ { "kind": "field", "name": "date", "type": { "text": "Date | string" }, "default": "new Date()", "description": "The date/time to format. If not set, the current date and time will be used.", "attribute": "date" }, { "kind": "field", "name": "lang", "type": { "text": "string" }, "description": "The locale to use when formatting the date/time.", "attribute": "lang" }, { "kind": "field", "name": "weekday", "type": { "text": "'narrow' | 'short' | 'long'" }, "description": "The format for displaying the weekday.", "attribute": "weekday" }, { "kind": "field", "name": "era", "type": { "text": "'narrow' | 'short' | 'long'" }, "description": "The format for displaying the era.", "attribute": "era" }, { "kind": "field", "name": "year", "type": { "text": "'numeric' | '2-digit'" }, "description": "The format for displaying the year.", "attribute": "year" }, { "kind": "field", "name": "month", "type": { "text": "'numeric' | '2-digit' | 'narrow' | 'short' | 'long'" }, "description": "The format for displaying the month.", "attribute": "month" }, { "kind": "field", "name": "day", "type": { "text": "'numeric' | '2-digit'" }, "description": "The format for displaying the day.", "attribute": "day" }, { "kind": "field", "name": "hour", "type": { "text": "'numeric' | '2-digit'" }, "description": "The format for displaying the hour.", "attribute": "hour" }, { "kind": "field", "name": "minute", "type": { "text": "'numeric' | '2-digit'" }, "description": "The format for displaying the minute.", "attribute": "minute" }, { "kind": "field", "name": "second", "type": { "text": "'numeric' | '2-digit'" }, "description": "The format for displaying the second.", "attribute": "second" }, { "kind": "field", "name": "timeZoneName", "type": { "text": "'short' | 'long'" }, "description": "The format for displaying the time.", "attribute": "time-zone-name" }, { "kind": "field", "name": "timeZone", "type": { "text": "string" }, "description": "The time zone to express the time in.", "attribute": "time-zone" }, { "kind": "field", "name": "hourFormat", "type": { "text": "'auto' | '12' | '24'" }, "default": "'auto'", "description": "When set, 24 hour time will always be used.", "attribute": "hour-format" } ], "attributes": [ { "name": "date", "type": { "text": "Date | string" }, "default": "new Date()", "description": "The date/time to format. If not set, the current date and time will be used.", "fieldName": "date" }, { "name": "lang", "type": { "text": "string" }, "description": "The locale to use when formatting the date/time.", "fieldName": "lang" }, { "name": "weekday", "type": { "text": "'narrow' | 'short' | 'long'" }, "description": "The format for displaying the weekday.", "fieldName": "weekday" }, { "name": "era", "type": { "text": "'narrow' | 'short' | 'long'" }, "description": "The format for displaying the era.", "fieldName": "era" }, { "name": "year", "type": { "text": "'numeric' | '2-digit'" }, "description": "The format for displaying the year.", "fieldName": "year" }, { "name": "month", "type": { "text": "'numeric' | '2-digit' | 'narrow' | 'short' | 'long'" }, "description": "The format for displaying the month.", "fieldName": "month" }, { "name": "day", "type": { "text": "'numeric' | '2-digit'" }, "description": "The format for displaying the day.", "fieldName": "day" }, { "name": "hour", "type": { "text": "'numeric' | '2-digit'" }, "description": "The format for displaying the hour.", "fieldName": "hour" }, { "name": "minute", "type": { "text": "'numeric' | '2-digit'" }, "description": "The format for displaying the minute.", "fieldName": "minute" }, { "name": "second", "type": { "text": "'numeric' | '2-digit'" }, "description": "The format for displaying the second.", "fieldName": "second" }, { "name": "time-zone-name", "type": { "text": "'short' | 'long'" }, "description": "The format for displaying the time.", "fieldName": "timeZoneName" }, { "name": "time-zone", "type": { "text": "string" }, "description": "The time zone to express the time in.", "fieldName": "timeZone" }, { "name": "hour-format", "type": { "text": "'auto' | '12' | '24'" }, "default": "'auto'", "description": "When set, 24 hour time will always be used.", "fieldName": "hourFormat" } ], "superclass": { "name": "SlFormatDate", "package": "@shoelace-style/shoelace/dist/components/format-date/format-date" } } ], "exports": [ { "kind": "js", "name": "FormatDateBase", "declaration": { "name": "FormatDateBase", "module": "src/components/format-date/format-date-base.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/format-date/format-date.ts", "declarations": [ { "kind": "class", "description": "", "name": "FormatDate", "superclass": { "name": "FormatDateBase", "module": "/src/components/format-date/format-date-base.js" }, "tagName": "bp-format-date", "customElement": true, "attributes": [ { "name": "date", "type": { "text": "Date | string" }, "default": "new Date()", "description": "The date/time to format. If not set, the current date and time will be used.", "fieldName": "date", "inheritedFrom": { "name": "FormatDateBase", "module": "src/components/format-date/format-date-base.ts" } }, { "name": "lang", "type": { "text": "string" }, "description": "The locale to use when formatting the date/time.", "fieldName": "lang", "inheritedFrom": { "name": "FormatDateBase", "module": "src/components/format-date/format-date-base.ts" } }, { "name": "weekday", "type": { "text": "'narrow' | 'short' | 'long'" }, "description": "The format for displaying the weekday.", "fieldName": "weekday", "inheritedFrom": { "name": "FormatDateBase", "module": "src/components/format-date/format-date-base.ts" } }, { "name": "era", "type": { "text": "'narrow' | 'short' | 'long'" }, "description": "The format for displaying the era.", "fieldName": "era", "inheritedFrom": { "name": "FormatDateBase", "module": "src/components/format-date/format-date-base.ts" } }, { "name": "year", "type": { "text": "'numeric' | '2-digit'" }, "description": "The format for displaying the year.", "fieldName": "year", "inheritedFrom": { "name": "FormatDateBase", "module": "src/components/format-date/format-date-base.ts" } }, { "name": "month", "type": { "text": "'numeric' | '2-digit' | 'narrow' | 'short' | 'long'" }, "description": "The format for displaying the month.", "fieldName": "month", "inheritedFrom": { "name": "FormatDateBase", "module": "src/components/format-date/format-date-base.ts" } }, { "name": "day", "type": { "text": "'numeric' | '2-digit'" }, "description": "The format for displaying the day.", "fieldName": "day", "inheritedFrom": { "name": "FormatDateBase", "module": "src/components/format-date/format-date-base.ts" } }, { "name": "hour", "type": { "text": "'numeric' | '2-digit'" }, "description": "The format for displaying the hour.", "fieldName": "hour", "inheritedFrom": { "name": "FormatDateBase", "module": "src/components/format-date/format-date-base.ts" } }, { "name": "minute", "type": { "text": "'numeric' | '2-digit'" }, "description": "The format for displaying the minute.", "fieldName": "minute", "inheritedFrom": { "name": "FormatDateBase", "module": "src/components/format-date/format-date-base.ts" } }, { "name": "second", "type": { "text": "'numeric' | '2-digit'" }, "description": "The format for displaying the second.", "fieldName": "second", "inheritedFrom": { "name": "FormatDateBase", "module": "src/components/format-date/format-date-base.ts" } }, { "name": "time-zone-name", "type": { "text": "'short' | 'long'" }, "description": "The format for displaying the time.", "fieldName": "timeZoneName", "inheritedFrom": { "name": "FormatDateBase", "module": "src/components/format-date/format-date-base.ts" } }, { "name": "time-zone", "type": { "text": "string" }, "description": "The time zone to express the time in.", "fieldName": "timeZone", "inheritedFrom": { "name": "FormatDateBase", "module": "src/components/format-date/format-date-base.ts" } }, { "name": "hour-format", "type": { "text": "'auto' | '12' | '24'" }, "default": "'auto'", "description": "When set, 24 hour time will always be used.", "fieldName": "hourFormat", "inheritedFrom": { "name": "FormatDateBase", "module": "src/components/format-date/format-date-base.ts" } } ], "members": [ { "kind": "field", "name": "date", "type": { "text": "Date | string" }, "default": "new Date()", "description": "The date/time to format. If not set, the current date and time will be used.", "attribute": "date", "inheritedFrom": { "name": "FormatDateBase", "module": "src/components/format-date/format-date-base.ts" } }, { "kind": "field", "name": "lang", "type": { "text": "string" }, "description": "The locale to use when formatting the date/time.", "attribute": "lang", "inheritedFrom": { "name": "FormatDateBase", "module": "src/components/format-date/format-date-base.ts" } }, { "kind": "field", "name": "weekday", "type": { "text": "'narrow' | 'short' | 'long'" }, "description": "The format for displaying the weekday.", "attribute": "weekday", "inheritedFrom": { "name": "FormatDateBase", "module": "src/components/format-date/format-date-base.ts" } }, { "kind": "field", "name": "era", "type": { "text": "'narrow' | 'short' | 'long'" }, "description": "The format for displaying the era.", "attribute": "era", "inheritedFrom": { "name": "FormatDateBase", "module": "src/components/format-date/format-date-base.ts" } }, { "kind": "field", "name": "year", "type": { "text": "'numeric' | '2-digit'" }, "description": "The format for displaying the year.", "attribute": "year", "inheritedFrom": { "name": "FormatDateBase", "module": "src/components/format-date/format-date-base.ts" } }, { "kind": "field", "name": "month", "type": { "text": "'numeric' | '2-digit' | 'narrow' | 'short' | 'long'" }, "description": "The format for displaying the month.", "attribute": "month", "inheritedFrom": { "name": "FormatDateBase", "module": "src/components/format-date/format-date-base.ts" } }, { "kind": "field", "name": "day", "type": { "text": "'numeric' | '2-digit'" }, "description": "The format for displaying the day.", "attribute": "day", "inheritedFrom": { "name": "FormatDateBase", "module": "src/components/format-date/format-date-base.ts" } }, { "kind": "field", "name": "hour", "type": { "text": "'numeric' | '2-digit'" }, "description": "The format for displaying the hour.", "attribute": "hour", "inheritedFrom": { "name": "FormatDateBase", "module": "src/components/format-date/format-date-base.ts" } }, { "kind": "field", "name": "minute", "type": { "text": "'numeric' | '2-digit'" }, "description": "The format for displaying the minute.", "attribute": "minute", "inheritedFrom": { "name": "FormatDateBase", "module": "src/components/format-date/format-date-base.ts" } }, { "kind": "field", "name": "second", "type": { "text": "'numeric' | '2-digit'" }, "description": "The format for displaying the second.", "attribute": "second", "inheritedFrom": { "name": "FormatDateBase", "module": "src/components/format-date/format-date-base.ts" } }, { "kind": "field", "name": "timeZoneName", "type": { "text": "'short' | 'long'" }, "description": "The format for displaying the time.", "attribute": "time-zone-name", "inheritedFrom": { "name": "FormatDateBase", "module": "src/components/format-date/format-date-base.ts" } }, { "kind": "field", "name": "timeZone", "type": { "text": "string" }, "description": "The time zone to express the time in.", "attribute": "time-zone", "inheritedFrom": { "name": "FormatDateBase", "module": "src/components/format-date/format-date-base.ts" } }, { "kind": "field", "name": "hourFormat", "type": { "text": "'auto' | '12' | '24'" }, "default": "'auto'", "description": "When set, 24 hour time will always be used.", "attribute": "hour-format", "inheritedFrom": { "name": "FormatDateBase", "module": "src/components/format-date/format-date-base.ts" } } ] } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "FormatDate", "module": "src/components/format-date/format-date.ts" } }, { "kind": "custom-element-definition", "name": "bp-format-date", "declaration": { "name": "FormatDate", "module": "src/components/format-date/format-date.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/format-number/format-number-base.ts", "declarations": [ { "kind": "class", "description": "", "name": "FormatNumberBase", "members": [ { "kind": "field", "name": "value", "type": { "text": "number" }, "default": "0", "description": "The number to format.", "attribute": "value" }, { "kind": "field", "name": "lang", "type": { "text": "string" }, "description": "The locale to use when formatting the number.", "attribute": "lang" }, { "kind": "field", "name": "type", "type": { "text": "'currency' | 'decimal' | 'percent'" }, "default": "'decimal'", "description": "The formatting style to use.", "attribute": "type" }, { "kind": "field", "name": "noGrouping", "type": { "text": "boolean" }, "default": "false", "description": "Turns off grouping separators.", "attribute": "noGrouping" }, { "kind": "field", "name": "currency", "type": { "text": "string" }, "default": "'USD'", "description": "The currency to use when formatting. Must be an ISO 4217 currency code such as USD or EUR.", "attribute": "currency" }, { "kind": "field", "name": "currencyDisplay", "type": { "text": "'symbol' | 'narrowSymbol' | 'code' | 'name'" }, "default": "'symbol'", "description": "How to display the currency.", "attribute": "currencyDisplay" }, { "kind": "field", "name": "minimumIntegerDigits", "type": { "text": "number" }, "description": "The minimum number of integer digits to use. Possible values are 1 - 21.", "attribute": "minimumIntegerDigits" }, { "kind": "field", "name": "minimumFractionDigits", "type": { "text": "number" }, "description": "The minimum number of fraction digits to use. Possible values are 0 - 20.", "attribute": "minimumFractionDigits" }, { "kind": "field", "name": "maximumFractionDigits", "type": { "text": "number" }, "description": "The maximum number of fraction digits to use. Possible values are 0 - 20.", "attribute": "maximumFractionDigits" }, { "kind": "field", "name": "minimumSignificantDigits", "type": { "text": "number" }, "description": "The minimum number of significant digits to use. Possible values are 1 - 21.", "attribute": "minimumSignificantDigits" }, { "kind": "field", "name": "maximumSignificantDigits", "type": { "text": "number" }, "description": "The maximum number of significant digits to use,. Possible values are 1 - 21.", "attribute": "maximumSignificantDigits" } ], "attributes": [ { "name": "value", "type": { "text": "number" }, "default": "0", "description": "The number to format.", "fieldName": "value" }, { "name": "lang", "type": { "text": "string" }, "description": "The locale to use when formatting the number.", "fieldName": "lang" }, { "name": "type", "type": { "text": "'currency' | 'decimal' | 'percent'" }, "default": "'decimal'", "description": "The formatting style to use.", "fieldName": "type" }, { "name": "noGrouping", "type": { "text": "boolean" }, "default": "false", "description": "Turns off grouping separators.", "fieldName": "noGrouping" }, { "name": "currency", "type": { "text": "string" }, "default": "'USD'", "description": "The currency to use when formatting. Must be an ISO 4217 currency code such as USD or EUR.", "fieldName": "currency" }, { "name": "currencyDisplay", "type": { "text": "'symbol' | 'narrowSymbol' | 'code' | 'name'" }, "default": "'symbol'", "description": "How to display the currency.", "fieldName": "currencyDisplay" }, { "name": "minimumIntegerDigits", "type": { "text": "number" }, "description": "The minimum number of integer digits to use. Possible values are 1 - 21.", "fieldName": "minimumIntegerDigits" }, { "name": "minimumFractionDigits", "type": { "text": "number" }, "description": "The minimum number of fraction digits to use. Possible values are 0 - 20.", "fieldName": "minimumFractionDigits" }, { "name": "maximumFractionDigits", "type": { "text": "number" }, "description": "The maximum number of fraction digits to use. Possible values are 0 - 20.", "fieldName": "maximumFractionDigits" }, { "name": "minimumSignificantDigits", "type": { "text": "number" }, "description": "The minimum number of significant digits to use. Possible values are 1 - 21.", "fieldName": "minimumSignificantDigits" }, { "name": "maximumSignificantDigits", "type": { "text": "number" }, "description": "The maximum number of significant digits to use,. Possible values are 1 - 21.", "fieldName": "maximumSignificantDigits" } ], "superclass": { "name": "SlFormatNumber", "package": "@shoelace-style/shoelace/dist/components/format-number/format-number" } } ], "exports": [ { "kind": "js", "name": "FormatNumberBase", "declaration": { "name": "FormatNumberBase", "module": "src/components/format-number/format-number-base.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/format-number/format-number.ts", "declarations": [ { "kind": "class", "description": "", "name": "FormatNumber", "superclass": { "name": "FormatNumberBase", "module": "/src/components/format-number/format-number-base.js" }, "since": "0.1.1-beta.1", "status": "beta", "tagName": "bp-format-number", "customElement": true, "attributes": [ { "name": "value", "type": { "text": "number" }, "default": "0", "description": "The number to format.", "fieldName": "value", "inheritedFrom": { "name": "FormatNumberBase", "module": "src/components/format-number/format-number-base.ts" } }, { "name": "lang", "type": { "text": "string" }, "description": "The locale to use when formatting the number.", "fieldName": "lang", "inheritedFrom": { "name": "FormatNumberBase", "module": "src/components/format-number/format-number-base.ts" } }, { "name": "type", "type": { "text": "'currency' | 'decimal' | 'percent'" }, "default": "'decimal'", "description": "The formatting style to use.", "fieldName": "type", "inheritedFrom": { "name": "FormatNumberBase", "module": "src/components/format-number/format-number-base.ts" } }, { "name": "noGrouping", "type": { "text": "boolean" }, "default": "false", "description": "Turns off grouping separators.", "fieldName": "noGrouping", "inheritedFrom": { "name": "FormatNumberBase", "module": "src/components/format-number/format-number-base.ts" } }, { "name": "currency", "type": { "text": "string" }, "default": "'USD'", "description": "The currency to use when formatting. Must be an ISO 4217 currency code such as USD or EUR.", "fieldName": "currency", "inheritedFrom": { "name": "FormatNumberBase", "module": "src/components/format-number/format-number-base.ts" } }, { "name": "currencyDisplay", "type": { "text": "'symbol' | 'narrowSymbol' | 'code' | 'name'" }, "default": "'symbol'", "description": "How to display the currency.", "fieldName": "currencyDisplay", "inheritedFrom": { "name": "FormatNumberBase", "module": "src/components/format-number/format-number-base.ts" } }, { "name": "minimumIntegerDigits", "type": { "text": "number" }, "description": "The minimum number of integer digits to use. Possible values are 1 - 21.", "fieldName": "minimumIntegerDigits", "inheritedFrom": { "name": "FormatNumberBase", "module": "src/components/format-number/format-number-base.ts" } }, { "name": "minimumFractionDigits", "type": { "text": "number" }, "description": "The minimum number of fraction digits to use. Possible values are 0 - 20.", "fieldName": "minimumFractionDigits", "inheritedFrom": { "name": "FormatNumberBase", "module": "src/components/format-number/format-number-base.ts" } }, { "name": "maximumFractionDigits", "type": { "text": "number" }, "description": "The maximum number of fraction digits to use. Possible values are 0 - 20.", "fieldName": "maximumFractionDigits", "inheritedFrom": { "name": "FormatNumberBase", "module": "src/components/format-number/format-number-base.ts" } }, { "name": "minimumSignificantDigits", "type": { "text": "number" }, "description": "The minimum number of significant digits to use. Possible values are 1 - 21.", "fieldName": "minimumSignificantDigits", "inheritedFrom": { "name": "FormatNumberBase", "module": "src/components/format-number/format-number-base.ts" } }, { "name": "maximumSignificantDigits", "type": { "text": "number" }, "description": "The maximum number of significant digits to use,. Possible values are 1 - 21.", "fieldName": "maximumSignificantDigits", "inheritedFrom": { "name": "FormatNumberBase", "module": "src/components/format-number/format-number-base.ts" } } ], "members": [ { "kind": "field", "name": "value", "type": { "text": "number" }, "default": "0", "description": "The number to format.", "attribute": "value", "inheritedFrom": { "name": "FormatNumberBase", "module": "src/components/format-number/format-number-base.ts" } }, { "kind": "field", "name": "lang", "type": { "text": "string" }, "description": "The locale to use when formatting the number.", "attribute": "lang", "inheritedFrom": { "name": "FormatNumberBase", "module": "src/components/format-number/format-number-base.ts" } }, { "kind": "field", "name": "type", "type": { "text": "'currency' | 'decimal' | 'percent'" }, "default": "'decimal'", "description": "The formatting style to use.", "attribute": "type", "inheritedFrom": { "name": "FormatNumberBase", "module": "src/components/format-number/format-number-base.ts" } }, { "kind": "field", "name": "noGrouping", "type": { "text": "boolean" }, "default": "false", "description": "Turns off grouping separators.", "attribute": "noGrouping", "inheritedFrom": { "name": "FormatNumberBase", "module": "src/components/format-number/format-number-base.ts" } }, { "kind": "field", "name": "currency", "type": { "text": "string" }, "default": "'USD'", "description": "The currency to use when formatting. Must be an ISO 4217 currency code such as USD or EUR.", "attribute": "currency", "inheritedFrom": { "name": "FormatNumberBase", "module": "src/components/format-number/format-number-base.ts" } }, { "kind": "field", "name": "currencyDisplay", "type": { "text": "'symbol' | 'narrowSymbol' | 'code' | 'name'" }, "default": "'symbol'", "description": "How to display the currency.", "attribute": "currencyDisplay", "inheritedFrom": { "name": "FormatNumberBase", "module": "src/components/format-number/format-number-base.ts" } }, { "kind": "field", "name": "minimumIntegerDigits", "type": { "text": "number" }, "description": "The minimum number of integer digits to use. Possible values are 1 - 21.", "attribute": "minimumIntegerDigits", "inheritedFrom": { "name": "FormatNumberBase", "module": "src/components/format-number/format-number-base.ts" } }, { "kind": "field", "name": "minimumFractionDigits", "type": { "text": "number" }, "description": "The minimum number of fraction digits to use. Possible values are 0 - 20.", "attribute": "minimumFractionDigits", "inheritedFrom": { "name": "FormatNumberBase", "module": "src/components/format-number/format-number-base.ts" } }, { "kind": "field", "name": "maximumFractionDigits", "type": { "text": "number" }, "description": "The maximum number of fraction digits to use. Possible values are 0 - 20.", "attribute": "maximumFractionDigits", "inheritedFrom": { "name": "FormatNumberBase", "module": "src/components/format-number/format-number-base.ts" } }, { "kind": "field", "name": "minimumSignificantDigits", "type": { "text": "number" }, "description": "The minimum number of significant digits to use. Possible values are 1 - 21.", "attribute": "minimumSignificantDigits", "inheritedFrom": { "name": "FormatNumberBase", "module": "src/components/format-number/format-number-base.ts" } }, { "kind": "field", "name": "maximumSignificantDigits", "type": { "text": "number" }, "description": "The maximum number of significant digits to use,. Possible values are 1 - 21.", "attribute": "maximumSignificantDigits", "inheritedFrom": { "name": "FormatNumberBase", "module": "src/components/format-number/format-number-base.ts" } } ] } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "FormatNumber", "module": "src/components/format-number/format-number.ts" } }, { "kind": "custom-element-definition", "name": "bp-format-number", "declaration": { "name": "FormatNumber", "module": "src/components/format-number/format-number.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icon-base.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconBase", "members": [ { "kind": "field", "name": "color", "type": { "text": "| 'primary'\n | 'secondary'\n | 'success'\n | 'warning'\n | 'info'\n | 'error'\n | string" }, "default": "'primary'", "description": "The icon's color.", "attribute": "color" }, { "kind": "method", "name": "getRenderClasses" } ], "attributes": [ { "name": "color", "type": { "text": "| 'primary'\n | 'secondary'\n | 'success'\n | 'warning'\n | 'info'\n | 'error'\n | string" }, "default": "'primary'", "description": "The icon's color.", "fieldName": "color" } ], "superclass": { "name": "LitElement", "package": "lit" }, "customElement": true } ], "exports": [ { "kind": "js", "name": "IconBase", "declaration": { "name": "IconBase", "module": "src/components/icon/icon-base.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icon.ts", "declarations": [ { "kind": "class", "description": "", "name": "Icon", "cssProperties": [ { "description": "The size property for the icon.", "name": "--bp-icon-size", "default": "24px" } ], "slots": [ { "description": "The Material Icon name.", "name": "" } ], "members": [ { "kind": "field", "name": "color", "type": { "text": "| 'primary'\n | 'secondary'\n | 'success'\n | 'warning'\n | 'info'\n | 'error'\n | string" }, "default": "'primary'", "description": "The icon's color.", "attribute": "color", "inheritedFrom": { "name": "IconBase", "module": "src/components/icon/icon-base.ts" } }, { "kind": "method", "name": "getRenderClasses", "inheritedFrom": { "name": "IconBase", "module": "src/components/icon/icon-base.ts" } } ], "superclass": { "name": "IconBase", "module": "/src/components/icon/icon-base.js" }, "since": "0.1.1-beta.1", "status": "beta", "tagName": "bp-icon", "customElement": true, "attributes": [ { "name": "color", "type": { "text": "| 'primary'\n | 'secondary'\n | 'success'\n | 'warning'\n | 'info'\n | 'error'\n | string" }, "default": "'primary'", "description": "The icon's color.", "fieldName": "color", "inheritedFrom": { "name": "IconBase", "module": "src/components/icon/icon-base.ts" } } ] } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "Icon", "module": "src/components/icon/icon.ts" } }, { "kind": "custom-element-definition", "name": "bp-icon", "declaration": { "name": "Icon", "module": "src/components/icon/icon.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon-button/icon-button-base.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconButtonBase", "members": [ { "kind": "field", "name": "icon", "type": { "text": "string" }, "default": "''", "description": "The name of the icon.", "attribute": "icon" }, { "kind": "field", "name": "color", "type": { "text": "| 'primary'\n | 'secondary'\n | 'success'\n | 'warning'\n | 'info'\n | 'error'\n | string" }, "default": "'primary'", "description": "The icon's color.", "attribute": "color" }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Disables the icon button", "attribute": "disabled" }, { "kind": "method", "name": "emitClickHandler" }, { "kind": "method", "name": "getRenderClasses" } ], "attributes": [ { "name": "icon", "type": { "text": "string" }, "default": "''", "description": "The name of the icon.", "fieldName": "icon" }, { "name": "color", "type": { "text": "| 'primary'\n | 'secondary'\n | 'success'\n | 'warning'\n | 'info'\n | 'error'\n | string" }, "default": "'primary'", "description": "The icon's color.", "fieldName": "color" }, { "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Disables the icon button", "fieldName": "disabled" } ], "superclass": { "name": "_IconButtonBase", "package": "@material/mwc-icon-button/mwc-icon-button-base" } } ], "exports": [ { "kind": "js", "name": "IconButtonBase", "declaration": { "name": "IconButtonBase", "module": "src/components/icon-button/icon-button-base.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon-button/icon-button.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconButton", "cssProperties": [ { "description": "The size property for the icon.", "name": "--bp-icon-size", "default": "24px" } ], "members": [ { "kind": "field", "name": "icon", "type": { "text": "string" }, "default": "''", "description": "The name of the icon.", "attribute": "icon", "inheritedFrom": { "name": "IconButtonBase", "module": "src/components/icon-button/icon-button-base.ts" } }, { "kind": "field", "name": "color", "type": { "text": "| 'primary'\n | 'secondary'\n | 'success'\n | 'warning'\n | 'info'\n | 'error'\n | string" }, "default": "'primary'", "description": "The icon's color.", "attribute": "color", "inheritedFrom": { "name": "IconButtonBase", "module": "src/components/icon-button/icon-button-base.ts" } }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Disables the icon button", "attribute": "disabled", "inheritedFrom": { "name": "IconButtonBase", "module": "src/components/icon-button/icon-button-base.ts" } }, { "kind": "method", "name": "emitClickHandler", "inheritedFrom": { "name": "IconButtonBase", "module": "src/components/icon-button/icon-button-base.ts" } }, { "kind": "method", "name": "getRenderClasses", "inheritedFrom": { "name": "IconButtonBase", "module": "src/components/icon-button/icon-button-base.ts" } } ], "superclass": { "name": "IconButtonBase", "module": "/src/components/icon-button/icon-button-base.js" }, "since": "0.1.1-beta.1", "status": "beta", "tagName": "bp-icon-button", "customElement": true, "attributes": [ { "name": "icon", "type": { "text": "string" }, "default": "''", "description": "The name of the icon.", "fieldName": "icon", "inheritedFrom": { "name": "IconButtonBase", "module": "src/components/icon-button/icon-button-base.ts" } }, { "name": "color", "type": { "text": "| 'primary'\n | 'secondary'\n | 'success'\n | 'warning'\n | 'info'\n | 'error'\n | string" }, "default": "'primary'", "description": "The icon's color.", "fieldName": "color", "inheritedFrom": { "name": "IconButtonBase", "module": "src/components/icon-button/icon-button-base.ts" } }, { "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Disables the icon button", "fieldName": "disabled", "inheritedFrom": { "name": "IconButtonBase", "module": "src/components/icon-button/icon-button-base.ts" } } ] } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "IconButton", "module": "src/components/icon-button/icon-button.ts" } }, { "kind": "custom-element-definition", "name": "bp-icon-button", "declaration": { "name": "IconButton", "module": "src/components/icon-button/icon-button.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon-button-toggle/icon-button-toggle-base.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconButtonToggleBase", "members": [ { "kind": "field", "name": "on", "type": { "text": "boolean" }, "default": "false", "description": "Whether the toggle is activated.", "attribute": "on", "reflects": true }, { "kind": "field", "name": "onIcon", "type": { "text": "string" }, "default": "''", "description": "Icon to display when on is true.", "attribute": "onIcon" }, { "kind": "field", "name": "offIcon", "type": { "text": "string" }, "default": "''", "description": "Icon to display when on is false.", "attribute": "offIcon" }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Disabled buttons cannot be interacted with and have no visual interaction effect.", "attribute": "disabled" }, { "kind": "method", "name": "emitClickHandler", "parameters": [ { "name": "e", "type": { "text": "Event" } } ] } ], "attributes": [ { "name": "on", "type": { "text": "boolean" }, "default": "false", "description": "Whether the toggle is activated.", "fieldName": "on" }, { "name": "onIcon", "type": { "text": "string" }, "default": "''", "description": "Icon to display when on is true.", "fieldName": "onIcon" }, { "name": "offIcon", "type": { "text": "string" }, "default": "''", "description": "Icon to display when on is false.", "fieldName": "offIcon" }, { "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Disabled buttons cannot be interacted with and have no visual interaction effect.", "fieldName": "disabled" } ], "superclass": { "name": "_IconButtonToggleBase", "package": "@material/mwc-icon-button-toggle/mwc-icon-button-toggle-base" } } ], "exports": [ { "kind": "js", "name": "IconButtonToggleBase", "declaration": { "name": "IconButtonToggleBase", "module": "src/components/icon-button-toggle/icon-button-toggle-base.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon-button-toggle/icon-button-toggle.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconButtonToggle", "slots": [ { "description": "Optional or to display instead of using an icon font for the onIcon property.", "name": "onIcon" }, { "description": "Optional or to display instead of using an icon font for the offIcon property.", "name": "offIcon" } ], "members": [ { "kind": "field", "name": "on", "type": { "text": "boolean" }, "default": "false", "description": "Whether the toggle is activated.", "attribute": "on", "reflects": true, "inheritedFrom": { "name": "IconButtonToggleBase", "module": "src/components/icon-button-toggle/icon-button-toggle-base.ts" } }, { "kind": "field", "name": "onIcon", "type": { "text": "string" }, "default": "''", "description": "Icon to display when on is true.", "attribute": "onIcon", "inheritedFrom": { "name": "IconButtonToggleBase", "module": "src/components/icon-button-toggle/icon-button-toggle-base.ts" } }, { "kind": "field", "name": "offIcon", "type": { "text": "string" }, "default": "''", "description": "Icon to display when on is false.", "attribute": "offIcon", "inheritedFrom": { "name": "IconButtonToggleBase", "module": "src/components/icon-button-toggle/icon-button-toggle-base.ts" } }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Disabled buttons cannot be interacted with and have no visual interaction effect.", "attribute": "disabled", "inheritedFrom": { "name": "IconButtonToggleBase", "module": "src/components/icon-button-toggle/icon-button-toggle-base.ts" } }, { "kind": "method", "name": "emitClickHandler", "parameters": [ { "name": "e", "type": { "text": "Event" } } ], "inheritedFrom": { "name": "IconButtonToggleBase", "module": "src/components/icon-button-toggle/icon-button-toggle-base.ts" } } ], "events": [ { "type": { "text": "isOn: boolean" }, "description": "Fires when the button is clicked.", "name": "bp-icon-button-toggle-changed", "reactName": "onBpIconButtonToggleChanged" } ], "superclass": { "name": "IconButtonToggleBase", "module": "/src/components/icon-button-toggle/icon-button-toggle-base.js" }, "since": "0.1.1-beta.1", "status": "beta", "tagName": "bp-icon-button-toggle", "customElement": true, "attributes": [ { "name": "on", "type": { "text": "boolean" }, "default": "false", "description": "Whether the toggle is activated.", "fieldName": "on", "inheritedFrom": { "name": "IconButtonToggleBase", "module": "src/components/icon-button-toggle/icon-button-toggle-base.ts" } }, { "name": "onIcon", "type": { "text": "string" }, "default": "''", "description": "Icon to display when on is true.", "fieldName": "onIcon", "inheritedFrom": { "name": "IconButtonToggleBase", "module": "src/components/icon-button-toggle/icon-button-toggle-base.ts" } }, { "name": "offIcon", "type": { "text": "string" }, "default": "''", "description": "Icon to display when on is false.", "fieldName": "offIcon", "inheritedFrom": { "name": "IconButtonToggleBase", "module": "src/components/icon-button-toggle/icon-button-toggle-base.ts" } }, { "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Disabled buttons cannot be interacted with and have no visual interaction effect.", "fieldName": "disabled", "inheritedFrom": { "name": "IconButtonToggleBase", "module": "src/components/icon-button-toggle/icon-button-toggle-base.ts" } } ] } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "IconButtonToggle", "module": "src/components/icon-button-toggle/icon-button-toggle.ts" } }, { "kind": "custom-element-definition", "name": "bp-icon-button-toggle", "declaration": { "name": "IconButtonToggle", "module": "src/components/icon-button-toggle/icon-button-toggle.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/lang-switcher/lang-switcher-base.ts", "declarations": [ { "kind": "class", "description": "", "name": "LangSwitcherBase", "members": [ { "kind": "field", "name": "msg", "type": { "text": "string" }, "default": "''", "attribute": "msg" }, { "kind": "field", "name": "lang", "type": { "text": "string" }, "default": "'en'", "attribute": "lang", "reflects": true }, { "kind": "field", "name": "currency", "type": { "text": "string" }, "default": "'USD'", "attribute": "currency", "reflects": true }, { "kind": "method", "name": "handleToggle", "privacy": "private" }, { "kind": "field", "name": "_flag" } ], "attributes": [ { "name": "msg", "type": { "text": "string" }, "default": "''", "fieldName": "msg" }, { "name": "lang", "type": { "text": "string" }, "default": "'en'", "fieldName": "lang" }, { "name": "currency", "type": { "text": "string" }, "default": "'USD'", "fieldName": "currency" } ], "superclass": { "name": "LitElement", "package": "lit" }, "customElement": true } ], "exports": [ { "kind": "js", "name": "LangSwitcherBase", "declaration": { "name": "LangSwitcherBase", "module": "src/components/lang-switcher/lang-switcher-base.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/lang-switcher/lang-switcher.ts", "declarations": [ { "kind": "class", "description": "", "name": "LangSwitcher", "superclass": { "name": "LangSwitcherBase", "module": "/src/components/lang-switcher/lang-switcher-base.js" }, "tagName": "bp-lang-switcher", "customElement": true, "attributes": [ { "name": "msg", "type": { "text": "string" }, "default": "''", "fieldName": "msg", "inheritedFrom": { "name": "LangSwitcherBase", "module": "src/components/lang-switcher/lang-switcher-base.ts" } }, { "name": "lang", "type": { "text": "string" }, "default": "'en'", "fieldName": "lang", "inheritedFrom": { "name": "LangSwitcherBase", "module": "src/components/lang-switcher/lang-switcher-base.ts" } }, { "name": "currency", "type": { "text": "string" }, "default": "'USD'", "fieldName": "currency", "inheritedFrom": { "name": "LangSwitcherBase", "module": "src/components/lang-switcher/lang-switcher-base.ts" } } ], "members": [ { "kind": "field", "name": "msg", "type": { "text": "string" }, "default": "''", "attribute": "msg", "inheritedFrom": { "name": "LangSwitcherBase", "module": "src/components/lang-switcher/lang-switcher-base.ts" } }, { "kind": "field", "name": "lang", "type": { "text": "string" }, "default": "'en'", "attribute": "lang", "reflects": true, "inheritedFrom": { "name": "LangSwitcherBase", "module": "src/components/lang-switcher/lang-switcher-base.ts" } }, { "kind": "field", "name": "currency", "type": { "text": "string" }, "default": "'USD'", "attribute": "currency", "reflects": true, "inheritedFrom": { "name": "LangSwitcherBase", "module": "src/components/lang-switcher/lang-switcher-base.ts" } }, { "kind": "method", "name": "handleToggle", "privacy": "private", "inheritedFrom": { "name": "LangSwitcherBase", "module": "src/components/lang-switcher/lang-switcher-base.ts" } }, { "kind": "field", "name": "_flag", "inheritedFrom": { "name": "LangSwitcherBase", "module": "src/components/lang-switcher/lang-switcher-base.ts" } } ] } ], "exports": [ { "kind": "js", "name": "LangSwitcher", "declaration": { "name": "LangSwitcher", "module": "src/components/lang-switcher/lang-switcher.ts" } }, { "kind": "custom-element-definition", "name": "bp-lang-switcher", "declaration": { "name": "LangSwitcher", "module": "src/components/lang-switcher/lang-switcher.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/layout-grid/layout-grid-base.ts", "declarations": [ { "kind": "class", "description": "", "name": "LayoutGridBase", "members": [ { "kind": "field", "name": "gridPosition", "type": { "text": "'left' | 'right' | 'center' | ''" }, "default": "''", "description": "Optional, specifies the alignment of the whole grid, requires max-width", "attribute": "gridPosition" }, { "kind": "field", "name": "gutter", "type": { "text": "string" }, "default": "'24px'", "description": "Optional, specifies the distance between grid items.", "attribute": "gutter" }, { "kind": "field", "name": "margin", "type": { "text": "string" }, "default": "'24px'", "description": "Optional, specifies the margin of the grid.", "attribute": "margin" }, { "kind": "field", "name": "getClasses" }, { "kind": "field", "name": "getStyles" } ], "attributes": [ { "name": "gridPosition", "type": { "text": "'left' | 'right' | 'center' | ''" }, "default": "''", "description": "Optional, specifies the alignment of the whole grid, requires max-width", "fieldName": "gridPosition" }, { "name": "gutter", "type": { "text": "string" }, "default": "'24px'", "description": "Optional, specifies the distance between grid items.", "fieldName": "gutter" }, { "name": "margin", "type": { "text": "string" }, "default": "'24px'", "description": "Optional, specifies the margin of the grid.", "fieldName": "margin" } ], "superclass": { "name": "LitElement", "package": "lit" }, "customElement": true } ], "exports": [ { "kind": "js", "name": "LayoutGridBase", "declaration": { "name": "LayoutGridBase", "module": "src/components/layout-grid/layout-grid-base.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/layout-grid/layout-grid.ts", "declarations": [ { "kind": "class", "description": "", "name": "LayoutGrid", "cssProperties": [ { "description": "Restricts max width of the layout grid.", "name": "--bp-layout-grid--max-width" } ], "slots": [ { "description": "The layout grid content slot.", "name": "" } ], "members": [ { "kind": "field", "name": "gridPosition", "type": { "text": "'left' | 'right' | 'center' | ''" }, "default": "''", "description": "Optional, specifies the alignment of the whole grid, requires max-width", "attribute": "gridPosition", "inheritedFrom": { "name": "LayoutGridBase", "module": "src/components/layout-grid/layout-grid-base.ts" } }, { "kind": "field", "name": "gutter", "type": { "text": "string" }, "default": "'24px'", "description": "Optional, specifies the distance between grid items.", "attribute": "gutter", "inheritedFrom": { "name": "LayoutGridBase", "module": "src/components/layout-grid/layout-grid-base.ts" } }, { "kind": "field", "name": "margin", "type": { "text": "string" }, "default": "'24px'", "description": "Optional, specifies the margin of the grid.", "attribute": "margin", "inheritedFrom": { "name": "LayoutGridBase", "module": "src/components/layout-grid/layout-grid-base.ts" } }, { "kind": "field", "name": "getClasses", "inheritedFrom": { "name": "LayoutGridBase", "module": "src/components/layout-grid/layout-grid-base.ts" } }, { "kind": "field", "name": "getStyles", "inheritedFrom": { "name": "LayoutGridBase", "module": "src/components/layout-grid/layout-grid-base.ts" } } ], "superclass": { "name": "LayoutGridBase", "module": "/src/components/layout-grid/layout-grid-base.js" }, "since": "0.1.1-beta.1", "status": "beta", "tagName": "bp-layout-grid", "customElement": true, "attributes": [ { "name": "gridPosition", "type": { "text": "'left' | 'right' | 'center' | ''" }, "default": "''", "description": "Optional, specifies the alignment of the whole grid, requires max-width", "fieldName": "gridPosition", "inheritedFrom": { "name": "LayoutGridBase", "module": "src/components/layout-grid/layout-grid-base.ts" } }, { "name": "gutter", "type": { "text": "string" }, "default": "'24px'", "description": "Optional, specifies the distance between grid items.", "fieldName": "gutter", "inheritedFrom": { "name": "LayoutGridBase", "module": "src/components/layout-grid/layout-grid-base.ts" } }, { "name": "margin", "type": { "text": "string" }, "default": "'24px'", "description": "Optional, specifies the margin of the grid.", "fieldName": "margin", "inheritedFrom": { "name": "LayoutGridBase", "module": "src/components/layout-grid/layout-grid-base.ts" } } ] } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "LayoutGrid", "module": "src/components/layout-grid/layout-grid.ts" } }, { "kind": "custom-element-definition", "name": "bp-layout-grid", "declaration": { "name": "LayoutGrid", "module": "src/components/layout-grid/layout-grid.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/layout-grid-cell/layout-grid-cell-base.ts", "declarations": [ { "kind": "class", "description": "", "name": "LayoutGridCellBase", "members": [ { "kind": "field", "name": "desktopCols", "type": { "text": "| number\n | null" }, "default": "null", "description": "Optional, specifies the number of the 12 columns the cell spans on desktop", "attribute": "desktop-cols" }, { "kind": "field", "name": "tabletCols", "type": { "text": "| number\n | null" }, "default": "null", "description": "Optional, specifies the number of the 8 columns the cell spans on tablet", "attribute": "tablet-cols" }, { "kind": "field", "name": "phoneCols", "type": { "text": "number | null" }, "default": "null", "description": "Optional, specifies the number of the 4 columns the cell spans on phone", "attribute": "phone-cols" }, { "kind": "field", "name": "alignment", "type": { "text": "| 'top'\n | 'middle'\n | 'bottom'\n | 'stretch'\n | ''" }, "default": "''", "description": "Optional, specifies the alignment of cell", "attribute": "alignment" }, { "kind": "field", "name": "getClasses" } ], "attributes": [ { "name": "desktop-cols", "type": { "text": "| number\n | null" }, "default": "null", "description": "Optional, specifies the number of the 12 columns the cell spans on desktop", "fieldName": "desktopCols" }, { "name": "tablet-cols", "type": { "text": "| number\n | null" }, "default": "null", "description": "Optional, specifies the number of the 8 columns the cell spans on tablet", "fieldName": "tabletCols" }, { "name": "phone-cols", "type": { "text": "number | null" }, "default": "null", "description": "Optional, specifies the number of the 4 columns the cell spans on phone", "fieldName": "phoneCols" }, { "name": "alignment", "type": { "text": "| 'top'\n | 'middle'\n | 'bottom'\n | 'stretch'\n | ''" }, "default": "''", "description": "Optional, specifies the alignment of cell", "fieldName": "alignment" } ], "superclass": { "name": "LitElement", "package": "lit" }, "customElement": true } ], "exports": [ { "kind": "js", "name": "LayoutGridCellBase", "declaration": { "name": "LayoutGridCellBase", "module": "src/components/layout-grid-cell/layout-grid-cell-base.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/layout-grid-cell/layout-grid-cell.ts", "declarations": [ { "kind": "class", "description": "", "name": "LayoutGridCell", "slots": [ { "description": "The layout grid cell content.", "name": "" } ], "members": [ { "kind": "field", "name": "desktopCols", "type": { "text": "| number\n | null" }, "default": "null", "description": "Optional, specifies the number of the 12 columns the cell spans on desktop", "attribute": "desktop-cols", "inheritedFrom": { "name": "LayoutGridCellBase", "module": "src/components/layout-grid-cell/layout-grid-cell-base.ts" } }, { "kind": "field", "name": "tabletCols", "type": { "text": "| number\n | null" }, "default": "null", "description": "Optional, specifies the number of the 8 columns the cell spans on tablet", "attribute": "tablet-cols", "inheritedFrom": { "name": "LayoutGridCellBase", "module": "src/components/layout-grid-cell/layout-grid-cell-base.ts" } }, { "kind": "field", "name": "phoneCols", "type": { "text": "number | null" }, "default": "null", "description": "Optional, specifies the number of the 4 columns the cell spans on phone", "attribute": "phone-cols", "inheritedFrom": { "name": "LayoutGridCellBase", "module": "src/components/layout-grid-cell/layout-grid-cell-base.ts" } }, { "kind": "field", "name": "alignment", "type": { "text": "| 'top'\n | 'middle'\n | 'bottom'\n | 'stretch'\n | ''" }, "default": "''", "description": "Optional, specifies the alignment of cell", "attribute": "alignment", "inheritedFrom": { "name": "LayoutGridCellBase", "module": "src/components/layout-grid-cell/layout-grid-cell-base.ts" } }, { "kind": "field", "name": "getClasses", "inheritedFrom": { "name": "LayoutGridCellBase", "module": "src/components/layout-grid-cell/layout-grid-cell-base.ts" } } ], "superclass": { "name": "LayoutGridCellBase", "module": "/src/components/layout-grid-cell/layout-grid-cell-base.js" }, "since": "0.1.1-beta.1", "status": "beta", "tagName": "bp-layout-grid-cell", "customElement": true, "attributes": [ { "name": "desktop-cols", "type": { "text": "| number\n | null" }, "default": "null", "description": "Optional, specifies the number of the 12 columns the cell spans on desktop", "fieldName": "desktopCols", "inheritedFrom": { "name": "LayoutGridCellBase", "module": "src/components/layout-grid-cell/layout-grid-cell-base.ts" } }, { "name": "tablet-cols", "type": { "text": "| number\n | null" }, "default": "null", "description": "Optional, specifies the number of the 8 columns the cell spans on tablet", "fieldName": "tabletCols", "inheritedFrom": { "name": "LayoutGridCellBase", "module": "src/components/layout-grid-cell/layout-grid-cell-base.ts" } }, { "name": "phone-cols", "type": { "text": "number | null" }, "default": "null", "description": "Optional, specifies the number of the 4 columns the cell spans on phone", "fieldName": "phoneCols", "inheritedFrom": { "name": "LayoutGridCellBase", "module": "src/components/layout-grid-cell/layout-grid-cell-base.ts" } }, { "name": "alignment", "type": { "text": "| 'top'\n | 'middle'\n | 'bottom'\n | 'stretch'\n | ''" }, "default": "''", "description": "Optional, specifies the alignment of cell", "fieldName": "alignment", "inheritedFrom": { "name": "LayoutGridCellBase", "module": "src/components/layout-grid-cell/layout-grid-cell-base.ts" } } ] } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "LayoutGridCell", "module": "src/components/layout-grid-cell/layout-grid-cell.ts" } }, { "kind": "custom-element-definition", "name": "bp-layout-grid-cell", "declaration": { "name": "LayoutGridCell", "module": "src/components/layout-grid-cell/layout-grid-cell.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/linear-progress/linear-progress-base.ts", "declarations": [ { "kind": "class", "description": "", "name": "LinearProgressBase", "members": [ { "kind": "field", "name": "indeterminate", "type": { "text": "boolean" }, "default": "false", "description": "Sets the linear-progress into its indeterminate state.", "attribute": "indeterminate" }, { "kind": "field", "name": "progress", "type": { "text": "number" }, "default": "0", "description": "Sets the primary progress bar's value. Value should be between [0, 1].", "attribute": "progress" }, { "kind": "field", "name": "buffer", "type": { "text": "number" }, "default": "1", "description": "Sets the buffer progress bar's value. Value should be between [0, 1]. Setting this value to be less than 1 will reveal moving, buffering dots.", "attribute": "buffer" }, { "kind": "field", "name": "reverse", "type": { "text": "boolean" }, "default": "false", "description": "Reverses the direction of the linear progress indicator.", "attribute": "reverse" }, { "kind": "field", "name": "closed", "type": { "text": "boolean" }, "default": "false", "description": "Sets the progress indicator to the closed state. Sets content opactiy to 0. Typically should be set to true when loading has finished.", "attribute": "closed" }, { "kind": "field", "name": "color", "type": { "text": "| 'primary'\n | 'secondary'\n | 'success'\n | 'warning'\n | 'error'\n | 'info'" }, "default": "'primary'", "description": "The color of the filled portion of the progress bar.", "attribute": "color" } ], "attributes": [ { "name": "indeterminate", "type": { "text": "boolean" }, "default": "false", "description": "Sets the linear-progress into its indeterminate state.", "fieldName": "indeterminate" }, { "name": "progress", "type": { "text": "number" }, "default": "0", "description": "Sets the primary progress bar's value. Value should be between [0, 1].", "fieldName": "progress" }, { "name": "buffer", "type": { "text": "number" }, "default": "1", "description": "Sets the buffer progress bar's value. Value should be between [0, 1]. Setting this value to be less than 1 will reveal moving, buffering dots.", "fieldName": "buffer" }, { "name": "reverse", "type": { "text": "boolean" }, "default": "false", "description": "Reverses the direction of the linear progress indicator.", "fieldName": "reverse" }, { "name": "closed", "type": { "text": "boolean" }, "default": "false", "description": "Sets the progress indicator to the closed state. Sets content opactiy to 0. Typically should be set to true when loading has finished.", "fieldName": "closed" }, { "name": "color", "type": { "text": "| 'primary'\n | 'secondary'\n | 'success'\n | 'warning'\n | 'error'\n | 'info'" }, "default": "'primary'", "description": "The color of the filled portion of the progress bar.", "fieldName": "color" } ], "superclass": { "name": "_LinearProgressBase", "package": "@material/mwc-linear-progress/mwc-linear-progress-base" } } ], "exports": [ { "kind": "js", "name": "LinearProgressBase", "declaration": { "name": "LinearProgressBase", "module": "src/components/linear-progress/linear-progress-base.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/linear-progress/linear-progress.ts", "declarations": [ { "kind": "class", "description": "", "name": "LinearProgress", "members": [ { "kind": "field", "name": "indeterminate", "type": { "text": "boolean" }, "default": "false", "description": "Sets the linear-progress into its indeterminate state.", "attribute": "indeterminate", "inheritedFrom": { "name": "LinearProgressBase", "module": "src/components/linear-progress/linear-progress-base.ts" } }, { "kind": "field", "name": "progress", "type": { "text": "number" }, "default": "0", "description": "Sets the primary progress bar's value. Value should be between [0, 1].", "attribute": "progress", "inheritedFrom": { "name": "LinearProgressBase", "module": "src/components/linear-progress/linear-progress-base.ts" } }, { "kind": "field", "name": "buffer", "type": { "text": "number" }, "default": "1", "description": "Sets the buffer progress bar's value. Value should be between [0, 1]. Setting this value to be less than 1 will reveal moving, buffering dots.", "attribute": "buffer", "inheritedFrom": { "name": "LinearProgressBase", "module": "src/components/linear-progress/linear-progress-base.ts" } }, { "kind": "field", "name": "reverse", "type": { "text": "boolean" }, "default": "false", "description": "Reverses the direction of the linear progress indicator.", "attribute": "reverse", "inheritedFrom": { "name": "LinearProgressBase", "module": "src/components/linear-progress/linear-progress-base.ts" } }, { "kind": "field", "name": "closed", "type": { "text": "boolean" }, "default": "false", "description": "Sets the progress indicator to the closed state. Sets content opactiy to 0. Typically should be set to true when loading has finished.", "attribute": "closed", "inheritedFrom": { "name": "LinearProgressBase", "module": "src/components/linear-progress/linear-progress-base.ts" } }, { "kind": "field", "name": "color", "type": { "text": "| 'primary'\n | 'secondary'\n | 'success'\n | 'warning'\n | 'error'\n | 'info'" }, "default": "'primary'", "description": "The color of the filled portion of the progress bar.", "attribute": "color", "inheritedFrom": { "name": "LinearProgressBase", "module": "src/components/linear-progress/linear-progress-base.ts" } } ], "superclass": { "name": "LinearProgressBase", "module": "/src/components/linear-progress/linear-progress-base.js" }, "since": "0.1.1-beta.1", "status": "beta", "tagName": "bp-linear-progress", "customElement": true, "attributes": [ { "name": "indeterminate", "type": { "text": "boolean" }, "default": "false", "description": "Sets the linear-progress into its indeterminate state.", "fieldName": "indeterminate", "inheritedFrom": { "name": "LinearProgressBase", "module": "src/components/linear-progress/linear-progress-base.ts" } }, { "name": "progress", "type": { "text": "number" }, "default": "0", "description": "Sets the primary progress bar's value. Value should be between [0, 1].", "fieldName": "progress", "inheritedFrom": { "name": "LinearProgressBase", "module": "src/components/linear-progress/linear-progress-base.ts" } }, { "name": "buffer", "type": { "text": "number" }, "default": "1", "description": "Sets the buffer progress bar's value. Value should be between [0, 1]. Setting this value to be less than 1 will reveal moving, buffering dots.", "fieldName": "buffer", "inheritedFrom": { "name": "LinearProgressBase", "module": "src/components/linear-progress/linear-progress-base.ts" } }, { "name": "reverse", "type": { "text": "boolean" }, "default": "false", "description": "Reverses the direction of the linear progress indicator.", "fieldName": "reverse", "inheritedFrom": { "name": "LinearProgressBase", "module": "src/components/linear-progress/linear-progress-base.ts" } }, { "name": "closed", "type": { "text": "boolean" }, "default": "false", "description": "Sets the progress indicator to the closed state. Sets content opactiy to 0. Typically should be set to true when loading has finished.", "fieldName": "closed", "inheritedFrom": { "name": "LinearProgressBase", "module": "src/components/linear-progress/linear-progress-base.ts" } }, { "name": "color", "type": { "text": "| 'primary'\n | 'secondary'\n | 'success'\n | 'warning'\n | 'error'\n | 'info'" }, "default": "'primary'", "description": "The color of the filled portion of the progress bar.", "fieldName": "color", "inheritedFrom": { "name": "LinearProgressBase", "module": "src/components/linear-progress/linear-progress-base.ts" } } ] } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "LinearProgress", "module": "src/components/linear-progress/linear-progress.ts" } }, { "kind": "custom-element-definition", "name": "bp-linear-progress", "declaration": { "name": "LinearProgress", "module": "src/components/linear-progress/linear-progress.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/link/link-base.ts", "declarations": [ { "kind": "class", "description": "", "name": "LinkBase", "members": [ { "kind": "field", "name": "href", "type": { "text": "string" }, "default": "''", "description": "The page to navigate to ((e.g. http://www.blackpurl.com)) it needs to be a full URL.", "attribute": "href" }, { "kind": "field", "name": "route", "type": { "text": "string" }, "default": "''", "description": "The page to navigate to (e.g. /blog/). Note: it needs to be a pathname, not a full URL.", "attribute": "route" }, { "kind": "field", "name": "_target", "type": { "text": "'_blank' | '_self' | '_parent' | '_top'" }, "default": "'_blank'", "description": "Specifies where to open the linked document (only works when href is used not route)", "attribute": "_target" }, { "kind": "field", "name": "underline", "type": { "text": "'none' | 'hover' | 'always'" }, "default": "'none'", "description": "Defines if and when the link should be underlined.", "attribute": "underline" }, { "kind": "method", "name": "emitRouteClickHandler", "privacy": "protected" }, { "kind": "field", "name": "renderHref", "privacy": "protected" }, { "kind": "field", "name": "renderRoute", "privacy": "protected" } ], "attributes": [ { "name": "href", "type": { "text": "string" }, "default": "''", "description": "The page to navigate to ((e.g. http://www.blackpurl.com)) it needs to be a full URL.", "fieldName": "href" }, { "name": "route", "type": { "text": "string" }, "default": "''", "description": "The page to navigate to (e.g. /blog/). Note: it needs to be a pathname, not a full URL.", "fieldName": "route" }, { "name": "_target", "type": { "text": "'_blank' | '_self' | '_parent' | '_top'" }, "default": "'_blank'", "description": "Specifies where to open the linked document (only works when href is used not route)", "fieldName": "_target" }, { "name": "underline", "type": { "text": "'none' | 'hover' | 'always'" }, "default": "'none'", "description": "Defines if and when the link should be underlined.", "fieldName": "underline" } ], "superclass": { "name": "LitElement", "package": "lit" }, "customElement": true } ], "exports": [ { "kind": "js", "name": "LinkBase", "declaration": { "name": "LinkBase", "module": "src/components/link/link-base.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/link/link.ts", "declarations": [ { "kind": "class", "description": "", "name": "Link", "slots": [ { "description": "The Link's content.", "name": "" } ], "members": [ { "kind": "field", "name": "href", "type": { "text": "string" }, "default": "''", "description": "The page to navigate to ((e.g. http://www.blackpurl.com)) it needs to be a full URL.", "attribute": "href", "inheritedFrom": { "name": "LinkBase", "module": "src/components/link/link-base.ts" } }, { "kind": "field", "name": "route", "type": { "text": "string" }, "default": "''", "description": "The page to navigate to (e.g. /blog/). Note: it needs to be a pathname, not a full URL.", "attribute": "route", "inheritedFrom": { "name": "LinkBase", "module": "src/components/link/link-base.ts" } }, { "kind": "field", "name": "_target", "type": { "text": "'_blank' | '_self' | '_parent' | '_top'" }, "default": "'_blank'", "description": "Specifies where to open the linked document (only works when href is used not route)", "attribute": "_target", "inheritedFrom": { "name": "LinkBase", "module": "src/components/link/link-base.ts" } }, { "kind": "field", "name": "underline", "type": { "text": "'none' | 'hover' | 'always'" }, "default": "'none'", "description": "Defines if and when the link should be underlined.", "attribute": "underline", "inheritedFrom": { "name": "LinkBase", "module": "src/components/link/link-base.ts" } }, { "kind": "method", "name": "emitRouteClickHandler", "privacy": "protected", "inheritedFrom": { "name": "LinkBase", "module": "src/components/link/link-base.ts" } }, { "kind": "field", "name": "renderHref", "privacy": "protected", "inheritedFrom": { "name": "LinkBase", "module": "src/components/link/link-base.ts" } }, { "kind": "field", "name": "renderRoute", "privacy": "protected", "inheritedFrom": { "name": "LinkBase", "module": "src/components/link/link-base.ts" } } ], "events": [ { "type": { "text": "{route:string}" }, "description": "Fires when a selection has been made via click or keyboard action.", "name": "bp-route-clicked", "reactName": "onBpRouteClicked" } ], "superclass": { "name": "LinkBase", "module": "/src/components/link/link-base.js" }, "since": "0.1.1-beta.1", "status": "beta", "tagName": "bp-link", "customElement": true, "attributes": [ { "name": "href", "type": { "text": "string" }, "default": "''", "description": "The page to navigate to ((e.g. http://www.blackpurl.com)) it needs to be a full URL.", "fieldName": "href", "inheritedFrom": { "name": "LinkBase", "module": "src/components/link/link-base.ts" } }, { "name": "route", "type": { "text": "string" }, "default": "''", "description": "The page to navigate to (e.g. /blog/). Note: it needs to be a pathname, not a full URL.", "fieldName": "route", "inheritedFrom": { "name": "LinkBase", "module": "src/components/link/link-base.ts" } }, { "name": "_target", "type": { "text": "'_blank' | '_self' | '_parent' | '_top'" }, "default": "'_blank'", "description": "Specifies where to open the linked document (only works when href is used not route)", "fieldName": "_target", "inheritedFrom": { "name": "LinkBase", "module": "src/components/link/link-base.ts" } }, { "name": "underline", "type": { "text": "'none' | 'hover' | 'always'" }, "default": "'none'", "description": "Defines if and when the link should be underlined.", "fieldName": "underline", "inheritedFrom": { "name": "LinkBase", "module": "src/components/link/link-base.ts" } } ] } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "Link", "module": "src/components/link/link.ts" } }, { "kind": "custom-element-definition", "name": "bp-link", "declaration": { "name": "Link", "module": "src/components/link/link.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/list/list-base.ts", "declarations": [ { "kind": "class", "description": "", "name": "ListBase", "members": [ { "kind": "field", "name": "color", "type": { "text": "| 'primary'\n | 'secondary'\n | 'success'\n | 'warning'\n | 'error'\n | 'info'" }, "default": "'primary'", "attribute": "color", "reflects": true }, { "kind": "field", "name": "formSubmitController", "type": { "text": "FormSubmitController" }, "default": "new FormSubmitController(this, {\n value: (control: ListBase) =>\n JSON.stringify(control.getActivatedItemValues()),\n defaultValue: (control: ListBase) => control.defaultValue,\n setValue: (control: ListBase) => {\n control.activateItemsByValues();\n return control.defaultValue;\n },\n })" }, { "kind": "field", "name": "activatable", "type": { "text": "boolean" }, "default": "false", "description": "Sets activated attribute on selected items which provides a focus-persistent highlight.", "attribute": "activatable" }, { "kind": "field", "name": "rootTabbable", "type": { "text": "boolean" }, "default": "false", "description": "When true, sets tabindex=\"0\" on the internal list. Otherwise sets tabindex=\"-1\".", "attribute": "rootTabbable" }, { "kind": "field", "name": "multi", "type": { "text": "boolean" }, "default": "false", "description": "When true, enables selection of multiple items. This will result in index being of type Set and selected returning ListItemBase[].", "attribute": "multi" }, { "kind": "field", "name": "wrapFocus", "type": { "text": "boolean" }, "default": "false", "description": "When true, pressing up on the keyboard when focused on the first item will focus the last item and down when focused on the last item will focus the first item.", "attribute": "wrapFocus" }, { "kind": "field", "name": "itemRoles", "type": { "text": "null | string" }, "default": "null", "description": "Determines what role attribute to set on all list items.", "attribute": "itemRoles" }, { "kind": "field", "name": "innerAriaLabel", "type": { "text": "null | string" }, "default": "null", "description": "ARIA label of the internal
    element.", "attribute": "innerAriaLabel" }, { "kind": "field", "name": "innerRole", "type": { "text": "null | string" }, "default": "null", "description": "Role of the internal
      element.", "attribute": "innerRole" }, { "kind": "field", "name": "noninteractive", "type": { "text": "boolean" }, "default": "false", "description": "When true, disables focus and pointer events (thus ripples) on the list. Used for display-only lists.", "attribute": "noninteractive" }, { "kind": "field", "name": "name", "type": { "text": "string" }, "default": "''", "description": "HTMLForm name.", "attribute": "name" }, { "kind": "field", "name": "value", "type": { "text": "string" }, "default": "''", "description": "Values of the selected list items in JSON format.", "attribute": "value" }, { "kind": "field", "name": "defaultValue", "type": { "text": "string" }, "default": "''" }, { "kind": "method", "name": "getActivatedItemValues", "return": { "type": { "text": "(string | null)[]" } } }, { "kind": "method", "name": "activateItemsByValues" }, { "kind": "method", "name": "setSelectionAttributes", "parameters": [ { "name": "idx", "type": { "text": "number" } } ] }, { "kind": "method", "name": "removeSelectionAttributes", "parameters": [ { "name": "idx", "type": { "text": "number" } } ] }, { "kind": "field", "name": "_selectedFiredForAction", "type": { "text": "boolean" }, "privacy": "private", "default": "false" }, { "kind": "field", "name": "_reselectThrottled", "type": { "text": "boolean" }, "privacy": "private", "default": "false" }, { "kind": "method", "name": "emitActionHandler", "parameters": [ { "name": "e", "type": { "text": "CustomEvent" } } ] }, { "kind": "method", "name": "emitSelectedHandler", "parameters": [ { "name": "e", "type": { "text": "CustomEvent" } } ] }, { "kind": "field", "name": "isTabIndexSet" }, { "kind": "method", "name": "updateItems" }, { "kind": "method", "name": "getIndexOfTarget", "parameters": [ { "name": "evt", "type": { "text": "CustomEvent" } } ] } ], "attributes": [ { "name": "color", "type": { "text": "| 'primary'\n | 'secondary'\n | 'success'\n | 'warning'\n | 'error'\n | 'info'" }, "default": "'primary'", "fieldName": "color" }, { "name": "activatable", "type": { "text": "boolean" }, "default": "false", "description": "Sets activated attribute on selected items which provides a focus-persistent highlight.", "fieldName": "activatable" }, { "name": "rootTabbable", "type": { "text": "boolean" }, "default": "false", "description": "When true, sets tabindex=\"0\" on the internal list. Otherwise sets tabindex=\"-1\".", "fieldName": "rootTabbable" }, { "name": "multi", "type": { "text": "boolean" }, "default": "false", "description": "When true, enables selection of multiple items. This will result in index being of type Set and selected returning ListItemBase[].", "fieldName": "multi" }, { "name": "wrapFocus", "type": { "text": "boolean" }, "default": "false", "description": "When true, pressing up on the keyboard when focused on the first item will focus the last item and down when focused on the last item will focus the first item.", "fieldName": "wrapFocus" }, { "name": "itemRoles", "type": { "text": "null | string" }, "default": "null", "description": "Determines what role attribute to set on all list items.", "fieldName": "itemRoles" }, { "name": "innerAriaLabel", "type": { "text": "null | string" }, "default": "null", "description": "ARIA label of the internal
        element.", "fieldName": "innerAriaLabel" }, { "name": "innerRole", "type": { "text": "null | string" }, "default": "null", "description": "Role of the internal
          element.", "fieldName": "innerRole" }, { "name": "noninteractive", "type": { "text": "boolean" }, "default": "false", "description": "When true, disables focus and pointer events (thus ripples) on the list. Used for display-only lists.", "fieldName": "noninteractive" }, { "name": "name", "type": { "text": "string" }, "default": "''", "description": "HTMLForm name.", "fieldName": "name" }, { "name": "value", "type": { "text": "string" }, "default": "''", "description": "Values of the selected list items in JSON format.", "fieldName": "value" } ], "superclass": { "name": "_ListBase", "package": "@material/mwc-list/mwc-list-base" } } ], "exports": [ { "kind": "js", "name": "ListBase", "declaration": { "name": "ListBase", "module": "src/components/list/list-base.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/list/list.ts", "declarations": [ { "kind": "class", "description": "", "name": "List", "members": [ { "kind": "field", "name": "color", "type": { "text": "| 'primary'\n | 'secondary'\n | 'success'\n | 'warning'\n | 'error'\n | 'info'" }, "default": "'primary'", "attribute": "color", "reflects": true, "inheritedFrom": { "name": "ListBase", "module": "src/components/list/list-base.ts" } }, { "kind": "field", "name": "formSubmitController", "type": { "text": "FormSubmitController" }, "default": "new FormSubmitController(this, {\n value: (control: ListBase) =>\n JSON.stringify(control.getActivatedItemValues()),\n defaultValue: (control: ListBase) => control.defaultValue,\n setValue: (control: ListBase) => {\n control.activateItemsByValues();\n return control.defaultValue;\n },\n })", "inheritedFrom": { "name": "ListBase", "module": "src/components/list/list-base.ts" } }, { "kind": "field", "name": "activatable", "type": { "text": "boolean" }, "default": "false", "description": "Sets activated attribute on selected items which provides a focus-persistent highlight.", "attribute": "activatable", "inheritedFrom": { "name": "ListBase", "module": "src/components/list/list-base.ts" } }, { "kind": "field", "name": "rootTabbable", "type": { "text": "boolean" }, "default": "false", "description": "When true, sets tabindex=\"0\" on the internal list. Otherwise sets tabindex=\"-1\".", "attribute": "rootTabbable", "inheritedFrom": { "name": "ListBase", "module": "src/components/list/list-base.ts" } }, { "kind": "field", "name": "multi", "type": { "text": "boolean" }, "default": "false", "description": "When true, enables selection of multiple items. This will result in index being of type Set and selected returning ListItemBase[].", "attribute": "multi", "inheritedFrom": { "name": "ListBase", "module": "src/components/list/list-base.ts" } }, { "kind": "field", "name": "wrapFocus", "type": { "text": "boolean" }, "default": "false", "description": "When true, pressing up on the keyboard when focused on the first item will focus the last item and down when focused on the last item will focus the first item.", "attribute": "wrapFocus", "inheritedFrom": { "name": "ListBase", "module": "src/components/list/list-base.ts" } }, { "kind": "field", "name": "itemRoles", "type": { "text": "null | string" }, "default": "null", "description": "Determines what role attribute to set on all list items.", "attribute": "itemRoles", "inheritedFrom": { "name": "ListBase", "module": "src/components/list/list-base.ts" } }, { "kind": "field", "name": "innerAriaLabel", "type": { "text": "null | string" }, "default": "null", "description": "ARIA label of the internal
            element.", "attribute": "innerAriaLabel", "inheritedFrom": { "name": "ListBase", "module": "src/components/list/list-base.ts" } }, { "kind": "field", "name": "innerRole", "type": { "text": "null | string" }, "default": "null", "description": "Role of the internal
              element.", "attribute": "innerRole", "inheritedFrom": { "name": "ListBase", "module": "src/components/list/list-base.ts" } }, { "kind": "field", "name": "noninteractive", "type": { "text": "boolean" }, "default": "false", "description": "When true, disables focus and pointer events (thus ripples) on the list. Used for display-only lists.", "attribute": "noninteractive", "inheritedFrom": { "name": "ListBase", "module": "src/components/list/list-base.ts" } }, { "kind": "field", "name": "name", "type": { "text": "string" }, "default": "''", "description": "HTMLForm name.", "attribute": "name", "inheritedFrom": { "name": "ListBase", "module": "src/components/list/list-base.ts" } }, { "kind": "field", "name": "value", "type": { "text": "string" }, "default": "''", "description": "Values of the selected list items in JSON format.", "attribute": "value", "inheritedFrom": { "name": "ListBase", "module": "src/components/list/list-base.ts" } }, { "kind": "field", "name": "defaultValue", "type": { "text": "string" }, "default": "''", "inheritedFrom": { "name": "ListBase", "module": "src/components/list/list-base.ts" } }, { "kind": "method", "name": "getActivatedItemValues", "return": { "type": { "text": "(string | null)[]" } }, "inheritedFrom": { "name": "ListBase", "module": "src/components/list/list-base.ts" } }, { "kind": "method", "name": "activateItemsByValues", "inheritedFrom": { "name": "ListBase", "module": "src/components/list/list-base.ts" } }, { "kind": "method", "name": "setSelectionAttributes", "parameters": [ { "name": "idx", "type": { "text": "number" } } ], "inheritedFrom": { "name": "ListBase", "module": "src/components/list/list-base.ts" } }, { "kind": "method", "name": "removeSelectionAttributes", "parameters": [ { "name": "idx", "type": { "text": "number" } } ], "inheritedFrom": { "name": "ListBase", "module": "src/components/list/list-base.ts" } }, { "kind": "field", "name": "_selectedFiredForAction", "type": { "text": "boolean" }, "privacy": "private", "default": "false", "inheritedFrom": { "name": "ListBase", "module": "src/components/list/list-base.ts" } }, { "kind": "field", "name": "_reselectThrottled", "type": { "text": "boolean" }, "privacy": "private", "default": "false", "inheritedFrom": { "name": "ListBase", "module": "src/components/list/list-base.ts" } }, { "kind": "method", "name": "emitActionHandler", "parameters": [ { "name": "e", "type": { "text": "CustomEvent" } } ], "inheritedFrom": { "name": "ListBase", "module": "src/components/list/list-base.ts" } }, { "kind": "method", "name": "emitSelectedHandler", "parameters": [ { "name": "e", "type": { "text": "CustomEvent" } } ], "inheritedFrom": { "name": "ListBase", "module": "src/components/list/list-base.ts" } }, { "kind": "field", "name": "isTabIndexSet", "inheritedFrom": { "name": "ListBase", "module": "src/components/list/list-base.ts" } }, { "kind": "method", "name": "updateItems", "inheritedFrom": { "name": "ListBase", "module": "src/components/list/list-base.ts" } }, { "kind": "method", "name": "getIndexOfTarget", "parameters": [ { "name": "evt", "type": { "text": "CustomEvent" } } ], "inheritedFrom": { "name": "ListBase", "module": "src/components/list/list-base.ts" } } ], "events": [ { "type": { "text": "{index:number}" }, "description": "Fired when a selection has been made via click or keyboard action.", "name": "bp-list-action", "reactName": "onBpListAction" }, { "type": { "text": "{index:number|Set, diff:undefined|{added:[index], removed:[index]}}" }, "description": "Fired when a selection has been made. `index` is the selected index (will be of type Set if multi and number if single-select), and diff (IndexDiff when multi and undefined when single-select) represents the diff of added and removed indexes from previous selection.", "name": "bp-list-selected", "reactName": "onBpListSelected" } ], "superclass": { "name": "ListBase", "module": "/src/components/list/list-base.js" }, "since": "0.1.1-beta.1", "status": "beta", "tagName": "bp-list", "customElement": true, "attributes": [ { "name": "color", "type": { "text": "| 'primary'\n | 'secondary'\n | 'success'\n | 'warning'\n | 'error'\n | 'info'" }, "default": "'primary'", "fieldName": "color", "inheritedFrom": { "name": "ListBase", "module": "src/components/list/list-base.ts" } }, { "name": "activatable", "type": { "text": "boolean" }, "default": "false", "description": "Sets activated attribute on selected items which provides a focus-persistent highlight.", "fieldName": "activatable", "inheritedFrom": { "name": "ListBase", "module": "src/components/list/list-base.ts" } }, { "name": "rootTabbable", "type": { "text": "boolean" }, "default": "false", "description": "When true, sets tabindex=\"0\" on the internal list. Otherwise sets tabindex=\"-1\".", "fieldName": "rootTabbable", "inheritedFrom": { "name": "ListBase", "module": "src/components/list/list-base.ts" } }, { "name": "multi", "type": { "text": "boolean" }, "default": "false", "description": "When true, enables selection of multiple items. This will result in index being of type Set and selected returning ListItemBase[].", "fieldName": "multi", "inheritedFrom": { "name": "ListBase", "module": "src/components/list/list-base.ts" } }, { "name": "wrapFocus", "type": { "text": "boolean" }, "default": "false", "description": "When true, pressing up on the keyboard when focused on the first item will focus the last item and down when focused on the last item will focus the first item.", "fieldName": "wrapFocus", "inheritedFrom": { "name": "ListBase", "module": "src/components/list/list-base.ts" } }, { "name": "itemRoles", "type": { "text": "null | string" }, "default": "null", "description": "Determines what role attribute to set on all list items.", "fieldName": "itemRoles", "inheritedFrom": { "name": "ListBase", "module": "src/components/list/list-base.ts" } }, { "name": "innerAriaLabel", "type": { "text": "null | string" }, "default": "null", "description": "ARIA label of the internal
                element.", "fieldName": "innerAriaLabel", "inheritedFrom": { "name": "ListBase", "module": "src/components/list/list-base.ts" } }, { "name": "innerRole", "type": { "text": "null | string" }, "default": "null", "description": "Role of the internal
                  element.", "fieldName": "innerRole", "inheritedFrom": { "name": "ListBase", "module": "src/components/list/list-base.ts" } }, { "name": "noninteractive", "type": { "text": "boolean" }, "default": "false", "description": "When true, disables focus and pointer events (thus ripples) on the list. Used for display-only lists.", "fieldName": "noninteractive", "inheritedFrom": { "name": "ListBase", "module": "src/components/list/list-base.ts" } }, { "name": "name", "type": { "text": "string" }, "default": "''", "description": "HTMLForm name.", "fieldName": "name", "inheritedFrom": { "name": "ListBase", "module": "src/components/list/list-base.ts" } }, { "name": "value", "type": { "text": "string" }, "default": "''", "description": "Values of the selected list items in JSON format.", "fieldName": "value", "inheritedFrom": { "name": "ListBase", "module": "src/components/list/list-base.ts" } } ] } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "List", "module": "src/components/list/list.ts" } }, { "kind": "custom-element-definition", "name": "bp-list", "declaration": { "name": "List", "module": "src/components/list/list.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/list-item/list-item-base.ts", "declarations": [ { "kind": "class", "description": "", "name": "ListItemBase", "members": [ { "kind": "field", "name": "color", "type": { "text": "string" }, "default": "'primary'", "attribute": "color" }, { "kind": "method", "name": "handleClick" }, { "kind": "method", "name": "handleFocus" }, { "kind": "method", "name": "handleBlur" }, { "kind": "field", "name": "value", "type": { "text": "string" }, "default": "''", "description": "Value associated with this list item (used by bp-select).", "attribute": "value" }, { "kind": "field", "name": "group", "type": { "text": "null | string" }, "default": "null", "description": "Used to group items together (used by bp-menu for menu selection groups and bp-radio-list-element).", "attribute": "group" }, { "kind": "field", "name": "tabindex", "type": { "text": "number" }, "default": "-1", "description": "Reflects tabindex and sets internal tab indices.", "attribute": "tabindex" }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Reflects disabled and sets internal disabled attributes.", "attribute": "disabled" }, { "kind": "field", "name": "twoline", "type": { "text": "boolean" }, "default": "false", "description": "Activates the two-line variant and enables the secondary slot.", "attribute": "twoline" }, { "kind": "field", "name": "threeline", "type": { "text": "boolean" }, "default": "false", "description": "Activates the three-line variant and enables the secondary and tertiary slots.", "attribute": "threeline" }, { "kind": "field", "name": "fourline", "type": { "text": "boolean" }, "default": "false", "description": "Activates the four-line variant and enables an additional slot.", "attribute": "fourline" }, { "kind": "field", "name": "activated", "type": { "text": "boolean" }, "default": "false", "description": "Activates focus-persistent ripple.", "attribute": "activated" }, { "kind": "field", "name": "graphic", "type": { "text": "| 'avatar'\n | 'icon'\n | 'medium'\n | 'large'\n | 'control'\n | null" }, "default": "null", "description": "Determines which graphic layout to show and enables the graphic slot.", "attribute": "graphic" }, { "kind": "field", "name": "multipleGraphics", "type": { "text": "boolean" }, "default": "false", "description": "Allows arbitrary width for multiple slotted graphics.", "attribute": "multipleGraphics" }, { "kind": "field", "name": "hasMeta", "type": { "text": "boolean" }, "default": "false", "description": "Activates the meta layout tile and enables the meta slot.", "attribute": "hasMeta" }, { "kind": "field", "name": "noninteractive", "type": { "text": "boolean" }, "default": "false", "description": "Disables focus and pointer events for the list item.", "attribute": "noninteractive" }, { "kind": "field", "name": "selected", "type": { "text": "boolean" }, "default": "false", "description": "Denotes that the list item is selected.", "attribute": "selected" }, { "kind": "field", "name": "left", "type": { "text": "boolean" }, "default": "false", "description": "Displays the checkbox/radio on the left. Overrides graphic", "attribute": "left" }, { "kind": "method", "name": "renderText" }, { "kind": "method", "name": "renderThreeline" }, { "kind": "method", "name": "renderFourline", "description": "New renderer for four lines" } ], "attributes": [ { "name": "color", "type": { "text": "string" }, "default": "'primary'", "fieldName": "color" }, { "name": "value", "type": { "text": "string" }, "default": "''", "description": "Value associated with this list item (used by bp-select).", "fieldName": "value" }, { "name": "group", "type": { "text": "null | string" }, "default": "null", "description": "Used to group items together (used by bp-menu for menu selection groups and bp-radio-list-element).", "fieldName": "group" }, { "name": "tabindex", "type": { "text": "number" }, "default": "-1", "description": "Reflects tabindex and sets internal tab indices.", "fieldName": "tabindex" }, { "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Reflects disabled and sets internal disabled attributes.", "fieldName": "disabled" }, { "name": "twoline", "type": { "text": "boolean" }, "default": "false", "description": "Activates the two-line variant and enables the secondary slot.", "fieldName": "twoline" }, { "name": "threeline", "type": { "text": "boolean" }, "default": "false", "description": "Activates the three-line variant and enables the secondary and tertiary slots.", "fieldName": "threeline" }, { "name": "fourline", "type": { "text": "boolean" }, "default": "false", "description": "Activates the four-line variant and enables an additional slot.", "fieldName": "fourline" }, { "name": "activated", "type": { "text": "boolean" }, "default": "false", "description": "Activates focus-persistent ripple.", "fieldName": "activated" }, { "name": "graphic", "type": { "text": "| 'avatar'\n | 'icon'\n | 'medium'\n | 'large'\n | 'control'\n | null" }, "default": "null", "description": "Determines which graphic layout to show and enables the graphic slot.", "fieldName": "graphic" }, { "name": "multipleGraphics", "type": { "text": "boolean" }, "default": "false", "description": "Allows arbitrary width for multiple slotted graphics.", "fieldName": "multipleGraphics" }, { "name": "hasMeta", "type": { "text": "boolean" }, "default": "false", "description": "Activates the meta layout tile and enables the meta slot.", "fieldName": "hasMeta" }, { "name": "noninteractive", "type": { "text": "boolean" }, "default": "false", "description": "Disables focus and pointer events for the list item.", "fieldName": "noninteractive" }, { "name": "selected", "type": { "text": "boolean" }, "default": "false", "description": "Denotes that the list item is selected.", "fieldName": "selected" }, { "name": "left", "type": { "text": "boolean" }, "default": "false", "description": "Displays the checkbox/radio on the left. Overrides graphic", "fieldName": "left" } ], "superclass": { "name": "_ListItemBase", "package": "@material/mwc-list/mwc-list-item-base" } } ], "exports": [ { "kind": "js", "name": "ListItemBase", "declaration": { "name": "ListItemBase", "module": "src/components/list-item/list-item-base.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/list-item/list-item-check-base.ts", "declarations": [ { "kind": "class", "description": "", "name": "CheckListItemBase", "superclass": { "name": "_CheckListItemBase", "package": "@material/mwc-list/mwc-check-list-item-base" } } ], "exports": [ { "kind": "js", "name": "CheckListItemBase", "declaration": { "name": "CheckListItemBase", "module": "src/components/list-item/list-item-check-base.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/list-item/list-item-check.ts", "declarations": [ { "kind": "class", "description": "", "name": "CheckListItem", "members": [], "superclass": { "name": "CheckListItemBase", "module": "/src/components/list-item/list-item-check-base.js" }, "tagName": "bp-list-item-check", "customElement": true } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "CheckListItem", "module": "src/components/list-item/list-item-check.ts" } }, { "kind": "custom-element-definition", "name": "bp-list-item-check", "declaration": { "name": "CheckListItem", "module": "src/components/list-item/list-item-check.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/list-item/list-item-radio-base.ts", "declarations": [ { "kind": "class", "description": "", "name": "RadioListItemBase", "superclass": { "name": "_RadioListItemBase", "package": "@material/mwc-list/mwc-radio-list-item-base" } } ], "exports": [ { "kind": "js", "name": "RadioListItemBase", "declaration": { "name": "RadioListItemBase", "module": "src/components/list-item/list-item-radio-base.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/list-item/list-item-radio.ts", "declarations": [ { "kind": "class", "description": "", "name": "RadioListItem", "members": [], "superclass": { "name": "RadioListItemBase", "module": "/src/components/list-item/list-item-radio-base.js" }, "tagName": "bp-list-item-radio", "customElement": true } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "RadioListItem", "module": "src/components/list-item/list-item-radio.ts" } }, { "kind": "custom-element-definition", "name": "bp-list-item-radio", "declaration": { "name": "RadioListItem", "module": "src/components/list-item/list-item-radio.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/list-item/list-item.ts", "declarations": [ { "kind": "class", "description": "", "name": "ListItem", "cssParts": [ { "description": "The component's internal wrapper.", "name": "base" }, { "description": "The prefix slot's container.", "name": "prefix" }, { "description": "The button's label.", "name": "label" }, { "description": "The suffix slot's container.", "name": "suffix" }, { "description": "The button's caret.", "name": "caret" } ], "slots": [ { "description": "Used for the secondary text line.", "name": "secondary" }, { "description": "Used to prepend an icon or similar element to the button.", "name": "graphic" }, { "description": "Used to append an icon or similar element to the button.", "name": "meta" } ], "members": [ { "kind": "field", "name": "color", "type": { "text": "string" }, "default": "'primary'", "attribute": "color", "inheritedFrom": { "name": "ListItemBase", "module": "src/components/list-item/list-item-base.ts" } }, { "kind": "method", "name": "handleClick", "inheritedFrom": { "name": "ListItemBase", "module": "src/components/list-item/list-item-base.ts" } }, { "kind": "method", "name": "handleFocus", "inheritedFrom": { "name": "ListItemBase", "module": "src/components/list-item/list-item-base.ts" } }, { "kind": "method", "name": "handleBlur", "inheritedFrom": { "name": "ListItemBase", "module": "src/components/list-item/list-item-base.ts" } }, { "kind": "field", "name": "value", "type": { "text": "string" }, "default": "''", "description": "Value associated with this list item (used by bp-select).", "attribute": "value", "inheritedFrom": { "name": "ListItemBase", "module": "src/components/list-item/list-item-base.ts" } }, { "kind": "field", "name": "group", "type": { "text": "null | string" }, "default": "null", "description": "Used to group items together (used by bp-menu for menu selection groups and bp-radio-list-element).", "attribute": "group", "inheritedFrom": { "name": "ListItemBase", "module": "src/components/list-item/list-item-base.ts" } }, { "kind": "field", "name": "tabindex", "type": { "text": "number" }, "default": "-1", "description": "Reflects tabindex and sets internal tab indices.", "attribute": "tabindex", "inheritedFrom": { "name": "ListItemBase", "module": "src/components/list-item/list-item-base.ts" } }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Reflects disabled and sets internal disabled attributes.", "attribute": "disabled", "inheritedFrom": { "name": "ListItemBase", "module": "src/components/list-item/list-item-base.ts" } }, { "kind": "field", "name": "twoline", "type": { "text": "boolean" }, "default": "false", "description": "Activates the two-line variant and enables the secondary slot.", "attribute": "twoline", "inheritedFrom": { "name": "ListItemBase", "module": "src/components/list-item/list-item-base.ts" } }, { "kind": "field", "name": "threeline", "type": { "text": "boolean" }, "default": "false", "description": "Activates the three-line variant and enables the secondary and tertiary slots.", "attribute": "threeline", "inheritedFrom": { "name": "ListItemBase", "module": "src/components/list-item/list-item-base.ts" } }, { "kind": "field", "name": "fourline", "type": { "text": "boolean" }, "default": "false", "description": "Activates the four-line variant and enables an additional slot.", "attribute": "fourline", "inheritedFrom": { "name": "ListItemBase", "module": "src/components/list-item/list-item-base.ts" } }, { "kind": "field", "name": "activated", "type": { "text": "boolean" }, "default": "false", "description": "Activates focus-persistent ripple.", "attribute": "activated", "inheritedFrom": { "name": "ListItemBase", "module": "src/components/list-item/list-item-base.ts" } }, { "kind": "field", "name": "graphic", "type": { "text": "| 'avatar'\n | 'icon'\n | 'medium'\n | 'large'\n | 'control'\n | null" }, "default": "null", "description": "Determines which graphic layout to show and enables the graphic slot.", "attribute": "graphic", "inheritedFrom": { "name": "ListItemBase", "module": "src/components/list-item/list-item-base.ts" } }, { "kind": "field", "name": "multipleGraphics", "type": { "text": "boolean" }, "default": "false", "description": "Allows arbitrary width for multiple slotted graphics.", "attribute": "multipleGraphics", "inheritedFrom": { "name": "ListItemBase", "module": "src/components/list-item/list-item-base.ts" } }, { "kind": "field", "name": "hasMeta", "type": { "text": "boolean" }, "default": "false", "description": "Activates the meta layout tile and enables the meta slot.", "attribute": "hasMeta", "inheritedFrom": { "name": "ListItemBase", "module": "src/components/list-item/list-item-base.ts" } }, { "kind": "field", "name": "noninteractive", "type": { "text": "boolean" }, "default": "false", "description": "Disables focus and pointer events for the list item.", "attribute": "noninteractive", "inheritedFrom": { "name": "ListItemBase", "module": "src/components/list-item/list-item-base.ts" } }, { "kind": "field", "name": "selected", "type": { "text": "boolean" }, "default": "false", "description": "Denotes that the list item is selected.", "attribute": "selected", "inheritedFrom": { "name": "ListItemBase", "module": "src/components/list-item/list-item-base.ts" } }, { "kind": "field", "name": "left", "type": { "text": "boolean" }, "default": "false", "description": "Displays the checkbox/radio on the left. Overrides graphic", "attribute": "left", "inheritedFrom": { "name": "ListItemBase", "module": "src/components/list-item/list-item-base.ts" } }, { "kind": "method", "name": "renderText", "inheritedFrom": { "name": "ListItemBase", "module": "src/components/list-item/list-item-base.ts" } }, { "kind": "method", "name": "renderThreeline", "inheritedFrom": { "name": "ListItemBase", "module": "src/components/list-item/list-item-base.ts" } }, { "kind": "method", "name": "renderFourline", "description": "New renderer for four lines", "inheritedFrom": { "name": "ListItemBase", "module": "src/components/list-item/list-item-base.ts" } } ], "superclass": { "name": "ListItemBase", "module": "/src/components/list-item/list-item-base.js" }, "since": "0.1.1-beta.1", "status": "beta", "tagName": "bp-list-item", "customElement": true, "attributes": [ { "name": "color", "type": { "text": "string" }, "default": "'primary'", "fieldName": "color", "inheritedFrom": { "name": "ListItemBase", "module": "src/components/list-item/list-item-base.ts" } }, { "name": "value", "type": { "text": "string" }, "default": "''", "description": "Value associated with this list item (used by bp-select).", "fieldName": "value", "inheritedFrom": { "name": "ListItemBase", "module": "src/components/list-item/list-item-base.ts" } }, { "name": "group", "type": { "text": "null | string" }, "default": "null", "description": "Used to group items together (used by bp-menu for menu selection groups and bp-radio-list-element).", "fieldName": "group", "inheritedFrom": { "name": "ListItemBase", "module": "src/components/list-item/list-item-base.ts" } }, { "name": "tabindex", "type": { "text": "number" }, "default": "-1", "description": "Reflects tabindex and sets internal tab indices.", "fieldName": "tabindex", "inheritedFrom": { "name": "ListItemBase", "module": "src/components/list-item/list-item-base.ts" } }, { "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Reflects disabled and sets internal disabled attributes.", "fieldName": "disabled", "inheritedFrom": { "name": "ListItemBase", "module": "src/components/list-item/list-item-base.ts" } }, { "name": "twoline", "type": { "text": "boolean" }, "default": "false", "description": "Activates the two-line variant and enables the secondary slot.", "fieldName": "twoline", "inheritedFrom": { "name": "ListItemBase", "module": "src/components/list-item/list-item-base.ts" } }, { "name": "threeline", "type": { "text": "boolean" }, "default": "false", "description": "Activates the three-line variant and enables the secondary and tertiary slots.", "fieldName": "threeline", "inheritedFrom": { "name": "ListItemBase", "module": "src/components/list-item/list-item-base.ts" } }, { "name": "fourline", "type": { "text": "boolean" }, "default": "false", "description": "Activates the four-line variant and enables an additional slot.", "fieldName": "fourline", "inheritedFrom": { "name": "ListItemBase", "module": "src/components/list-item/list-item-base.ts" } }, { "name": "activated", "type": { "text": "boolean" }, "default": "false", "description": "Activates focus-persistent ripple.", "fieldName": "activated", "inheritedFrom": { "name": "ListItemBase", "module": "src/components/list-item/list-item-base.ts" } }, { "name": "graphic", "type": { "text": "| 'avatar'\n | 'icon'\n | 'medium'\n | 'large'\n | 'control'\n | null" }, "default": "null", "description": "Determines which graphic layout to show and enables the graphic slot.", "fieldName": "graphic", "inheritedFrom": { "name": "ListItemBase", "module": "src/components/list-item/list-item-base.ts" } }, { "name": "multipleGraphics", "type": { "text": "boolean" }, "default": "false", "description": "Allows arbitrary width for multiple slotted graphics.", "fieldName": "multipleGraphics", "inheritedFrom": { "name": "ListItemBase", "module": "src/components/list-item/list-item-base.ts" } }, { "name": "hasMeta", "type": { "text": "boolean" }, "default": "false", "description": "Activates the meta layout tile and enables the meta slot.", "fieldName": "hasMeta", "inheritedFrom": { "name": "ListItemBase", "module": "src/components/list-item/list-item-base.ts" } }, { "name": "noninteractive", "type": { "text": "boolean" }, "default": "false", "description": "Disables focus and pointer events for the list item.", "fieldName": "noninteractive", "inheritedFrom": { "name": "ListItemBase", "module": "src/components/list-item/list-item-base.ts" } }, { "name": "selected", "type": { "text": "boolean" }, "default": "false", "description": "Denotes that the list item is selected.", "fieldName": "selected", "inheritedFrom": { "name": "ListItemBase", "module": "src/components/list-item/list-item-base.ts" } }, { "name": "left", "type": { "text": "boolean" }, "default": "false", "description": "Displays the checkbox/radio on the left. Overrides graphic", "fieldName": "left", "inheritedFrom": { "name": "ListItemBase", "module": "src/components/list-item/list-item-base.ts" } } ] } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "ListItem", "module": "src/components/list-item/list-item.ts" } }, { "kind": "custom-element-definition", "name": "bp-list-item", "declaration": { "name": "ListItem", "module": "src/components/list-item/list-item.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/list-multi-column/list-multi-column-base.ts", "declarations": [ { "kind": "class", "description": "", "name": "ListMultiColumnBase", "members": [ { "kind": "field", "name": "innerRole", "type": { "text": "null | string" }, "default": "null", "description": "Role of the internal
                    element.", "attribute": "innerRole", "inheritedFrom": { "name": "ListBase", "module": "src/components/list/list-base.ts" } }, { "kind": "field", "name": "columns", "type": { "text": "number" }, "default": "2", "description": "The amount of columns for the list.", "attribute": "columns" }, { "kind": "field", "name": "columnGap", "type": { "text": "string" }, "default": "'8px'", "description": "The gap between columns.", "attribute": "column-gap" }, { "kind": "field", "name": "focusFirstItem", "type": { "text": "boolean" }, "default": "false", "description": "Focuses the first item at the start if true.", "attribute": "focus-first-item" }, { "kind": "field", "name": "horizontal", "type": { "text": "boolean" }, "default": "false", "description": "Horizontal layout of the list.", "attribute": "horizontal" }, { "kind": "method", "name": "focusItem", "parameters": [ { "name": "index", "type": { "text": "number" } } ] }, { "kind": "method", "name": "onKeydown", "parameters": [ { "name": "evt", "type": { "text": "KeyboardEvent" } } ] }, { "kind": "field", "name": "color", "type": { "text": "| 'primary'\n | 'secondary'\n | 'success'\n | 'warning'\n | 'error'\n | 'info'" }, "default": "'primary'", "attribute": "color", "reflects": true, "inheritedFrom": { "name": "ListBase", "module": "src/components/list/list-base.ts" } }, { "kind": "field", "name": "formSubmitController", "type": { "text": "FormSubmitController" }, "default": "new FormSubmitController(this, {\n value: (control: ListBase) =>\n JSON.stringify(control.getActivatedItemValues()),\n defaultValue: (control: ListBase) => control.defaultValue,\n setValue: (control: ListBase) => {\n control.activateItemsByValues();\n return control.defaultValue;\n },\n })", "inheritedFrom": { "name": "ListBase", "module": "src/components/list/list-base.ts" } }, { "kind": "field", "name": "activatable", "type": { "text": "boolean" }, "default": "false", "description": "Sets activated attribute on selected items which provides a focus-persistent highlight.", "attribute": "activatable", "inheritedFrom": { "name": "ListBase", "module": "src/components/list/list-base.ts" } }, { "kind": "field", "name": "rootTabbable", "type": { "text": "boolean" }, "default": "false", "description": "When true, sets tabindex=\"0\" on the internal list. Otherwise sets tabindex=\"-1\".", "attribute": "rootTabbable", "inheritedFrom": { "name": "ListBase", "module": "src/components/list/list-base.ts" } }, { "kind": "field", "name": "multi", "type": { "text": "boolean" }, "default": "false", "description": "When true, enables selection of multiple items. This will result in index being of type Set and selected returning ListItemBase[].", "attribute": "multi", "inheritedFrom": { "name": "ListBase", "module": "src/components/list/list-base.ts" } }, { "kind": "field", "name": "wrapFocus", "type": { "text": "boolean" }, "default": "false", "description": "When true, pressing up on the keyboard when focused on the first item will focus the last item and down when focused on the last item will focus the first item.", "attribute": "wrapFocus", "inheritedFrom": { "name": "ListBase", "module": "src/components/list/list-base.ts" } }, { "kind": "field", "name": "itemRoles", "type": { "text": "null | string" }, "default": "null", "description": "Determines what role attribute to set on all list items.", "attribute": "itemRoles", "inheritedFrom": { "name": "ListBase", "module": "src/components/list/list-base.ts" } }, { "kind": "field", "name": "innerAriaLabel", "type": { "text": "null | string" }, "default": "null", "description": "ARIA label of the internal
                      element.", "attribute": "innerAriaLabel", "inheritedFrom": { "name": "ListBase", "module": "src/components/list/list-base.ts" } }, { "kind": "field", "name": "noninteractive", "type": { "text": "boolean" }, "default": "false", "description": "When true, disables focus and pointer events (thus ripples) on the list. Used for display-only lists.", "attribute": "noninteractive", "inheritedFrom": { "name": "ListBase", "module": "src/components/list/list-base.ts" } }, { "kind": "field", "name": "name", "type": { "text": "string" }, "default": "''", "description": "HTMLForm name.", "attribute": "name", "inheritedFrom": { "name": "ListBase", "module": "src/components/list/list-base.ts" } }, { "kind": "field", "name": "value", "type": { "text": "string" }, "default": "''", "description": "Values of the selected list items in JSON format.", "attribute": "value", "inheritedFrom": { "name": "ListBase", "module": "src/components/list/list-base.ts" } }, { "kind": "field", "name": "defaultValue", "type": { "text": "string" }, "default": "''", "inheritedFrom": { "name": "ListBase", "module": "src/components/list/list-base.ts" } }, { "kind": "method", "name": "getActivatedItemValues", "return": { "type": { "text": "(string | null)[]" } }, "inheritedFrom": { "name": "ListBase", "module": "src/components/list/list-base.ts" } }, { "kind": "method", "name": "activateItemsByValues", "inheritedFrom": { "name": "ListBase", "module": "src/components/list/list-base.ts" } }, { "kind": "method", "name": "setSelectionAttributes", "parameters": [ { "name": "idx", "type": { "text": "number" } } ], "inheritedFrom": { "name": "ListBase", "module": "src/components/list/list-base.ts" } }, { "kind": "method", "name": "removeSelectionAttributes", "parameters": [ { "name": "idx", "type": { "text": "number" } } ], "inheritedFrom": { "name": "ListBase", "module": "src/components/list/list-base.ts" } }, { "kind": "field", "name": "_selectedFiredForAction", "type": { "text": "boolean" }, "privacy": "private", "default": "false", "inheritedFrom": { "name": "ListBase", "module": "src/components/list/list-base.ts" } }, { "kind": "field", "name": "_reselectThrottled", "type": { "text": "boolean" }, "privacy": "private", "default": "false", "inheritedFrom": { "name": "ListBase", "module": "src/components/list/list-base.ts" } }, { "kind": "method", "name": "emitActionHandler", "parameters": [ { "name": "e", "type": { "text": "CustomEvent" } } ], "inheritedFrom": { "name": "ListBase", "module": "src/components/list/list-base.ts" } }, { "kind": "method", "name": "emitSelectedHandler", "parameters": [ { "name": "e", "type": { "text": "CustomEvent" } } ], "inheritedFrom": { "name": "ListBase", "module": "src/components/list/list-base.ts" } }, { "kind": "field", "name": "isTabIndexSet", "inheritedFrom": { "name": "ListBase", "module": "src/components/list/list-base.ts" } }, { "kind": "method", "name": "updateItems", "inheritedFrom": { "name": "ListBase", "module": "src/components/list/list-base.ts" } }, { "kind": "method", "name": "getIndexOfTarget", "parameters": [ { "name": "evt", "type": { "text": "CustomEvent" } } ], "inheritedFrom": { "name": "ListBase", "module": "src/components/list/list-base.ts" } } ], "attributes": [ { "name": "innerRole", "type": { "text": "null | string" }, "default": "null", "description": "Role of the internal
                        element.", "fieldName": "innerRole", "inheritedFrom": { "name": "ListBase", "module": "src/components/list/list-base.ts" } }, { "name": "columns", "type": { "text": "number" }, "default": "2", "description": "The amount of columns for the list.", "fieldName": "columns" }, { "name": "column-gap", "type": { "text": "string" }, "default": "'8px'", "description": "The gap between columns.", "fieldName": "columnGap" }, { "name": "focus-first-item", "type": { "text": "boolean" }, "default": "false", "description": "Focuses the first item at the start if true.", "fieldName": "focusFirstItem" }, { "name": "horizontal", "type": { "text": "boolean" }, "default": "false", "description": "Horizontal layout of the list.", "fieldName": "horizontal" }, { "name": "color", "type": { "text": "| 'primary'\n | 'secondary'\n | 'success'\n | 'warning'\n | 'error'\n | 'info'" }, "default": "'primary'", "fieldName": "color", "inheritedFrom": { "name": "ListBase", "module": "src/components/list/list-base.ts" } }, { "name": "activatable", "type": { "text": "boolean" }, "default": "false", "description": "Sets activated attribute on selected items which provides a focus-persistent highlight.", "fieldName": "activatable", "inheritedFrom": { "name": "ListBase", "module": "src/components/list/list-base.ts" } }, { "name": "rootTabbable", "type": { "text": "boolean" }, "default": "false", "description": "When true, sets tabindex=\"0\" on the internal list. Otherwise sets tabindex=\"-1\".", "fieldName": "rootTabbable", "inheritedFrom": { "name": "ListBase", "module": "src/components/list/list-base.ts" } }, { "name": "multi", "type": { "text": "boolean" }, "default": "false", "description": "When true, enables selection of multiple items. This will result in index being of type Set and selected returning ListItemBase[].", "fieldName": "multi", "inheritedFrom": { "name": "ListBase", "module": "src/components/list/list-base.ts" } }, { "name": "wrapFocus", "type": { "text": "boolean" }, "default": "false", "description": "When true, pressing up on the keyboard when focused on the first item will focus the last item and down when focused on the last item will focus the first item.", "fieldName": "wrapFocus", "inheritedFrom": { "name": "ListBase", "module": "src/components/list/list-base.ts" } }, { "name": "itemRoles", "type": { "text": "null | string" }, "default": "null", "description": "Determines what role attribute to set on all list items.", "fieldName": "itemRoles", "inheritedFrom": { "name": "ListBase", "module": "src/components/list/list-base.ts" } }, { "name": "innerAriaLabel", "type": { "text": "null | string" }, "default": "null", "description": "ARIA label of the internal
                          element.", "fieldName": "innerAriaLabel", "inheritedFrom": { "name": "ListBase", "module": "src/components/list/list-base.ts" } }, { "name": "noninteractive", "type": { "text": "boolean" }, "default": "false", "description": "When true, disables focus and pointer events (thus ripples) on the list. Used for display-only lists.", "fieldName": "noninteractive", "inheritedFrom": { "name": "ListBase", "module": "src/components/list/list-base.ts" } }, { "name": "name", "type": { "text": "string" }, "default": "''", "description": "HTMLForm name.", "fieldName": "name", "inheritedFrom": { "name": "ListBase", "module": "src/components/list/list-base.ts" } }, { "name": "value", "type": { "text": "string" }, "default": "''", "description": "Values of the selected list items in JSON format.", "fieldName": "value", "inheritedFrom": { "name": "ListBase", "module": "src/components/list/list-base.ts" } } ], "superclass": { "name": "List", "module": "/src/components/list/list" }, "events": [ { "type": { "text": "{index:number}" }, "description": "Fired when a selection has been made via click or keyboard action.", "name": "bp-list-action", "reactName": "onBpListAction", "inheritedFrom": { "name": "List", "module": "src/components/list/list.ts" } }, { "type": { "text": "{index:number|Set, diff:undefined|{added:[index], removed:[index]}}" }, "description": "Fired when a selection has been made. `index` is the selected index (will be of type Set if multi and number if single-select), and diff (IndexDiff when multi and undefined when single-select) represents the diff of added and removed indexes from previous selection.", "name": "bp-list-selected", "reactName": "onBpListSelected", "inheritedFrom": { "name": "List", "module": "src/components/list/list.ts" } } ] } ], "exports": [ { "kind": "js", "name": "ListMultiColumnBase", "declaration": { "name": "ListMultiColumnBase", "module": "src/components/list-multi-column/list-multi-column-base.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/list-multi-column/list-multi-column.ts", "declarations": [ { "kind": "class", "description": "", "name": "ListMultiColumn", "members": [ { "kind": "field", "name": "innerRole", "type": { "text": "null | string" }, "default": "null", "description": "Role of the internal
                            element.", "attribute": "innerRole", "inheritedFrom": { "name": "ListBase", "module": "src/components/list/list-base.ts" } }, { "kind": "field", "name": "columns", "type": { "text": "number" }, "default": "2", "description": "The amount of columns for the list.", "attribute": "columns", "inheritedFrom": { "name": "ListMultiColumnBase", "module": "src/components/list-multi-column/list-multi-column-base.ts" } }, { "kind": "field", "name": "columnGap", "type": { "text": "string" }, "default": "'8px'", "description": "The gap between columns.", "attribute": "column-gap", "inheritedFrom": { "name": "ListMultiColumnBase", "module": "src/components/list-multi-column/list-multi-column-base.ts" } }, { "kind": "field", "name": "focusFirstItem", "type": { "text": "boolean" }, "default": "false", "description": "Focuses the first item at the start if true.", "attribute": "focus-first-item", "inheritedFrom": { "name": "ListMultiColumnBase", "module": "src/components/list-multi-column/list-multi-column-base.ts" } }, { "kind": "field", "name": "horizontal", "type": { "text": "boolean" }, "default": "false", "description": "Horizontal layout of the list.", "attribute": "horizontal", "inheritedFrom": { "name": "ListMultiColumnBase", "module": "src/components/list-multi-column/list-multi-column-base.ts" } }, { "kind": "method", "name": "focusItem", "parameters": [ { "name": "index", "type": { "text": "number" } } ], "inheritedFrom": { "name": "ListMultiColumnBase", "module": "src/components/list-multi-column/list-multi-column-base.ts" } }, { "kind": "method", "name": "onKeydown", "parameters": [ { "name": "evt", "type": { "text": "KeyboardEvent" } } ], "inheritedFrom": { "name": "ListMultiColumnBase", "module": "src/components/list-multi-column/list-multi-column-base.ts" } }, { "kind": "field", "name": "color", "type": { "text": "| 'primary'\n | 'secondary'\n | 'success'\n | 'warning'\n | 'error'\n | 'info'" }, "default": "'primary'", "attribute": "color", "reflects": true, "inheritedFrom": { "name": "ListBase", "module": "src/components/list/list-base.ts" } }, { "kind": "field", "name": "formSubmitController", "type": { "text": "FormSubmitController" }, "default": "new FormSubmitController(this, {\n value: (control: ListBase) =>\n JSON.stringify(control.getActivatedItemValues()),\n defaultValue: (control: ListBase) => control.defaultValue,\n setValue: (control: ListBase) => {\n control.activateItemsByValues();\n return control.defaultValue;\n },\n })", "inheritedFrom": { "name": "ListBase", "module": "src/components/list/list-base.ts" } }, { "kind": "field", "name": "activatable", "type": { "text": "boolean" }, "default": "false", "description": "Sets activated attribute on selected items which provides a focus-persistent highlight.", "attribute": "activatable", "inheritedFrom": { "name": "ListBase", "module": "src/components/list/list-base.ts" } }, { "kind": "field", "name": "rootTabbable", "type": { "text": "boolean" }, "default": "false", "description": "When true, sets tabindex=\"0\" on the internal list. Otherwise sets tabindex=\"-1\".", "attribute": "rootTabbable", "inheritedFrom": { "name": "ListBase", "module": "src/components/list/list-base.ts" } }, { "kind": "field", "name": "multi", "type": { "text": "boolean" }, "default": "false", "description": "When true, enables selection of multiple items. This will result in index being of type Set and selected returning ListItemBase[].", "attribute": "multi", "inheritedFrom": { "name": "ListBase", "module": "src/components/list/list-base.ts" } }, { "kind": "field", "name": "wrapFocus", "type": { "text": "boolean" }, "default": "false", "description": "When true, pressing up on the keyboard when focused on the first item will focus the last item and down when focused on the last item will focus the first item.", "attribute": "wrapFocus", "inheritedFrom": { "name": "ListBase", "module": "src/components/list/list-base.ts" } }, { "kind": "field", "name": "itemRoles", "type": { "text": "null | string" }, "default": "null", "description": "Determines what role attribute to set on all list items.", "attribute": "itemRoles", "inheritedFrom": { "name": "ListBase", "module": "src/components/list/list-base.ts" } }, { "kind": "field", "name": "innerAriaLabel", "type": { "text": "null | string" }, "default": "null", "description": "ARIA label of the internal
                              element.", "attribute": "innerAriaLabel", "inheritedFrom": { "name": "ListBase", "module": "src/components/list/list-base.ts" } }, { "kind": "field", "name": "noninteractive", "type": { "text": "boolean" }, "default": "false", "description": "When true, disables focus and pointer events (thus ripples) on the list. Used for display-only lists.", "attribute": "noninteractive", "inheritedFrom": { "name": "ListBase", "module": "src/components/list/list-base.ts" } }, { "kind": "field", "name": "name", "type": { "text": "string" }, "default": "''", "description": "HTMLForm name.", "attribute": "name", "inheritedFrom": { "name": "ListBase", "module": "src/components/list/list-base.ts" } }, { "kind": "field", "name": "value", "type": { "text": "string" }, "default": "''", "description": "Values of the selected list items in JSON format.", "attribute": "value", "inheritedFrom": { "name": "ListBase", "module": "src/components/list/list-base.ts" } }, { "kind": "field", "name": "defaultValue", "type": { "text": "string" }, "default": "''", "inheritedFrom": { "name": "ListBase", "module": "src/components/list/list-base.ts" } }, { "kind": "method", "name": "getActivatedItemValues", "return": { "type": { "text": "(string | null)[]" } }, "inheritedFrom": { "name": "ListBase", "module": "src/components/list/list-base.ts" } }, { "kind": "method", "name": "activateItemsByValues", "inheritedFrom": { "name": "ListBase", "module": "src/components/list/list-base.ts" } }, { "kind": "method", "name": "setSelectionAttributes", "parameters": [ { "name": "idx", "type": { "text": "number" } } ], "inheritedFrom": { "name": "ListBase", "module": "src/components/list/list-base.ts" } }, { "kind": "method", "name": "removeSelectionAttributes", "parameters": [ { "name": "idx", "type": { "text": "number" } } ], "inheritedFrom": { "name": "ListBase", "module": "src/components/list/list-base.ts" } }, { "kind": "field", "name": "_selectedFiredForAction", "type": { "text": "boolean" }, "privacy": "private", "default": "false", "inheritedFrom": { "name": "ListBase", "module": "src/components/list/list-base.ts" } }, { "kind": "field", "name": "_reselectThrottled", "type": { "text": "boolean" }, "privacy": "private", "default": "false", "inheritedFrom": { "name": "ListBase", "module": "src/components/list/list-base.ts" } }, { "kind": "method", "name": "emitActionHandler", "parameters": [ { "name": "e", "type": { "text": "CustomEvent" } } ], "inheritedFrom": { "name": "ListBase", "module": "src/components/list/list-base.ts" } }, { "kind": "method", "name": "emitSelectedHandler", "parameters": [ { "name": "e", "type": { "text": "CustomEvent" } } ], "inheritedFrom": { "name": "ListBase", "module": "src/components/list/list-base.ts" } }, { "kind": "field", "name": "isTabIndexSet", "inheritedFrom": { "name": "ListBase", "module": "src/components/list/list-base.ts" } }, { "kind": "method", "name": "updateItems", "inheritedFrom": { "name": "ListBase", "module": "src/components/list/list-base.ts" } }, { "kind": "method", "name": "getIndexOfTarget", "parameters": [ { "name": "evt", "type": { "text": "CustomEvent" } } ], "inheritedFrom": { "name": "ListBase", "module": "src/components/list/list-base.ts" } } ], "superclass": { "name": "ListMultiColumnBase", "module": "/src/components/list-multi-column/list-multi-column-base.js" }, "since": "1.0", "status": "Experimental", "tagName": "bp-list-multi-column", "customElement": true, "attributes": [ { "name": "innerRole", "type": { "text": "null | string" }, "default": "null", "description": "Role of the internal
                                element.", "fieldName": "innerRole", "inheritedFrom": { "name": "ListBase", "module": "src/components/list/list-base.ts" } }, { "name": "columns", "type": { "text": "number" }, "default": "2", "description": "The amount of columns for the list.", "fieldName": "columns", "inheritedFrom": { "name": "ListMultiColumnBase", "module": "src/components/list-multi-column/list-multi-column-base.ts" } }, { "name": "column-gap", "type": { "text": "string" }, "default": "'8px'", "description": "The gap between columns.", "fieldName": "columnGap", "inheritedFrom": { "name": "ListMultiColumnBase", "module": "src/components/list-multi-column/list-multi-column-base.ts" } }, { "name": "focus-first-item", "type": { "text": "boolean" }, "default": "false", "description": "Focuses the first item at the start if true.", "fieldName": "focusFirstItem", "inheritedFrom": { "name": "ListMultiColumnBase", "module": "src/components/list-multi-column/list-multi-column-base.ts" } }, { "name": "horizontal", "type": { "text": "boolean" }, "default": "false", "description": "Horizontal layout of the list.", "fieldName": "horizontal", "inheritedFrom": { "name": "ListMultiColumnBase", "module": "src/components/list-multi-column/list-multi-column-base.ts" } }, { "name": "color", "type": { "text": "| 'primary'\n | 'secondary'\n | 'success'\n | 'warning'\n | 'error'\n | 'info'" }, "default": "'primary'", "fieldName": "color", "inheritedFrom": { "name": "ListBase", "module": "src/components/list/list-base.ts" } }, { "name": "activatable", "type": { "text": "boolean" }, "default": "false", "description": "Sets activated attribute on selected items which provides a focus-persistent highlight.", "fieldName": "activatable", "inheritedFrom": { "name": "ListBase", "module": "src/components/list/list-base.ts" } }, { "name": "rootTabbable", "type": { "text": "boolean" }, "default": "false", "description": "When true, sets tabindex=\"0\" on the internal list. Otherwise sets tabindex=\"-1\".", "fieldName": "rootTabbable", "inheritedFrom": { "name": "ListBase", "module": "src/components/list/list-base.ts" } }, { "name": "multi", "type": { "text": "boolean" }, "default": "false", "description": "When true, enables selection of multiple items. This will result in index being of type Set and selected returning ListItemBase[].", "fieldName": "multi", "inheritedFrom": { "name": "ListBase", "module": "src/components/list/list-base.ts" } }, { "name": "wrapFocus", "type": { "text": "boolean" }, "default": "false", "description": "When true, pressing up on the keyboard when focused on the first item will focus the last item and down when focused on the last item will focus the first item.", "fieldName": "wrapFocus", "inheritedFrom": { "name": "ListBase", "module": "src/components/list/list-base.ts" } }, { "name": "itemRoles", "type": { "text": "null | string" }, "default": "null", "description": "Determines what role attribute to set on all list items.", "fieldName": "itemRoles", "inheritedFrom": { "name": "ListBase", "module": "src/components/list/list-base.ts" } }, { "name": "innerAriaLabel", "type": { "text": "null | string" }, "default": "null", "description": "ARIA label of the internal
                                  element.", "fieldName": "innerAriaLabel", "inheritedFrom": { "name": "ListBase", "module": "src/components/list/list-base.ts" } }, { "name": "noninteractive", "type": { "text": "boolean" }, "default": "false", "description": "When true, disables focus and pointer events (thus ripples) on the list. Used for display-only lists.", "fieldName": "noninteractive", "inheritedFrom": { "name": "ListBase", "module": "src/components/list/list-base.ts" } }, { "name": "name", "type": { "text": "string" }, "default": "''", "description": "HTMLForm name.", "fieldName": "name", "inheritedFrom": { "name": "ListBase", "module": "src/components/list/list-base.ts" } }, { "name": "value", "type": { "text": "string" }, "default": "''", "description": "Values of the selected list items in JSON format.", "fieldName": "value", "inheritedFrom": { "name": "ListBase", "module": "src/components/list/list-base.ts" } } ], "events": [ { "type": { "text": "{index:number}" }, "description": "Fired when a selection has been made via click or keyboard action.", "name": "bp-list-action", "reactName": "onBpListAction", "inheritedFrom": { "name": "List", "module": "src/components/list/list.ts" } }, { "type": { "text": "{index:number|Set, diff:undefined|{added:[index], removed:[index]}}" }, "description": "Fired when a selection has been made. `index` is the selected index (will be of type Set if multi and number if single-select), and diff (IndexDiff when multi and undefined when single-select) represents the diff of added and removed indexes from previous selection.", "name": "bp-list-selected", "reactName": "onBpListSelected", "inheritedFrom": { "name": "List", "module": "src/components/list/list.ts" } } ] } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "ListMultiColumn", "module": "src/components/list-multi-column/list-multi-column.ts" } }, { "kind": "custom-element-definition", "name": "bp-list-multi-column", "declaration": { "name": "ListMultiColumn", "module": "src/components/list-multi-column/list-multi-column.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/menu/menu-base.ts", "declarations": [ { "kind": "class", "description": "", "name": "MenuBase", "members": [ { "kind": "field", "name": "open", "type": { "text": "boolean" }, "default": "false", "description": "Whether the menu should open and display.", "attribute": "open" }, { "kind": "field", "name": "anchorId", "type": { "text": "string" }, "default": "''", "description": "Determines from which element the floating menu should calculate sizing and position offsets. In the default case, both menu and the anchor should share a parent with position:relative. Changing anchor typically requires absolute or fixed.", "attribute": "anchor-id" }, { "kind": "field", "name": "corner", "type": { "text": "Corner" }, "default": "'TOP_START'", "description": "Corner of the anchor from which the menu should position itself.", "attribute": "corner" }, { "kind": "field", "name": "menuCorner", "type": { "text": "MenuCorner" }, "default": "'START'", "description": "Horizontal corner of the menu from which the menu should position itself. NOTE: Only horizontal corners are supported.", "attribute": "menuCorner" }, { "kind": "field", "name": "quick", "type": { "text": "boolean" }, "default": "false", "description": "Whether to skip the opening animation.", "attribute": "quick" }, { "kind": "field", "name": "absolute", "type": { "text": "boolean" }, "default": "false", "description": "Makes the menu's position absolute which will be relative to whichever ancestor has position:relative. Setting x and y will modify the menu's left and top. Setting anchor will attempt to position the menu to the anchor.", "attribute": "absolute" }, { "kind": "field", "name": "fixed", "type": { "text": "boolean" }, "default": "false", "description": "Makes the menu's position fixed which will be relative to the window. Setting x and y will modify the menu's left and top. Setting anchor will attempt to position the menu to the anchor's immediate position before opening.", "attribute": "fixed" }, { "kind": "field", "name": "x", "type": { "text": "number | null" }, "default": "null", "description": "Sets horizontal position when absolute. When given an anchor, sets horizontal position relative to anchor at given corner. Requires y not to be null.", "attribute": "x" }, { "kind": "field", "name": "y", "type": { "text": "number | null" }, "default": "null", "description": "Sets vertical position when absolute. When given an anchor, sets vertical position relative to anchor at given corner. Requires x not to be null.", "attribute": "y" }, { "kind": "field", "name": "forceGroupSelection", "type": { "text": "boolean" }, "default": "false", "description": "Forces a menu group to have a selected item by preventing deselection of menu items in menu groups via user interaction.", "attribute": "forceGroupSelection" }, { "kind": "field", "name": "defaultFocus", "type": { "text": "DefaultFocusState" }, "default": "'LIST_ROOT'", "description": "Item to focus upon menu open.", "attribute": "defaultFocus" }, { "kind": "field", "name": "fullwidth", "type": { "text": "boolean" }, "default": "false", "description": "Sets surface width to 100%.", "attribute": "fullwidth" }, { "kind": "field", "name": "stayOpenOnBodyClick", "type": { "text": "boolean" }, "default": "false", "description": "Prevents the menu from closing when clicking outside the menu.", "attribute": "stayOpenOnBodyClick" }, { "kind": "field", "name": "wrapFocus", "type": { "text": "boolean" }, "default": "false", "description": "Proxies to bp-list's wrapFocus property.", "attribute": "wrapFocus" }, { "kind": "field", "name": "innerAriaLabel", "type": { "text": "null | string" }, "default": "null", "description": "Proxies to bp-list's innerAriaLabel property.", "attribute": "innerAriaLabel" }, { "kind": "field", "name": "innerRole", "type": { "text": "'menu' | 'listbox'" }, "default": "'menu'", "description": "Proxies to bp-list's innerRole property.", "attribute": "innerRole" }, { "kind": "field", "name": "multi", "type": { "text": "boolean" }, "default": "false", "description": "Proxies to bp-list's multi property.", "attribute": "multi" }, { "kind": "field", "name": "activatable", "type": { "text": "boolean" }, "default": "false", "description": "Proxies to bp-list's activatable property.", "attribute": "activatable" }, { "kind": "method", "name": "emitActionHandler", "parameters": [ { "name": "e", "type": { "text": "CustomEvent" } } ] }, { "kind": "method", "name": "emitSelectedHandler", "parameters": [ { "name": "e", "type": { "text": "CustomEvent" } } ] }, { "kind": "field", "name": "isTabIndexSet" } ], "attributes": [ { "name": "open", "type": { "text": "boolean" }, "default": "false", "description": "Whether the menu should open and display.", "fieldName": "open" }, { "name": "anchor-id", "type": { "text": "string" }, "default": "''", "description": "Determines from which element the floating menu should calculate sizing and position offsets. In the default case, both menu and the anchor should share a parent with position:relative. Changing anchor typically requires absolute or fixed.", "fieldName": "anchorId" }, { "name": "corner", "type": { "text": "Corner" }, "default": "'TOP_START'", "description": "Corner of the anchor from which the menu should position itself.", "fieldName": "corner" }, { "name": "menuCorner", "type": { "text": "MenuCorner" }, "default": "'START'", "description": "Horizontal corner of the menu from which the menu should position itself. NOTE: Only horizontal corners are supported.", "fieldName": "menuCorner" }, { "name": "quick", "type": { "text": "boolean" }, "default": "false", "description": "Whether to skip the opening animation.", "fieldName": "quick" }, { "name": "absolute", "type": { "text": "boolean" }, "default": "false", "description": "Makes the menu's position absolute which will be relative to whichever ancestor has position:relative. Setting x and y will modify the menu's left and top. Setting anchor will attempt to position the menu to the anchor.", "fieldName": "absolute" }, { "name": "fixed", "type": { "text": "boolean" }, "default": "false", "description": "Makes the menu's position fixed which will be relative to the window. Setting x and y will modify the menu's left and top. Setting anchor will attempt to position the menu to the anchor's immediate position before opening.", "fieldName": "fixed" }, { "name": "x", "type": { "text": "number | null" }, "default": "null", "description": "Sets horizontal position when absolute. When given an anchor, sets horizontal position relative to anchor at given corner. Requires y not to be null.", "fieldName": "x" }, { "name": "y", "type": { "text": "number | null" }, "default": "null", "description": "Sets vertical position when absolute. When given an anchor, sets vertical position relative to anchor at given corner. Requires x not to be null.", "fieldName": "y" }, { "name": "forceGroupSelection", "type": { "text": "boolean" }, "default": "false", "description": "Forces a menu group to have a selected item by preventing deselection of menu items in menu groups via user interaction.", "fieldName": "forceGroupSelection" }, { "name": "defaultFocus", "type": { "text": "DefaultFocusState" }, "default": "'LIST_ROOT'", "description": "Item to focus upon menu open.", "fieldName": "defaultFocus" }, { "name": "fullwidth", "type": { "text": "boolean" }, "default": "false", "description": "Sets surface width to 100%.", "fieldName": "fullwidth" }, { "name": "stayOpenOnBodyClick", "type": { "text": "boolean" }, "default": "false", "description": "Prevents the menu from closing when clicking outside the menu.", "fieldName": "stayOpenOnBodyClick" }, { "name": "wrapFocus", "type": { "text": "boolean" }, "default": "false", "description": "Proxies to bp-list's wrapFocus property.", "fieldName": "wrapFocus" }, { "name": "innerAriaLabel", "type": { "text": "null | string" }, "default": "null", "description": "Proxies to bp-list's innerAriaLabel property.", "fieldName": "innerAriaLabel" }, { "name": "innerRole", "type": { "text": "'menu' | 'listbox'" }, "default": "'menu'", "description": "Proxies to bp-list's innerRole property.", "fieldName": "innerRole" }, { "name": "multi", "type": { "text": "boolean" }, "default": "false", "description": "Proxies to bp-list's multi property.", "fieldName": "multi" }, { "name": "activatable", "type": { "text": "boolean" }, "default": "false", "description": "Proxies to bp-list's activatable property.", "fieldName": "activatable" } ], "superclass": { "name": "_MenuBase", "package": "@material/mwc-menu/mwc-menu-base" } } ], "exports": [ { "kind": "js", "name": "MenuBase", "declaration": { "name": "MenuBase", "module": "src/components/menu/menu-base.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/menu/menu.ts", "declarations": [ { "kind": "class", "description": "", "name": "Menu", "slots": [ { "description": "The Menu's list item content.", "name": "" } ], "members": [ { "kind": "field", "name": "open", "type": { "text": "boolean" }, "default": "false", "description": "Whether the menu should open and display.", "attribute": "open", "inheritedFrom": { "name": "MenuBase", "module": "src/components/menu/menu-base.ts" } }, { "kind": "field", "name": "anchorId", "type": { "text": "string" }, "default": "''", "description": "Determines from which element the floating menu should calculate sizing and position offsets. In the default case, both menu and the anchor should share a parent with position:relative. Changing anchor typically requires absolute or fixed.", "attribute": "anchor-id", "inheritedFrom": { "name": "MenuBase", "module": "src/components/menu/menu-base.ts" } }, { "kind": "field", "name": "corner", "type": { "text": "Corner" }, "default": "'TOP_START'", "description": "Corner of the anchor from which the menu should position itself.", "attribute": "corner", "inheritedFrom": { "name": "MenuBase", "module": "src/components/menu/menu-base.ts" } }, { "kind": "field", "name": "menuCorner", "type": { "text": "MenuCorner" }, "default": "'START'", "description": "Horizontal corner of the menu from which the menu should position itself. NOTE: Only horizontal corners are supported.", "attribute": "menuCorner", "inheritedFrom": { "name": "MenuBase", "module": "src/components/menu/menu-base.ts" } }, { "kind": "field", "name": "quick", "type": { "text": "boolean" }, "default": "false", "description": "Whether to skip the opening animation.", "attribute": "quick", "inheritedFrom": { "name": "MenuBase", "module": "src/components/menu/menu-base.ts" } }, { "kind": "field", "name": "absolute", "type": { "text": "boolean" }, "default": "false", "description": "Makes the menu's position absolute which will be relative to whichever ancestor has position:relative. Setting x and y will modify the menu's left and top. Setting anchor will attempt to position the menu to the anchor.", "attribute": "absolute", "inheritedFrom": { "name": "MenuBase", "module": "src/components/menu/menu-base.ts" } }, { "kind": "field", "name": "fixed", "type": { "text": "boolean" }, "default": "false", "description": "Makes the menu's position fixed which will be relative to the window. Setting x and y will modify the menu's left and top. Setting anchor will attempt to position the menu to the anchor's immediate position before opening.", "attribute": "fixed", "inheritedFrom": { "name": "MenuBase", "module": "src/components/menu/menu-base.ts" } }, { "kind": "field", "name": "x", "type": { "text": "number | null" }, "default": "null", "description": "Sets horizontal position when absolute. When given an anchor, sets horizontal position relative to anchor at given corner. Requires y not to be null.", "attribute": "x", "inheritedFrom": { "name": "MenuBase", "module": "src/components/menu/menu-base.ts" } }, { "kind": "field", "name": "y", "type": { "text": "number | null" }, "default": "null", "description": "Sets vertical position when absolute. When given an anchor, sets vertical position relative to anchor at given corner. Requires x not to be null.", "attribute": "y", "inheritedFrom": { "name": "MenuBase", "module": "src/components/menu/menu-base.ts" } }, { "kind": "field", "name": "forceGroupSelection", "type": { "text": "boolean" }, "default": "false", "description": "Forces a menu group to have a selected item by preventing deselection of menu items in menu groups via user interaction.", "attribute": "forceGroupSelection", "inheritedFrom": { "name": "MenuBase", "module": "src/components/menu/menu-base.ts" } }, { "kind": "field", "name": "defaultFocus", "type": { "text": "DefaultFocusState" }, "default": "'LIST_ROOT'", "description": "Item to focus upon menu open.", "attribute": "defaultFocus", "inheritedFrom": { "name": "MenuBase", "module": "src/components/menu/menu-base.ts" } }, { "kind": "field", "name": "fullwidth", "type": { "text": "boolean" }, "default": "false", "description": "Sets surface width to 100%.", "attribute": "fullwidth", "inheritedFrom": { "name": "MenuBase", "module": "src/components/menu/menu-base.ts" } }, { "kind": "field", "name": "stayOpenOnBodyClick", "type": { "text": "boolean" }, "default": "false", "description": "Prevents the menu from closing when clicking outside the menu.", "attribute": "stayOpenOnBodyClick", "inheritedFrom": { "name": "MenuBase", "module": "src/components/menu/menu-base.ts" } }, { "kind": "field", "name": "wrapFocus", "type": { "text": "boolean" }, "default": "false", "description": "Proxies to bp-list's wrapFocus property.", "attribute": "wrapFocus", "inheritedFrom": { "name": "MenuBase", "module": "src/components/menu/menu-base.ts" } }, { "kind": "field", "name": "innerAriaLabel", "type": { "text": "null | string" }, "default": "null", "description": "Proxies to bp-list's innerAriaLabel property.", "attribute": "innerAriaLabel", "inheritedFrom": { "name": "MenuBase", "module": "src/components/menu/menu-base.ts" } }, { "kind": "field", "name": "innerRole", "type": { "text": "'menu' | 'listbox'" }, "default": "'menu'", "description": "Proxies to bp-list's innerRole property.", "attribute": "innerRole", "inheritedFrom": { "name": "MenuBase", "module": "src/components/menu/menu-base.ts" } }, { "kind": "field", "name": "multi", "type": { "text": "boolean" }, "default": "false", "description": "Proxies to bp-list's multi property.", "attribute": "multi", "inheritedFrom": { "name": "MenuBase", "module": "src/components/menu/menu-base.ts" } }, { "kind": "field", "name": "activatable", "type": { "text": "boolean" }, "default": "false", "description": "Proxies to bp-list's activatable property.", "attribute": "activatable", "inheritedFrom": { "name": "MenuBase", "module": "src/components/menu/menu-base.ts" } }, { "kind": "method", "name": "emitActionHandler", "parameters": [ { "name": "e", "type": { "text": "CustomEvent" } } ], "inheritedFrom": { "name": "MenuBase", "module": "src/components/menu/menu-base.ts" } }, { "kind": "method", "name": "emitSelectedHandler", "parameters": [ { "name": "e", "type": { "text": "CustomEvent" } } ], "inheritedFrom": { "name": "MenuBase", "module": "src/components/menu/menu-base.ts" } }, { "kind": "field", "name": "isTabIndexSet", "inheritedFrom": { "name": "MenuBase", "module": "src/components/menu/menu-base.ts" } } ], "events": [ { "type": { "text": "{index:number}" }, "description": "Fires when a selection has been made via click or keyboard action.", "name": "bp-menu-action", "reactName": "onBpMenuAction" }, { "type": { "text": "{index:number|Set, diff:{added:[index], removed:[index]}}" }, "description": "Fires when a selection has been made. index is the selected index (will be of type Set if multi and number if single), and diff (of type IndexDiff**) represents the diff of added and removed indices from previous selection and will be defined only if multi is true.", "name": "bp-menu-selected", "reactName": "onBpMenuSelected" } ], "superclass": { "name": "MenuBase", "module": "/src/components/menu/menu-base.js" }, "since": "0.1.1-beta.1", "status": "beta", "tagName": "bp-menu", "customElement": true, "attributes": [ { "name": "open", "type": { "text": "boolean" }, "default": "false", "description": "Whether the menu should open and display.", "fieldName": "open", "inheritedFrom": { "name": "MenuBase", "module": "src/components/menu/menu-base.ts" } }, { "name": "anchor-id", "type": { "text": "string" }, "default": "''", "description": "Determines from which element the floating menu should calculate sizing and position offsets. In the default case, both menu and the anchor should share a parent with position:relative. Changing anchor typically requires absolute or fixed.", "fieldName": "anchorId", "inheritedFrom": { "name": "MenuBase", "module": "src/components/menu/menu-base.ts" } }, { "name": "corner", "type": { "text": "Corner" }, "default": "'TOP_START'", "description": "Corner of the anchor from which the menu should position itself.", "fieldName": "corner", "inheritedFrom": { "name": "MenuBase", "module": "src/components/menu/menu-base.ts" } }, { "name": "menuCorner", "type": { "text": "MenuCorner" }, "default": "'START'", "description": "Horizontal corner of the menu from which the menu should position itself. NOTE: Only horizontal corners are supported.", "fieldName": "menuCorner", "inheritedFrom": { "name": "MenuBase", "module": "src/components/menu/menu-base.ts" } }, { "name": "quick", "type": { "text": "boolean" }, "default": "false", "description": "Whether to skip the opening animation.", "fieldName": "quick", "inheritedFrom": { "name": "MenuBase", "module": "src/components/menu/menu-base.ts" } }, { "name": "absolute", "type": { "text": "boolean" }, "default": "false", "description": "Makes the menu's position absolute which will be relative to whichever ancestor has position:relative. Setting x and y will modify the menu's left and top. Setting anchor will attempt to position the menu to the anchor.", "fieldName": "absolute", "inheritedFrom": { "name": "MenuBase", "module": "src/components/menu/menu-base.ts" } }, { "name": "fixed", "type": { "text": "boolean" }, "default": "false", "description": "Makes the menu's position fixed which will be relative to the window. Setting x and y will modify the menu's left and top. Setting anchor will attempt to position the menu to the anchor's immediate position before opening.", "fieldName": "fixed", "inheritedFrom": { "name": "MenuBase", "module": "src/components/menu/menu-base.ts" } }, { "name": "x", "type": { "text": "number | null" }, "default": "null", "description": "Sets horizontal position when absolute. When given an anchor, sets horizontal position relative to anchor at given corner. Requires y not to be null.", "fieldName": "x", "inheritedFrom": { "name": "MenuBase", "module": "src/components/menu/menu-base.ts" } }, { "name": "y", "type": { "text": "number | null" }, "default": "null", "description": "Sets vertical position when absolute. When given an anchor, sets vertical position relative to anchor at given corner. Requires x not to be null.", "fieldName": "y", "inheritedFrom": { "name": "MenuBase", "module": "src/components/menu/menu-base.ts" } }, { "name": "forceGroupSelection", "type": { "text": "boolean" }, "default": "false", "description": "Forces a menu group to have a selected item by preventing deselection of menu items in menu groups via user interaction.", "fieldName": "forceGroupSelection", "inheritedFrom": { "name": "MenuBase", "module": "src/components/menu/menu-base.ts" } }, { "name": "defaultFocus", "type": { "text": "DefaultFocusState" }, "default": "'LIST_ROOT'", "description": "Item to focus upon menu open.", "fieldName": "defaultFocus", "inheritedFrom": { "name": "MenuBase", "module": "src/components/menu/menu-base.ts" } }, { "name": "fullwidth", "type": { "text": "boolean" }, "default": "false", "description": "Sets surface width to 100%.", "fieldName": "fullwidth", "inheritedFrom": { "name": "MenuBase", "module": "src/components/menu/menu-base.ts" } }, { "name": "stayOpenOnBodyClick", "type": { "text": "boolean" }, "default": "false", "description": "Prevents the menu from closing when clicking outside the menu.", "fieldName": "stayOpenOnBodyClick", "inheritedFrom": { "name": "MenuBase", "module": "src/components/menu/menu-base.ts" } }, { "name": "wrapFocus", "type": { "text": "boolean" }, "default": "false", "description": "Proxies to bp-list's wrapFocus property.", "fieldName": "wrapFocus", "inheritedFrom": { "name": "MenuBase", "module": "src/components/menu/menu-base.ts" } }, { "name": "innerAriaLabel", "type": { "text": "null | string" }, "default": "null", "description": "Proxies to bp-list's innerAriaLabel property.", "fieldName": "innerAriaLabel", "inheritedFrom": { "name": "MenuBase", "module": "src/components/menu/menu-base.ts" } }, { "name": "innerRole", "type": { "text": "'menu' | 'listbox'" }, "default": "'menu'", "description": "Proxies to bp-list's innerRole property.", "fieldName": "innerRole", "inheritedFrom": { "name": "MenuBase", "module": "src/components/menu/menu-base.ts" } }, { "name": "multi", "type": { "text": "boolean" }, "default": "false", "description": "Proxies to bp-list's multi property.", "fieldName": "multi", "inheritedFrom": { "name": "MenuBase", "module": "src/components/menu/menu-base.ts" } }, { "name": "activatable", "type": { "text": "boolean" }, "default": "false", "description": "Proxies to bp-list's activatable property.", "fieldName": "activatable", "inheritedFrom": { "name": "MenuBase", "module": "src/components/menu/menu-base.ts" } } ] } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "Menu", "module": "src/components/menu/menu.ts" } }, { "kind": "custom-element-definition", "name": "bp-menu", "declaration": { "name": "Menu", "module": "src/components/menu/menu.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/radio/radio-base.ts", "declarations": [ { "kind": "class", "description": "", "name": "RadioBase", "members": [ { "kind": "field", "name": "formSubmitController", "privacy": "private", "default": "new FormSubmitController(this, {\n value: (control: RadioBase) =>\n control.checked ? control.value || 'on' : undefined,\n defaultValue: (control: RadioBase) => control.defaultChecked,\n setValue: (control: RadioBase, selected: boolean) =>\n (control.checked = selected),\n })" }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "If true, this radio button cannot be selected or de-selected. Maps to the native disabled attribute.", "attribute": "disabled" }, { "kind": "field", "name": "name", "type": { "text": "string" }, "default": "''", "description": "Name of the input for form submission, and identifier for the selection group. Only one radio button can be checked for a given selection group. Maps to the native name attribute.", "attribute": "name" }, { "kind": "field", "name": "value", "type": { "text": "string" }, "default": "''", "description": "Value of the input for form submission. Maps to the native value attribute.", "attribute": "value" }, { "kind": "field", "name": "global", "type": { "text": "boolean" }, "default": "false", "description": "If true, this radio button will use a global, document-level scope for its selection group rather than its local shadow root.", "attribute": "global" }, { "kind": "field", "name": "color", "type": { "text": "| 'primary'\n | 'secondary'\n | 'success'\n | 'warning'\n | 'error'\n | 'info'" }, "default": "'primary'", "description": "Defines the color of the radio.", "attribute": "color" }, { "kind": "field", "name": "defaultChecked" }, { "kind": "method", "name": "emitClickHandler", "parameters": [ { "name": "e", "type": { "text": "Event" } } ] }, { "kind": "method", "name": "setCustomValidity", "privacy": "public", "parameters": [ { "name": "message", "type": { "text": "string" } } ], "description": "HTMLObjectElement setCustomValidity." }, { "kind": "method", "name": "reportValidity", "privacy": "public", "description": "HTMLObjectElement reportValidity." } ], "attributes": [ { "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "If true, this radio button cannot be selected or de-selected. Maps to the native disabled attribute.", "fieldName": "disabled" }, { "name": "name", "type": { "text": "string" }, "default": "''", "description": "Name of the input for form submission, and identifier for the selection group. Only one radio button can be checked for a given selection group. Maps to the native name attribute.", "fieldName": "name" }, { "name": "value", "type": { "text": "string" }, "default": "''", "description": "Value of the input for form submission. Maps to the native value attribute.", "fieldName": "value" }, { "name": "global", "type": { "text": "boolean" }, "default": "false", "description": "If true, this radio button will use a global, document-level scope for its selection group rather than its local shadow root.", "fieldName": "global" }, { "name": "color", "type": { "text": "| 'primary'\n | 'secondary'\n | 'success'\n | 'warning'\n | 'error'\n | 'info'" }, "default": "'primary'", "description": "Defines the color of the radio.", "fieldName": "color" } ], "superclass": { "name": "_RadioBase", "package": "@material/mwc-radio/mwc-radio-base" } } ], "exports": [ { "kind": "js", "name": "RadioBase", "declaration": { "name": "RadioBase", "module": "src/components/radio/radio-base.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/radio/radio.ts", "declarations": [ { "kind": "class", "description": "", "name": "Radio", "members": [ { "kind": "field", "name": "formSubmitController", "privacy": "private", "default": "new FormSubmitController(this, {\n value: (control: RadioBase) =>\n control.checked ? control.value || 'on' : undefined,\n defaultValue: (control: RadioBase) => control.defaultChecked,\n setValue: (control: RadioBase, selected: boolean) =>\n (control.checked = selected),\n })", "inheritedFrom": { "name": "RadioBase", "module": "src/components/radio/radio-base.ts" } }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "If true, this radio button cannot be selected or de-selected. Maps to the native disabled attribute.", "attribute": "disabled", "inheritedFrom": { "name": "RadioBase", "module": "src/components/radio/radio-base.ts" } }, { "kind": "field", "name": "name", "type": { "text": "string" }, "default": "''", "description": "Name of the input for form submission, and identifier for the selection group. Only one radio button can be checked for a given selection group. Maps to the native name attribute.", "attribute": "name", "inheritedFrom": { "name": "RadioBase", "module": "src/components/radio/radio-base.ts" } }, { "kind": "field", "name": "value", "type": { "text": "string" }, "default": "''", "description": "Value of the input for form submission. Maps to the native value attribute.", "attribute": "value", "inheritedFrom": { "name": "RadioBase", "module": "src/components/radio/radio-base.ts" } }, { "kind": "field", "name": "global", "type": { "text": "boolean" }, "default": "false", "description": "If true, this radio button will use a global, document-level scope for its selection group rather than its local shadow root.", "attribute": "global", "inheritedFrom": { "name": "RadioBase", "module": "src/components/radio/radio-base.ts" } }, { "kind": "field", "name": "color", "type": { "text": "| 'primary'\n | 'secondary'\n | 'success'\n | 'warning'\n | 'error'\n | 'info'" }, "default": "'primary'", "description": "Defines the color of the radio.", "attribute": "color", "inheritedFrom": { "name": "RadioBase", "module": "src/components/radio/radio-base.ts" } }, { "kind": "field", "name": "defaultChecked", "inheritedFrom": { "name": "RadioBase", "module": "src/components/radio/radio-base.ts" } }, { "kind": "method", "name": "emitClickHandler", "parameters": [ { "name": "e", "type": { "text": "Event" } } ], "inheritedFrom": { "name": "RadioBase", "module": "src/components/radio/radio-base.ts" } }, { "kind": "method", "name": "setCustomValidity", "privacy": "public", "parameters": [ { "name": "message", "type": { "text": "string" } } ], "description": "HTMLObjectElement setCustomValidity.", "inheritedFrom": { "name": "RadioBase", "module": "src/components/radio/radio-base.ts" } }, { "kind": "method", "name": "reportValidity", "privacy": "public", "description": "HTMLObjectElement reportValidity.", "inheritedFrom": { "name": "RadioBase", "module": "src/components/radio/radio-base.ts" } } ], "events": [ { "type": { "text": "name: value" }, "description": "Global event, emitted whenever a radio selection changed.", "name": "bp-radio-changed", "reactName": "onBpRadioChanged" } ], "superclass": { "name": "RadioBase", "module": "/src/components/radio/radio-base.js" }, "since": "1.0", "status": "Experimental", "tagName": "bp-radio", "customElement": true, "attributes": [ { "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "If true, this radio button cannot be selected or de-selected. Maps to the native disabled attribute.", "fieldName": "disabled", "inheritedFrom": { "name": "RadioBase", "module": "src/components/radio/radio-base.ts" } }, { "name": "name", "type": { "text": "string" }, "default": "''", "description": "Name of the input for form submission, and identifier for the selection group. Only one radio button can be checked for a given selection group. Maps to the native name attribute.", "fieldName": "name", "inheritedFrom": { "name": "RadioBase", "module": "src/components/radio/radio-base.ts" } }, { "name": "value", "type": { "text": "string" }, "default": "''", "description": "Value of the input for form submission. Maps to the native value attribute.", "fieldName": "value", "inheritedFrom": { "name": "RadioBase", "module": "src/components/radio/radio-base.ts" } }, { "name": "global", "type": { "text": "boolean" }, "default": "false", "description": "If true, this radio button will use a global, document-level scope for its selection group rather than its local shadow root.", "fieldName": "global", "inheritedFrom": { "name": "RadioBase", "module": "src/components/radio/radio-base.ts" } }, { "name": "color", "type": { "text": "| 'primary'\n | 'secondary'\n | 'success'\n | 'warning'\n | 'error'\n | 'info'" }, "default": "'primary'", "description": "Defines the color of the radio.", "fieldName": "color", "inheritedFrom": { "name": "RadioBase", "module": "src/components/radio/radio-base.ts" } } ] } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "Radio", "module": "src/components/radio/radio.ts" } }, { "kind": "custom-element-definition", "name": "bp-radio", "declaration": { "name": "Radio", "module": "src/components/radio/radio.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/relative-time/relative-time-base.ts", "declarations": [ { "kind": "class", "description": "", "name": "RelativeTimeBase", "members": [ { "kind": "field", "name": "date", "type": { "text": "Date | string" }, "default": "new Date()", "description": "The date from which to calculate time from. If not set, the current date and time will be used. When passing a string, it's strongly recommended to use the ISO 8601 format to ensure timezones are handled correctly. To convert a date to this format in JavaScript, use date.toISOString().", "attribute": "date" }, { "kind": "field", "name": "format", "type": { "text": "'long' | 'short' | 'narrow'" }, "default": "'long'", "description": "The formatting style to use.", "attribute": "format" }, { "kind": "field", "name": "numeric", "type": { "text": "'always' | 'auto'" }, "default": "'auto'", "description": "When auto, values such as \"yesterday\" and \"tomorrow\" will be shown when possible. When always, values such as \"1 day ago\" and \"in 1 day\" will be shown.", "attribute": "numeric" }, { "kind": "field", "name": "sync", "type": { "text": "boolean" }, "default": "false", "description": "Keep the displayed value up to date as time passes.", "attribute": "sync" } ], "attributes": [ { "name": "date", "type": { "text": "Date | string" }, "default": "new Date()", "description": "The date from which to calculate time from. If not set, the current date and time will be used. When passing a string, it's strongly recommended to use the ISO 8601 format to ensure timezones are handled correctly. To convert a date to this format in JavaScript, use date.toISOString().", "fieldName": "date" }, { "name": "format", "type": { "text": "'long' | 'short' | 'narrow'" }, "default": "'long'", "description": "The formatting style to use.", "fieldName": "format" }, { "name": "numeric", "type": { "text": "'always' | 'auto'" }, "default": "'auto'", "description": "When auto, values such as \"yesterday\" and \"tomorrow\" will be shown when possible. When always, values such as \"1 day ago\" and \"in 1 day\" will be shown.", "fieldName": "numeric" }, { "name": "sync", "type": { "text": "boolean" }, "default": "false", "description": "Keep the displayed value up to date as time passes.", "fieldName": "sync" } ], "superclass": { "name": "SlRelativeTime", "package": "@shoelace-style/shoelace/dist/components/relative-time/relative-time" } } ], "exports": [ { "kind": "js", "name": "RelativeTimeBase", "declaration": { "name": "RelativeTimeBase", "module": "src/components/relative-time/relative-time-base.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/relative-time/relative-time.ts", "declarations": [ { "kind": "class", "description": "", "name": "RelativeTime", "superclass": { "name": "RelativeTimeBase", "module": "/src/components/relative-time/relative-time-base.js" }, "since": "0.1.1-beta.1", "status": "beta", "tagName": "bp-relative-time", "customElement": true, "attributes": [ { "name": "date", "type": { "text": "Date | string" }, "default": "new Date()", "description": "The date from which to calculate time from. If not set, the current date and time will be used. When passing a string, it's strongly recommended to use the ISO 8601 format to ensure timezones are handled correctly. To convert a date to this format in JavaScript, use date.toISOString().", "fieldName": "date", "inheritedFrom": { "name": "RelativeTimeBase", "module": "src/components/relative-time/relative-time-base.ts" } }, { "name": "format", "type": { "text": "'long' | 'short' | 'narrow'" }, "default": "'long'", "description": "The formatting style to use.", "fieldName": "format", "inheritedFrom": { "name": "RelativeTimeBase", "module": "src/components/relative-time/relative-time-base.ts" } }, { "name": "numeric", "type": { "text": "'always' | 'auto'" }, "default": "'auto'", "description": "When auto, values such as \"yesterday\" and \"tomorrow\" will be shown when possible. When always, values such as \"1 day ago\" and \"in 1 day\" will be shown.", "fieldName": "numeric", "inheritedFrom": { "name": "RelativeTimeBase", "module": "src/components/relative-time/relative-time-base.ts" } }, { "name": "sync", "type": { "text": "boolean" }, "default": "false", "description": "Keep the displayed value up to date as time passes.", "fieldName": "sync", "inheritedFrom": { "name": "RelativeTimeBase", "module": "src/components/relative-time/relative-time-base.ts" } } ], "members": [ { "kind": "field", "name": "date", "type": { "text": "Date | string" }, "default": "new Date()", "description": "The date from which to calculate time from. If not set, the current date and time will be used. When passing a string, it's strongly recommended to use the ISO 8601 format to ensure timezones are handled correctly. To convert a date to this format in JavaScript, use date.toISOString().", "attribute": "date", "inheritedFrom": { "name": "RelativeTimeBase", "module": "src/components/relative-time/relative-time-base.ts" } }, { "kind": "field", "name": "format", "type": { "text": "'long' | 'short' | 'narrow'" }, "default": "'long'", "description": "The formatting style to use.", "attribute": "format", "inheritedFrom": { "name": "RelativeTimeBase", "module": "src/components/relative-time/relative-time-base.ts" } }, { "kind": "field", "name": "numeric", "type": { "text": "'always' | 'auto'" }, "default": "'auto'", "description": "When auto, values such as \"yesterday\" and \"tomorrow\" will be shown when possible. When always, values such as \"1 day ago\" and \"in 1 day\" will be shown.", "attribute": "numeric", "inheritedFrom": { "name": "RelativeTimeBase", "module": "src/components/relative-time/relative-time-base.ts" } }, { "kind": "field", "name": "sync", "type": { "text": "boolean" }, "default": "false", "description": "Keep the displayed value up to date as time passes.", "attribute": "sync", "inheritedFrom": { "name": "RelativeTimeBase", "module": "src/components/relative-time/relative-time-base.ts" } } ] } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "RelativeTime", "module": "src/components/relative-time/relative-time.ts" } }, { "kind": "custom-element-definition", "name": "bp-relative-time", "declaration": { "name": "RelativeTime", "module": "src/components/relative-time/relative-time.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/select/select-base.ts", "declarations": [ { "kind": "class", "description": "", "name": "SelectBase", "members": [ { "kind": "method", "name": "setFormData", "privacy": "protected", "return": { "type": { "text": "void" } } }, { "kind": "field", "name": "formSubmitController", "type": { "text": "FormSubmitController" }, "default": "new FormSubmitController(this)" }, { "kind": "field", "name": "value", "type": { "text": "string" }, "default": "''", "description": "The select control's value determined by the value property of the currently selected list item. Setting value will attempt to select a list-item with the same value. If one does not match, it will set itself to \"\" and the index to -1. Setting value before the list item is attached will not select the item.", "attribute": "value" }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "Sets floating label value. NOTE: The label will not float if the selected item has a falsey value property.", "attribute": "label" }, { "kind": "field", "name": "naturalMenuWidth", "type": { "text": "boolean" }, "default": "false", "description": "Sets the dropdown menu's width to auto.", "attribute": "naturalMenuWidth" }, { "kind": "field", "name": "fixedMenuPosition", "type": { "text": "boolean" }, "default": "false", "description": "Sets the dropdown menu's position to fixed. This is useful when the select is inside of a stacking context e.g. inside of an mwc-dialog. Note, that --mdc-menu-min-width or --mdc-menu-max-width may have to be set to resize the menu to the width anchor.", "attribute": "fixedMenuPosition" }, { "kind": "field", "name": "icon", "type": { "text": "string" }, "default": "''", "description": "Leading icon to display in select. See bp-icon. Note: for proper list spacing, each list item must have graphic=\"icon\" or graphic=\"avatar\" to be set.", "attribute": "icon" }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Whether or not the select should be disabled.", "attribute": "disabled" }, { "kind": "field", "name": "outlined", "type": { "text": "boolean" }, "default": "false", "description": "Whether or not to show the material outlined variant.", "attribute": "outlined" }, { "kind": "field", "name": "helper", "type": { "text": "string" }, "default": "''", "description": "Helper text to display below the select. Always displays by default.", "attribute": "helper" }, { "kind": "field", "name": "required", "type": { "text": "boolean" }, "default": "false", "description": "Displays error state if value is empty and select is blurred.", "attribute": "required" }, { "kind": "field", "name": "validationMessage", "type": { "text": "string" }, "default": "''", "description": "Message to show in the error color when the select is invalid. (Helper text will not be visible)", "attribute": "validationMessage" }, { "kind": "field", "name": "validateOnInitialRender", "type": { "text": "boolean" }, "default": "false", "description": "Runs validation check on initial render.", "attribute": "validateOnInitialRender" }, { "kind": "field", "name": "defaultValue", "type": { "text": "string" }, "default": "''", "description": "Set the default/initial value to roll back to after reset" }, { "kind": "method", "name": "emitSelectedHandler", "parameters": [ { "name": "e", "type": { "text": "CustomEvent<{index: number}>" } } ] } ], "attributes": [ { "name": "value", "type": { "text": "string" }, "default": "''", "description": "The select control's value determined by the value property of the currently selected list item. Setting value will attempt to select a list-item with the same value. If one does not match, it will set itself to \"\" and the index to -1. Setting value before the list item is attached will not select the item.", "fieldName": "value" }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "Sets floating label value. NOTE: The label will not float if the selected item has a falsey value property.", "fieldName": "label" }, { "name": "naturalMenuWidth", "type": { "text": "boolean" }, "default": "false", "description": "Sets the dropdown menu's width to auto.", "fieldName": "naturalMenuWidth" }, { "name": "fixedMenuPosition", "type": { "text": "boolean" }, "default": "false", "description": "Sets the dropdown menu's position to fixed. This is useful when the select is inside of a stacking context e.g. inside of an mwc-dialog. Note, that --mdc-menu-min-width or --mdc-menu-max-width may have to be set to resize the menu to the width anchor.", "fieldName": "fixedMenuPosition" }, { "name": "icon", "type": { "text": "string" }, "default": "''", "description": "Leading icon to display in select. See bp-icon. Note: for proper list spacing, each list item must have graphic=\"icon\" or graphic=\"avatar\" to be set.", "fieldName": "icon" }, { "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Whether or not the select should be disabled.", "fieldName": "disabled" }, { "name": "outlined", "type": { "text": "boolean" }, "default": "false", "description": "Whether or not to show the material outlined variant.", "fieldName": "outlined" }, { "name": "helper", "type": { "text": "string" }, "default": "''", "description": "Helper text to display below the select. Always displays by default.", "fieldName": "helper" }, { "name": "required", "type": { "text": "boolean" }, "default": "false", "description": "Displays error state if value is empty and select is blurred.", "fieldName": "required" }, { "name": "validationMessage", "type": { "text": "string" }, "default": "''", "description": "Message to show in the error color when the select is invalid. (Helper text will not be visible)", "fieldName": "validationMessage" }, { "name": "validateOnInitialRender", "type": { "text": "boolean" }, "default": "false", "description": "Runs validation check on initial render.", "fieldName": "validateOnInitialRender" } ], "superclass": { "name": "_SelectBase", "package": "@material/mwc-select/mwc-select-base" } } ], "exports": [ { "kind": "js", "name": "SelectBase", "declaration": { "name": "SelectBase", "module": "src/components/select/select-base.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/select/select.ts", "declarations": [ { "kind": "class", "description": "", "name": "Select", "slots": [ { "description": "The select's options in the form of menu items (bp-list-item).", "name": "" } ], "members": [ { "kind": "method", "name": "setFormData", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "SelectBase", "module": "src/components/select/select-base.ts" } }, { "kind": "field", "name": "formSubmitController", "type": { "text": "FormSubmitController" }, "default": "new FormSubmitController(this)", "inheritedFrom": { "name": "SelectBase", "module": "src/components/select/select-base.ts" } }, { "kind": "field", "name": "value", "type": { "text": "string" }, "default": "''", "description": "The select control's value determined by the value property of the currently selected list item. Setting value will attempt to select a list-item with the same value. If one does not match, it will set itself to \"\" and the index to -1. Setting value before the list item is attached will not select the item.", "attribute": "value", "inheritedFrom": { "name": "SelectBase", "module": "src/components/select/select-base.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "Sets floating label value. NOTE: The label will not float if the selected item has a falsey value property.", "attribute": "label", "inheritedFrom": { "name": "SelectBase", "module": "src/components/select/select-base.ts" } }, { "kind": "field", "name": "naturalMenuWidth", "type": { "text": "boolean" }, "default": "false", "description": "Sets the dropdown menu's width to auto.", "attribute": "naturalMenuWidth", "inheritedFrom": { "name": "SelectBase", "module": "src/components/select/select-base.ts" } }, { "kind": "field", "name": "fixedMenuPosition", "type": { "text": "boolean" }, "default": "false", "description": "Sets the dropdown menu's position to fixed. This is useful when the select is inside of a stacking context e.g. inside of an mwc-dialog. Note, that --mdc-menu-min-width or --mdc-menu-max-width may have to be set to resize the menu to the width anchor.", "attribute": "fixedMenuPosition", "inheritedFrom": { "name": "SelectBase", "module": "src/components/select/select-base.ts" } }, { "kind": "field", "name": "icon", "type": { "text": "string" }, "default": "''", "description": "Leading icon to display in select. See bp-icon. Note: for proper list spacing, each list item must have graphic=\"icon\" or graphic=\"avatar\" to be set.", "attribute": "icon", "inheritedFrom": { "name": "SelectBase", "module": "src/components/select/select-base.ts" } }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Whether or not the select should be disabled.", "attribute": "disabled", "inheritedFrom": { "name": "SelectBase", "module": "src/components/select/select-base.ts" } }, { "kind": "field", "name": "outlined", "type": { "text": "boolean" }, "default": "false", "description": "Whether or not to show the material outlined variant.", "attribute": "outlined", "inheritedFrom": { "name": "SelectBase", "module": "src/components/select/select-base.ts" } }, { "kind": "field", "name": "helper", "type": { "text": "string" }, "default": "''", "description": "Helper text to display below the select. Always displays by default.", "attribute": "helper", "inheritedFrom": { "name": "SelectBase", "module": "src/components/select/select-base.ts" } }, { "kind": "field", "name": "required", "type": { "text": "boolean" }, "default": "false", "description": "Displays error state if value is empty and select is blurred.", "attribute": "required", "inheritedFrom": { "name": "SelectBase", "module": "src/components/select/select-base.ts" } }, { "kind": "field", "name": "validationMessage", "type": { "text": "string" }, "default": "''", "description": "Message to show in the error color when the select is invalid. (Helper text will not be visible)", "attribute": "validationMessage", "inheritedFrom": { "name": "SelectBase", "module": "src/components/select/select-base.ts" } }, { "kind": "field", "name": "validateOnInitialRender", "type": { "text": "boolean" }, "default": "false", "description": "Runs validation check on initial render.", "attribute": "validateOnInitialRender", "inheritedFrom": { "name": "SelectBase", "module": "src/components/select/select-base.ts" } }, { "kind": "field", "name": "defaultValue", "type": { "text": "string" }, "default": "''", "description": "Set the default/initial value to roll back to after reset", "inheritedFrom": { "name": "SelectBase", "module": "src/components/select/select-base.ts" } }, { "kind": "method", "name": "emitSelectedHandler", "parameters": [ { "name": "e", "type": { "text": "CustomEvent<{index: number}>" } } ], "inheritedFrom": { "name": "SelectBase", "module": "src/components/select/select-base.ts" } } ], "events": [ { "type": { "text": "{index: number}" }, "description": "Emitted when an item is selected.", "name": "bp-select-selected", "reactName": "onBpSelectSelected" } ], "superclass": { "name": "SelectBase", "module": "/src/components/select/select-base.js" }, "since": "0.1.1-beta.1", "status": "beta", "dependencies": [ "bp-menu", "bp-icon", "bp-list-item" ], "tagName": "bp-select", "customElement": true, "attributes": [ { "name": "value", "type": { "text": "string" }, "default": "''", "description": "The select control's value determined by the value property of the currently selected list item. Setting value will attempt to select a list-item with the same value. If one does not match, it will set itself to \"\" and the index to -1. Setting value before the list item is attached will not select the item.", "fieldName": "value", "inheritedFrom": { "name": "SelectBase", "module": "src/components/select/select-base.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "Sets floating label value. NOTE: The label will not float if the selected item has a falsey value property.", "fieldName": "label", "inheritedFrom": { "name": "SelectBase", "module": "src/components/select/select-base.ts" } }, { "name": "naturalMenuWidth", "type": { "text": "boolean" }, "default": "false", "description": "Sets the dropdown menu's width to auto.", "fieldName": "naturalMenuWidth", "inheritedFrom": { "name": "SelectBase", "module": "src/components/select/select-base.ts" } }, { "name": "fixedMenuPosition", "type": { "text": "boolean" }, "default": "false", "description": "Sets the dropdown menu's position to fixed. This is useful when the select is inside of a stacking context e.g. inside of an mwc-dialog. Note, that --mdc-menu-min-width or --mdc-menu-max-width may have to be set to resize the menu to the width anchor.", "fieldName": "fixedMenuPosition", "inheritedFrom": { "name": "SelectBase", "module": "src/components/select/select-base.ts" } }, { "name": "icon", "type": { "text": "string" }, "default": "''", "description": "Leading icon to display in select. See bp-icon. Note: for proper list spacing, each list item must have graphic=\"icon\" or graphic=\"avatar\" to be set.", "fieldName": "icon", "inheritedFrom": { "name": "SelectBase", "module": "src/components/select/select-base.ts" } }, { "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Whether or not the select should be disabled.", "fieldName": "disabled", "inheritedFrom": { "name": "SelectBase", "module": "src/components/select/select-base.ts" } }, { "name": "outlined", "type": { "text": "boolean" }, "default": "false", "description": "Whether or not to show the material outlined variant.", "fieldName": "outlined", "inheritedFrom": { "name": "SelectBase", "module": "src/components/select/select-base.ts" } }, { "name": "helper", "type": { "text": "string" }, "default": "''", "description": "Helper text to display below the select. Always displays by default.", "fieldName": "helper", "inheritedFrom": { "name": "SelectBase", "module": "src/components/select/select-base.ts" } }, { "name": "required", "type": { "text": "boolean" }, "default": "false", "description": "Displays error state if value is empty and select is blurred.", "fieldName": "required", "inheritedFrom": { "name": "SelectBase", "module": "src/components/select/select-base.ts" } }, { "name": "validationMessage", "type": { "text": "string" }, "default": "''", "description": "Message to show in the error color when the select is invalid. (Helper text will not be visible)", "fieldName": "validationMessage", "inheritedFrom": { "name": "SelectBase", "module": "src/components/select/select-base.ts" } }, { "name": "validateOnInitialRender", "type": { "text": "boolean" }, "default": "false", "description": "Runs validation check on initial render.", "fieldName": "validateOnInitialRender", "inheritedFrom": { "name": "SelectBase", "module": "src/components/select/select-base.ts" } } ] } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "Select", "module": "src/components/select/select.ts" } }, { "kind": "custom-element-definition", "name": "bp-select", "declaration": { "name": "Select", "module": "src/components/select/select.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/skeleton/skeleton-base.ts", "declarations": [ { "kind": "class", "description": "", "name": "SkeletonBase", "members": [ { "kind": "field", "name": "type", "type": { "text": "'rectangle' | 'circle' | 'text'" }, "default": "'rectangle'", "description": "Sets the shape of the skeleton element", "attribute": "type" }, { "kind": "field", "name": "height", "type": { "text": "number" }, "default": "10", "description": "Sets the elements height", "attribute": "height" }, { "kind": "field", "name": "width", "type": { "text": "number" }, "default": "10", "description": "Sets the elements width", "attribute": "width" }, { "kind": "field", "name": "animation", "type": { "text": "'pulse' | 'sheen' | 'none'" }, "default": "'none'", "description": "Determines which effect the skeleton will use.", "attribute": "animation" }, { "kind": "field", "name": "getHeight" } ], "attributes": [ { "name": "type", "type": { "text": "'rectangle' | 'circle' | 'text'" }, "default": "'rectangle'", "description": "Sets the shape of the skeleton element", "fieldName": "type" }, { "name": "height", "type": { "text": "number" }, "default": "10", "description": "Sets the elements height", "fieldName": "height" }, { "name": "width", "type": { "text": "number" }, "default": "10", "description": "Sets the elements width", "fieldName": "width" }, { "name": "animation", "type": { "text": "'pulse' | 'sheen' | 'none'" }, "default": "'none'", "description": "Determines which effect the skeleton will use.", "fieldName": "animation" } ], "superclass": { "name": "SlSkeleton", "package": "@shoelace-style/shoelace/dist/components/skeleton/skeleton.js" } } ], "exports": [ { "kind": "js", "name": "SkeletonBase", "declaration": { "name": "SkeletonBase", "module": "src/components/skeleton/skeleton-base.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/skeleton/skeleton.ts", "declarations": [ { "kind": "class", "description": "", "name": "Skeleton", "cssProperties": [ { "description": "The skeleton's border radius.", "name": "--border-radius" }, { "description": "The color of the skeleton.", "name": "--color" }, { "description": "The sheen color when the skeleton is in its loading state.", "name": "--sheen-color" } ], "members": [ { "kind": "field", "name": "type", "type": { "text": "'rectangle' | 'circle' | 'text'" }, "default": "'rectangle'", "description": "Sets the shape of the skeleton element", "attribute": "type", "inheritedFrom": { "name": "SkeletonBase", "module": "src/components/skeleton/skeleton-base.ts" } }, { "kind": "field", "name": "height", "type": { "text": "number" }, "default": "10", "description": "Sets the elements height", "attribute": "height", "inheritedFrom": { "name": "SkeletonBase", "module": "src/components/skeleton/skeleton-base.ts" } }, { "kind": "field", "name": "width", "type": { "text": "number" }, "default": "10", "description": "Sets the elements width", "attribute": "width", "inheritedFrom": { "name": "SkeletonBase", "module": "src/components/skeleton/skeleton-base.ts" } }, { "kind": "field", "name": "animation", "type": { "text": "'pulse' | 'sheen' | 'none'" }, "default": "'none'", "description": "Determines which effect the skeleton will use.", "attribute": "animation", "inheritedFrom": { "name": "SkeletonBase", "module": "src/components/skeleton/skeleton-base.ts" } }, { "kind": "field", "name": "getHeight", "inheritedFrom": { "name": "SkeletonBase", "module": "src/components/skeleton/skeleton-base.ts" } } ], "superclass": { "name": "SkeletonBase", "module": "/src/components/skeleton/skeleton-base.js" }, "since": "0.1.1-beta.1", "status": "beta", "tagName": "bp-skeleton", "customElement": true, "attributes": [ { "name": "type", "type": { "text": "'rectangle' | 'circle' | 'text'" }, "default": "'rectangle'", "description": "Sets the shape of the skeleton element", "fieldName": "type", "inheritedFrom": { "name": "SkeletonBase", "module": "src/components/skeleton/skeleton-base.ts" } }, { "name": "height", "type": { "text": "number" }, "default": "10", "description": "Sets the elements height", "fieldName": "height", "inheritedFrom": { "name": "SkeletonBase", "module": "src/components/skeleton/skeleton-base.ts" } }, { "name": "width", "type": { "text": "number" }, "default": "10", "description": "Sets the elements width", "fieldName": "width", "inheritedFrom": { "name": "SkeletonBase", "module": "src/components/skeleton/skeleton-base.ts" } }, { "name": "animation", "type": { "text": "'pulse' | 'sheen' | 'none'" }, "default": "'none'", "description": "Determines which effect the skeleton will use.", "fieldName": "animation", "inheritedFrom": { "name": "SkeletonBase", "module": "src/components/skeleton/skeleton-base.ts" } } ] } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "Skeleton", "module": "src/components/skeleton/skeleton.ts" } }, { "kind": "custom-element-definition", "name": "bp-skeleton", "declaration": { "name": "Skeleton", "module": "src/components/skeleton/skeleton.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/slider/slider-base.ts", "declarations": [ { "kind": "class", "description": "", "name": "SliderSingleBase", "members": [ { "kind": "field", "name": "min", "type": { "text": "number" }, "default": "0", "description": "Value representing the minimum allowed value.", "attribute": "min" }, { "kind": "field", "name": "max", "type": { "text": "number" }, "default": "0", "description": "Value representing the maximum allowed value.", "attribute": "max" }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Disables the slider, preventing interaction.", "attribute": "disabled" }, { "kind": "field", "name": "step", "type": { "text": "number" }, "default": "1", "description": "Step for value quantization.", "attribute": "step" }, { "kind": "field", "name": "discrete", "type": { "text": "boolean" }, "default": "false", "description": "Displays a numeric value label upon pressing the thumb which allows the user to select an exact value.", "attribute": "discrete" }, { "kind": "field", "name": "color", "type": { "text": "| 'primary'\n | 'secondary'\n | 'success'\n | 'warning'\n | 'error'\n | 'info'" }, "default": "'primary'", "description": "Color of the slider.", "attribute": "color" }, { "kind": "method", "name": "emitInputHandler", "parameters": [ { "name": "e", "type": { "text": "Event" } } ] }, { "kind": "method", "name": "emitChangeHandler", "parameters": [ { "name": "e", "type": { "text": "Event" } } ] } ], "attributes": [ { "name": "min", "type": { "text": "number" }, "default": "0", "description": "Value representing the minimum allowed value.", "fieldName": "min" }, { "name": "max", "type": { "text": "number" }, "default": "0", "description": "Value representing the maximum allowed value.", "fieldName": "max" }, { "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Disables the slider, preventing interaction.", "fieldName": "disabled" }, { "name": "step", "type": { "text": "number" }, "default": "1", "description": "Step for value quantization.", "fieldName": "step" }, { "name": "discrete", "type": { "text": "boolean" }, "default": "false", "description": "Displays a numeric value label upon pressing the thumb which allows the user to select an exact value.", "fieldName": "discrete" }, { "name": "color", "type": { "text": "| 'primary'\n | 'secondary'\n | 'success'\n | 'warning'\n | 'error'\n | 'info'" }, "default": "'primary'", "description": "Color of the slider.", "fieldName": "color" } ], "superclass": { "name": "_SliderSingleBase", "package": "@material/mwc-slider/slider-single-base" } } ], "exports": [ { "kind": "js", "name": "SliderSingleBase", "declaration": { "name": "SliderSingleBase", "module": "src/components/slider/slider-base.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/slider/slider.ts", "declarations": [ { "kind": "class", "description": "", "name": "Slider", "members": [ { "kind": "field", "name": "min", "type": { "text": "number" }, "default": "0", "description": "Value representing the minimum allowed value.", "attribute": "min", "inheritedFrom": { "name": "SliderRangeBase", "module": "src/components/slider-range/slider-range-base.ts" } }, { "kind": "field", "name": "max", "type": { "text": "number" }, "default": "0", "description": "Value representing the maximum allowed value.", "attribute": "max", "inheritedFrom": { "name": "SliderRangeBase", "module": "src/components/slider-range/slider-range-base.ts" } }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Disables the slider, preventing interaction.", "attribute": "disabled", "inheritedFrom": { "name": "SliderRangeBase", "module": "src/components/slider-range/slider-range-base.ts" } }, { "kind": "field", "name": "step", "type": { "text": "number" }, "default": "1", "description": "Step for value quantization.", "attribute": "step", "inheritedFrom": { "name": "SliderRangeBase", "module": "src/components/slider-range/slider-range-base.ts" } }, { "kind": "field", "name": "discrete", "type": { "text": "boolean" }, "default": "false", "description": "Displays a numeric value label upon pressing the thumb which allows the user to select an exact value.", "attribute": "discrete", "inheritedFrom": { "name": "SliderRangeBase", "module": "src/components/slider-range/slider-range-base.ts" } }, { "kind": "field", "name": "color", "type": { "text": "| 'primary'\n | 'secondary'\n | 'success'\n | 'warning'\n | 'error'\n | 'info'" }, "default": "'primary'", "description": "Color of the slider.", "attribute": "color", "inheritedFrom": { "name": "SliderRangeBase", "module": "src/components/slider-range/slider-range-base.ts" } }, { "kind": "method", "name": "emitInputHandler", "parameters": [ { "name": "e", "type": { "text": "Event" } } ], "inheritedFrom": { "name": "SliderRangeBase", "module": "src/components/slider-range/slider-range-base.ts" } }, { "kind": "method", "name": "emitChangeHandler", "parameters": [ { "name": "e", "type": { "text": "Event" } } ], "inheritedFrom": { "name": "SliderRangeBase", "module": "src/components/slider-range/slider-range-base.ts" } } ], "events": [ { "type": { "text": "value: number" }, "description": "Fires when the user is holding down the slider and changing values.", "name": "bp-slider-input", "reactName": "onBpSliderInput" }, { "type": { "text": "value: number" }, "description": "Fires when the user has let go of the slider at a certain value.", "name": "bp-slider-changed", "reactName": "onBpSliderChanged" } ], "superclass": { "name": "SliderSingleBase", "module": "/src/components/slider/slider-base.js" }, "since": "0.1.1-beta.1", "status": "beta", "tagName": "bp-slider", "customElement": true, "attributes": [ { "name": "min", "type": { "text": "number" }, "default": "0", "description": "Value representing the minimum allowed value.", "fieldName": "min", "inheritedFrom": { "name": "SliderRangeBase", "module": "src/components/slider-range/slider-range-base.ts" } }, { "name": "max", "type": { "text": "number" }, "default": "0", "description": "Value representing the maximum allowed value.", "fieldName": "max", "inheritedFrom": { "name": "SliderRangeBase", "module": "src/components/slider-range/slider-range-base.ts" } }, { "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Disables the slider, preventing interaction.", "fieldName": "disabled", "inheritedFrom": { "name": "SliderRangeBase", "module": "src/components/slider-range/slider-range-base.ts" } }, { "name": "step", "type": { "text": "number" }, "default": "1", "description": "Step for value quantization.", "fieldName": "step", "inheritedFrom": { "name": "SliderRangeBase", "module": "src/components/slider-range/slider-range-base.ts" } }, { "name": "discrete", "type": { "text": "boolean" }, "default": "false", "description": "Displays a numeric value label upon pressing the thumb which allows the user to select an exact value.", "fieldName": "discrete", "inheritedFrom": { "name": "SliderRangeBase", "module": "src/components/slider-range/slider-range-base.ts" } }, { "name": "color", "type": { "text": "| 'primary'\n | 'secondary'\n | 'success'\n | 'warning'\n | 'error'\n | 'info'" }, "default": "'primary'", "description": "Color of the slider.", "fieldName": "color", "inheritedFrom": { "name": "SliderRangeBase", "module": "src/components/slider-range/slider-range-base.ts" } } ] } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "Slider", "module": "src/components/slider/slider.ts" } }, { "kind": "custom-element-definition", "name": "bp-slider", "declaration": { "name": "Slider", "module": "src/components/slider/slider.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/slider-range/slider-range-base.ts", "declarations": [ { "kind": "class", "description": "", "name": "SliderRangeBase", "members": [ { "kind": "field", "name": "min", "type": { "text": "number" }, "default": "0", "description": "Value representing the minimum allowed value.", "attribute": "min" }, { "kind": "field", "name": "max", "type": { "text": "number" }, "default": "0", "description": "Value representing the maximum allowed value.", "attribute": "max" }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Disables the slider, preventing interaction.", "attribute": "disabled" }, { "kind": "field", "name": "step", "type": { "text": "number" }, "default": "1", "description": "Step for value quantization.", "attribute": "step" }, { "kind": "field", "name": "discrete", "type": { "text": "boolean" }, "default": "false", "description": "Displays a numeric value label upon pressing the thumb which allows the user to select an exact value.", "attribute": "discrete" }, { "kind": "field", "name": "color", "type": { "text": "| 'primary'\n | 'secondary'\n | 'success'\n | 'warning'\n | 'error'\n | 'info'" }, "default": "'primary'", "description": "Color of the slider.", "attribute": "color" }, { "kind": "method", "name": "emitInputHandler", "parameters": [ { "name": "e", "type": { "text": "Event" } } ] }, { "kind": "method", "name": "emitChangeHandler", "parameters": [ { "name": "e", "type": { "text": "Event" } } ] } ], "attributes": [ { "name": "min", "type": { "text": "number" }, "default": "0", "description": "Value representing the minimum allowed value.", "fieldName": "min" }, { "name": "max", "type": { "text": "number" }, "default": "0", "description": "Value representing the maximum allowed value.", "fieldName": "max" }, { "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Disables the slider, preventing interaction.", "fieldName": "disabled" }, { "name": "step", "type": { "text": "number" }, "default": "1", "description": "Step for value quantization.", "fieldName": "step" }, { "name": "discrete", "type": { "text": "boolean" }, "default": "false", "description": "Displays a numeric value label upon pressing the thumb which allows the user to select an exact value.", "fieldName": "discrete" }, { "name": "color", "type": { "text": "| 'primary'\n | 'secondary'\n | 'success'\n | 'warning'\n | 'error'\n | 'info'" }, "default": "'primary'", "description": "Color of the slider.", "fieldName": "color" } ], "superclass": { "name": "_SliderRangeBase", "package": "@material/mwc-slider/slider-range-base" } } ], "exports": [ { "kind": "js", "name": "SliderRangeBase", "declaration": { "name": "SliderRangeBase", "module": "src/components/slider-range/slider-range-base.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/slider-range/slider-range.ts", "declarations": [ { "kind": "class", "description": "", "name": "Slider", "members": [ { "kind": "field", "name": "min", "type": { "text": "number" }, "default": "0", "description": "Value representing the minimum allowed value.", "attribute": "min", "inheritedFrom": { "name": "SliderRangeBase", "module": "src/components/slider-range/slider-range-base.ts" } }, { "kind": "field", "name": "max", "type": { "text": "number" }, "default": "0", "description": "Value representing the maximum allowed value.", "attribute": "max", "inheritedFrom": { "name": "SliderRangeBase", "module": "src/components/slider-range/slider-range-base.ts" } }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Disables the slider, preventing interaction.", "attribute": "disabled", "inheritedFrom": { "name": "SliderRangeBase", "module": "src/components/slider-range/slider-range-base.ts" } }, { "kind": "field", "name": "step", "type": { "text": "number" }, "default": "1", "description": "Step for value quantization.", "attribute": "step", "inheritedFrom": { "name": "SliderRangeBase", "module": "src/components/slider-range/slider-range-base.ts" } }, { "kind": "field", "name": "discrete", "type": { "text": "boolean" }, "default": "false", "description": "Displays a numeric value label upon pressing the thumb which allows the user to select an exact value.", "attribute": "discrete", "inheritedFrom": { "name": "SliderRangeBase", "module": "src/components/slider-range/slider-range-base.ts" } }, { "kind": "field", "name": "color", "type": { "text": "| 'primary'\n | 'secondary'\n | 'success'\n | 'warning'\n | 'error'\n | 'info'" }, "default": "'primary'", "description": "Color of the slider.", "attribute": "color", "inheritedFrom": { "name": "SliderRangeBase", "module": "src/components/slider-range/slider-range-base.ts" } }, { "kind": "method", "name": "emitInputHandler", "parameters": [ { "name": "e", "type": { "text": "Event" } } ], "inheritedFrom": { "name": "SliderRangeBase", "module": "src/components/slider-range/slider-range-base.ts" } }, { "kind": "method", "name": "emitChangeHandler", "parameters": [ { "name": "e", "type": { "text": "Event" } } ], "inheritedFrom": { "name": "SliderRangeBase", "module": "src/components/slider-range/slider-range-base.ts" } } ], "events": [ { "type": { "text": "value: number" }, "description": "Fires when the user is holding down the slider and changing values.", "name": "bp-slider-input", "reactName": "onBpSliderInput" }, { "type": { "text": "value: number" }, "description": "Fires when the user has let go of the slider at a certain value.", "name": "bp-slider-changed", "reactName": "onBpSliderChanged" } ], "superclass": { "name": "SliderRangeBase", "module": "/src/components/slider-range/slider-range-base.js" }, "since": "0.1.1-beta.1", "status": "beta", "tagName": "bp-slider", "customElement": true, "attributes": [ { "name": "min", "type": { "text": "number" }, "default": "0", "description": "Value representing the minimum allowed value.", "fieldName": "min", "inheritedFrom": { "name": "SliderRangeBase", "module": "src/components/slider-range/slider-range-base.ts" } }, { "name": "max", "type": { "text": "number" }, "default": "0", "description": "Value representing the maximum allowed value.", "fieldName": "max", "inheritedFrom": { "name": "SliderRangeBase", "module": "src/components/slider-range/slider-range-base.ts" } }, { "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Disables the slider, preventing interaction.", "fieldName": "disabled", "inheritedFrom": { "name": "SliderRangeBase", "module": "src/components/slider-range/slider-range-base.ts" } }, { "name": "step", "type": { "text": "number" }, "default": "1", "description": "Step for value quantization.", "fieldName": "step", "inheritedFrom": { "name": "SliderRangeBase", "module": "src/components/slider-range/slider-range-base.ts" } }, { "name": "discrete", "type": { "text": "boolean" }, "default": "false", "description": "Displays a numeric value label upon pressing the thumb which allows the user to select an exact value.", "fieldName": "discrete", "inheritedFrom": { "name": "SliderRangeBase", "module": "src/components/slider-range/slider-range-base.ts" } }, { "name": "color", "type": { "text": "| 'primary'\n | 'secondary'\n | 'success'\n | 'warning'\n | 'error'\n | 'info'" }, "default": "'primary'", "description": "Color of the slider.", "fieldName": "color", "inheritedFrom": { "name": "SliderRangeBase", "module": "src/components/slider-range/slider-range-base.ts" } } ] } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "Slider", "module": "src/components/slider-range/slider-range.ts" } }, { "kind": "custom-element-definition", "name": "bp-slider-range", "declaration": { "name": "Slider", "module": "src/components/slider-range/slider-range.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/snackbar/snackbar-base.ts", "declarations": [ { "kind": "class", "description": "", "name": "SnackbarBase", "members": [ { "kind": "field", "name": "open", "type": { "text": "boolean" }, "default": "false", "description": "Whether the snackbar is currently open.", "attribute": "open" }, { "kind": "field", "name": "timeoutMs", "type": { "text": "number" }, "default": "5000", "description": "Automatic dismiss timeout in milliseconds. Value must be between 4000 and 10000 (or -1 to disable the timeout completely) or an error will be thrown. Defaults to 5000 (5 seconds).", "attribute": "timeoutMs" }, { "kind": "field", "name": "closeOnEscape", "type": { "text": "boolean" }, "default": "false", "description": "Whether the snackbar closes when it is focused and the user presses the ESC key. Defaults to false.", "attribute": "closeOnEscape" }, { "kind": "field", "name": "labelText", "type": { "text": "string" }, "default": "''", "description": "The text content of the label element.", "attribute": "labelText" }, { "kind": "field", "name": "stacked", "type": { "text": "boolean" }, "default": "false", "description": "Enables the stacked layout.", "attribute": "stacked" }, { "kind": "field", "name": "leading", "type": { "text": "boolean" }, "default": "false", "description": "Enables the leading layout.", "attribute": "leading" }, { "kind": "method", "name": "show", "return": { "type": { "text": "void" } }, "description": "Shows the snackbar." }, { "kind": "method", "name": "close", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "reason", "optional": true, "type": { "text": "string | undefined" } } ], "description": "Hides the snackbar. Takes in optional `reason` string for clarifying the reason for closing." }, { "kind": "method", "name": "emitOpeningHandler", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "emitOpenedHandler", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "emitClosingHandler", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "e", "type": { "text": "Event" } } ] }, { "kind": "method", "name": "emitClosedHandler", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "e", "type": { "text": "Event" } } ] } ], "attributes": [ { "name": "open", "type": { "text": "boolean" }, "default": "false", "description": "Whether the snackbar is currently open.", "fieldName": "open" }, { "name": "timeoutMs", "type": { "text": "number" }, "default": "5000", "description": "Automatic dismiss timeout in milliseconds. Value must be between 4000 and 10000 (or -1 to disable the timeout completely) or an error will be thrown. Defaults to 5000 (5 seconds).", "fieldName": "timeoutMs" }, { "name": "closeOnEscape", "type": { "text": "boolean" }, "default": "false", "description": "Whether the snackbar closes when it is focused and the user presses the ESC key. Defaults to false.", "fieldName": "closeOnEscape" }, { "name": "labelText", "type": { "text": "string" }, "default": "''", "description": "The text content of the label element.", "fieldName": "labelText" }, { "name": "stacked", "type": { "text": "boolean" }, "default": "false", "description": "Enables the stacked layout.", "fieldName": "stacked" }, { "name": "leading", "type": { "text": "boolean" }, "default": "false", "description": "Enables the leading layout.", "fieldName": "leading" } ], "superclass": { "name": "_SnackbarBase", "package": "@material/mwc-snackbar/mwc-snackbar-base" } } ], "exports": [ { "kind": "js", "name": "SnackbarBase", "declaration": { "name": "SnackbarBase", "module": "src/components/snackbar/snackbar-base.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/snackbar/snackbar.ts", "declarations": [ { "kind": "class", "description": "", "name": "Snackbar", "cssParts": [ { "description": "sets the z-index of the snackbar, default 8.", "name": "--bp-snackbar-z-index" } ], "slots": [ { "description": "Optional button which closes the snackbar with reason 'action'.", "name": "action" }, { "description": "Optional icon button which closes the snackbar with reason 'dismiss'.", "name": "dismiss" } ], "members": [ { "kind": "field", "name": "open", "type": { "text": "boolean" }, "default": "false", "description": "Whether the snackbar is currently open.", "attribute": "open", "inheritedFrom": { "name": "SnackbarBase", "module": "src/components/snackbar/snackbar-base.ts" } }, { "kind": "field", "name": "timeoutMs", "type": { "text": "number" }, "default": "5000", "description": "Automatic dismiss timeout in milliseconds. Value must be between 4000 and 10000 (or -1 to disable the timeout completely) or an error will be thrown. Defaults to 5000 (5 seconds).", "attribute": "timeoutMs", "inheritedFrom": { "name": "SnackbarBase", "module": "src/components/snackbar/snackbar-base.ts" } }, { "kind": "field", "name": "closeOnEscape", "type": { "text": "boolean" }, "default": "false", "description": "Whether the snackbar closes when it is focused and the user presses the ESC key. Defaults to false.", "attribute": "closeOnEscape", "inheritedFrom": { "name": "SnackbarBase", "module": "src/components/snackbar/snackbar-base.ts" } }, { "kind": "field", "name": "labelText", "type": { "text": "string" }, "default": "''", "description": "The text content of the label element.", "attribute": "labelText", "inheritedFrom": { "name": "SnackbarBase", "module": "src/components/snackbar/snackbar-base.ts" } }, { "kind": "field", "name": "stacked", "type": { "text": "boolean" }, "default": "false", "description": "Enables the stacked layout.", "attribute": "stacked", "inheritedFrom": { "name": "SnackbarBase", "module": "src/components/snackbar/snackbar-base.ts" } }, { "kind": "field", "name": "leading", "type": { "text": "boolean" }, "default": "false", "description": "Enables the leading layout.", "attribute": "leading", "inheritedFrom": { "name": "SnackbarBase", "module": "src/components/snackbar/snackbar-base.ts" } }, { "kind": "method", "name": "show", "return": { "type": { "text": "void" } }, "description": "Shows the snackbar.", "inheritedFrom": { "name": "SnackbarBase", "module": "src/components/snackbar/snackbar-base.ts" } }, { "kind": "method", "name": "close", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "reason", "optional": true, "type": { "text": "string | undefined" } } ], "description": "Hides the snackbar. Takes in optional `reason` string for clarifying the reason for closing.", "inheritedFrom": { "name": "SnackbarBase", "module": "src/components/snackbar/snackbar-base.ts" } }, { "kind": "method", "name": "emitOpeningHandler", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "SnackbarBase", "module": "src/components/snackbar/snackbar-base.ts" } }, { "kind": "method", "name": "emitOpenedHandler", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "SnackbarBase", "module": "src/components/snackbar/snackbar-base.ts" } }, { "kind": "method", "name": "emitClosingHandler", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "e", "type": { "text": "Event" } } ], "inheritedFrom": { "name": "SnackbarBase", "module": "src/components/snackbar/snackbar-base.ts" } }, { "kind": "method", "name": "emitClosedHandler", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "e", "type": { "text": "Event" } } ], "inheritedFrom": { "name": "SnackbarBase", "module": "src/components/snackbar/snackbar-base.ts" } } ], "events": [ { "description": "Fires when the snackbar starts to open.", "name": "bp-snackbar-opening", "reactName": "onBpSnackbarOpening" }, { "description": "Fires when the snackbar has opened.", "name": "bp-snackbar-opened", "reactName": "onBpSnackbarOpened" }, { "type": { "text": "reason?: string" }, "description": "Fires when the snackbar starts to close.", "name": "bp-snackbar-closing", "reactName": "onBpSnackbarClosing" }, { "type": { "text": "reason?: string" }, "description": "Fires when the snackbar has closed.", "name": "bp-snackbar-closed", "reactName": "onBpSnackbarClosed" } ], "superclass": { "name": "SnackbarBase", "module": "/src/components/snackbar/snackbar-base.js" }, "since": "0.1.1-beta.1", "status": "beta", "tagName": "bp-snackbar", "customElement": true, "attributes": [ { "name": "open", "type": { "text": "boolean" }, "default": "false", "description": "Whether the snackbar is currently open.", "fieldName": "open", "inheritedFrom": { "name": "SnackbarBase", "module": "src/components/snackbar/snackbar-base.ts" } }, { "name": "timeoutMs", "type": { "text": "number" }, "default": "5000", "description": "Automatic dismiss timeout in milliseconds. Value must be between 4000 and 10000 (or -1 to disable the timeout completely) or an error will be thrown. Defaults to 5000 (5 seconds).", "fieldName": "timeoutMs", "inheritedFrom": { "name": "SnackbarBase", "module": "src/components/snackbar/snackbar-base.ts" } }, { "name": "closeOnEscape", "type": { "text": "boolean" }, "default": "false", "description": "Whether the snackbar closes when it is focused and the user presses the ESC key. Defaults to false.", "fieldName": "closeOnEscape", "inheritedFrom": { "name": "SnackbarBase", "module": "src/components/snackbar/snackbar-base.ts" } }, { "name": "labelText", "type": { "text": "string" }, "default": "''", "description": "The text content of the label element.", "fieldName": "labelText", "inheritedFrom": { "name": "SnackbarBase", "module": "src/components/snackbar/snackbar-base.ts" } }, { "name": "stacked", "type": { "text": "boolean" }, "default": "false", "description": "Enables the stacked layout.", "fieldName": "stacked", "inheritedFrom": { "name": "SnackbarBase", "module": "src/components/snackbar/snackbar-base.ts" } }, { "name": "leading", "type": { "text": "boolean" }, "default": "false", "description": "Enables the leading layout.", "fieldName": "leading", "inheritedFrom": { "name": "SnackbarBase", "module": "src/components/snackbar/snackbar-base.ts" } } ] } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "Snackbar", "module": "src/components/snackbar/snackbar.ts" } }, { "kind": "custom-element-definition", "name": "bp-snackbar", "declaration": { "name": "Snackbar", "module": "src/components/snackbar/snackbar.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/stack/stack-base.ts", "declarations": [ { "kind": "class", "description": "", "name": "StackBase", "members": [ { "kind": "field", "name": "direction", "type": { "text": "| 'row'\n | 'row-reverse'\n | 'column'\n | 'column-reverse'" }, "default": "'column'", "description": "Direction of the flex for the stack.", "attribute": "direction" }, { "kind": "field", "name": "alignItems", "type": { "text": "| 'flex-start'\n | 'center'\n | 'flex-end'\n | 'stretch'\n | 'baseline'" }, "default": "'stretch'", "description": "Align items of the flex for the stack.", "attribute": "align-items" }, { "kind": "field", "name": "justifyContent", "type": { "text": "| 'flex-start'\n | 'center'\n | 'flex-end'\n | 'space-between'\n | 'space-around'\n | 'space-evenly'" }, "default": "'center'", "description": "Justify content of the flex for the stack.", "attribute": "justify-content" }, { "kind": "field", "name": "spacing", "type": { "text": "string" }, "default": "'8px'", "description": "Spacing between elements.", "attribute": "spacing" } ], "attributes": [ { "name": "direction", "type": { "text": "| 'row'\n | 'row-reverse'\n | 'column'\n | 'column-reverse'" }, "default": "'column'", "description": "Direction of the flex for the stack.", "fieldName": "direction" }, { "name": "align-items", "type": { "text": "| 'flex-start'\n | 'center'\n | 'flex-end'\n | 'stretch'\n | 'baseline'" }, "default": "'stretch'", "description": "Align items of the flex for the stack.", "fieldName": "alignItems" }, { "name": "justify-content", "type": { "text": "| 'flex-start'\n | 'center'\n | 'flex-end'\n | 'space-between'\n | 'space-around'\n | 'space-evenly'" }, "default": "'center'", "description": "Justify content of the flex for the stack.", "fieldName": "justifyContent" }, { "name": "spacing", "type": { "text": "string" }, "default": "'8px'", "description": "Spacing between elements.", "fieldName": "spacing" } ], "superclass": { "name": "LitElement", "package": "lit" }, "customElement": true } ], "exports": [ { "kind": "js", "name": "StackBase", "declaration": { "name": "StackBase", "module": "src/components/stack/stack-base.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/stack/stack.ts", "declarations": [ { "kind": "class", "description": "", "name": "Stack", "cssParts": [ { "description": "part for styling the stack's internal container.", "name": "base" }, { "description": "css variable for the top spacing of stack's children.", "name": "--bp-stack-margin-top" }, { "description": "css variable for the right spacing of stack's children.", "name": "--bp-stack-margin-right" }, { "description": "css variable for the bottom spacing of stack's children.", "name": "--bp-stack-margin-bottom" }, { "description": "css variable for the left spacing of stack's children.", "name": "--bp-stack-margin-left" } ], "slots": [ { "description": "Contains elements that the stack will flex.", "name": "" } ], "members": [ { "kind": "field", "name": "direction", "type": { "text": "| 'row'\n | 'row-reverse'\n | 'column'\n | 'column-reverse'" }, "default": "'column'", "description": "Direction of the flex for the stack.", "attribute": "direction", "inheritedFrom": { "name": "StackBase", "module": "src/components/stack/stack-base.ts" } }, { "kind": "field", "name": "alignItems", "type": { "text": "| 'flex-start'\n | 'center'\n | 'flex-end'\n | 'stretch'\n | 'baseline'" }, "default": "'stretch'", "description": "Align items of the flex for the stack.", "attribute": "align-items", "inheritedFrom": { "name": "StackBase", "module": "src/components/stack/stack-base.ts" } }, { "kind": "field", "name": "justifyContent", "type": { "text": "| 'flex-start'\n | 'center'\n | 'flex-end'\n | 'space-between'\n | 'space-around'\n | 'space-evenly'" }, "default": "'center'", "description": "Justify content of the flex for the stack.", "attribute": "justify-content", "inheritedFrom": { "name": "StackBase", "module": "src/components/stack/stack-base.ts" } }, { "kind": "field", "name": "spacing", "type": { "text": "string" }, "default": "'8px'", "description": "Spacing between elements.", "attribute": "spacing", "inheritedFrom": { "name": "StackBase", "module": "src/components/stack/stack-base.ts" } } ], "superclass": { "name": "StackBase", "module": "/src/components/stack/stack-base.js" }, "since": "1.0", "status": "Experimental", "tagName": "bp-stack", "customElement": true, "attributes": [ { "name": "direction", "type": { "text": "| 'row'\n | 'row-reverse'\n | 'column'\n | 'column-reverse'" }, "default": "'column'", "description": "Direction of the flex for the stack.", "fieldName": "direction", "inheritedFrom": { "name": "StackBase", "module": "src/components/stack/stack-base.ts" } }, { "name": "align-items", "type": { "text": "| 'flex-start'\n | 'center'\n | 'flex-end'\n | 'stretch'\n | 'baseline'" }, "default": "'stretch'", "description": "Align items of the flex for the stack.", "fieldName": "alignItems", "inheritedFrom": { "name": "StackBase", "module": "src/components/stack/stack-base.ts" } }, { "name": "justify-content", "type": { "text": "| 'flex-start'\n | 'center'\n | 'flex-end'\n | 'space-between'\n | 'space-around'\n | 'space-evenly'" }, "default": "'center'", "description": "Justify content of the flex for the stack.", "fieldName": "justifyContent", "inheritedFrom": { "name": "StackBase", "module": "src/components/stack/stack-base.ts" } }, { "name": "spacing", "type": { "text": "string" }, "default": "'8px'", "description": "Spacing between elements.", "fieldName": "spacing", "inheritedFrom": { "name": "StackBase", "module": "src/components/stack/stack-base.ts" } } ] } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "Stack", "module": "src/components/stack/stack.ts" } }, { "kind": "custom-element-definition", "name": "bp-stack", "declaration": { "name": "Stack", "module": "src/components/stack/stack.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/stepper-bar/stepper-bar-base.ts", "declarations": [ { "kind": "class", "description": "", "name": "StepperBarBase", "members": [ { "kind": "field", "name": "activeStep", "type": { "text": "number" }, "default": "0", "description": "The active step of the stepper.", "attribute": "activeStep" }, { "kind": "field", "name": "steps", "type": { "text": "StepperStep[]" }, "default": "[]" }, { "kind": "method", "name": "emit", "privacy": "protected", "parameters": [ { "name": "evt", "type": { "text": "string" } }, { "name": "detail", "optional": true, "type": { "text": "number" } } ] }, { "kind": "method", "name": "activateStep", "privacy": "public", "parameters": [ { "name": "index", "type": { "text": "number" } } ], "description": "Activates a step by its index." }, { "kind": "method", "name": "nextStep", "privacy": "public", "parameters": [ { "name": "wrap", "optional": true, "type": { "text": "boolean" } } ], "description": "Activates the next step." }, { "kind": "method", "name": "nextIncompleteStep", "privacy": "public", "parameters": [ { "name": "wrap", "optional": true, "type": { "text": "boolean" } } ], "description": "Activates the next step that is not complete." }, { "kind": "method", "name": "previousIncompleteStep", "privacy": "public", "parameters": [ { "name": "wrap", "optional": true, "type": { "text": "boolean" } } ], "description": "Activates the previous step that is not complete." }, { "kind": "method", "name": "previousStep", "privacy": "public", "parameters": [ { "name": "wrap", "optional": true, "type": { "text": "boolean" } } ], "description": "Activates the previous step." }, { "kind": "method", "name": "completeActiveStep", "privacy": "public", "description": "Completes the active step." }, { "kind": "method", "name": "incompleteActiveStep", "privacy": "public", "description": "Incompletes the active step." }, { "kind": "method", "name": "completeStep", "privacy": "public", "parameters": [ { "name": "index", "type": { "text": "number" } } ], "description": "Completes a step by its index." }, { "kind": "method", "name": "incompleteStep", "privacy": "public", "parameters": [ { "name": "index", "type": { "text": "number" } } ], "description": "Incompletes a step by its index." }, { "kind": "method", "name": "resetStepper", "privacy": "public", "description": "Resets the stepper's steps and sets the first step as active." } ], "events": [ { "name": "evtName", "type": { "text": "CustomEvent" }, "reactName": "onEvtName" } ], "attributes": [ { "name": "activeStep", "type": { "text": "number" }, "default": "0", "description": "The active step of the stepper.", "fieldName": "activeStep" } ], "superclass": { "name": "LitElement", "package": "lit" }, "customElement": true } ], "exports": [ { "kind": "js", "name": "StepperBarBase", "declaration": { "name": "StepperBarBase", "module": "src/components/stepper-bar/stepper-bar-base.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/stepper-bar/stepper-bar.ts", "declarations": [ { "kind": "class", "description": "", "name": "StepperBar", "slots": [ { "description": "The default slot is expected to contain stepper-step components.", "name": "" } ], "members": [ { "kind": "field", "name": "activeStep", "type": { "text": "number" }, "default": "0", "description": "The active step of the stepper.", "attribute": "activeStep", "inheritedFrom": { "name": "StepperBarBase", "module": "src/components/stepper-bar/stepper-bar-base.ts" } }, { "kind": "field", "name": "steps", "type": { "text": "StepperStep[]" }, "default": "[]", "inheritedFrom": { "name": "StepperBarBase", "module": "src/components/stepper-bar/stepper-bar-base.ts" } }, { "kind": "method", "name": "emit", "privacy": "protected", "parameters": [ { "name": "evt", "type": { "text": "string" } }, { "name": "detail", "optional": true, "type": { "text": "number" } } ], "inheritedFrom": { "name": "StepperBarBase", "module": "src/components/stepper-bar/stepper-bar-base.ts" } }, { "kind": "method", "name": "activateStep", "privacy": "public", "parameters": [ { "name": "index", "type": { "text": "number" } } ], "description": "Activates a step by its index.", "inheritedFrom": { "name": "StepperBarBase", "module": "src/components/stepper-bar/stepper-bar-base.ts" } }, { "kind": "method", "name": "nextStep", "privacy": "public", "parameters": [ { "name": "wrap", "optional": true, "type": { "text": "boolean" } } ], "description": "Activates the next step.", "inheritedFrom": { "name": "StepperBarBase", "module": "src/components/stepper-bar/stepper-bar-base.ts" } }, { "kind": "method", "name": "nextIncompleteStep", "privacy": "public", "parameters": [ { "name": "wrap", "optional": true, "type": { "text": "boolean" } } ], "description": "Activates the next step that is not complete.", "inheritedFrom": { "name": "StepperBarBase", "module": "src/components/stepper-bar/stepper-bar-base.ts" } }, { "kind": "method", "name": "previousIncompleteStep", "privacy": "public", "parameters": [ { "name": "wrap", "optional": true, "type": { "text": "boolean" } } ], "description": "Activates the previous step that is not complete.", "inheritedFrom": { "name": "StepperBarBase", "module": "src/components/stepper-bar/stepper-bar-base.ts" } }, { "kind": "method", "name": "previousStep", "privacy": "public", "parameters": [ { "name": "wrap", "optional": true, "type": { "text": "boolean" } } ], "description": "Activates the previous step.", "inheritedFrom": { "name": "StepperBarBase", "module": "src/components/stepper-bar/stepper-bar-base.ts" } }, { "kind": "method", "name": "completeActiveStep", "privacy": "public", "description": "Completes the active step.", "inheritedFrom": { "name": "StepperBarBase", "module": "src/components/stepper-bar/stepper-bar-base.ts" } }, { "kind": "method", "name": "incompleteActiveStep", "privacy": "public", "description": "Incompletes the active step.", "inheritedFrom": { "name": "StepperBarBase", "module": "src/components/stepper-bar/stepper-bar-base.ts" } }, { "kind": "method", "name": "completeStep", "privacy": "public", "parameters": [ { "name": "index", "type": { "text": "number" } } ], "description": "Completes a step by its index.", "inheritedFrom": { "name": "StepperBarBase", "module": "src/components/stepper-bar/stepper-bar-base.ts" } }, { "kind": "method", "name": "incompleteStep", "privacy": "public", "parameters": [ { "name": "index", "type": { "text": "number" } } ], "description": "Incompletes a step by its index.", "inheritedFrom": { "name": "StepperBarBase", "module": "src/components/stepper-bar/stepper-bar-base.ts" } }, { "kind": "method", "name": "resetStepper", "privacy": "public", "description": "Resets the stepper's steps and sets the first step as active.", "inheritedFrom": { "name": "StepperBarBase", "module": "src/components/stepper-bar/stepper-bar-base.ts" } } ], "events": [ { "type": { "text": "number" }, "description": "Emitted when a step is activated. The detail includes the step's index.", "name": "bp-stepper-bar-step-activated", "reactName": "onBpStepperBarStepActivated" }, { "type": { "text": "number" }, "description": "Emitted when a step is completed. The detail includes the step's index.", "name": "bp-stepper-bar-step-completed", "reactName": "onBpStepperBarStepCompleted" }, { "description": "Emitted when the stepper-bar is reset.", "name": "bp-stepper-bar-reset", "reactName": "onBpStepperBarReset" }, { "name": "evtName", "type": { "text": "CustomEvent" }, "reactName": "onEvtName", "inheritedFrom": { "name": "StepperBarBase", "module": "src/components/stepper-bar/stepper-bar-base.ts" } } ], "superclass": { "name": "StepperBarBase", "module": "/src/components/stepper-bar/stepper-bar-base.js" }, "since": "1.0", "status": "Experimental", "tagName": "bp-stepper-bar", "customElement": true, "attributes": [ { "name": "activeStep", "type": { "text": "number" }, "default": "0", "description": "The active step of the stepper.", "fieldName": "activeStep", "inheritedFrom": { "name": "StepperBarBase", "module": "src/components/stepper-bar/stepper-bar-base.ts" } } ] } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "StepperBar", "module": "src/components/stepper-bar/stepper-bar.ts" } }, { "kind": "custom-element-definition", "name": "bp-stepper-bar", "declaration": { "name": "StepperBar", "module": "src/components/stepper-bar/stepper-bar.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/stepper-group/stepper-group-base.ts", "declarations": [ { "kind": "class", "description": "", "name": "StepperGroupBase", "members": [ { "kind": "field", "name": "stepperBar", "type": { "text": "StepperBar | undefined" } }, { "kind": "field", "name": "stepperPanels", "type": { "text": "StepperPanel[]" }, "default": "[]" }, { "kind": "field", "name": "incompleteSteps", "type": { "text": "StepperStep[]" }, "default": "[]" }, { "kind": "method", "name": "activatePanel", "privacy": "public", "parameters": [ { "name": "index", "type": { "text": "number" } } ] }, { "kind": "method", "name": "nextStep", "privacy": "public", "description": "Navigates to the next step." }, { "kind": "method", "name": "previousStep", "privacy": "public", "description": "Navigates to the previous step." }, { "kind": "method", "name": "completeActiveStep", "privacy": "public", "description": "Completes the step and navigates to the next step if it exists." } ], "superclass": { "name": "LitElement", "package": "lit" }, "customElement": true } ], "exports": [ { "kind": "js", "name": "StepperGroupBase", "declaration": { "name": "StepperGroupBase", "module": "src/components/stepper-group/stepper-group-base.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/stepper-group/stepper-group.ts", "declarations": [ { "kind": "class", "description": "", "name": "StepperGroup", "slots": [ { "description": "The default slot is expected to contain a stepper-bar (with stepper-steps) and corresponding stepper-panels.", "name": "" } ], "members": [ { "kind": "field", "name": "stepperBar", "type": { "text": "StepperBar | undefined" }, "inheritedFrom": { "name": "StepperGroupBase", "module": "src/components/stepper-group/stepper-group-base.ts" } }, { "kind": "field", "name": "stepperPanels", "type": { "text": "StepperPanel[]" }, "default": "[]", "inheritedFrom": { "name": "StepperGroupBase", "module": "src/components/stepper-group/stepper-group-base.ts" } }, { "kind": "field", "name": "incompleteSteps", "type": { "text": "StepperStep[]" }, "default": "[]", "inheritedFrom": { "name": "StepperGroupBase", "module": "src/components/stepper-group/stepper-group-base.ts" } }, { "kind": "method", "name": "activatePanel", "privacy": "public", "parameters": [ { "name": "index", "type": { "text": "number" } } ], "inheritedFrom": { "name": "StepperGroupBase", "module": "src/components/stepper-group/stepper-group-base.ts" } }, { "kind": "method", "name": "nextStep", "privacy": "public", "description": "Navigates to the next step.", "inheritedFrom": { "name": "StepperGroupBase", "module": "src/components/stepper-group/stepper-group-base.ts" } }, { "kind": "method", "name": "previousStep", "privacy": "public", "description": "Navigates to the previous step.", "inheritedFrom": { "name": "StepperGroupBase", "module": "src/components/stepper-group/stepper-group-base.ts" } }, { "kind": "method", "name": "completeActiveStep", "privacy": "public", "description": "Completes the step and navigates to the next step if it exists.", "inheritedFrom": { "name": "StepperGroupBase", "module": "src/components/stepper-group/stepper-group-base.ts" } } ], "superclass": { "name": "StepperGroupBase", "module": "/src/components/stepper-group/stepper-group-base.js" }, "since": "1.0", "status": "Experimental", "tagName": "bp-stepper-group", "customElement": true } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "StepperGroup", "module": "src/components/stepper-group/stepper-group.ts" } }, { "kind": "custom-element-definition", "name": "bp-stepper-group", "declaration": { "name": "StepperGroup", "module": "src/components/stepper-group/stepper-group.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/stepper-panel/stepper-panel-base.ts", "declarations": [ { "kind": "class", "description": "", "name": "StepperPanelBase", "members": [ { "kind": "field", "name": "hidden", "type": { "text": "boolean" }, "default": "false", "description": "Whether this tab is hidden or not.", "attribute": "hidden" } ], "attributes": [ { "name": "hidden", "type": { "text": "boolean" }, "default": "false", "description": "Whether this tab is hidden or not.", "fieldName": "hidden" } ], "superclass": { "name": "LitElement", "package": "lit" }, "customElement": true } ], "exports": [ { "kind": "js", "name": "StepperPanelBase", "declaration": { "name": "StepperPanelBase", "module": "src/components/stepper-panel/stepper-panel-base.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/stepper-panel/stepper-panel.ts", "declarations": [ { "kind": "class", "description": "", "name": "StepperPanel", "cssParts": [ { "description": "The component's internal wrapper.", "name": "base" } ], "slots": [ { "description": "The default slot.", "name": "" }, { "description": "A specific slot.", "name": "specific-slot" } ], "members": [ { "kind": "field", "name": "hidden", "type": { "text": "boolean" }, "default": "false", "description": "Whether this tab is hidden or not.", "attribute": "hidden", "inheritedFrom": { "name": "StepperPanelBase", "module": "src/components/stepper-panel/stepper-panel-base.ts" } } ], "events": [ { "type": { "text": "detail: number" }, "description": "Emitted whenever.", "name": "bpda-component-event", "reactName": "onBpdaComponentEvent" } ], "superclass": { "name": "StepperPanelBase", "module": "/src/components/stepper-panel/stepper-panel-base.js" }, "since": "1.0", "status": "Experimental", "dependencies": [ "bp-component" ], "tagName": "bp-stepper-panel", "customElement": true, "attributes": [ { "name": "hidden", "type": { "text": "boolean" }, "default": "false", "description": "Whether this tab is hidden or not.", "fieldName": "hidden", "inheritedFrom": { "name": "StepperPanelBase", "module": "src/components/stepper-panel/stepper-panel-base.ts" } } ] } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "StepperPanel", "module": "src/components/stepper-panel/stepper-panel.ts" } }, { "kind": "custom-element-definition", "name": "bp-stepper-panel", "declaration": { "name": "StepperPanel", "module": "src/components/stepper-panel/stepper-panel.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/stepper-step/stepper-step-base.ts", "declarations": [ { "kind": "class", "description": "", "name": "StepperStepBase", "members": [ { "kind": "field", "name": "stepNumber", "type": { "text": "number" }, "default": "1", "description": "Order (index + 1) of the step.", "attribute": "stepNumber" }, { "kind": "field", "name": "completed", "type": { "text": "boolean" }, "default": "false", "description": "Whether the step is completed or not.", "attribute": "completed" }, { "kind": "field", "name": "active", "type": { "text": "boolean" }, "default": "false", "description": "Whether the step is active or not.", "attribute": "active" }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Whether the step is disabled or not.", "attribute": "disabled" }, { "kind": "method", "name": "emit", "privacy": "private" }, { "kind": "method", "name": "setupRipple", "privacy": "private" } ], "events": [ { "name": "bp-stepper-step-clicked", "type": { "text": "CustomEvent" }, "reactName": "onBpStepperStepClicked" } ], "attributes": [ { "name": "stepNumber", "type": { "text": "number" }, "default": "1", "description": "Order (index + 1) of the step.", "fieldName": "stepNumber" }, { "name": "completed", "type": { "text": "boolean" }, "default": "false", "description": "Whether the step is completed or not.", "fieldName": "completed" }, { "name": "active", "type": { "text": "boolean" }, "default": "false", "description": "Whether the step is active or not.", "fieldName": "active" }, { "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Whether the step is disabled or not.", "fieldName": "disabled" } ], "superclass": { "name": "LitElement", "package": "lit" }, "customElement": true } ], "exports": [ { "kind": "js", "name": "StepperStepBase", "declaration": { "name": "StepperStepBase", "module": "src/components/stepper-step/stepper-step-base.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/stepper-step/stepper-step.ts", "declarations": [ { "kind": "class", "description": "", "name": "StepperStep", "cssProperties": [ { "description": "The number's cricle's padding.", "name": "--bp-stepper-step-padding" } ], "slots": [ { "description": "Default slot contains the step's label.", "name": "" } ], "members": [ { "kind": "field", "name": "stepNumber", "type": { "text": "number" }, "default": "1", "description": "Order (index + 1) of the step.", "attribute": "stepNumber", "inheritedFrom": { "name": "StepperStepBase", "module": "src/components/stepper-step/stepper-step-base.ts" } }, { "kind": "field", "name": "completed", "type": { "text": "boolean" }, "default": "false", "description": "Whether the step is completed or not.", "attribute": "completed", "inheritedFrom": { "name": "StepperStepBase", "module": "src/components/stepper-step/stepper-step-base.ts" } }, { "kind": "field", "name": "active", "type": { "text": "boolean" }, "default": "false", "description": "Whether the step is active or not.", "attribute": "active", "inheritedFrom": { "name": "StepperStepBase", "module": "src/components/stepper-step/stepper-step-base.ts" } }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Whether the step is disabled or not.", "attribute": "disabled", "inheritedFrom": { "name": "StepperStepBase", "module": "src/components/stepper-step/stepper-step-base.ts" } }, { "kind": "method", "name": "emit", "privacy": "private", "inheritedFrom": { "name": "StepperStepBase", "module": "src/components/stepper-step/stepper-step-base.ts" } }, { "kind": "method", "name": "setupRipple", "privacy": "private", "inheritedFrom": { "name": "StepperStepBase", "module": "src/components/stepper-step/stepper-step-base.ts" } } ], "events": [ { "name": "bp-stepper-step-clicked", "type": { "text": "CustomEvent" }, "reactName": "onBpStepperStepClicked", "description": "Emitted when the step is clicked.", "inheritedFrom": { "name": "StepperStepBase", "module": "src/components/stepper-step/stepper-step-base.ts" } } ], "superclass": { "name": "StepperStepBase", "module": "/src/components/stepper-step/stepper-step-base.js" }, "since": "1.0", "status": "Experimental", "tagName": "bp-stepper-step", "customElement": true, "attributes": [ { "name": "stepNumber", "type": { "text": "number" }, "default": "1", "description": "Order (index + 1) of the step.", "fieldName": "stepNumber", "inheritedFrom": { "name": "StepperStepBase", "module": "src/components/stepper-step/stepper-step-base.ts" } }, { "name": "completed", "type": { "text": "boolean" }, "default": "false", "description": "Whether the step is completed or not.", "fieldName": "completed", "inheritedFrom": { "name": "StepperStepBase", "module": "src/components/stepper-step/stepper-step-base.ts" } }, { "name": "active", "type": { "text": "boolean" }, "default": "false", "description": "Whether the step is active or not.", "fieldName": "active", "inheritedFrom": { "name": "StepperStepBase", "module": "src/components/stepper-step/stepper-step-base.ts" } }, { "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Whether the step is disabled or not.", "fieldName": "disabled", "inheritedFrom": { "name": "StepperStepBase", "module": "src/components/stepper-step/stepper-step-base.ts" } } ] } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "StepperStep", "module": "src/components/stepper-step/stepper-step.ts" } }, { "kind": "custom-element-definition", "name": "bp-stepper-step", "declaration": { "name": "StepperStep", "module": "src/components/stepper-step/stepper-step.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/switch/switch-base.ts", "declarations": [ { "kind": "class", "description": "", "name": "SwitchBase", "members": [ { "kind": "field", "name": "formSubmitController", "privacy": "private", "default": "new FormSubmitController(this, {\n value: (control: SwitchBase) =>\n control.selected ? control.value || 'on' : undefined,\n defaultValue: (control: SwitchBase) => control.defaultSelected,\n setValue: (control: SwitchBase, selected: boolean) =>\n (control.selected = selected),\n })" }, { "kind": "field", "name": "selected", "type": { "text": "boolean" }, "default": "false", "description": "Whether the switch is selected or not.", "attribute": "selected" }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Whether the switch is disabled or not.", "attribute": "disabled" }, { "kind": "field", "name": "color", "type": { "text": "| 'primary'\n | 'success'\n | 'warning'\n | 'error'\n | 'info'" }, "default": "'primary'", "description": "The color of the switch.", "attribute": "color" }, { "kind": "field", "name": "name", "type": { "text": "string" }, "default": "''", "description": "Name of the switch (for form control).", "attribute": "name" }, { "kind": "field", "name": "value", "type": { "text": "string" }, "default": "''", "description": "Value of the switch (for form control).", "attribute": "value" }, { "kind": "field", "name": "defaultSelected" }, { "kind": "method", "name": "select", "description": "Selects switch." }, { "kind": "method", "name": "deselect", "description": "Deselects switch." }, { "kind": "method", "name": "toggle", "description": "Toggles switch." }, { "kind": "method", "name": "emit", "parameters": [ { "name": "event", "type": { "text": "'selected' | 'deselected'" } } ] } ], "events": [ { "name": "bp-switch-changed", "type": { "text": "CustomEvent" }, "reactName": "onBpSwitchChanged" }, { "name": "eventName", "type": { "text": "CustomEvent" }, "reactName": "onEventName" } ], "attributes": [ { "name": "selected", "type": { "text": "boolean" }, "default": "false", "description": "Whether the switch is selected or not.", "fieldName": "selected" }, { "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Whether the switch is disabled or not.", "fieldName": "disabled" }, { "name": "color", "type": { "text": "| 'primary'\n | 'success'\n | 'warning'\n | 'error'\n | 'info'" }, "default": "'primary'", "description": "The color of the switch.", "fieldName": "color" }, { "name": "name", "type": { "text": "string" }, "default": "''", "description": "Name of the switch (for form control).", "fieldName": "name" }, { "name": "value", "type": { "text": "string" }, "default": "''", "description": "Value of the switch (for form control).", "fieldName": "value" } ], "superclass": { "name": "LitElement", "package": "lit" }, "customElement": true } ], "exports": [ { "kind": "js", "name": "SwitchBase", "declaration": { "name": "SwitchBase", "module": "src/components/switch/switch-base.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/switch/switch.ts", "declarations": [ { "kind": "class", "description": "", "name": "Switch", "members": [ { "kind": "field", "name": "formSubmitController", "privacy": "private", "default": "new FormSubmitController(this, {\n value: (control: SwitchBase) =>\n control.selected ? control.value || 'on' : undefined,\n defaultValue: (control: SwitchBase) => control.defaultSelected,\n setValue: (control: SwitchBase, selected: boolean) =>\n (control.selected = selected),\n })", "inheritedFrom": { "name": "SwitchBase", "module": "src/components/switch/switch-base.ts" } }, { "kind": "field", "name": "selected", "type": { "text": "boolean" }, "default": "false", "description": "Whether the switch is selected or not.", "attribute": "selected", "inheritedFrom": { "name": "SwitchBase", "module": "src/components/switch/switch-base.ts" } }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Whether the switch is disabled or not.", "attribute": "disabled", "inheritedFrom": { "name": "SwitchBase", "module": "src/components/switch/switch-base.ts" } }, { "kind": "field", "name": "color", "type": { "text": "| 'primary'\n | 'success'\n | 'warning'\n | 'error'\n | 'info'" }, "default": "'primary'", "description": "The color of the switch.", "attribute": "color", "inheritedFrom": { "name": "SwitchBase", "module": "src/components/switch/switch-base.ts" } }, { "kind": "field", "name": "name", "type": { "text": "string" }, "default": "''", "description": "Name of the switch (for form control).", "attribute": "name", "inheritedFrom": { "name": "SwitchBase", "module": "src/components/switch/switch-base.ts" } }, { "kind": "field", "name": "value", "type": { "text": "string" }, "default": "''", "description": "Value of the switch (for form control).", "attribute": "value", "inheritedFrom": { "name": "SwitchBase", "module": "src/components/switch/switch-base.ts" } }, { "kind": "field", "name": "defaultSelected", "inheritedFrom": { "name": "SwitchBase", "module": "src/components/switch/switch-base.ts" } }, { "kind": "method", "name": "select", "description": "Selects switch.", "inheritedFrom": { "name": "SwitchBase", "module": "src/components/switch/switch-base.ts" } }, { "kind": "method", "name": "deselect", "description": "Deselects switch.", "inheritedFrom": { "name": "SwitchBase", "module": "src/components/switch/switch-base.ts" } }, { "kind": "method", "name": "toggle", "description": "Toggles switch.", "inheritedFrom": { "name": "SwitchBase", "module": "src/components/switch/switch-base.ts" } }, { "kind": "method", "name": "emit", "parameters": [ { "name": "event", "type": { "text": "'selected' | 'deselected'" } } ], "inheritedFrom": { "name": "SwitchBase", "module": "src/components/switch/switch-base.ts" } } ], "events": [ { "name": "bp-switch-changed", "type": { "text": "CustomEvent" }, "reactName": "onBpSwitchChanged", "description": "Global event, emitted whenever the switch changes state.", "inheritedFrom": { "name": "SwitchBase", "module": "src/components/switch/switch-base.ts" } }, { "description": "Emitted whenever the switch is selected.", "name": "bp-switch-selected", "reactName": "onBpSwitchSelected" }, { "description": "Emitted whenever the switch is deselected.", "name": "bp-switch-deselected", "reactName": "onBpSwitchDeselected" }, { "name": "eventName", "type": { "text": "CustomEvent" }, "reactName": "onEventName", "inheritedFrom": { "name": "SwitchBase", "module": "src/components/switch/switch-base.ts" } } ], "superclass": { "name": "SwitchBase", "module": "/src/components/switch/switch-base.js" }, "since": "1.0", "status": "Experimental", "tagName": "bp-switch", "customElement": true, "attributes": [ { "name": "selected", "type": { "text": "boolean" }, "default": "false", "description": "Whether the switch is selected or not.", "fieldName": "selected", "inheritedFrom": { "name": "SwitchBase", "module": "src/components/switch/switch-base.ts" } }, { "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Whether the switch is disabled or not.", "fieldName": "disabled", "inheritedFrom": { "name": "SwitchBase", "module": "src/components/switch/switch-base.ts" } }, { "name": "color", "type": { "text": "| 'primary'\n | 'success'\n | 'warning'\n | 'error'\n | 'info'" }, "default": "'primary'", "description": "The color of the switch.", "fieldName": "color", "inheritedFrom": { "name": "SwitchBase", "module": "src/components/switch/switch-base.ts" } }, { "name": "name", "type": { "text": "string" }, "default": "''", "description": "Name of the switch (for form control).", "fieldName": "name", "inheritedFrom": { "name": "SwitchBase", "module": "src/components/switch/switch-base.ts" } }, { "name": "value", "type": { "text": "string" }, "default": "''", "description": "Value of the switch (for form control).", "fieldName": "value", "inheritedFrom": { "name": "SwitchBase", "module": "src/components/switch/switch-base.ts" } } ] } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "Switch", "module": "src/components/switch/switch.ts" } }, { "kind": "custom-element-definition", "name": "bp-switch", "declaration": { "name": "Switch", "module": "src/components/switch/switch.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/tab/tab-base.ts", "declarations": [ { "kind": "class", "description": "", "name": "TabBase", "members": [ { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "Text label to display in tab.", "attribute": "label" }, { "kind": "field", "name": "icon", "type": { "text": "string" }, "default": "''", "description": "Material design icon name to display.", "attribute": "icon" }, { "kind": "field", "name": "hasImageIcon", "type": { "text": "boolean" }, "default": "false", "description": "Displays a slot to show an image icon.", "attribute": "hasImageIcon" }, { "kind": "field", "name": "stacked", "type": { "text": "boolean" }, "default": "false", "description": "Stacks icon on top of label text.", "attribute": "stacked" }, { "kind": "field", "name": "minWidth", "type": { "text": "boolean" }, "default": "false", "description": "Shrinks tab as narrow as possible without causing text to wrap.", "attribute": "minWidth" }, { "kind": "field", "name": "isFadingIndicator", "type": { "text": "boolean" }, "default": "false", "description": "Indicator fades in and out instead of sliding.", "attribute": "isFadingIndicator" }, { "kind": "field", "name": "isMinWidthIndicator", "type": { "text": "boolean" }, "default": "false", "description": "Shrinks indicator to be the size of the content.", "attribute": "isMinWidthIndicator" }, { "kind": "field", "name": "indicatorIcon", "type": { "text": "string" }, "default": "''", "description": "Material design icon name to display as the indicator.", "attribute": "indicatorIcon" } ], "attributes": [ { "name": "label", "type": { "text": "string" }, "default": "''", "description": "Text label to display in tab.", "fieldName": "label" }, { "name": "icon", "type": { "text": "string" }, "default": "''", "description": "Material design icon name to display.", "fieldName": "icon" }, { "name": "hasImageIcon", "type": { "text": "boolean" }, "default": "false", "description": "Displays a slot to show an image icon.", "fieldName": "hasImageIcon" }, { "name": "stacked", "type": { "text": "boolean" }, "default": "false", "description": "Stacks icon on top of label text.", "fieldName": "stacked" }, { "name": "minWidth", "type": { "text": "boolean" }, "default": "false", "description": "Shrinks tab as narrow as possible without causing text to wrap.", "fieldName": "minWidth" }, { "name": "isFadingIndicator", "type": { "text": "boolean" }, "default": "false", "description": "Indicator fades in and out instead of sliding.", "fieldName": "isFadingIndicator" }, { "name": "isMinWidthIndicator", "type": { "text": "boolean" }, "default": "false", "description": "Shrinks indicator to be the size of the content.", "fieldName": "isMinWidthIndicator" }, { "name": "indicatorIcon", "type": { "text": "string" }, "default": "''", "description": "Material design icon name to display as the indicator.", "fieldName": "indicatorIcon" } ], "superclass": { "name": "_TabBase", "package": "@material/mwc-tab/mwc-tab-base.js" } } ], "exports": [ { "kind": "js", "name": "TabBase", "declaration": { "name": "TabBase", "module": "src/components/tab/tab-base.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/tab/tab.ts", "declarations": [ { "kind": "class", "description": "", "name": "Tab", "members": [ { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "Text label to display in tab.", "attribute": "label", "inheritedFrom": { "name": "TabBase", "module": "src/components/tab/tab-base.ts" } }, { "kind": "field", "name": "icon", "type": { "text": "string" }, "default": "''", "description": "Material design icon name to display.", "attribute": "icon", "inheritedFrom": { "name": "TabBase", "module": "src/components/tab/tab-base.ts" } }, { "kind": "field", "name": "hasImageIcon", "type": { "text": "boolean" }, "default": "false", "description": "Displays a slot to show an image icon.", "attribute": "hasImageIcon", "inheritedFrom": { "name": "TabBase", "module": "src/components/tab/tab-base.ts" } }, { "kind": "field", "name": "stacked", "type": { "text": "boolean" }, "default": "false", "description": "Stacks icon on top of label text.", "attribute": "stacked", "inheritedFrom": { "name": "TabBase", "module": "src/components/tab/tab-base.ts" } }, { "kind": "field", "name": "minWidth", "type": { "text": "boolean" }, "default": "false", "description": "Shrinks tab as narrow as possible without causing text to wrap.", "attribute": "minWidth", "inheritedFrom": { "name": "TabBase", "module": "src/components/tab/tab-base.ts" } }, { "kind": "field", "name": "isFadingIndicator", "type": { "text": "boolean" }, "default": "false", "description": "Indicator fades in and out instead of sliding.", "attribute": "isFadingIndicator", "inheritedFrom": { "name": "TabBase", "module": "src/components/tab/tab-base.ts" } }, { "kind": "field", "name": "isMinWidthIndicator", "type": { "text": "boolean" }, "default": "false", "description": "Shrinks indicator to be the size of the content.", "attribute": "isMinWidthIndicator", "inheritedFrom": { "name": "TabBase", "module": "src/components/tab/tab-base.ts" } }, { "kind": "field", "name": "indicatorIcon", "type": { "text": "string" }, "default": "''", "description": "Material design icon name to display as the indicator.", "attribute": "indicatorIcon", "inheritedFrom": { "name": "TabBase", "module": "src/components/tab/tab-base.ts" } } ], "events": [ { "description": "Emitted when the tab is selected.", "name": "bp-tab-selected", "reactName": "onBpTabSelected" } ], "superclass": { "name": "TabBase", "module": "/src/components/tab/tab-base.js" }, "since": "0.1.1-beta.1", "status": "beta", "tagName": "bp-tab", "customElement": true, "attributes": [ { "name": "label", "type": { "text": "string" }, "default": "''", "description": "Text label to display in tab.", "fieldName": "label", "inheritedFrom": { "name": "TabBase", "module": "src/components/tab/tab-base.ts" } }, { "name": "icon", "type": { "text": "string" }, "default": "''", "description": "Material design icon name to display.", "fieldName": "icon", "inheritedFrom": { "name": "TabBase", "module": "src/components/tab/tab-base.ts" } }, { "name": "hasImageIcon", "type": { "text": "boolean" }, "default": "false", "description": "Displays a slot to show an image icon.", "fieldName": "hasImageIcon", "inheritedFrom": { "name": "TabBase", "module": "src/components/tab/tab-base.ts" } }, { "name": "stacked", "type": { "text": "boolean" }, "default": "false", "description": "Stacks icon on top of label text.", "fieldName": "stacked", "inheritedFrom": { "name": "TabBase", "module": "src/components/tab/tab-base.ts" } }, { "name": "minWidth", "type": { "text": "boolean" }, "default": "false", "description": "Shrinks tab as narrow as possible without causing text to wrap.", "fieldName": "minWidth", "inheritedFrom": { "name": "TabBase", "module": "src/components/tab/tab-base.ts" } }, { "name": "isFadingIndicator", "type": { "text": "boolean" }, "default": "false", "description": "Indicator fades in and out instead of sliding.", "fieldName": "isFadingIndicator", "inheritedFrom": { "name": "TabBase", "module": "src/components/tab/tab-base.ts" } }, { "name": "isMinWidthIndicator", "type": { "text": "boolean" }, "default": "false", "description": "Shrinks indicator to be the size of the content.", "fieldName": "isMinWidthIndicator", "inheritedFrom": { "name": "TabBase", "module": "src/components/tab/tab-base.ts" } }, { "name": "indicatorIcon", "type": { "text": "string" }, "default": "''", "description": "Material design icon name to display as the indicator.", "fieldName": "indicatorIcon", "inheritedFrom": { "name": "TabBase", "module": "src/components/tab/tab-base.ts" } } ] } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "Tab", "module": "src/components/tab/tab.ts" } }, { "kind": "custom-element-definition", "name": "bp-tab", "declaration": { "name": "Tab", "module": "src/components/tab/tab.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/tab-bar/tab-bar-base.ts", "declarations": [ { "kind": "class", "description": "", "name": "TabBarBase", "members": [ { "kind": "field", "name": "activeIndex", "type": { "text": "number" }, "default": "0", "description": "Index of tab that is active.", "attribute": "activeIndex" }, { "kind": "field", "name": "color", "type": { "text": "| 'primary'\n | 'success'\n | 'warning'\n | 'error'\n | 'info'" }, "default": "'primary'", "description": "Accent color of the tabs in the tab bar.", "attribute": "color" } ], "attributes": [ { "name": "activeIndex", "type": { "text": "number" }, "default": "0", "description": "Index of tab that is active.", "fieldName": "activeIndex" }, { "name": "color", "type": { "text": "| 'primary'\n | 'success'\n | 'warning'\n | 'error'\n | 'info'" }, "default": "'primary'", "description": "Accent color of the tabs in the tab bar.", "fieldName": "color" } ], "superclass": { "name": "_TabBarBase", "package": "@material/mwc-tab-bar/mwc-tab-bar-base.js" } } ], "exports": [ { "kind": "js", "name": "TabBarBase", "declaration": { "name": "TabBarBase", "module": "src/components/tab-bar/tab-bar-base.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/tab-bar/tab-bar.ts", "declarations": [ { "kind": "class", "description": "", "name": "TabBar", "slots": [ { "description": "Default slot for bp-tab children.", "name": "" } ], "members": [ { "kind": "field", "name": "activeIndex", "type": { "text": "number" }, "default": "0", "description": "Index of tab that is active.", "attribute": "activeIndex", "inheritedFrom": { "name": "TabBarBase", "module": "src/components/tab-bar/tab-bar-base.ts" } }, { "kind": "field", "name": "color", "type": { "text": "| 'primary'\n | 'success'\n | 'warning'\n | 'error'\n | 'info'" }, "default": "'primary'", "description": "Accent color of the tabs in the tab bar.", "attribute": "color", "inheritedFrom": { "name": "TabBarBase", "module": "src/components/tab-bar/tab-bar-base.ts" } } ], "events": [ { "type": { "text": "index: number" }, "description": "Emitted when a tab is selected.", "name": "bp-tab-bar-tab-selected", "reactName": "onBpTabBarTabSelected" } ], "superclass": { "name": "TabBarBase", "module": "/src/components/tab-bar/tab-bar-base.js" }, "since": "0.1.1-beta.1", "status": "beta", "dependencies": [ "bp-tab" ], "tagName": "bp-tab-bar", "customElement": true, "attributes": [ { "name": "activeIndex", "type": { "text": "number" }, "default": "0", "description": "Index of tab that is active.", "fieldName": "activeIndex", "inheritedFrom": { "name": "TabBarBase", "module": "src/components/tab-bar/tab-bar-base.ts" } }, { "name": "color", "type": { "text": "| 'primary'\n | 'success'\n | 'warning'\n | 'error'\n | 'info'" }, "default": "'primary'", "description": "Accent color of the tabs in the tab bar.", "fieldName": "color", "inheritedFrom": { "name": "TabBarBase", "module": "src/components/tab-bar/tab-bar-base.ts" } } ] } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "TabBar", "module": "src/components/tab-bar/tab-bar.ts" } }, { "kind": "custom-element-definition", "name": "bp-tab-bar", "declaration": { "name": "TabBar", "module": "src/components/tab-bar/tab-bar.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/tab-group/tab-group-base.ts", "declarations": [ { "kind": "class", "description": "", "name": "TabGroupBase", "members": [ { "kind": "field", "name": "tabPanels", "type": { "text": "NodeListOf | null" } }, { "kind": "field", "name": "tabBar", "type": { "text": "TabBar | null" } }, { "kind": "field", "name": "activeTab", "type": { "text": "number" }, "default": "0", "description": "The active tab of the Tab Group", "attribute": "active-tab" }, { "kind": "field", "name": "prevActiveTab", "type": { "text": "number" }, "default": "0" }, { "kind": "field", "name": "changeTab" }, { "kind": "field", "name": "deselectPreviousTab" }, { "kind": "field", "name": "selectNewTab" }, { "kind": "field", "name": "setupTabs" } ], "attributes": [ { "name": "active-tab", "type": { "text": "number" }, "default": "0", "description": "The active tab of the Tab Group", "fieldName": "activeTab" } ], "superclass": { "name": "LitElement", "package": "lit" }, "customElement": true } ], "exports": [ { "kind": "js", "name": "TabGroupBase", "declaration": { "name": "TabGroupBase", "module": "src/components/tab-group/tab-group-base.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/tab-group/tab-group.ts", "declarations": [ { "kind": "class", "description": "", "name": "TabGroup", "slots": [ { "description": "Slot for the bp-tab-panels.", "name": "" }, { "description": "Slot specifically for the bp-tab-bar component.", "name": "tab-bar" } ], "members": [ { "kind": "field", "name": "tabPanels", "type": { "text": "NodeListOf | null" }, "inheritedFrom": { "name": "TabGroupBase", "module": "src/components/tab-group/tab-group-base.ts" } }, { "kind": "field", "name": "tabBar", "type": { "text": "TabBar | null" }, "inheritedFrom": { "name": "TabGroupBase", "module": "src/components/tab-group/tab-group-base.ts" } }, { "kind": "field", "name": "activeTab", "type": { "text": "number" }, "default": "0", "description": "The active tab of the Tab Group", "attribute": "active-tab", "inheritedFrom": { "name": "TabGroupBase", "module": "src/components/tab-group/tab-group-base.ts" } }, { "kind": "field", "name": "prevActiveTab", "type": { "text": "number" }, "default": "0", "inheritedFrom": { "name": "TabGroupBase", "module": "src/components/tab-group/tab-group-base.ts" } }, { "kind": "field", "name": "changeTab", "inheritedFrom": { "name": "TabGroupBase", "module": "src/components/tab-group/tab-group-base.ts" } }, { "kind": "field", "name": "deselectPreviousTab", "inheritedFrom": { "name": "TabGroupBase", "module": "src/components/tab-group/tab-group-base.ts" } }, { "kind": "field", "name": "selectNewTab", "inheritedFrom": { "name": "TabGroupBase", "module": "src/components/tab-group/tab-group-base.ts" } }, { "kind": "field", "name": "setupTabs", "inheritedFrom": { "name": "TabGroupBase", "module": "src/components/tab-group/tab-group-base.ts" } } ], "events": [ { "type": { "text": "index: number" }, "description": "Emitted when a tab is selected in a tab group.", "name": "bp-tab-group-tab-selected", "reactName": "onBpTabGroupTabSelected" } ], "superclass": { "name": "TabGroupBase", "module": "/src/components/tab-group/tab-group-base.js" }, "since": "0.1.1-beta.1", "status": "Experimental", "tagName": "bp-tab-group", "customElement": true, "attributes": [ { "name": "active-tab", "type": { "text": "number" }, "default": "0", "description": "The active tab of the Tab Group", "fieldName": "activeTab", "inheritedFrom": { "name": "TabGroupBase", "module": "src/components/tab-group/tab-group-base.ts" } } ] } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "TabGroup", "module": "src/components/tab-group/tab-group.ts" } }, { "kind": "custom-element-definition", "name": "bp-tab-group", "declaration": { "name": "TabGroup", "module": "src/components/tab-group/tab-group.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/tab-panel/tab-panel-base.ts", "declarations": [ { "kind": "class", "description": "", "name": "TabPanelBase", "members": [ { "kind": "field", "name": "hidden", "type": { "text": "boolean" }, "default": "false", "description": "Whether to show the tab panel, or not.", "attribute": "hidden" }, { "kind": "field", "name": "index", "type": { "text": "number" }, "default": "-1", "description": "Unique key for the panel.", "attribute": "index" }, { "kind": "method", "name": "hide", "description": "Hides the tab panel." }, { "kind": "method", "name": "show", "description": "Shows the tab panel." } ], "attributes": [ { "name": "hidden", "type": { "text": "boolean" }, "default": "false", "description": "Whether to show the tab panel, or not.", "fieldName": "hidden" }, { "name": "index", "type": { "text": "number" }, "default": "-1", "description": "Unique key for the panel.", "fieldName": "index" } ], "superclass": { "name": "LitElement", "package": "lit" }, "customElement": true } ], "exports": [ { "kind": "js", "name": "TabPanelBase", "declaration": { "name": "TabPanelBase", "module": "src/components/tab-panel/tab-panel-base.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/tab-panel/tab-panel.ts", "declarations": [ { "kind": "class", "description": "", "name": "TabPanel", "slots": [ { "description": "The panel's content.", "name": "" } ], "members": [ { "kind": "field", "name": "hidden", "type": { "text": "boolean" }, "default": "false", "description": "Whether to show the tab panel, or not.", "attribute": "hidden", "inheritedFrom": { "name": "TabPanelBase", "module": "src/components/tab-panel/tab-panel-base.ts" } }, { "kind": "field", "name": "index", "type": { "text": "number" }, "default": "-1", "description": "Unique key for the panel.", "attribute": "index", "inheritedFrom": { "name": "TabPanelBase", "module": "src/components/tab-panel/tab-panel-base.ts" } }, { "kind": "method", "name": "hide", "description": "Hides the tab panel.", "inheritedFrom": { "name": "TabPanelBase", "module": "src/components/tab-panel/tab-panel-base.ts" } }, { "kind": "method", "name": "show", "description": "Shows the tab panel.", "inheritedFrom": { "name": "TabPanelBase", "module": "src/components/tab-panel/tab-panel-base.ts" } } ], "superclass": { "name": "TabPanelBase", "module": "/src/components/tab-panel/tab-panel-base.js" }, "since": "0.1.1-beta.1", "status": "Experimental", "tagName": "bp-tab-panel", "customElement": true, "attributes": [ { "name": "hidden", "type": { "text": "boolean" }, "default": "false", "description": "Whether to show the tab panel, or not.", "fieldName": "hidden", "inheritedFrom": { "name": "TabPanelBase", "module": "src/components/tab-panel/tab-panel-base.ts" } }, { "name": "index", "type": { "text": "number" }, "default": "-1", "description": "Unique key for the panel.", "fieldName": "index", "inheritedFrom": { "name": "TabPanelBase", "module": "src/components/tab-panel/tab-panel-base.ts" } } ] } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "TabPanel", "module": "src/components/tab-panel/tab-panel.ts" } }, { "kind": "custom-element-definition", "name": "bp-tab-panel", "declaration": { "name": "TabPanel", "module": "src/components/tab-panel/tab-panel.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/textarea/textarea-base.ts", "declarations": [ { "kind": "class", "description": "", "name": "TextareaBase", "members": [ { "kind": "method", "name": "setFormData", "privacy": "protected", "return": { "type": { "text": "void" } } }, { "kind": "field", "name": "formSubmitController", "type": { "text": "FormSubmitController" }, "default": "new FormSubmitController(this)" }, { "kind": "field", "name": "value", "type": { "text": "string" }, "default": "''", "description": "The input control's value.", "attribute": "value" }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "Sets floating label value.", "attribute": "label" }, { "kind": "field", "name": "placeholder", "type": { "text": "string" }, "default": "''", "description": "Sets disappearing input placeholder.", "attribute": "placeholder" }, { "kind": "field", "name": "rows", "type": { "text": "number" }, "default": "2", "description": "Sets the amount of rows to render", "attribute": "rows" }, { "kind": "field", "name": "cols", "type": { "text": "number" }, "default": "20", "description": "Sets the amount of columns to render", "attribute": "cols" }, { "kind": "field", "name": "fullwidth", "type": { "text": "boolean" }, "default": "false", "attribute": "fullwidth" }, { "kind": "field", "name": "endAligned", "type": { "text": "boolean" }, "default": "false", "attribute": "endAligned" }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Whether or not the input should be disabled.", "attribute": "disabled" }, { "kind": "field", "name": "required", "type": { "text": "boolean" }, "default": "false", "description": "Displays error state if value is empty and input is blurred.", "attribute": "required" }, { "kind": "field", "name": "maxLength", "type": { "text": "number" }, "default": "-1", "description": "Maximum length to accept input.", "attribute": "maxLength" }, { "kind": "field", "name": "outlined", "type": { "text": "boolean" }, "default": "false", "description": "Whether or not to show the material outlined variant.", "attribute": "outlined" }, { "kind": "field", "name": "helper", "type": { "text": "string" }, "default": "''", "description": "Helper text to display below the input. Display default only when focused.", "attribute": "helper" }, { "kind": "field", "name": "helperPersistent", "type": { "text": "boolean" }, "default": "false", "description": "If we should show the helper text regardless of focus.", "attribute": "helperPersistent" }, { "kind": "field", "name": "defaultValue", "type": { "text": "string" }, "default": "''" }, { "kind": "method", "name": "handleInputChange" } ], "attributes": [ { "name": "value", "type": { "text": "string" }, "default": "''", "description": "The input control's value.", "fieldName": "value" }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "Sets floating label value.", "fieldName": "label" }, { "name": "placeholder", "type": { "text": "string" }, "default": "''", "description": "Sets disappearing input placeholder.", "fieldName": "placeholder" }, { "name": "rows", "type": { "text": "number" }, "default": "2", "description": "Sets the amount of rows to render", "fieldName": "rows" }, { "name": "cols", "type": { "text": "number" }, "default": "20", "description": "Sets the amount of columns to render", "fieldName": "cols" }, { "name": "fullwidth", "type": { "text": "boolean" }, "default": "false", "fieldName": "fullwidth" }, { "name": "endAligned", "type": { "text": "boolean" }, "default": "false", "fieldName": "endAligned" }, { "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Whether or not the input should be disabled.", "fieldName": "disabled" }, { "name": "required", "type": { "text": "boolean" }, "default": "false", "description": "Displays error state if value is empty and input is blurred.", "fieldName": "required" }, { "name": "maxLength", "type": { "text": "number" }, "default": "-1", "description": "Maximum length to accept input.", "fieldName": "maxLength" }, { "name": "outlined", "type": { "text": "boolean" }, "default": "false", "description": "Whether or not to show the material outlined variant.", "fieldName": "outlined" }, { "name": "helper", "type": { "text": "string" }, "default": "''", "description": "Helper text to display below the input. Display default only when focused.", "fieldName": "helper" }, { "name": "helperPersistent", "type": { "text": "boolean" }, "default": "false", "description": "If we should show the helper text regardless of focus.", "fieldName": "helperPersistent" } ], "superclass": { "name": "_TextareaBase", "package": "@material/mwc-textarea/mwc-textarea-base" } } ], "exports": [ { "kind": "js", "name": "TextareaBase", "declaration": { "name": "TextareaBase", "module": "src/components/textarea/textarea-base.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/textarea/textarea.ts", "declarations": [ { "kind": "class", "description": "", "name": "Textarea", "members": [ { "kind": "method", "name": "setFormData", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "TextareaBase", "module": "src/components/textarea/textarea-base.ts" } }, { "kind": "field", "name": "formSubmitController", "type": { "text": "FormSubmitController" }, "default": "new FormSubmitController(this)", "inheritedFrom": { "name": "TextareaBase", "module": "src/components/textarea/textarea-base.ts" } }, { "kind": "field", "name": "value", "type": { "text": "string" }, "default": "''", "description": "The input control's value.", "attribute": "value", "inheritedFrom": { "name": "TextareaBase", "module": "src/components/textarea/textarea-base.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "Sets floating label value.", "attribute": "label", "inheritedFrom": { "name": "TextareaBase", "module": "src/components/textarea/textarea-base.ts" } }, { "kind": "field", "name": "placeholder", "type": { "text": "string" }, "default": "''", "description": "Sets disappearing input placeholder.", "attribute": "placeholder", "inheritedFrom": { "name": "TextareaBase", "module": "src/components/textarea/textarea-base.ts" } }, { "kind": "field", "name": "rows", "type": { "text": "number" }, "default": "2", "description": "Sets the amount of rows to render", "attribute": "rows", "inheritedFrom": { "name": "TextareaBase", "module": "src/components/textarea/textarea-base.ts" } }, { "kind": "field", "name": "cols", "type": { "text": "number" }, "default": "20", "description": "Sets the amount of columns to render", "attribute": "cols", "inheritedFrom": { "name": "TextareaBase", "module": "src/components/textarea/textarea-base.ts" } }, { "kind": "field", "name": "fullwidth", "type": { "text": "boolean" }, "default": "false", "attribute": "fullwidth", "inheritedFrom": { "name": "TextareaBase", "module": "src/components/textarea/textarea-base.ts" } }, { "kind": "field", "name": "endAligned", "type": { "text": "boolean" }, "default": "false", "attribute": "endAligned", "inheritedFrom": { "name": "TextareaBase", "module": "src/components/textarea/textarea-base.ts" } }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Whether or not the input should be disabled.", "attribute": "disabled", "inheritedFrom": { "name": "TextareaBase", "module": "src/components/textarea/textarea-base.ts" } }, { "kind": "field", "name": "required", "type": { "text": "boolean" }, "default": "false", "description": "Displays error state if value is empty and input is blurred.", "attribute": "required", "inheritedFrom": { "name": "TextareaBase", "module": "src/components/textarea/textarea-base.ts" } }, { "kind": "field", "name": "maxLength", "type": { "text": "number" }, "default": "-1", "description": "Maximum length to accept input.", "attribute": "maxLength", "inheritedFrom": { "name": "TextareaBase", "module": "src/components/textarea/textarea-base.ts" } }, { "kind": "field", "name": "outlined", "type": { "text": "boolean" }, "default": "false", "description": "Whether or not to show the material outlined variant.", "attribute": "outlined", "inheritedFrom": { "name": "TextareaBase", "module": "src/components/textarea/textarea-base.ts" } }, { "kind": "field", "name": "helper", "type": { "text": "string" }, "default": "''", "description": "Helper text to display below the input. Display default only when focused.", "attribute": "helper", "inheritedFrom": { "name": "TextareaBase", "module": "src/components/textarea/textarea-base.ts" } }, { "kind": "field", "name": "helperPersistent", "type": { "text": "boolean" }, "default": "false", "description": "If we should show the helper text regardless of focus.", "attribute": "helperPersistent", "inheritedFrom": { "name": "TextareaBase", "module": "src/components/textarea/textarea-base.ts" } }, { "kind": "field", "name": "defaultValue", "type": { "text": "string" }, "default": "''", "inheritedFrom": { "name": "TextareaBase", "module": "src/components/textarea/textarea-base.ts" } }, { "kind": "method", "name": "handleInputChange", "inheritedFrom": { "name": "TextareaBase", "module": "src/components/textarea/textarea-base.ts" } } ], "events": [ { "type": { "text": "value: string" }, "description": "Fires, when the textfield value changes.", "name": "bp-textarea-changed", "reactName": "onBpTextareaChanged" } ], "superclass": { "name": "TextareaBase", "module": "/src/components/textarea/textarea-base.js" }, "since": "0.1.1-beta.1", "status": "Experimental", "tagName": "bp-textarea", "customElement": true, "attributes": [ { "name": "value", "type": { "text": "string" }, "default": "''", "description": "The input control's value.", "fieldName": "value", "inheritedFrom": { "name": "TextareaBase", "module": "src/components/textarea/textarea-base.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "Sets floating label value.", "fieldName": "label", "inheritedFrom": { "name": "TextareaBase", "module": "src/components/textarea/textarea-base.ts" } }, { "name": "placeholder", "type": { "text": "string" }, "default": "''", "description": "Sets disappearing input placeholder.", "fieldName": "placeholder", "inheritedFrom": { "name": "TextareaBase", "module": "src/components/textarea/textarea-base.ts" } }, { "name": "rows", "type": { "text": "number" }, "default": "2", "description": "Sets the amount of rows to render", "fieldName": "rows", "inheritedFrom": { "name": "TextareaBase", "module": "src/components/textarea/textarea-base.ts" } }, { "name": "cols", "type": { "text": "number" }, "default": "20", "description": "Sets the amount of columns to render", "fieldName": "cols", "inheritedFrom": { "name": "TextareaBase", "module": "src/components/textarea/textarea-base.ts" } }, { "name": "fullwidth", "type": { "text": "boolean" }, "default": "false", "fieldName": "fullwidth", "inheritedFrom": { "name": "TextareaBase", "module": "src/components/textarea/textarea-base.ts" } }, { "name": "endAligned", "type": { "text": "boolean" }, "default": "false", "fieldName": "endAligned", "inheritedFrom": { "name": "TextareaBase", "module": "src/components/textarea/textarea-base.ts" } }, { "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Whether or not the input should be disabled.", "fieldName": "disabled", "inheritedFrom": { "name": "TextareaBase", "module": "src/components/textarea/textarea-base.ts" } }, { "name": "required", "type": { "text": "boolean" }, "default": "false", "description": "Displays error state if value is empty and input is blurred.", "fieldName": "required", "inheritedFrom": { "name": "TextareaBase", "module": "src/components/textarea/textarea-base.ts" } }, { "name": "maxLength", "type": { "text": "number" }, "default": "-1", "description": "Maximum length to accept input.", "fieldName": "maxLength", "inheritedFrom": { "name": "TextareaBase", "module": "src/components/textarea/textarea-base.ts" } }, { "name": "outlined", "type": { "text": "boolean" }, "default": "false", "description": "Whether or not to show the material outlined variant.", "fieldName": "outlined", "inheritedFrom": { "name": "TextareaBase", "module": "src/components/textarea/textarea-base.ts" } }, { "name": "helper", "type": { "text": "string" }, "default": "''", "description": "Helper text to display below the input. Display default only when focused.", "fieldName": "helper", "inheritedFrom": { "name": "TextareaBase", "module": "src/components/textarea/textarea-base.ts" } }, { "name": "helperPersistent", "type": { "text": "boolean" }, "default": "false", "description": "If we should show the helper text regardless of focus.", "fieldName": "helperPersistent", "inheritedFrom": { "name": "TextareaBase", "module": "src/components/textarea/textarea-base.ts" } } ] } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "Textarea", "module": "src/components/textarea/textarea.ts" } }, { "kind": "custom-element-definition", "name": "bp-textarea", "declaration": { "name": "Textarea", "module": "src/components/textarea/textarea.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/textfield/textfield-base.ts", "declarations": [ { "kind": "class", "description": "", "name": "TextfieldBase", "members": [ { "kind": "method", "name": "setFormData", "privacy": "protected", "return": { "type": { "text": "void" } } }, { "kind": "field", "name": "formSubmitController", "type": { "text": "FormSubmitController" }, "default": "new FormSubmitController(this)" }, { "kind": "field", "name": "value", "type": { "text": "string" }, "default": "''", "description": "The input control's value.", "attribute": "value" }, { "kind": "field", "name": "type", "type": { "text": "TextFieldType" }, "default": "'text'", "description": "A string specifying the type of control to render.", "attribute": "type" }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "Sets floating label value.", "attribute": "label" }, { "kind": "field", "name": "placeholder", "type": { "text": "string" }, "default": "''", "description": "Sets disappearing input placeholder.", "attribute": "placeholder" }, { "kind": "field", "name": "prefix", "type": { "text": "string" }, "default": "''", "description": "Prefix text to display before the input.", "attribute": "prefix" }, { "kind": "field", "name": "suffix", "type": { "text": "string" }, "default": "''", "description": "Suffix text to display after the input.", "attribute": "suffix" }, { "kind": "field", "name": "icon", "type": { "text": "string" }, "default": "''", "description": "Leading icon to display in input. See bp-icon.", "attribute": "icon" }, { "kind": "field", "name": "iconTrailing", "type": { "text": "string" }, "default": "''", "description": "Trailing icon to display in input. See bp-icon.", "attribute": "iconTrailing" }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Whether or not the input should be disabled.", "attribute": "disabled" }, { "kind": "field", "name": "required", "type": { "text": "boolean" }, "default": "false", "description": "Displays error state if value is empty and input is blurred.", "attribute": "required" }, { "kind": "field", "name": "maxLength", "type": { "text": "number" }, "default": "-1", "description": "Maximum length to accept input.", "attribute": "maxLength" }, { "kind": "field", "name": "outlined", "type": { "text": "boolean" }, "default": "false", "description": "Whether or not to show the material outlined variant.", "attribute": "outlined" }, { "kind": "field", "name": "helper", "type": { "text": "string" }, "default": "''", "description": "Helper text to display below the input. Display default only when focused.", "attribute": "helper" }, { "kind": "field", "name": "validateOnInitialRender", "type": { "text": "boolean" }, "default": "false", "description": "Runs validation check on initial render.", "attribute": "validateOnInitialRender" }, { "kind": "field", "name": "validationMessage", "type": { "text": "string" }, "default": "''", "description": "HTMLInputElement.prototype.pattern (empty string will unset attribute)", "attribute": "validationMessage" }, { "kind": "field", "name": "autoValidate", "type": { "text": "boolean" }, "default": "false", "description": "Reports validity on value change rather than only on blur.", "attribute": "autoValidate" }, { "kind": "field", "name": "pattern", "type": { "text": "string" }, "default": "''", "description": "HTMLInputElement.prototype.pattern (empty string will unset attribute)", "attribute": "pattern" }, { "kind": "field", "name": "min", "type": { "text": "number | string" }, "default": "''", "description": "HTMLInputElement.prototype.min (empty string will unset attribute)", "attribute": "min" }, { "kind": "field", "name": "max", "type": { "text": "number | string" }, "default": "''", "description": "HTMLInputElement.prototype.max (empty string will unset attribute)", "attribute": "max" }, { "kind": "field", "name": "size", "type": { "text": "number | null" }, "default": "null", "description": "HTMLInputElement.prototype.size (null will unset attribute)", "attribute": "size" }, { "kind": "field", "name": "step", "type": { "text": "number | null" }, "default": "null", "description": "HTMLInputElement.prototype.step (null will unset attribute)", "attribute": "step" }, { "kind": "field", "name": "inputEllipsis", "type": { "text": "boolean" }, "default": "false", "description": "Whether to show ellipsis on input field or not", "attribute": "input-ellipsis" }, { "kind": "field", "name": "defaultValue", "type": { "text": "string" }, "default": "''" }, { "kind": "method", "name": "handleInputChange" } ], "attributes": [ { "name": "value", "type": { "text": "string" }, "default": "''", "description": "The input control's value.", "fieldName": "value" }, { "name": "type", "type": { "text": "TextFieldType" }, "default": "'text'", "description": "A string specifying the type of control to render.", "fieldName": "type" }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "Sets floating label value.", "fieldName": "label" }, { "name": "placeholder", "type": { "text": "string" }, "default": "''", "description": "Sets disappearing input placeholder.", "fieldName": "placeholder" }, { "name": "prefix", "type": { "text": "string" }, "default": "''", "description": "Prefix text to display before the input.", "fieldName": "prefix" }, { "name": "suffix", "type": { "text": "string" }, "default": "''", "description": "Suffix text to display after the input.", "fieldName": "suffix" }, { "name": "icon", "type": { "text": "string" }, "default": "''", "description": "Leading icon to display in input. See bp-icon.", "fieldName": "icon" }, { "name": "iconTrailing", "type": { "text": "string" }, "default": "''", "description": "Trailing icon to display in input. See bp-icon.", "fieldName": "iconTrailing" }, { "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Whether or not the input should be disabled.", "fieldName": "disabled" }, { "name": "required", "type": { "text": "boolean" }, "default": "false", "description": "Displays error state if value is empty and input is blurred.", "fieldName": "required" }, { "name": "maxLength", "type": { "text": "number" }, "default": "-1", "description": "Maximum length to accept input.", "fieldName": "maxLength" }, { "name": "outlined", "type": { "text": "boolean" }, "default": "false", "description": "Whether or not to show the material outlined variant.", "fieldName": "outlined" }, { "name": "helper", "type": { "text": "string" }, "default": "''", "description": "Helper text to display below the input. Display default only when focused.", "fieldName": "helper" }, { "name": "validateOnInitialRender", "type": { "text": "boolean" }, "default": "false", "description": "Runs validation check on initial render.", "fieldName": "validateOnInitialRender" }, { "name": "validationMessage", "type": { "text": "string" }, "default": "''", "description": "HTMLInputElement.prototype.pattern (empty string will unset attribute)", "fieldName": "validationMessage" }, { "name": "autoValidate", "type": { "text": "boolean" }, "default": "false", "description": "Reports validity on value change rather than only on blur.", "fieldName": "autoValidate" }, { "name": "pattern", "type": { "text": "string" }, "default": "''", "description": "HTMLInputElement.prototype.pattern (empty string will unset attribute)", "fieldName": "pattern" }, { "name": "min", "type": { "text": "number | string" }, "default": "''", "description": "HTMLInputElement.prototype.min (empty string will unset attribute)", "fieldName": "min" }, { "name": "max", "type": { "text": "number | string" }, "default": "''", "description": "HTMLInputElement.prototype.max (empty string will unset attribute)", "fieldName": "max" }, { "name": "size", "type": { "text": "number | null" }, "default": "null", "description": "HTMLInputElement.prototype.size (null will unset attribute)", "fieldName": "size" }, { "name": "step", "type": { "text": "number | null" }, "default": "null", "description": "HTMLInputElement.prototype.step (null will unset attribute)", "fieldName": "step" }, { "name": "input-ellipsis", "type": { "text": "boolean" }, "default": "false", "description": "Whether to show ellipsis on input field or not", "fieldName": "inputEllipsis" } ], "superclass": { "name": "_TextFieldBase", "package": "@material/mwc-textfield/mwc-textfield-base" } } ], "exports": [ { "kind": "js", "name": "TextfieldBase", "declaration": { "name": "TextfieldBase", "module": "src/components/textfield/textfield-base.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/textfield/textfield.ts", "declarations": [ { "kind": "class", "description": "", "name": "Textfield", "members": [ { "kind": "method", "name": "setFormData", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "TextfieldBase", "module": "src/components/textfield/textfield-base.ts" } }, { "kind": "field", "name": "formSubmitController", "type": { "text": "FormSubmitController" }, "default": "new FormSubmitController(this)", "inheritedFrom": { "name": "TextfieldBase", "module": "src/components/textfield/textfield-base.ts" } }, { "kind": "field", "name": "value", "type": { "text": "string" }, "default": "''", "description": "The input control's value.", "attribute": "value", "inheritedFrom": { "name": "TextfieldBase", "module": "src/components/textfield/textfield-base.ts" } }, { "kind": "field", "name": "type", "type": { "text": "TextFieldType" }, "default": "'text'", "description": "A string specifying the type of control to render.", "attribute": "type", "inheritedFrom": { "name": "TextfieldBase", "module": "src/components/textfield/textfield-base.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "Sets floating label value.", "attribute": "label", "inheritedFrom": { "name": "TextfieldBase", "module": "src/components/textfield/textfield-base.ts" } }, { "kind": "field", "name": "placeholder", "type": { "text": "string" }, "default": "''", "description": "Sets disappearing input placeholder.", "attribute": "placeholder", "inheritedFrom": { "name": "TextfieldBase", "module": "src/components/textfield/textfield-base.ts" } }, { "kind": "field", "name": "prefix", "type": { "text": "string" }, "default": "''", "description": "Prefix text to display before the input.", "attribute": "prefix", "inheritedFrom": { "name": "TextfieldBase", "module": "src/components/textfield/textfield-base.ts" } }, { "kind": "field", "name": "suffix", "type": { "text": "string" }, "default": "''", "description": "Suffix text to display after the input.", "attribute": "suffix", "inheritedFrom": { "name": "TextfieldBase", "module": "src/components/textfield/textfield-base.ts" } }, { "kind": "field", "name": "icon", "type": { "text": "string" }, "default": "''", "description": "Leading icon to display in input. See bp-icon.", "attribute": "icon", "inheritedFrom": { "name": "TextfieldBase", "module": "src/components/textfield/textfield-base.ts" } }, { "kind": "field", "name": "iconTrailing", "type": { "text": "string" }, "default": "''", "description": "Trailing icon to display in input. See bp-icon.", "attribute": "iconTrailing", "inheritedFrom": { "name": "TextfieldBase", "module": "src/components/textfield/textfield-base.ts" } }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Whether or not the input should be disabled.", "attribute": "disabled", "inheritedFrom": { "name": "TextfieldBase", "module": "src/components/textfield/textfield-base.ts" } }, { "kind": "field", "name": "required", "type": { "text": "boolean" }, "default": "false", "description": "Displays error state if value is empty and input is blurred.", "attribute": "required", "inheritedFrom": { "name": "TextfieldBase", "module": "src/components/textfield/textfield-base.ts" } }, { "kind": "field", "name": "maxLength", "type": { "text": "number" }, "default": "-1", "description": "Maximum length to accept input.", "attribute": "maxLength", "inheritedFrom": { "name": "TextfieldBase", "module": "src/components/textfield/textfield-base.ts" } }, { "kind": "field", "name": "outlined", "type": { "text": "boolean" }, "default": "false", "description": "Whether or not to show the material outlined variant.", "attribute": "outlined", "inheritedFrom": { "name": "TextfieldBase", "module": "src/components/textfield/textfield-base.ts" } }, { "kind": "field", "name": "helper", "type": { "text": "string" }, "default": "''", "description": "Helper text to display below the input. Display default only when focused.", "attribute": "helper", "inheritedFrom": { "name": "TextfieldBase", "module": "src/components/textfield/textfield-base.ts" } }, { "kind": "field", "name": "validateOnInitialRender", "type": { "text": "boolean" }, "default": "false", "description": "Runs validation check on initial render.", "attribute": "validateOnInitialRender", "inheritedFrom": { "name": "TextfieldBase", "module": "src/components/textfield/textfield-base.ts" } }, { "kind": "field", "name": "validationMessage", "type": { "text": "string" }, "default": "''", "description": "HTMLInputElement.prototype.pattern (empty string will unset attribute)", "attribute": "validationMessage", "inheritedFrom": { "name": "TextfieldBase", "module": "src/components/textfield/textfield-base.ts" } }, { "kind": "field", "name": "autoValidate", "type": { "text": "boolean" }, "default": "false", "description": "Reports validity on value change rather than only on blur.", "attribute": "autoValidate", "inheritedFrom": { "name": "TextfieldBase", "module": "src/components/textfield/textfield-base.ts" } }, { "kind": "field", "name": "pattern", "type": { "text": "string" }, "default": "''", "description": "HTMLInputElement.prototype.pattern (empty string will unset attribute)", "attribute": "pattern", "inheritedFrom": { "name": "TextfieldBase", "module": "src/components/textfield/textfield-base.ts" } }, { "kind": "field", "name": "min", "type": { "text": "number | string" }, "default": "''", "description": "HTMLInputElement.prototype.min (empty string will unset attribute)", "attribute": "min", "inheritedFrom": { "name": "TextfieldBase", "module": "src/components/textfield/textfield-base.ts" } }, { "kind": "field", "name": "max", "type": { "text": "number | string" }, "default": "''", "description": "HTMLInputElement.prototype.max (empty string will unset attribute)", "attribute": "max", "inheritedFrom": { "name": "TextfieldBase", "module": "src/components/textfield/textfield-base.ts" } }, { "kind": "field", "name": "size", "type": { "text": "number | null" }, "default": "null", "description": "HTMLInputElement.prototype.size (null will unset attribute)", "attribute": "size", "inheritedFrom": { "name": "TextfieldBase", "module": "src/components/textfield/textfield-base.ts" } }, { "kind": "field", "name": "step", "type": { "text": "number | null" }, "default": "null", "description": "HTMLInputElement.prototype.step (null will unset attribute)", "attribute": "step", "inheritedFrom": { "name": "TextfieldBase", "module": "src/components/textfield/textfield-base.ts" } }, { "kind": "field", "name": "inputEllipsis", "type": { "text": "boolean" }, "default": "false", "description": "Whether to show ellipsis on input field or not", "attribute": "input-ellipsis", "inheritedFrom": { "name": "TextfieldBase", "module": "src/components/textfield/textfield-base.ts" } }, { "kind": "field", "name": "defaultValue", "type": { "text": "string" }, "default": "''", "inheritedFrom": { "name": "TextfieldBase", "module": "src/components/textfield/textfield-base.ts" } }, { "kind": "method", "name": "handleInputChange", "inheritedFrom": { "name": "TextfieldBase", "module": "src/components/textfield/textfield-base.ts" } } ], "events": [ { "type": { "text": "{value: string}" }, "description": "Emitted when the input value changes.", "name": "bp-textfield-changed", "reactName": "onBpTextfieldChanged" } ], "superclass": { "name": "TextfieldBase", "module": "/src/components/textfield/textfield-base.js" }, "since": "0.1.1-beta.1", "status": "beta", "dependencies": [ "bp-icon" ], "tagName": "bp-textfield", "customElement": true, "attributes": [ { "name": "value", "type": { "text": "string" }, "default": "''", "description": "The input control's value.", "fieldName": "value", "inheritedFrom": { "name": "TextfieldBase", "module": "src/components/textfield/textfield-base.ts" } }, { "name": "type", "type": { "text": "TextFieldType" }, "default": "'text'", "description": "A string specifying the type of control to render.", "fieldName": "type", "inheritedFrom": { "name": "TextfieldBase", "module": "src/components/textfield/textfield-base.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "Sets floating label value.", "fieldName": "label", "inheritedFrom": { "name": "TextfieldBase", "module": "src/components/textfield/textfield-base.ts" } }, { "name": "placeholder", "type": { "text": "string" }, "default": "''", "description": "Sets disappearing input placeholder.", "fieldName": "placeholder", "inheritedFrom": { "name": "TextfieldBase", "module": "src/components/textfield/textfield-base.ts" } }, { "name": "prefix", "type": { "text": "string" }, "default": "''", "description": "Prefix text to display before the input.", "fieldName": "prefix", "inheritedFrom": { "name": "TextfieldBase", "module": "src/components/textfield/textfield-base.ts" } }, { "name": "suffix", "type": { "text": "string" }, "default": "''", "description": "Suffix text to display after the input.", "fieldName": "suffix", "inheritedFrom": { "name": "TextfieldBase", "module": "src/components/textfield/textfield-base.ts" } }, { "name": "icon", "type": { "text": "string" }, "default": "''", "description": "Leading icon to display in input. See bp-icon.", "fieldName": "icon", "inheritedFrom": { "name": "TextfieldBase", "module": "src/components/textfield/textfield-base.ts" } }, { "name": "iconTrailing", "type": { "text": "string" }, "default": "''", "description": "Trailing icon to display in input. See bp-icon.", "fieldName": "iconTrailing", "inheritedFrom": { "name": "TextfieldBase", "module": "src/components/textfield/textfield-base.ts" } }, { "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Whether or not the input should be disabled.", "fieldName": "disabled", "inheritedFrom": { "name": "TextfieldBase", "module": "src/components/textfield/textfield-base.ts" } }, { "name": "required", "type": { "text": "boolean" }, "default": "false", "description": "Displays error state if value is empty and input is blurred.", "fieldName": "required", "inheritedFrom": { "name": "TextfieldBase", "module": "src/components/textfield/textfield-base.ts" } }, { "name": "maxLength", "type": { "text": "number" }, "default": "-1", "description": "Maximum length to accept input.", "fieldName": "maxLength", "inheritedFrom": { "name": "TextfieldBase", "module": "src/components/textfield/textfield-base.ts" } }, { "name": "outlined", "type": { "text": "boolean" }, "default": "false", "description": "Whether or not to show the material outlined variant.", "fieldName": "outlined", "inheritedFrom": { "name": "TextfieldBase", "module": "src/components/textfield/textfield-base.ts" } }, { "name": "helper", "type": { "text": "string" }, "default": "''", "description": "Helper text to display below the input. Display default only when focused.", "fieldName": "helper", "inheritedFrom": { "name": "TextfieldBase", "module": "src/components/textfield/textfield-base.ts" } }, { "name": "validateOnInitialRender", "type": { "text": "boolean" }, "default": "false", "description": "Runs validation check on initial render.", "fieldName": "validateOnInitialRender", "inheritedFrom": { "name": "TextfieldBase", "module": "src/components/textfield/textfield-base.ts" } }, { "name": "validationMessage", "type": { "text": "string" }, "default": "''", "description": "HTMLInputElement.prototype.pattern (empty string will unset attribute)", "fieldName": "validationMessage", "inheritedFrom": { "name": "TextfieldBase", "module": "src/components/textfield/textfield-base.ts" } }, { "name": "autoValidate", "type": { "text": "boolean" }, "default": "false", "description": "Reports validity on value change rather than only on blur.", "fieldName": "autoValidate", "inheritedFrom": { "name": "TextfieldBase", "module": "src/components/textfield/textfield-base.ts" } }, { "name": "pattern", "type": { "text": "string" }, "default": "''", "description": "HTMLInputElement.prototype.pattern (empty string will unset attribute)", "fieldName": "pattern", "inheritedFrom": { "name": "TextfieldBase", "module": "src/components/textfield/textfield-base.ts" } }, { "name": "min", "type": { "text": "number | string" }, "default": "''", "description": "HTMLInputElement.prototype.min (empty string will unset attribute)", "fieldName": "min", "inheritedFrom": { "name": "TextfieldBase", "module": "src/components/textfield/textfield-base.ts" } }, { "name": "max", "type": { "text": "number | string" }, "default": "''", "description": "HTMLInputElement.prototype.max (empty string will unset attribute)", "fieldName": "max", "inheritedFrom": { "name": "TextfieldBase", "module": "src/components/textfield/textfield-base.ts" } }, { "name": "size", "type": { "text": "number | null" }, "default": "null", "description": "HTMLInputElement.prototype.size (null will unset attribute)", "fieldName": "size", "inheritedFrom": { "name": "TextfieldBase", "module": "src/components/textfield/textfield-base.ts" } }, { "name": "step", "type": { "text": "number | null" }, "default": "null", "description": "HTMLInputElement.prototype.step (null will unset attribute)", "fieldName": "step", "inheritedFrom": { "name": "TextfieldBase", "module": "src/components/textfield/textfield-base.ts" } }, { "name": "input-ellipsis", "type": { "text": "boolean" }, "default": "false", "description": "Whether to show ellipsis on input field or not", "fieldName": "inputEllipsis", "inheritedFrom": { "name": "TextfieldBase", "module": "src/components/textfield/textfield-base.ts" } } ] } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "Textfield", "module": "src/components/textfield/textfield.ts" } }, { "kind": "custom-element-definition", "name": "bp-textfield", "declaration": { "name": "Textfield", "module": "src/components/textfield/textfield.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/toggle-button/toggle-button-base.ts", "declarations": [ { "kind": "class", "description": "", "name": "ToggleButtonBase", "members": [ { "kind": "field", "name": "selected", "type": { "text": "boolean" }, "default": "false", "description": "Whether this button is selected or not.", "attribute": "selected" }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Whether this button is disabled or not.", "attribute": "disabled" }, { "kind": "field", "name": "color", "type": { "text": "| 'primary'\n | 'secondary'\n | 'success'\n | 'warning'\n | 'error'\n | 'info'" }, "default": "'primary'", "description": "Color of the button.", "attribute": "color" }, { "kind": "field", "name": "icon", "type": { "text": "string" }, "default": "''", "description": "Optional Icon to add to the button.", "attribute": "icon" }, { "kind": "field", "name": "label", "type": { "text": "string | null" }, "default": "'def'" }, { "kind": "method", "name": "select", "privacy": "public", "description": "Selects the toggle button." }, { "kind": "method", "name": "deselect", "privacy": "public", "description": "Deselects the toggle button." }, { "kind": "method", "name": "toggle", "privacy": "public", "description": "Toggles selection state." }, { "kind": "method", "name": "emit", "privacy": "protected", "parameters": [ { "name": "name", "type": { "text": "'selected' | 'deselected' | 'changed'" } } ] }, { "kind": "method", "name": "handleSlotChange", "privacy": "private", "parameters": [ { "name": "e", "type": { "text": "Event" } } ] } ], "events": [ { "name": "eventName", "type": { "text": "CustomEvent" }, "reactName": "onEventName" } ], "attributes": [ { "name": "selected", "type": { "text": "boolean" }, "default": "false", "description": "Whether this button is selected or not.", "fieldName": "selected" }, { "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Whether this button is disabled or not.", "fieldName": "disabled" }, { "name": "color", "type": { "text": "| 'primary'\n | 'secondary'\n | 'success'\n | 'warning'\n | 'error'\n | 'info'" }, "default": "'primary'", "description": "Color of the button.", "fieldName": "color" }, { "name": "icon", "type": { "text": "string" }, "default": "''", "description": "Optional Icon to add to the button.", "fieldName": "icon" } ], "superclass": { "name": "LitElement", "package": "lit" }, "customElement": true } ], "exports": [ { "kind": "js", "name": "ToggleButtonBase", "declaration": { "name": "ToggleButtonBase", "module": "src/components/toggle-button/toggle-button-base.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/toggle-button/toggle-button.ts", "declarations": [ { "kind": "class", "description": "", "name": "ToggleButton", "cssParts": [ { "description": "CSS var for the button's main color.", "name": "--bp-toggle-button-color" }, { "description": "CSS var for the button's bg color when its selected.", "name": "--bp-toggle-button-selected-background" }, { "description": "CSS var for the button's general background.", "name": "--bp-toggle-button-background" }, { "description": "CSS var for the button's border radius.", "name": "--bp-toggle-button-border-radius" }, { "description": "CSS var for the button's right border.", "name": "--bp-toggle-button-border-right" }, { "description": "CSS var for the button's right border's width.", "name": "--bp-toggle-button-border-right-width" }, { "description": "CSS var for the button's right border's style.", "name": "--bp-toggle-button-border-right-style" }, { "description": "CSS var for the button's border color.", "name": "--bp-toggle-button-border-color" } ], "slots": [ { "description": "The default slot for the button's content.", "name": "" } ], "members": [ { "kind": "field", "name": "selected", "type": { "text": "boolean" }, "default": "false", "description": "Whether this button is selected or not.", "attribute": "selected", "inheritedFrom": { "name": "ToggleButtonBase", "module": "src/components/toggle-button/toggle-button-base.ts" } }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Whether this button is disabled or not.", "attribute": "disabled", "inheritedFrom": { "name": "ToggleButtonBase", "module": "src/components/toggle-button/toggle-button-base.ts" } }, { "kind": "field", "name": "color", "type": { "text": "| 'primary'\n | 'secondary'\n | 'success'\n | 'warning'\n | 'error'\n | 'info'" }, "default": "'primary'", "description": "Color of the button.", "attribute": "color", "inheritedFrom": { "name": "ToggleButtonBase", "module": "src/components/toggle-button/toggle-button-base.ts" } }, { "kind": "field", "name": "icon", "type": { "text": "string" }, "default": "''", "description": "Optional Icon to add to the button.", "attribute": "icon", "inheritedFrom": { "name": "ToggleButtonBase", "module": "src/components/toggle-button/toggle-button-base.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string | null" }, "default": "'def'", "inheritedFrom": { "name": "ToggleButtonBase", "module": "src/components/toggle-button/toggle-button-base.ts" } }, { "kind": "method", "name": "select", "privacy": "public", "description": "Selects the toggle button.", "inheritedFrom": { "name": "ToggleButtonBase", "module": "src/components/toggle-button/toggle-button-base.ts" } }, { "kind": "method", "name": "deselect", "privacy": "public", "description": "Deselects the toggle button.", "inheritedFrom": { "name": "ToggleButtonBase", "module": "src/components/toggle-button/toggle-button-base.ts" } }, { "kind": "method", "name": "toggle", "privacy": "public", "description": "Toggles selection state.", "inheritedFrom": { "name": "ToggleButtonBase", "module": "src/components/toggle-button/toggle-button-base.ts" } }, { "kind": "method", "name": "emit", "privacy": "protected", "parameters": [ { "name": "name", "type": { "text": "'selected' | 'deselected' | 'changed'" } } ], "inheritedFrom": { "name": "ToggleButtonBase", "module": "src/components/toggle-button/toggle-button-base.ts" } }, { "kind": "method", "name": "handleSlotChange", "privacy": "private", "parameters": [ { "name": "e", "type": { "text": "Event" } } ], "inheritedFrom": { "name": "ToggleButtonBase", "module": "src/components/toggle-button/toggle-button-base.ts" } } ], "events": [ { "description": "Emitted whenever the toggle button changes its selection state.", "name": "bp-toggle-button-changed", "reactName": "onBpToggleButtonChanged" }, { "description": "Emitted when the toggle button is selected.", "name": "bp-toggle-button-selected", "reactName": "onBpToggleButtonSelected" }, { "description": "Emitted when the toggle button is deselected.", "name": "bp-toggle-button-deselected", "reactName": "onBpToggleButtonDeselected" }, { "name": "eventName", "type": { "text": "CustomEvent" }, "reactName": "onEventName", "inheritedFrom": { "name": "ToggleButtonBase", "module": "src/components/toggle-button/toggle-button-base.ts" } } ], "superclass": { "name": "ToggleButtonBase", "module": "/src/components/toggle-button/toggle-button-base.js" }, "since": "1.0", "status": "Experimental", "dependencies": [ "bp-icon" ], "tagName": "bp-toggle-button", "customElement": true, "attributes": [ { "name": "selected", "type": { "text": "boolean" }, "default": "false", "description": "Whether this button is selected or not.", "fieldName": "selected", "inheritedFrom": { "name": "ToggleButtonBase", "module": "src/components/toggle-button/toggle-button-base.ts" } }, { "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Whether this button is disabled or not.", "fieldName": "disabled", "inheritedFrom": { "name": "ToggleButtonBase", "module": "src/components/toggle-button/toggle-button-base.ts" } }, { "name": "color", "type": { "text": "| 'primary'\n | 'secondary'\n | 'success'\n | 'warning'\n | 'error'\n | 'info'" }, "default": "'primary'", "description": "Color of the button.", "fieldName": "color", "inheritedFrom": { "name": "ToggleButtonBase", "module": "src/components/toggle-button/toggle-button-base.ts" } }, { "name": "icon", "type": { "text": "string" }, "default": "''", "description": "Optional Icon to add to the button.", "fieldName": "icon", "inheritedFrom": { "name": "ToggleButtonBase", "module": "src/components/toggle-button/toggle-button-base.ts" } } ] } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "ToggleButton", "module": "src/components/toggle-button/toggle-button.ts" } }, { "kind": "custom-element-definition", "name": "bp-toggle-button", "declaration": { "name": "ToggleButton", "module": "src/components/toggle-button/toggle-button.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/toggle-button-group/toggle-button-group-base.ts", "declarations": [ { "kind": "class", "description": "", "name": "ToggleButtonGroupBase", "members": [ { "kind": "field", "name": "color", "type": { "text": "| ''\n | 'primary'\n | 'secondary'\n | 'success'\n | 'warning'\n | 'error'\n | 'info'" }, "default": "''", "description": "If set, overrides the color of all the buttons in the toggle group.", "attribute": "color" }, { "kind": "field", "name": "multi", "type": { "text": "boolean" }, "default": "false", "description": "Enables multiselection within the toggle button group.", "attribute": "multi" }, { "kind": "field", "name": "slottedToggleButtons", "type": { "text": "ToggleButton[]" }, "default": "[]" }, { "kind": "field", "name": "selectedIndexes", "type": { "text": "number[]" }, "default": "[]" }, { "kind": "method", "name": "select", "privacy": "public", "parameters": [ { "name": "index", "type": { "text": "number" } } ], "description": "Selects a specific toggle-button by its index." }, { "kind": "method", "name": "deselect", "privacy": "public", "parameters": [ { "name": "index", "type": { "text": "number" } } ], "description": "Deselects a specific toggle-button by its index." }, { "kind": "method", "name": "enable", "privacy": "public", "parameters": [ { "name": "index", "type": { "text": "number" } } ], "description": "Enables a specific toggle-button by its index." }, { "kind": "method", "name": "disable", "privacy": "public", "parameters": [ { "name": "index", "type": { "text": "number" } } ], "description": "Disables a specific toggle-button by its index." }, { "kind": "method", "name": "emit", "privacy": "private", "parameters": [ { "name": "name", "type": { "text": "'selected' | 'deselected'" } } ] }, { "kind": "method", "name": "handleSlotChange", "privacy": "private", "parameters": [ { "name": "e", "type": { "text": "Event" } } ] } ], "events": [ { "name": "bp-toggle-button-group-changed", "type": { "text": "CustomEvent" }, "reactName": "onBpToggleButtonGroupChanged" }, { "name": "eventName", "type": { "text": "CustomEvent" }, "reactName": "onEventName" } ], "attributes": [ { "name": "color", "type": { "text": "| ''\n | 'primary'\n | 'secondary'\n | 'success'\n | 'warning'\n | 'error'\n | 'info'" }, "default": "''", "description": "If set, overrides the color of all the buttons in the toggle group.", "fieldName": "color" }, { "name": "multi", "type": { "text": "boolean" }, "default": "false", "description": "Enables multiselection within the toggle button group.", "fieldName": "multi" } ], "superclass": { "name": "LitElement", "package": "lit" }, "customElement": true } ], "exports": [ { "kind": "js", "name": "ToggleButtonGroupBase", "declaration": { "name": "ToggleButtonGroupBase", "module": "src/components/toggle-button-group/toggle-button-group-base.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/toggle-button-group/toggle-button-group.ts", "declarations": [ { "kind": "class", "description": "", "name": "ToggleButtonGroup", "slots": [ { "description": "The default slot for bp-toggle-button components.", "name": "" } ], "members": [ { "kind": "field", "name": "color", "type": { "text": "| ''\n | 'primary'\n | 'secondary'\n | 'success'\n | 'warning'\n | 'error'\n | 'info'" }, "default": "''", "description": "If set, overrides the color of all the buttons in the toggle group.", "attribute": "color", "inheritedFrom": { "name": "ToggleButtonGroupBase", "module": "src/components/toggle-button-group/toggle-button-group-base.ts" } }, { "kind": "field", "name": "multi", "type": { "text": "boolean" }, "default": "false", "description": "Enables multiselection within the toggle button group.", "attribute": "multi", "inheritedFrom": { "name": "ToggleButtonGroupBase", "module": "src/components/toggle-button-group/toggle-button-group-base.ts" } }, { "kind": "field", "name": "slottedToggleButtons", "type": { "text": "ToggleButton[]" }, "default": "[]", "inheritedFrom": { "name": "ToggleButtonGroupBase", "module": "src/components/toggle-button-group/toggle-button-group-base.ts" } }, { "kind": "field", "name": "selectedIndexes", "type": { "text": "number[]" }, "default": "[]", "inheritedFrom": { "name": "ToggleButtonGroupBase", "module": "src/components/toggle-button-group/toggle-button-group-base.ts" } }, { "kind": "method", "name": "select", "privacy": "public", "parameters": [ { "name": "index", "type": { "text": "number" } } ], "description": "Selects a specific toggle-button by its index.", "inheritedFrom": { "name": "ToggleButtonGroupBase", "module": "src/components/toggle-button-group/toggle-button-group-base.ts" } }, { "kind": "method", "name": "deselect", "privacy": "public", "parameters": [ { "name": "index", "type": { "text": "number" } } ], "description": "Deselects a specific toggle-button by its index.", "inheritedFrom": { "name": "ToggleButtonGroupBase", "module": "src/components/toggle-button-group/toggle-button-group-base.ts" } }, { "kind": "method", "name": "enable", "privacy": "public", "parameters": [ { "name": "index", "type": { "text": "number" } } ], "description": "Enables a specific toggle-button by its index.", "inheritedFrom": { "name": "ToggleButtonGroupBase", "module": "src/components/toggle-button-group/toggle-button-group-base.ts" } }, { "kind": "method", "name": "disable", "privacy": "public", "parameters": [ { "name": "index", "type": { "text": "number" } } ], "description": "Disables a specific toggle-button by its index.", "inheritedFrom": { "name": "ToggleButtonGroupBase", "module": "src/components/toggle-button-group/toggle-button-group-base.ts" } }, { "kind": "method", "name": "emit", "privacy": "private", "parameters": [ { "name": "name", "type": { "text": "'selected' | 'deselected'" } } ], "inheritedFrom": { "name": "ToggleButtonGroupBase", "module": "src/components/toggle-button-group/toggle-button-group-base.ts" } }, { "kind": "method", "name": "handleSlotChange", "privacy": "private", "parameters": [ { "name": "e", "type": { "text": "Event" } } ], "inheritedFrom": { "name": "ToggleButtonGroupBase", "module": "src/components/toggle-button-group/toggle-button-group-base.ts" } } ], "events": [ { "name": "bp-toggle-button-group-changed", "type": { "text": "CustomEvent" }, "reactName": "onBpToggleButtonGroupChanged", "description": "Emitted whenever the toggle button group changes its selection state.", "inheritedFrom": { "name": "ToggleButtonGroupBase", "module": "src/components/toggle-button-group/toggle-button-group-base.ts" } }, { "type": { "text": "detail: number[]" }, "description": "Emitted when one of the toggle buttons is selected.", "name": "bp-toggle-button-group-selected", "reactName": "onBpToggleButtonGroupSelected" }, { "type": { "text": "detail: number[]" }, "description": "Emitted when one of the toggle buttons is deselected.", "name": "bp-toggle-button-group-deselected", "reactName": "onBpToggleButtonGroupDeselected" }, { "name": "eventName", "type": { "text": "CustomEvent" }, "reactName": "onEventName", "inheritedFrom": { "name": "ToggleButtonGroupBase", "module": "src/components/toggle-button-group/toggle-button-group-base.ts" } } ], "superclass": { "name": "ToggleButtonGroupBase", "module": "/src/components/toggle-button-group/toggle-button-group-base.js" }, "since": "1.0", "status": "Experimental", "dependencies": [ "bp-toggle-button" ], "tagName": "bp-toggle-button-group", "customElement": true, "attributes": [ { "name": "color", "type": { "text": "| ''\n | 'primary'\n | 'secondary'\n | 'success'\n | 'warning'\n | 'error'\n | 'info'" }, "default": "''", "description": "If set, overrides the color of all the buttons in the toggle group.", "fieldName": "color", "inheritedFrom": { "name": "ToggleButtonGroupBase", "module": "src/components/toggle-button-group/toggle-button-group-base.ts" } }, { "name": "multi", "type": { "text": "boolean" }, "default": "false", "description": "Enables multiselection within the toggle button group.", "fieldName": "multi", "inheritedFrom": { "name": "ToggleButtonGroupBase", "module": "src/components/toggle-button-group/toggle-button-group-base.ts" } } ] } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "ToggleButtonGroup", "module": "src/components/toggle-button-group/toggle-button-group.ts" } }, { "kind": "custom-element-definition", "name": "bp-toggle-button-group", "declaration": { "name": "ToggleButtonGroup", "module": "src/components/toggle-button-group/toggle-button-group.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/tooltip/tooltip-base.ts", "declarations": [ { "kind": "class", "description": "", "name": "TooltipBase", "members": [ { "kind": "method", "name": "emitShowHandler" }, { "kind": "method", "name": "emitAfterShowHandler" }, { "kind": "method", "name": "emitHideHandler" }, { "kind": "method", "name": "emitAfterHideHandler" }, { "kind": "field", "name": "content", "type": { "text": "string" }, "default": "''", "description": "The tooltip's content. If you need to display HTML, you can use the `content` slot instead.", "attribute": "content" }, { "kind": "field", "name": "placement", "type": { "text": "| 'top'\n | 'top-start'\n | 'top-end'\n | 'right'\n | 'right-start'\n | 'right-end'\n | 'bottom'\n | 'bottom-start'\n | 'bottom-end'\n | 'left'\n | 'left-start'\n | 'left-end'" }, "default": "'top'", "description": "The preferred placement of the tooltip. Note that the actual placement may vary as needed to keep the tooltip\ninside of the viewport.", "attribute": "placement" }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Disables the tooltip so it won't show when triggered.", "attribute": "disabled", "reflects": true }, { "kind": "field", "name": "distance", "type": { "text": "number" }, "default": "8", "description": "The distance in pixels from which to offset the tooltip away from its target.", "attribute": "distance" }, { "kind": "field", "name": "open", "type": { "text": "boolean" }, "default": "false", "description": "Indicates whether or not the tooltip is open. You can use this in lieu of the show/hide methods.", "attribute": "open", "reflects": true }, { "kind": "field", "name": "skidding", "type": { "text": "number" }, "default": "0", "description": "The distance in pixels from which to offset the tooltip along its target.", "attribute": "skidding" }, { "kind": "field", "name": "trigger", "type": { "text": "string" }, "default": "'hover focus'", "description": "Controls how the tooltip is activated. Possible options include `click`, `hover`, `focus`, and `manual`. Multiple\noptions can be passed by separating them with a space. When manual is used, the tooltip must be activated\nprogrammatically.", "attribute": "trigger" }, { "kind": "field", "name": "hoist", "type": { "text": "boolean" }, "default": "false", "description": "Enable this option to prevent the tooltip from being clipped when the component is placed inside a container with\n`overflow: auto|hidden|scroll`.", "attribute": "hoist" }, { "kind": "method", "name": "show", "description": "Shows the alert." }, { "kind": "method", "name": "hide", "description": "Hides the alert" } ], "attributes": [ { "name": "content", "type": { "text": "string" }, "default": "''", "description": "The tooltip's content. If you need to display HTML, you can use the `content` slot instead.", "fieldName": "content" }, { "name": "placement", "type": { "text": "| 'top'\n | 'top-start'\n | 'top-end'\n | 'right'\n | 'right-start'\n | 'right-end'\n | 'bottom'\n | 'bottom-start'\n | 'bottom-end'\n | 'left'\n | 'left-start'\n | 'left-end'" }, "default": "'top'", "description": "The preferred placement of the tooltip. Note that the actual placement may vary as needed to keep the tooltip\ninside of the viewport.", "fieldName": "placement" }, { "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Disables the tooltip so it won't show when triggered.", "fieldName": "disabled" }, { "name": "distance", "type": { "text": "number" }, "default": "8", "description": "The distance in pixels from which to offset the tooltip away from its target.", "fieldName": "distance" }, { "name": "open", "type": { "text": "boolean" }, "default": "false", "description": "Indicates whether or not the tooltip is open. You can use this in lieu of the show/hide methods.", "fieldName": "open" }, { "name": "skidding", "type": { "text": "number" }, "default": "0", "description": "The distance in pixels from which to offset the tooltip along its target.", "fieldName": "skidding" }, { "name": "trigger", "type": { "text": "string" }, "default": "'hover focus'", "description": "Controls how the tooltip is activated. Possible options include `click`, `hover`, `focus`, and `manual`. Multiple\noptions can be passed by separating them with a space. When manual is used, the tooltip must be activated\nprogrammatically.", "fieldName": "trigger" }, { "name": "hoist", "type": { "text": "boolean" }, "default": "false", "description": "Enable this option to prevent the tooltip from being clipped when the component is placed inside a container with\n`overflow: auto|hidden|scroll`.", "fieldName": "hoist" } ], "superclass": { "name": "SlTooltip", "package": "@shoelace-style/shoelace/dist/components/tooltip/tooltip" } } ], "exports": [ { "kind": "js", "name": "TooltipBase", "declaration": { "name": "TooltipBase", "module": "src/components/tooltip/tooltip-base.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/tooltip/tooltip.ts", "declarations": [ { "kind": "class", "description": "", "name": "Tooltip", "cssProperties": [ { "description": "The maximum width of the tooltip.", "name": "--max-width" }, { "description": "The amount of time to wait before hiding the tooltip when hovering.", "name": "--hide-delay" }, { "description": "The amount of time to wait before showing the tooltip when hovering.", "name": "--show-delay" }, { "description": "The size of the arrow that links the tooltop to the target.", "name": "--bp-tooltip-arrow-size" } ], "slots": [ { "description": "The tooltip's target element. Only the first element will be used as the target.", "name": "(default)" }, { "description": "The tooltip's content. Alternatively, you can use the `content` attribute.", "name": "content" } ], "members": [ { "kind": "method", "name": "emitShowHandler", "inheritedFrom": { "name": "TooltipBase", "module": "src/components/tooltip/tooltip-base.ts" } }, { "kind": "method", "name": "emitAfterShowHandler", "inheritedFrom": { "name": "TooltipBase", "module": "src/components/tooltip/tooltip-base.ts" } }, { "kind": "method", "name": "emitHideHandler", "inheritedFrom": { "name": "TooltipBase", "module": "src/components/tooltip/tooltip-base.ts" } }, { "kind": "method", "name": "emitAfterHideHandler", "inheritedFrom": { "name": "TooltipBase", "module": "src/components/tooltip/tooltip-base.ts" } }, { "kind": "field", "name": "content", "type": { "text": "string" }, "default": "''", "description": "The tooltip's content. If you need to display HTML, you can use the `content` slot instead.", "attribute": "content", "inheritedFrom": { "name": "TooltipBase", "module": "src/components/tooltip/tooltip-base.ts" } }, { "kind": "field", "name": "placement", "type": { "text": "| 'top'\n | 'top-start'\n | 'top-end'\n | 'right'\n | 'right-start'\n | 'right-end'\n | 'bottom'\n | 'bottom-start'\n | 'bottom-end'\n | 'left'\n | 'left-start'\n | 'left-end'" }, "default": "'top'", "description": "The preferred placement of the tooltip. Note that the actual placement may vary as needed to keep the tooltip\ninside of the viewport.", "attribute": "placement", "inheritedFrom": { "name": "TooltipBase", "module": "src/components/tooltip/tooltip-base.ts" } }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Disables the tooltip so it won't show when triggered.", "attribute": "disabled", "reflects": true, "inheritedFrom": { "name": "TooltipBase", "module": "src/components/tooltip/tooltip-base.ts" } }, { "kind": "field", "name": "distance", "type": { "text": "number" }, "default": "8", "description": "The distance in pixels from which to offset the tooltip away from its target.", "attribute": "distance", "inheritedFrom": { "name": "TooltipBase", "module": "src/components/tooltip/tooltip-base.ts" } }, { "kind": "field", "name": "open", "type": { "text": "boolean" }, "default": "false", "description": "Indicates whether or not the tooltip is open. You can use this in lieu of the show/hide methods.", "attribute": "open", "reflects": true, "inheritedFrom": { "name": "TooltipBase", "module": "src/components/tooltip/tooltip-base.ts" } }, { "kind": "field", "name": "skidding", "type": { "text": "number" }, "default": "0", "description": "The distance in pixels from which to offset the tooltip along its target.", "attribute": "skidding", "inheritedFrom": { "name": "TooltipBase", "module": "src/components/tooltip/tooltip-base.ts" } }, { "kind": "field", "name": "trigger", "type": { "text": "string" }, "default": "'hover focus'", "description": "Controls how the tooltip is activated. Possible options include `click`, `hover`, `focus`, and `manual`. Multiple\noptions can be passed by separating them with a space. When manual is used, the tooltip must be activated\nprogrammatically.", "attribute": "trigger", "inheritedFrom": { "name": "TooltipBase", "module": "src/components/tooltip/tooltip-base.ts" } }, { "kind": "field", "name": "hoist", "type": { "text": "boolean" }, "default": "false", "description": "Enable this option to prevent the tooltip from being clipped when the component is placed inside a container with\n`overflow: auto|hidden|scroll`.", "attribute": "hoist", "inheritedFrom": { "name": "TooltipBase", "module": "src/components/tooltip/tooltip-base.ts" } }, { "kind": "method", "name": "show", "description": "Shows the alert.", "inheritedFrom": { "name": "TooltipBase", "module": "src/components/tooltip/tooltip-base.ts" } }, { "kind": "method", "name": "hide", "description": "Hides the alert", "inheritedFrom": { "name": "TooltipBase", "module": "src/components/tooltip/tooltip-base.ts" } } ], "events": [ { "description": "Emitted when the tooltip begins to show.", "name": "bp-tooltip-show", "reactName": "onBpTooltipShow" }, { "description": "Emitted after the tooltip has shown and all animations are complete.", "name": "bp-tooltip-after-show", "reactName": "onBpTooltipAfterShow" }, { "description": "Emitted when the tooltip begins to hide.", "name": "bp-tooltip-hide", "reactName": "onBpTooltipHide" }, { "description": "Emitted after the tooltip has hidden and all animations are complete.", "name": "bp-tooltip-after-hide", "reactName": "onBpTooltipAfterHide" } ], "superclass": { "name": "TooltipBase", "module": "/src/components/tooltip/tooltip-base.js" }, "since": "0.1.1-beta.1", "status": "beta", "tagName": "bp-tooltip", "customElement": true, "attributes": [ { "name": "content", "type": { "text": "string" }, "default": "''", "description": "The tooltip's content. If you need to display HTML, you can use the `content` slot instead.", "fieldName": "content", "inheritedFrom": { "name": "TooltipBase", "module": "src/components/tooltip/tooltip-base.ts" } }, { "name": "placement", "type": { "text": "| 'top'\n | 'top-start'\n | 'top-end'\n | 'right'\n | 'right-start'\n | 'right-end'\n | 'bottom'\n | 'bottom-start'\n | 'bottom-end'\n | 'left'\n | 'left-start'\n | 'left-end'" }, "default": "'top'", "description": "The preferred placement of the tooltip. Note that the actual placement may vary as needed to keep the tooltip\ninside of the viewport.", "fieldName": "placement", "inheritedFrom": { "name": "TooltipBase", "module": "src/components/tooltip/tooltip-base.ts" } }, { "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Disables the tooltip so it won't show when triggered.", "fieldName": "disabled", "inheritedFrom": { "name": "TooltipBase", "module": "src/components/tooltip/tooltip-base.ts" } }, { "name": "distance", "type": { "text": "number" }, "default": "8", "description": "The distance in pixels from which to offset the tooltip away from its target.", "fieldName": "distance", "inheritedFrom": { "name": "TooltipBase", "module": "src/components/tooltip/tooltip-base.ts" } }, { "name": "open", "type": { "text": "boolean" }, "default": "false", "description": "Indicates whether or not the tooltip is open. You can use this in lieu of the show/hide methods.", "fieldName": "open", "inheritedFrom": { "name": "TooltipBase", "module": "src/components/tooltip/tooltip-base.ts" } }, { "name": "skidding", "type": { "text": "number" }, "default": "0", "description": "The distance in pixels from which to offset the tooltip along its target.", "fieldName": "skidding", "inheritedFrom": { "name": "TooltipBase", "module": "src/components/tooltip/tooltip-base.ts" } }, { "name": "trigger", "type": { "text": "string" }, "default": "'hover focus'", "description": "Controls how the tooltip is activated. Possible options include `click`, `hover`, `focus`, and `manual`. Multiple\noptions can be passed by separating them with a space. When manual is used, the tooltip must be activated\nprogrammatically.", "fieldName": "trigger", "inheritedFrom": { "name": "TooltipBase", "module": "src/components/tooltip/tooltip-base.ts" } }, { "name": "hoist", "type": { "text": "boolean" }, "default": "false", "description": "Enable this option to prevent the tooltip from being clipped when the component is placed inside a container with\n`overflow: auto|hidden|scroll`.", "fieldName": "hoist", "inheritedFrom": { "name": "TooltipBase", "module": "src/components/tooltip/tooltip-base.ts" } } ] } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "Tooltip", "module": "src/components/tooltip/tooltip.ts" } }, { "kind": "custom-element-definition", "name": "bp-tooltip", "declaration": { "name": "Tooltip", "module": "src/components/tooltip/tooltip.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/top-app-bar/bp-top-app-bar-base.ts", "declarations": [ { "kind": "class", "description": "", "name": "TopAppBarBase", "members": [ { "kind": "field", "name": "centerTitle", "type": { "text": "boolean" }, "default": "false", "description": "Centers the title horizontally. Only meant to be used with 0 or 1 actionItems.", "attribute": "centerTitle" }, { "kind": "field", "name": "dense", "type": { "text": "boolean" }, "default": "false", "description": "Makes the bar a little smaller for higher density applications.", "attribute": "dense" }, { "kind": "field", "name": "prominent", "type": { "text": "boolean" }, "default": "false", "description": "Makes the bar much taller, can be combined with dense.", "attribute": "prominent" }, { "kind": "field", "name": "color", "type": { "text": "| 'primary'\n | 'secondary'\n | 'success'\n | 'warning'\n | 'error'\n | 'info'" }, "default": "'primary'", "description": "Color of the app bar.", "attribute": "color" } ], "attributes": [ { "name": "centerTitle", "type": { "text": "boolean" }, "default": "false", "description": "Centers the title horizontally. Only meant to be used with 0 or 1 actionItems.", "fieldName": "centerTitle" }, { "name": "dense", "type": { "text": "boolean" }, "default": "false", "description": "Makes the bar a little smaller for higher density applications.", "fieldName": "dense" }, { "name": "prominent", "type": { "text": "boolean" }, "default": "false", "description": "Makes the bar much taller, can be combined with dense.", "fieldName": "prominent" }, { "name": "color", "type": { "text": "| 'primary'\n | 'secondary'\n | 'success'\n | 'warning'\n | 'error'\n | 'info'" }, "default": "'primary'", "description": "Color of the app bar.", "fieldName": "color" } ], "superclass": { "name": "_TopAppBarBase", "package": "@material/mwc-top-app-bar/mwc-top-app-bar-base" } } ], "exports": [ { "kind": "js", "name": "TopAppBarBase", "declaration": { "name": "TopAppBarBase", "module": "src/components/top-app-bar/bp-top-app-bar-base.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/top-app-bar/bp-top-app-bar.ts", "declarations": [ { "kind": "class", "description": "", "name": "TopAppBar", "cssParts": [ { "description": "Sets the width of the appbar (default 100%);", "name": "--bp-top-app-bar-width" } ], "slots": [ { "description": "Scrollable content to display under the bar. This may be the entire application.", "name": "" }, { "description": "A number of elements to use for action icons on the right side.", "name": "actionItems" }, { "description": "One element to use for the left icon.", "name": "navigationIcon" }, { "description": "A
                                  or that will be used as the title text.", "name": "title" } ], "members": [ { "kind": "field", "name": "centerTitle", "type": { "text": "boolean" }, "default": "false", "description": "Centers the title horizontally. Only meant to be used with 0 or 1 actionItems.", "attribute": "centerTitle", "inheritedFrom": { "name": "TopAppBarBase", "module": "src/components/top-app-bar/bp-top-app-bar-base.ts" } }, { "kind": "field", "name": "dense", "type": { "text": "boolean" }, "default": "false", "description": "Makes the bar a little smaller for higher density applications.", "attribute": "dense", "inheritedFrom": { "name": "TopAppBarBase", "module": "src/components/top-app-bar/bp-top-app-bar-base.ts" } }, { "kind": "field", "name": "prominent", "type": { "text": "boolean" }, "default": "false", "description": "Makes the bar much taller, can be combined with dense.", "attribute": "prominent", "inheritedFrom": { "name": "TopAppBarBase", "module": "src/components/top-app-bar/bp-top-app-bar-base.ts" } }, { "kind": "field", "name": "color", "type": { "text": "| 'primary'\n | 'secondary'\n | 'success'\n | 'warning'\n | 'error'\n | 'info'" }, "default": "'primary'", "description": "Color of the app bar.", "attribute": "color", "inheritedFrom": { "name": "TopAppBarBase", "module": "src/components/top-app-bar/bp-top-app-bar-base.ts" } } ], "superclass": { "name": "TopAppBarBase", "module": "/src/components/top-app-bar/bp-top-app-bar-base.js" }, "since": "1.0", "status": "stable", "tagName": "bp-top-app-bar", "customElement": true, "attributes": [ { "name": "centerTitle", "type": { "text": "boolean" }, "default": "false", "description": "Centers the title horizontally. Only meant to be used with 0 or 1 actionItems.", "fieldName": "centerTitle", "inheritedFrom": { "name": "TopAppBarBase", "module": "src/components/top-app-bar/bp-top-app-bar-base.ts" } }, { "name": "dense", "type": { "text": "boolean" }, "default": "false", "description": "Makes the bar a little smaller for higher density applications.", "fieldName": "dense", "inheritedFrom": { "name": "TopAppBarBase", "module": "src/components/top-app-bar/bp-top-app-bar-base.ts" } }, { "name": "prominent", "type": { "text": "boolean" }, "default": "false", "description": "Makes the bar much taller, can be combined with dense.", "fieldName": "prominent", "inheritedFrom": { "name": "TopAppBarBase", "module": "src/components/top-app-bar/bp-top-app-bar-base.ts" } }, { "name": "color", "type": { "text": "| 'primary'\n | 'secondary'\n | 'success'\n | 'warning'\n | 'error'\n | 'info'" }, "default": "'primary'", "description": "Color of the app bar.", "fieldName": "color", "inheritedFrom": { "name": "TopAppBarBase", "module": "src/components/top-app-bar/bp-top-app-bar-base.ts" } } ] } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "TopAppBar", "module": "src/components/top-app-bar/bp-top-app-bar.ts" } }, { "kind": "custom-element-definition", "name": "bp-top-app-bar", "declaration": { "name": "TopAppBar", "module": "src/components/top-app-bar/bp-top-app-bar.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/translate/translate-base.ts", "declarations": [ { "kind": "class", "description": "", "name": "TranslateBase", "members": [ { "kind": "field", "name": "localize", "privacy": "private", "default": "new LocalizeController(this)" }, { "kind": "field", "name": "msg", "type": { "text": "string" }, "default": "''", "attribute": "msg" }, { "kind": "field", "name": "lang", "type": { "text": "string" }, "default": "''", "attribute": "lang" } ], "attributes": [ { "name": "msg", "type": { "text": "string" }, "default": "''", "fieldName": "msg" }, { "name": "lang", "type": { "text": "string" }, "default": "''", "fieldName": "lang" } ], "superclass": { "name": "LitElement", "package": "lit" }, "customElement": true } ], "exports": [ { "kind": "js", "name": "TranslateBase", "declaration": { "name": "TranslateBase", "module": "src/components/translate/translate-base.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/translate/translate.ts", "declarations": [ { "kind": "class", "description": "", "name": "Translate", "superclass": { "name": "TranslateBase", "module": "/src/components/translate/translate-base.js" }, "tagName": "bp-translate", "customElement": true, "attributes": [ { "name": "msg", "type": { "text": "string" }, "default": "''", "fieldName": "msg", "inheritedFrom": { "name": "TranslateBase", "module": "src/components/translate/translate-base.ts" } }, { "name": "lang", "type": { "text": "string" }, "default": "''", "fieldName": "lang", "inheritedFrom": { "name": "TranslateBase", "module": "src/components/translate/translate-base.ts" } } ], "members": [ { "kind": "field", "name": "localize", "privacy": "private", "default": "new LocalizeController(this)", "inheritedFrom": { "name": "TranslateBase", "module": "src/components/translate/translate-base.ts" } }, { "kind": "field", "name": "msg", "type": { "text": "string" }, "default": "''", "attribute": "msg", "inheritedFrom": { "name": "TranslateBase", "module": "src/components/translate/translate-base.ts" } }, { "kind": "field", "name": "lang", "type": { "text": "string" }, "default": "''", "attribute": "lang", "inheritedFrom": { "name": "TranslateBase", "module": "src/components/translate/translate-base.ts" } } ] } ], "exports": [ { "kind": "js", "name": "Translate", "declaration": { "name": "Translate", "module": "src/components/translate/translate.ts" } }, { "kind": "custom-element-definition", "name": "bp-translate", "declaration": { "name": "Translate", "module": "src/components/translate/translate.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/translations/en.ts", "declarations": [ { "kind": "variable", "name": "translation", "type": { "text": "DefaultTranslation" }, "default": "{\n $code: 'en',\n $name: 'English',\n $dir: 'ltr',\n}" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "translation", "module": "src/components/translations/en.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/translations/ja.ts", "declarations": [ { "kind": "variable", "name": "translation", "type": { "text": "DefaultTranslation" }, "default": "{\n $code: 'ja',\n $name: 'Japanese',\n $dir: 'ltr',\n}" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "translation", "module": "src/components/translations/ja.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/typography/typography-base.ts", "declarations": [ { "kind": "class", "description": "", "name": "TypographyBase", "members": [ { "kind": "field", "name": "variant", "type": { "text": "| 'headline1'\n | 'h1'\n | 'headline2'\n | 'h2'\n | 'headline3'\n | 'h3'\n | 'headline4'\n | 'h4'\n | 'headline5'\n | 'h5'\n | 'headline6'\n | 'h6'\n | 'subtitle1'\n | 'subtitle2'\n | 'body1'\n | 'body2'\n | 'caption'\n | 'button'\n | 'overline'\n | undefined" }, "default": "'body1'", "description": "Sets the theme typography styles.", "attribute": "variant" }, { "kind": "field", "name": "tag", "type": { "text": "Tag | undefined" }, "privacy": "private" }, { "kind": "method", "name": "getDefaultTagForVariant", "return": { "type": { "text": "Tag | undefined" } } }, { "kind": "method", "name": "tagGetter", "return": { "type": { "text": "StaticValue" } } } ], "attributes": [ { "name": "variant", "type": { "text": "| 'headline1'\n | 'h1'\n | 'headline2'\n | 'h2'\n | 'headline3'\n | 'h3'\n | 'headline4'\n | 'h4'\n | 'headline5'\n | 'h5'\n | 'headline6'\n | 'h6'\n | 'subtitle1'\n | 'subtitle2'\n | 'body1'\n | 'body2'\n | 'caption'\n | 'button'\n | 'overline'\n | undefined" }, "default": "'body1'", "description": "Sets the theme typography styles.", "fieldName": "variant" } ], "superclass": { "name": "LitElement", "package": "lit" }, "customElement": true } ], "exports": [ { "kind": "js", "name": "TypographyBase", "declaration": { "name": "TypographyBase", "module": "src/components/typography/typography-base.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/typography/typography.ts", "declarations": [ { "kind": "class", "description": "", "name": "Typography", "slots": [ { "description": "Slot used for content.", "name": "" } ], "superclass": { "name": "TypographyBase", "module": "/src/components/typography/typography-base.js" }, "since": "0.1.1-beta.1", "status": "beta", "tagName": "bp-typography", "customElement": true, "attributes": [ { "name": "variant", "type": { "text": "| 'headline1'\n | 'h1'\n | 'headline2'\n | 'h2'\n | 'headline3'\n | 'h3'\n | 'headline4'\n | 'h4'\n | 'headline5'\n | 'h5'\n | 'headline6'\n | 'h6'\n | 'subtitle1'\n | 'subtitle2'\n | 'body1'\n | 'body2'\n | 'caption'\n | 'button'\n | 'overline'\n | undefined" }, "default": "'body1'", "description": "Sets the theme typography styles.", "fieldName": "variant", "inheritedFrom": { "name": "TypographyBase", "module": "src/components/typography/typography-base.ts" } } ], "members": [ { "kind": "field", "name": "variant", "type": { "text": "| 'headline1'\n | 'h1'\n | 'headline2'\n | 'h2'\n | 'headline3'\n | 'h3'\n | 'headline4'\n | 'h4'\n | 'headline5'\n | 'h5'\n | 'headline6'\n | 'h6'\n | 'subtitle1'\n | 'subtitle2'\n | 'body1'\n | 'body2'\n | 'caption'\n | 'button'\n | 'overline'\n | undefined" }, "default": "'body1'", "description": "Sets the theme typography styles.", "attribute": "variant", "inheritedFrom": { "name": "TypographyBase", "module": "src/components/typography/typography-base.ts" } }, { "kind": "field", "name": "tag", "type": { "text": "Tag | undefined" }, "privacy": "private", "inheritedFrom": { "name": "TypographyBase", "module": "src/components/typography/typography-base.ts" } }, { "kind": "method", "name": "getDefaultTagForVariant", "return": { "type": { "text": "Tag | undefined" } }, "inheritedFrom": { "name": "TypographyBase", "module": "src/components/typography/typography-base.ts" } }, { "kind": "method", "name": "tagGetter", "return": { "type": { "text": "StaticValue" } }, "inheritedFrom": { "name": "TypographyBase", "module": "src/components/typography/typography-base.ts" } } ] } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "Typography", "module": "src/components/typography/typography.ts" } }, { "kind": "custom-element-definition", "name": "bp-typography", "declaration": { "name": "Typography", "module": "src/components/typography/typography.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/card/card-body/card-body-base.ts", "declarations": [ { "kind": "class", "description": "", "name": "CardBodyBase", "members": [], "superclass": { "name": "LitElement", "package": "lit" }, "customElement": true } ], "exports": [ { "kind": "js", "name": "CardBodyBase", "declaration": { "name": "CardBodyBase", "module": "src/components/card/card-body/card-body-base.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/card/card-body/card-body.ts", "declarations": [ { "kind": "class", "description": "", "name": "CardBody", "cssProperties": [ { "description": "The padding of the card body.", "name": "--bp-card-body-padding" } ], "members": [], "superclass": { "name": "CardBodyBase", "module": "/src/components/card/card-body/card-body-base" }, "since": "0.1.1-beta.1", "status": "beta", "dependencies": [ "bp-card" ], "tagName": "bp-card-body", "customElement": true } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "CardBody", "module": "src/components/card/card-body/card-body.ts" } }, { "kind": "custom-element-definition", "name": "bp-card-body", "declaration": { "name": "CardBody", "module": "src/components/card/card-body/card-body.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/card/card-media/card-media-base.ts", "declarations": [ { "kind": "class", "description": "", "name": "CardMediaBase", "members": [ { "kind": "field", "name": "aspectRatio", "type": { "text": "AspectRatioType" }, "default": "'16-9'", "description": "The aspect ratio of the media. Can be one of these values: '16-9' | 'square' | ''", "attribute": "aspectRatio" }, { "kind": "field", "name": "imageUrl", "type": { "text": "string" }, "default": "''", "description": "The background image url for the media", "attribute": "imageUrl" } ], "attributes": [ { "name": "aspectRatio", "type": { "text": "AspectRatioType" }, "default": "'16-9'", "description": "The aspect ratio of the media. Can be one of these values: '16-9' | 'square' | ''", "fieldName": "aspectRatio" }, { "name": "imageUrl", "type": { "text": "string" }, "default": "''", "description": "The background image url for the media", "fieldName": "imageUrl" } ], "superclass": { "name": "LitElement", "package": "lit" }, "customElement": true } ], "exports": [ { "kind": "js", "name": "CardMediaBase", "declaration": { "name": "CardMediaBase", "module": "src/components/card/card-media/card-media-base.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/card/card-media/card-media.ts", "declarations": [ { "kind": "class", "description": "", "name": "CardMedia", "members": [ { "description": "The border radius of the card media.", "name": "--mdc-card-media-border-radius", "kind": "field" }, { "description": "The background image of the card media.", "name": "--mdc-card-media-background-image", "kind": "field" }, { "kind": "field", "name": "aspectRatio", "type": { "text": "AspectRatioType" }, "default": "'16-9'", "description": "The aspect ratio of the media. Can be one of these values: '16-9' | 'square' | ''", "attribute": "aspectRatio", "inheritedFrom": { "name": "CardMediaBase", "module": "src/components/card/card-media/card-media-base.ts" } }, { "kind": "field", "name": "imageUrl", "type": { "text": "string" }, "default": "''", "description": "The background image url for the media", "attribute": "imageUrl", "inheritedFrom": { "name": "CardMediaBase", "module": "src/components/card/card-media/card-media-base.ts" } } ], "superclass": { "name": "CardMediaBase", "module": "/src/components/card/card-media/card-media-base" }, "since": "0.1.1-beta.1", "status": "beta", "dependencies": [ "bp-card" ], "tagName": "bp-card-media", "customElement": true, "attributes": [ { "name": "aspectRatio", "type": { "text": "AspectRatioType" }, "default": "'16-9'", "description": "The aspect ratio of the media. Can be one of these values: '16-9' | 'square' | ''", "fieldName": "aspectRatio", "inheritedFrom": { "name": "CardMediaBase", "module": "src/components/card/card-media/card-media-base.ts" } }, { "name": "imageUrl", "type": { "text": "string" }, "default": "''", "description": "The background image url for the media", "fieldName": "imageUrl", "inheritedFrom": { "name": "CardMediaBase", "module": "src/components/card/card-media/card-media-base.ts" } } ] } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "CardMedia", "module": "src/components/card/card-media/card-media.ts" } }, { "kind": "custom-element-definition", "name": "bp-card-media", "declaration": { "name": "CardMedia", "module": "src/components/card/card-media/card-media.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/card/card-primary-action/card-primary-action-base.ts", "declarations": [ { "kind": "class", "description": "", "name": "CardPrimaryActionBase", "members": [ { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "Label to display for the `aria-label`", "attribute": "label" }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Whether to disable the ripple effect.", "attribute": "disabled" }, { "kind": "method", "name": "getRipple" }, { "kind": "method", "name": "focus" }, { "kind": "method", "name": "blur" }, { "kind": "method", "name": "handleRippleActivate", "privacy": "protected", "parameters": [ { "name": "evt", "optional": true, "type": { "text": "Event" } } ] }, { "kind": "method", "name": "handleRippleDeactivate", "privacy": "protected" }, { "kind": "method", "name": "handleRippleMouseEnter", "privacy": "protected" }, { "kind": "method", "name": "handleRippleMouseLeave", "privacy": "protected" }, { "kind": "method", "name": "handleRippleFocus", "privacy": "protected" }, { "kind": "method", "name": "handleRippleBlur", "privacy": "protected" }, { "kind": "field", "name": "handleCardClick", "privacy": "protected" }, { "kind": "field", "name": "handleKeyPress", "privacy": "protected" } ], "attributes": [ { "name": "label", "type": { "text": "string" }, "default": "''", "description": "Label to display for the `aria-label`", "fieldName": "label" }, { "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Whether to disable the ripple effect.", "fieldName": "disabled" } ], "superclass": { "name": "LitElement", "package": "lit" }, "customElement": true } ], "exports": [ { "kind": "js", "name": "CardPrimaryActionBase", "declaration": { "name": "CardPrimaryActionBase", "module": "src/components/card/card-primary-action/card-primary-action-base.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/card/card-primary-action/card-primary-action.ts", "declarations": [ { "kind": "class", "description": "", "name": "CardPrimaryAction", "members": [ { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "Label to display for the `aria-label`", "attribute": "label", "inheritedFrom": { "name": "CardPrimaryActionBase", "module": "src/components/card/card-primary-action/card-primary-action-base.ts" } }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Whether to disable the ripple effect.", "attribute": "disabled", "inheritedFrom": { "name": "CardPrimaryActionBase", "module": "src/components/card/card-primary-action/card-primary-action-base.ts" } }, { "kind": "method", "name": "getRipple", "inheritedFrom": { "name": "CardPrimaryActionBase", "module": "src/components/card/card-primary-action/card-primary-action-base.ts" } }, { "kind": "method", "name": "focus", "inheritedFrom": { "name": "CardPrimaryActionBase", "module": "src/components/card/card-primary-action/card-primary-action-base.ts" } }, { "kind": "method", "name": "blur", "inheritedFrom": { "name": "CardPrimaryActionBase", "module": "src/components/card/card-primary-action/card-primary-action-base.ts" } }, { "kind": "method", "name": "handleRippleActivate", "privacy": "protected", "parameters": [ { "name": "evt", "optional": true, "type": { "text": "Event" } } ], "inheritedFrom": { "name": "CardPrimaryActionBase", "module": "src/components/card/card-primary-action/card-primary-action-base.ts" } }, { "kind": "method", "name": "handleRippleDeactivate", "privacy": "protected", "inheritedFrom": { "name": "CardPrimaryActionBase", "module": "src/components/card/card-primary-action/card-primary-action-base.ts" } }, { "kind": "method", "name": "handleRippleMouseEnter", "privacy": "protected", "inheritedFrom": { "name": "CardPrimaryActionBase", "module": "src/components/card/card-primary-action/card-primary-action-base.ts" } }, { "kind": "method", "name": "handleRippleMouseLeave", "privacy": "protected", "inheritedFrom": { "name": "CardPrimaryActionBase", "module": "src/components/card/card-primary-action/card-primary-action-base.ts" } }, { "kind": "method", "name": "handleRippleFocus", "privacy": "protected", "inheritedFrom": { "name": "CardPrimaryActionBase", "module": "src/components/card/card-primary-action/card-primary-action-base.ts" } }, { "kind": "method", "name": "handleRippleBlur", "privacy": "protected", "inheritedFrom": { "name": "CardPrimaryActionBase", "module": "src/components/card/card-primary-action/card-primary-action-base.ts" } }, { "kind": "field", "name": "handleCardClick", "privacy": "protected", "inheritedFrom": { "name": "CardPrimaryActionBase", "module": "src/components/card/card-primary-action/card-primary-action-base.ts" } }, { "kind": "field", "name": "handleKeyPress", "privacy": "protected", "inheritedFrom": { "name": "CardPrimaryActionBase", "module": "src/components/card/card-primary-action/card-primary-action-base.ts" } } ], "events": [ { "description": "Emitted when the card primary action is clicked.", "name": "bp-card-clicked", "reactName": "onBpCardClicked" } ], "superclass": { "name": "CardPrimaryActionBase", "module": "/src/components/card/card-primary-action/card-primary-action-base" }, "since": "0.1.1-beta.1", "status": "beta", "dependencies": [ "bp-card" ], "tagName": "bp-card-primary-action", "customElement": true, "attributes": [ { "name": "label", "type": { "text": "string" }, "default": "''", "description": "Label to display for the `aria-label`", "fieldName": "label", "inheritedFrom": { "name": "CardPrimaryActionBase", "module": "src/components/card/card-primary-action/card-primary-action-base.ts" } }, { "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Whether to disable the ripple effect.", "fieldName": "disabled", "inheritedFrom": { "name": "CardPrimaryActionBase", "module": "src/components/card/card-primary-action/card-primary-action-base.ts" } } ] } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "CardPrimaryAction", "module": "src/components/card/card-primary-action/card-primary-action.ts" } }, { "kind": "custom-element-definition", "name": "bp-card-primary-action", "declaration": { "name": "CardPrimaryAction", "module": "src/components/card/card-primary-action/card-primary-action.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/data-table/test/makeData.ts", "declarations": [ { "kind": "function", "name": "makeData", "parameters": [ { "name": "lens", "type": { "text": "number[]" } } ] }, { "kind": "function", "name": "getDefaultColdefs", "return": { "type": { "text": "ColumnDef[]" } } }, { "kind": "function", "name": "getGroupedColdefs", "return": { "type": { "text": "ColumnDef[]" } } } ], "exports": [ { "kind": "js", "name": "makeData", "declaration": { "name": "makeData", "module": "src/components/data-table/test/makeData.ts" } }, { "kind": "js", "name": "getDefaultColdefs", "declaration": { "name": "getDefaultColdefs", "module": "src/components/data-table/test/makeData.ts" } }, { "kind": "js", "name": "getGroupedColdefs", "declaration": { "name": "getGroupedColdefs", "module": "src/components/data-table/test/makeData.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/data-table/util/index.ts", "declarations": [ { "kind": "function", "name": "flexRender", "parameters": [ { "name": "out", "type": { "text": "unknown" } }, { "name": "props", "type": { "text": "T" } } ] }, { "kind": "function", "name": "renderHeaderCell", "parameters": [ { "name": "header", "type": { "text": "CoreHeader" } } ] }, { "kind": "function", "name": "renderCell", "parameters": [ { "name": "cell", "type": { "text": "CoreCell" } } ] } ], "exports": [ { "kind": "js", "name": "flexRender", "declaration": { "name": "flexRender", "module": "src/components/data-table/util/index.ts" } }, { "kind": "js", "name": "renderHeaderCell", "declaration": { "name": "renderHeaderCell", "module": "src/components/data-table/util/index.ts" } }, { "kind": "js", "name": "renderCell", "declaration": { "name": "renderCell", "module": "src/components/data-table/util/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/dialog/test/helpers.ts", "declarations": [ { "kind": "class", "description": "", "name": "TestFixture", "members": [ { "kind": "field", "name": "shouldAttachContents", "type": { "text": "boolean" }, "default": "true", "attribute": "shouldAttachContents" }, { "kind": "field", "name": "template", "type": { "text": "TemplateResult" }, "default": "html``", "attribute": "template" }, { "kind": "method", "name": "remove", "return": { "type": { "text": "boolean" } } }, { "kind": "field", "name": "root", "type": { "text": "ShadowRoot" } }, { "kind": "method", "name": "attachContents", "parameters": [ { "name": "options", "default": "{awaitRender: false}" } ] }, { "kind": "method", "name": "detachContents", "parameters": [ { "name": "options", "default": "{awaitRender: false}" } ] } ], "attributes": [ { "name": "shouldAttachContents", "type": { "text": "boolean" }, "default": "true", "fieldName": "shouldAttachContents" }, { "name": "template", "type": { "text": "TemplateResult" }, "default": "html``", "fieldName": "template" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "test-fixture", "customElement": true }, { "kind": "function", "name": "fixture", "parameters": [ { "name": "template", "type": { "text": "TemplateResult" } }, { "name": "options", "optional": true, "type": { "text": "Partial" } } ] }, { "kind": "function", "name": "measureFixtureCreation", "parameters": [ { "name": "template", "type": { "text": "TemplateResult" } }, { "name": "options", "optional": true, "type": { "text": "Partial" } } ] }, { "kind": "function", "name": "rafPromise" }, { "kind": "function", "name": "waitForEvent", "parameters": [ { "name": "el", "type": { "text": "Element" } }, { "name": "ev", "type": { "text": "string" } } ] }, { "kind": "function", "name": "ieSafeKeyboardEvent", "parameters": [ { "name": "type", "type": { "text": "string" } }, { "name": "keycode", "type": { "text": "number" } } ] } ], "exports": [ { "kind": "js", "name": "TestFixture", "declaration": { "name": "TestFixture", "module": "src/components/dialog/test/helpers.ts" } }, { "kind": "custom-element-definition", "name": "test-fixture", "declaration": { "name": "TestFixture", "module": "src/components/dialog/test/helpers.ts" } }, { "kind": "js", "name": "fixture", "declaration": { "name": "fixture", "module": "src/components/dialog/test/helpers.ts" } }, { "kind": "js", "name": "measureFixtureCreation", "declaration": { "name": "measureFixtureCreation", "module": "src/components/dialog/test/helpers.ts" } }, { "kind": "js", "name": "rafPromise", "declaration": { "name": "rafPromise", "module": "src/components/dialog/test/helpers.ts" } }, { "kind": "js", "name": "waitForEvent", "declaration": { "name": "waitForEvent", "module": "src/components/dialog/test/helpers.ts" } }, { "kind": "js", "name": "ieSafeKeyboardEvent", "declaration": { "name": "ieSafeKeyboardEvent", "module": "src/components/dialog/test/helpers.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/dual-listbox/lib/render-list-view.ts", "declarations": [ { "kind": "function", "name": "renderListView", "parameters": [ { "name": "list", "type": { "text": "IList[]" } }, { "name": "onItemDoubleClick", "type": { "text": "(value: number | string) => void" } } ] } ], "exports": [ { "kind": "js", "name": "renderListView", "declaration": { "name": "renderListView", "module": "src/components/dual-listbox/lib/render-list-view.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/dual-listbox/types/DispatchOption.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/dual-listbox/types/IAllAvailableList.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/dual-listbox/types/IList.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/layout-grid/types/IClasses.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/list-multi-column/types/roles.ts", "declarations": [], "exports": [] } ], "package": { "name": "@blackpurl/web-components", "description": "Blackpurl Web Components for Blackpurl product", "version": "0.1.1-beta.30", "author": "Blackpurl", "homepage": "https://web-components.blackpurl.com", "license": "MIT" } }