{ "schemaVersion": "1.0.0", "readme": "", "modules": [ { "kind": "javascript-module", "path": "components/bibtemplate/src/auro-bibtemplate.js", "declarations": [ { "kind": "class", "description": "The `auro-bibtemplate` element provides users a template for creating modal dialog elements.", "name": "AuroBibtemplate", "slots": [ { "description": "The default slot for the main content.", "name": "default" }, { "description": "Slot for the header content.", "name": "header" }, { "description": "Slot for the subheader content.", "name": "subheader" }, { "description": "Slot for the footer content.", "name": "footer" }, { "description": "Slot for the close button aria-label.", "name": "ariaLabel.close" } ], "members": [ { "kind": "method", "name": "register", "static": true, "parameters": [ { "name": "name", "default": "\"auro-bibtemplate\"", "description": "The name of element that you want to register to.", "optional": true, "type": { "text": "string" } } ], "description": "This will register this element with the browser." }, { "kind": "method", "name": "preventBodyScroll", "parameters": [ { "name": "event", "description": "The touchmove event.", "type": { "text": "Event" } } ], "description": "Prevents scrolling of the body when touching empty areas of the component.", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "focusCloseButton", "description": "Focuses the close button inside the bibtemplate's shadow DOM.\nUsed by parent components to set initial focus when the fullscreen dialog opens.", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "onCloseButtonClick" }, { "kind": "method", "name": "exposeCssParts", "description": "Exposes CSS parts for styling from parent components.", "return": { "type": { "text": "void" } } }, { "kind": "field", "name": "large", "privacy": "public", "type": { "text": "boolean" }, "default": "false", "attribute": "large", "reflects": true }, { "kind": "field", "name": "iconTag", "privacy": "private" }, { "kind": "field", "name": "headerTag", "privacy": "private" }, { "kind": "field", "name": "buttonTag", "privacy": "private" }, { "kind": "field", "name": "isFullscreen", "privacy": "public", "type": { "text": "boolean" }, "attribute": "isFullscreen", "reflects": true } ], "events": [ { "name": "close-click", "type": { "text": "Event" } }, { "name": "auro-bibtemplate-connected", "type": { "text": "CustomEvent" } } ], "attributes": [ { "name": "isFullscreen", "type": { "text": "boolean" }, "fieldName": "isFullscreen" }, { "name": "large", "type": { "text": "boolean" }, "default": "false", "fieldName": "large" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "auro-bibtemplate", "customElement": true } ], "exports": [ { "kind": "js", "name": "AuroBibtemplate", "declaration": { "name": "AuroBibtemplate", "module": "components/bibtemplate/src/auro-bibtemplate.js" } } ] }, { "kind": "javascript-module", "path": "components/bibtemplate/src/buttonVersion.js", "declarations": [], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "12.3.2", "module": "components/bibtemplate/src/buttonVersion.js" } } ] }, { "kind": "javascript-module", "path": "components/bibtemplate/src/headerVersion.js", "declarations": [], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "5.0.1", "module": "components/bibtemplate/src/headerVersion.js" } } ] }, { "kind": "javascript-module", "path": "components/bibtemplate/src/iconVersion.js", "declarations": [], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "9.1.2", "module": "components/bibtemplate/src/iconVersion.js" } } ] }, { "kind": "javascript-module", "path": "components/bibtemplate/src/index.js", "declarations": [], "exports": [ { "kind": "js", "name": "AuroBibtemplate", "declaration": { "name": "AuroBibtemplate", "module": "components/bibtemplate/src/index.js" } } ] }, { "kind": "javascript-module", "path": "components/bibtemplate/src/registered.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "components/checkbox/src/auro-checkbox-group.js", "declarations": [ { "kind": "class", "description": "The `auro-checkbox-group` element is a wrapper for `auro-checkbox` elements.", "name": "AuroCheckboxGroup", "slots": [ { "description": "Allows for the legend to be overridden.", "name": "legend" }, { "description": "Allows overriding the optional display text \"(optional)\", which appears next to the label.", "name": "optionalLabel" }, { "description": "Allows for the helper text to be overridden.", "name": "helpText" }, { "description": "The default slot for the checkbox items.", "name": "default" } ], "members": [ { "kind": "method", "name": "_initializeDefaults" }, { "kind": "method", "name": "register", "static": true, "parameters": [ { "name": "name", "default": "\"auro-checkbox-group\"", "description": "The name of the element that you want to register.", "optional": true, "type": { "text": "string" } } ], "description": "This will register this element with the browser." }, { "kind": "method", "name": "handleValueUpdate", "parameters": [ { "name": "value", "description": "The value of the checkbox.", "type": { "text": "String" } }, { "name": "selected", "description": "The checked state of the checkbox.", "type": { "text": "Boolean" } } ], "description": "Helper method to handle checkbox value changing.", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "handlePreselectedItems", "description": "Helper method that handles the state of preselected checkboxes.", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "handleItems", "description": "Helper method that handles the state of checkboxes.", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "reset", "description": "Resets component to initial state.", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "validate", "parameters": [ { "name": "force", "default": "false", "description": "Whether to force validation.", "optional": true, "type": { "text": "boolean" } } ], "description": "Validates value." }, { "kind": "field", "name": "appearance", "privacy": "public", "type": { "text": "'default' | 'inverse'" }, "description": "Defines whether the component will be on lighter or darker backgrounds.", "default": "'default'", "attribute": "appearance", "reflects": true }, { "kind": "field", "name": "disabled", "privacy": "public", "type": { "text": "boolean" }, "description": "If set, disables the checkbox group.", "attribute": "disabled", "reflects": true }, { "kind": "field", "name": "error", "privacy": "public", "type": { "text": "string" }, "description": "When defined, sets persistent validity to `customError` and sets the validation message to the attribute value.", "attribute": "error", "reflects": true }, { "kind": "field", "name": "horizontal", "privacy": "public", "type": { "text": "boolean" }, "description": "If set, checkboxes will be aligned horizontally.", "attribute": "horizontal", "reflects": true }, { "kind": "field", "name": "noValidate", "privacy": "public", "type": { "text": "boolean" }, "description": "If set, disables auto-validation on blur.", "attribute": "noValidate", "reflects": true }, { "kind": "field", "name": "onDark", "privacy": "public", "type": { "text": "boolean" }, "description": "DEPRECATED - use `appearance=\"inverse\"` instead.", "attribute": "onDark", "reflects": true }, { "kind": "field", "name": "required", "privacy": "public", "type": { "text": "boolean" }, "description": "Populates the `required` attribute on the element. Used for client-side validation.", "attribute": "required", "reflects": true }, { "kind": "field", "name": "setCustomValidity", "privacy": "public", "type": { "text": "string" }, "description": "Sets a custom help text message to display for all validityStates.", "attribute": "setCustomValidity" }, { "kind": "field", "name": "setCustomValidityCustomError", "privacy": "public", "type": { "text": "string" }, "description": "Custom help text message to display when validity = `customError`.", "attribute": "setCustomValidityCustomError" }, { "kind": "field", "name": "setCustomValidityValueMissing", "privacy": "public", "type": { "text": "string" }, "description": "Custom help text message to display when validity = `valueMissing`.", "attribute": "setCustomValidityValueMissing" }, { "kind": "field", "name": "validity", "privacy": "public", "type": { "text": "string" }, "description": "Specifies the `validityState` this element is in.", "attribute": "validity", "reflects": true } ], "events": [ { "name": "input", "type": { "text": "CustomEvent" } }, { "description": "Notifies that the `validity` and `errorMessage` values have changed.", "name": "auroFormElement-validated" } ], "attributes": [ { "name": "appearance", "type": { "text": "'default' | 'inverse'" }, "description": "Defines whether the component will be on lighter or darker backgrounds.", "default": "'default'", "fieldName": "appearance" }, { "name": "disabled", "type": { "text": "boolean" }, "description": "If set, disables the checkbox group.", "fieldName": "disabled" }, { "name": "error", "type": { "text": "string" }, "description": "When defined, sets persistent validity to `customError` and sets the validation message to the attribute value.", "fieldName": "error" }, { "name": "horizontal", "type": { "text": "boolean" }, "description": "If set, checkboxes will be aligned horizontally.", "fieldName": "horizontal" }, { "name": "noValidate", "type": { "text": "boolean" }, "description": "If set, disables auto-validation on blur.", "fieldName": "noValidate" }, { "name": "onDark", "type": { "text": "boolean" }, "description": "DEPRECATED - use `appearance=\"inverse\"` instead.", "fieldName": "onDark" }, { "name": "required", "type": { "text": "boolean" }, "description": "Populates the `required` attribute on the element. Used for client-side validation.", "fieldName": "required" }, { "name": "setCustomValidity", "type": { "text": "string" }, "description": "Sets a custom help text message to display for all validityStates.", "fieldName": "setCustomValidity" }, { "name": "setCustomValidityCustomError", "type": { "text": "string" }, "description": "Custom help text message to display when validity = `customError`.", "fieldName": "setCustomValidityCustomError" }, { "name": "setCustomValidityValueMissing", "type": { "text": "string" }, "description": "Custom help text message to display when validity = `valueMissing`.", "fieldName": "setCustomValidityValueMissing" }, { "name": "validity", "type": { "text": "string" }, "description": "Specifies the `validityState` this element is in.", "fieldName": "validity" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "auro-checkbox-group", "customElement": true } ], "exports": [ { "kind": "js", "name": "AuroCheckboxGroup", "declaration": { "name": "AuroCheckboxGroup", "module": "components/checkbox/src/auro-checkbox-group.js" } } ] }, { "kind": "javascript-module", "path": "components/checkbox/src/auro-checkbox.js", "declarations": [ { "kind": "class", "description": "The `auro-checkbox` element is for the purpose of allowing users to select one or more options of a limited number of choices.", "name": "AuroCheckbox", "cssParts": [ { "description": "apply css to a specific checkbox.", "name": "checkbox" }, { "description": "apply css to a specific checkbox's input.", "name": "checkbox-input" }, { "description": "apply css to a specific checkbox's label.", "name": "checkbox-label" } ], "slots": [ { "description": "The default slot for the checkbox label.", "name": "default" } ], "members": [ { "kind": "method", "name": "_initializeDefaults" }, { "kind": "method", "name": "register", "static": true, "parameters": [ { "name": "name", "default": "\"auro-checkbox\"", "description": "The name of element that you want to register to.", "optional": true, "type": { "text": "string" } } ], "description": "This will register this element with the browser." }, { "kind": "method", "name": "handleChange", "parameters": [ { "name": "event", "description": "The change event from the checkbox input.", "type": { "text": "Event" } } ], "description": "Handles the change event for the checkbox input.\nUpdates the checked state and dispatches a corresponding custom event.\nThis custom event is only for the purpose of supporting IE.", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "handleInput", "parameters": [ { "name": "event", "description": "The input event from the checkbox input.", "type": { "text": "Event" } } ], "description": "Handles the input event for the checkbox input.\nUpdates the checked state and dispatches a custom 'auroCheckbox-input' event.", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "handleFocusin", "description": "Function to support", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "generateIconHtml", "description": "Function to generate checkmark svg.", "privacy": "private", "return": { "type": { "text": "HTMLElement" } } }, { "kind": "method", "name": "reset", "description": "Resets component to initial state.", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "updateAriaLabel", "description": "Updates the aria-label based on slot content.", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "handleKeyDown", "parameters": [ { "name": "event", "description": "The keydown event from the checkbox input.", "type": { "text": "KeyboardEvent" } } ], "description": "Handles keydown event to toggle the checkbox with Space key.", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "field", "name": "appearance", "privacy": "public", "type": { "text": "'default' | 'inverse'" }, "description": "Defines whether the component will be on lighter or darker backgrounds.", "default": "'default'", "attribute": "appearance", "reflects": true }, { "kind": "field", "name": "checked", "privacy": "public", "type": { "text": "boolean" }, "description": "If set to true, the checkbox will be filled with a checkmark.", "attribute": "checked", "reflects": true }, { "kind": "field", "name": "disabled", "privacy": "public", "type": { "text": "boolean" }, "description": "If set to true, the checkbox will not be clickable.", "attribute": "disabled", "reflects": true }, { "kind": "field", "name": "error", "privacy": "public", "type": { "text": "boolean" }, "description": "If set to true, the checkbox will be displayed with an error state.", "attribute": "error", "reflects": true }, { "kind": "field", "name": "id", "privacy": "public", "type": { "text": "string" }, "description": "The id global attribute defines an identifier (ID) which must be unique in the whole document.", "attribute": "id" }, { "kind": "field", "name": "inputId", "privacy": "private", "type": { "text": "string" }, "description": "The id for input node." }, { "kind": "field", "name": "name", "privacy": "public", "type": { "text": "string" }, "description": "Accepts any string and is used to identify related checkboxes when submitting form data.", "attribute": "name" }, { "kind": "field", "name": "onDark", "privacy": "public", "type": { "text": "boolean" }, "description": "DEPRECATED - use `appearance=\"inverse\"` instead.", "attribute": "onDark", "reflects": true }, { "kind": "field", "name": "touched", "privacy": "private", "type": { "text": "boolean" }, "description": "Indicates whether the checkbox has been interacted with." }, { "kind": "field", "name": "value", "privacy": "public", "type": { "text": "string" }, "description": "Sets the element's input value. Must be unique within an auro-checkbox-group element.", "attribute": "value" }, { "kind": "field", "name": "tabIndex", "privacy": "private", "type": { "text": "number" }, "description": "The tabindex attribute for the checkbox.", "attribute": "tabindex", "reflects": true }, { "kind": "field", "name": "ariaChecked", "privacy": "private", "type": { "text": "string" }, "description": "The aria-checked attribute for the checkbox.", "attribute": "aria-checked", "reflects": true }, { "kind": "field", "name": "ariaDisabled", "privacy": "private", "type": { "text": "string" }, "description": "The aria-disabled attribute for the checkbox.", "attribute": "aria-disabled", "reflects": true }, { "kind": "field", "name": "role", "privacy": "private", "type": { "text": "string" }, "description": "The ARIA role for the element. Must remain 'checkbox' for screen readers\nto correctly identify this as a checkbox control.", "attribute": "role", "reflects": true } ], "events": [ { "name": "auroCheckbox-input", "type": { "text": "CustomEvent" } }, { "name": "auroCheckbox-focusin", "type": { "text": "CustomEvent" } }, { "name": "auroCheckbox-focusout", "type": { "text": "CustomEvent" } }, { "type": { "text": "CustomEvent" }, "description": "(Deprecated) Notifies when checked value is changed.", "name": "change" }, { "type": { "text": "InputEvent" }, "description": "Notifies when when checked value is changed by user's interface.", "name": "input" } ], "attributes": [ { "name": "appearance", "type": { "text": "'default' | 'inverse'" }, "description": "Defines whether the component will be on lighter or darker backgrounds.", "default": "'default'", "fieldName": "appearance" }, { "name": "checked", "type": { "text": "boolean" }, "description": "If set to true, the checkbox will be filled with a checkmark.", "fieldName": "checked" }, { "name": "disabled", "type": { "text": "boolean" }, "description": "If set to true, the checkbox will not be clickable.", "fieldName": "disabled" }, { "name": "error", "type": { "text": "boolean" }, "description": "If set to true, the checkbox will be displayed with an error state.", "fieldName": "error" }, { "name": "id", "type": { "text": "string" }, "description": "The id global attribute defines an identifier (ID) which must be unique in the whole document.", "fieldName": "id" }, { "name": "name", "type": { "text": "string" }, "description": "Accepts any string and is used to identify related checkboxes when submitting form data.", "fieldName": "name" }, { "name": "onDark", "type": { "text": "boolean" }, "description": "DEPRECATED - use `appearance=\"inverse\"` instead.", "fieldName": "onDark" }, { "name": "value", "type": { "text": "string" }, "description": "Sets the element's input value. Must be unique within an auro-checkbox-group element.", "fieldName": "value" }, { "name": "tabindex", "type": { "text": "number" }, "description": "The tabindex attribute for the checkbox.", "fieldName": "tabIndex" }, { "name": "aria-checked", "type": { "text": "string" }, "description": "The aria-checked attribute for the checkbox.", "fieldName": "ariaChecked" }, { "name": "aria-disabled", "type": { "text": "string" }, "description": "The aria-disabled attribute for the checkbox.", "fieldName": "ariaDisabled" }, { "name": "role", "type": { "text": "string" }, "description": "The ARIA role for the element. Must remain 'checkbox' for screen readers\nto correctly identify this as a checkbox control.", "fieldName": "role" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "auro-checkbox", "customElement": true } ], "exports": [ { "kind": "js", "name": "AuroCheckbox", "declaration": { "name": "AuroCheckbox", "module": "components/checkbox/src/auro-checkbox.js" } } ] }, { "kind": "javascript-module", "path": "components/checkbox/src/index.js", "declarations": [], "exports": [ { "kind": "js", "name": "AuroCheckbox", "declaration": { "name": "AuroCheckbox", "module": "components/checkbox/src/index.js" } }, { "kind": "js", "name": "AuroCheckboxGroup", "declaration": { "name": "AuroCheckboxGroup", "module": "components/checkbox/src/index.js" } } ] }, { "kind": "javascript-module", "path": "components/checkbox/src/registered.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "components/combobox/src/auro-combobox.js", "declarations": [ { "kind": "class", "description": "The `auro-combobox` element provides users with a way to select an option from a list of filtered or suggested options based on user input.", "name": "AuroCombobox", "slots": [ { "description": "Default slot for the menu content.", "name": "" }, { "type": { "text": "HTMLSlotElement" }, "description": "Allows overriding the optional display text \"(optional)\", which appears next to the label.", "name": "optionalLabel" }, { "description": "Sets aria-label on clear button", "name": "ariaLabel.input.clear" }, { "description": "Sets aria-label on close button in fullscreen bib", "name": "ariaLabel.bib.close" }, { "description": "Defines the headline to display above menu-options", "name": "bib.fullscreen.headline" }, { "description": "Defines the content of the label.", "name": "label" }, { "description": "Defines the content of the helpText.", "name": "helpText" }, { "description": "Allows custom HTML content to display the selected value when the combobox is not focused. Only works with `snowflake` and `emphasized` layouts.", "name": "displayValue" } ], "members": [ { "kind": "method", "name": "_initializeDefaults", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "field", "name": "inputValue", "description": "Returns the current value of the input element within the combobox.", "return": { "type": { "text": "string|undefined" } }, "readonly": true }, { "kind": "method", "name": "isValid", "description": "Checks if the element is valid.", "return": { "type": { "text": "boolean" } } }, { "kind": "method", "name": "register", "static": true, "parameters": [ { "name": "name", "default": "'auro-combobox'", "description": "The name of the element that you want to register.", "optional": true, "type": { "text": "string" } } ], "description": "This will register this element with the browser." }, { "kind": "method", "name": "updateFilter", "description": "Updates the filter for the available options based on the input value.", "privacy": "private" }, { "kind": "method", "name": "syncValuesAndStates", "description": "Syncs the values and states of this component, the input, and the menu, including this.optionSelected and this.menu.optionSelected.", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "updateTriggerTextDisplay", "parameters": [ { "name": "label", "description": "The label of the selected option.", "type": { "text": "string" } } ], "description": "Update displayValue or input.value, it's called when making a selection.", "privacy": "private" }, { "kind": "method", "name": "handleMenuOptions", "description": "Processes hidden state of all menu options and determines if there are any available options not hidden.", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "generateOptionsArray", "description": "Determines the element error state based on the `required` attribute and input value.", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "hideBib", "description": "Hides the dropdown bib if its open.", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "showBib", "description": "Shows the dropdown bib if there are options to show.", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "configureDropdown", "description": "Binds all behavior needed to the dropdown after rendering.", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "setClearBtnFocus", "privacy": "private" }, { "kind": "method", "name": "setInputFocus", "privacy": "private" }, { "kind": "method", "name": "updateBibDialogRole", "description": "Suppresses or restores dialog semantics on the bib's dialog element.\nOn desktop (non-fullscreen), VoiceOver verbosely announces \"listbox inside\nof a dialog\" which disrupts combobox usage. Setting role=\"presentation\"\nsuppresses this. In fullscreen mode, dialog semantics are restored.", "privacy": "private" }, { "kind": "method", "name": "updateMenuShapeSize", "description": "Update menu to default for fullscreen bib, otherwise to this.size and this.shape.", "privacy": "private" }, { "kind": "method", "name": "configureMenu", "description": "Binds all behavior needed to the menu after rendering.", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "configureInput", "description": "Binds all behavior needed to the input after rendering.", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "handleMenuLoadingChange", "parameters": [ { "name": "event", "description": "The event object containing details about the loading state change.", "type": { "text": "CustomEvent" } }, { "description": "Indicates whether the menu is currently loading.", "name": "event.detail.loading", "type": { "text": "boolean" } }, { "description": "Indicates if there are loading placeholders present.", "name": "event.detail.hasLoadingPlaceholder", "type": { "text": "boolean" } } ], "description": "Manages the visibility of the dropdown based on loading state changes.\n\nThis method listens for loading state changes and adjusts the visibility of the dropdown accordingly.\nIf the dropdown is visible and loading is true without any loading placeholders, it hides the dropdown\nand sets a flag to indicate it is hidden while loading. If loading is false and the dropdown was previously\nhidden, it checks if the active element is within the dropdown and shows it again if true.", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "handleInputValueChange", "parameters": [ { "name": "event", "description": "The input event triggered by the input element.", "type": { "text": "Event" } } ], "description": "Handle changes to the input value and trigger changes that should result.", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "configureCombobox", "description": "Binds all behavior needed to the combobox after rendering.", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "focus", "description": "Focuses the combobox trigger input.", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "setMenuValue", "parameters": [ { "name": "value", "description": "The value to set on the menu.", "type": { "text": "string" } } ], "description": "Sets the menu value if menu is available.", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "reset", "description": "Resets component to initial state.", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "clear", "description": "Clears the current value of the combobox.", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "validate", "parameters": [ { "name": "force", "default": "false", "description": "Whether to force validation.", "optional": true, "type": { "text": "boolean" } } ], "description": "Validates value." }, { "kind": "method", "name": "transportAssignedNodes", "parameters": [ { "name": "slot", "description": "The slot element containing the nodes to apply.", "type": { "text": "HTMLSlotElement" } }, { "name": "target", "description": "The target element to apply the nodes to.", "type": { "text": "HTMLElement" } }, { "name": "newSlotName", "description": "The new slot name for the applied nodes.", "type": { "text": "string" } } ], "description": "Applies slotted nodes to a target element with a new slot name.", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "updateActiveOption", "parameters": [ { "name": "index", "description": "Index of the option to make active.", "type": { "text": "number" } } ], "description": "Updates the active option in the menu." }, { "kind": "method", "name": "handleSlotChange", "parameters": [ { "name": "event", "description": "`slotchange` event.", "type": { "text": "Event" } } ], "description": "Watch for slot changes and recalculate the menuoptions.", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "field", "name": "appearance", "privacy": "public", "type": { "text": "string" }, "description": "Defines whether the component will be on lighter or darker backgrounds.", "default": "'default'", "attribute": "appearance", "reflects": true }, { "kind": "field", "name": "autocomplete", "privacy": "public", "type": { "text": "string" }, "description": "An enumerated attribute that defines what the user agent can suggest for autofill. At this time, only `autocomplete=\"off\"` is supported.", "attribute": "autocomplete", "reflects": true }, { "kind": "field", "name": "autoPlacement", "privacy": "public", "type": { "text": "boolean" }, "description": "If declared, bib's position will be automatically calculated where to appear.", "attribute": "autoPlacement", "reflects": true }, { "kind": "field", "name": "availableOptions", "privacy": "private", "type": { "text": "array" }, "description": "Array of available options to display in the dropdown.", "attribute": "availableOptions" }, { "kind": "field", "name": "behavior", "privacy": "public", "type": { "text": "'filter' | 'suggestion'" }, "description": "Sets the behavior of the combobox, \"filter\" or \"suggestion\".\n\"filter\" requires the user to select an option from the menu.\n\"suggestion\" allows the user to enter a value not present in the menu options.", "default": "'suggestion'", "attribute": "behavior", "reflects": true }, { "kind": "field", "name": "checkmark", "privacy": "public", "type": { "text": "boolean" }, "description": "When attribute is present auro-menu will apply check marks to selected options.", "attribute": "checkmark", "reflects": true }, { "kind": "field", "name": "disabled", "privacy": "public", "type": { "text": "boolean" }, "description": "If set, disables the combobox.", "attribute": "disabled", "reflects": true }, { "kind": "field", "name": "dropdownId", "privacy": "private", "type": { "text": "string" }, "description": "ID for the dropdown." }, { "kind": "field", "name": "dropdownOpen", "privacy": "private", "type": { "text": "boolean" }, "description": "Whether or not the dropdown is open." }, { "kind": "field", "name": "dvInputOnly", "privacy": "public", "type": { "text": "boolean" }, "description": "If defined, the display value slot content will only mask the HTML5 input element. The inputs label will not be masked.", "attribute": "dvInputOnly", "reflects": true }, { "kind": "field", "name": "error", "privacy": "public", "type": { "text": "string" }, "description": "When defined, sets persistent validity to `customError` and sets the validation message to the attribute value.", "attribute": "error", "reflects": true }, { "kind": "field", "name": "format", "privacy": "public", "type": { "text": "string" }, "description": "Specifies the input mask format.", "attribute": "format", "reflects": true }, { "kind": "field", "name": "inputmode", "privacy": "public", "type": { "text": "string" }, "description": "Exposes inputmode attribute for input.", "attribute": "inputmode", "reflects": true }, { "kind": "field", "name": "layout", "privacy": "public", "type": { "text": "string" }, "description": "Sets the layout of the combobox.", "default": "'classic'", "attribute": "layout", "reflects": true, "inheritedFrom": { "name": "AuroElement", "module": "components/layoutElement/src/auroElement.js" } }, { "kind": "field", "name": "matchWidth", "privacy": "private", "type": { "text": "boolean" }, "description": "If declared, the popover and trigger will be set to the same width.", "attribute": "matchWidth", "reflects": true }, { "kind": "field", "name": "noFilter", "privacy": "public", "type": { "text": "boolean" }, "description": "If set, combobox will not filter menuoptions based on input.", "attribute": "noFilter", "reflects": true }, { "kind": "field", "name": "noFlip", "privacy": "public", "type": { "text": "boolean" }, "description": "If declared, the bib will NOT flip to an alternate position\nwhen there isn't enough space in the specified `placement`.", "attribute": "noFlip", "reflects": true }, { "kind": "field", "name": "shift", "privacy": "public", "type": { "text": "boolean" }, "description": "If declared, the dropdown will shift its position to avoid being cut off by the viewport.", "attribute": "shift", "reflects": true }, { "kind": "field", "name": "noValidate", "privacy": "public", "type": { "text": "boolean" }, "description": "If set, disables auto-validation on blur.", "attribute": "noValidate", "reflects": true }, { "kind": "field", "name": "offset", "privacy": "public", "type": { "text": "number" }, "description": "Gap between the trigger element and bib.", "default": "0", "attribute": "offset", "reflects": true }, { "kind": "field", "name": "onDark", "privacy": "public", "type": { "text": "boolean" }, "attribute": "onDark", "reflects": true, "description": "DEPRECATED - use `appearance=\"inverse\"` instead.", "inheritedFrom": { "name": "AuroElement", "module": "components/layoutElement/src/auroElement.js" } }, { "kind": "field", "name": "optionSelected", "privacy": "public", "type": { "text": "HTMLElement" }, "description": "Specifies the current selected option.", "attribute": "optionSelected" }, { "kind": "field", "name": "persistInput", "privacy": "public", "type": { "text": "boolean" }, "description": "If declared, selecting a menu option will not change the input value. By doing so,\nthe current menu filter will be preserved and the user can continue from their last\nfilter state. It is recommended to use this in combination with the `displayValue` slot.", "attribute": "persistInput", "reflects": true }, { "kind": "field", "name": "placement", "privacy": "public", "type": { "text": "'top' | 'right' | 'bottom' | 'left' | 'bottom-start' | 'top-start' | 'top-end' | 'right-start' | 'right-end' | 'bottom-end' | 'left-start' | 'left-end'" }, "description": "Position where the bib should appear relative to the trigger.", "default": "'bottom-start'", "attribute": "placement", "reflects": true }, { "kind": "field", "name": "placeholder", "privacy": "public", "type": { "text": "string" }, "description": "Define custom placeholder text, only supported by date input formats.", "attribute": "placeholder", "reflects": true }, { "kind": "field", "name": "required", "privacy": "public", "type": { "text": "boolean" }, "description": "Populates the `required` attribute on the input. Used for client-side validation.", "attribute": "required", "reflects": true }, { "kind": "field", "name": "setCustomValidity", "privacy": "public", "type": { "text": "string" }, "description": "Sets a custom help text message to display for all validityStates.", "attribute": "setCustomValidity" }, { "kind": "field", "name": "setCustomValidityCustomError", "privacy": "public", "type": { "text": "string" }, "description": "Custom help text message to display when validity = `customError`.", "attribute": "setCustomValidityCustomError" }, { "kind": "field", "name": "setCustomValidityValueMissing", "privacy": "public", "type": { "text": "string" }, "description": "Custom help text message to display when validity = `valueMissing`.", "attribute": "setCustomValidityValueMissing" }, { "kind": "field", "name": "setCustomValidityValueMissingFilter", "privacy": "public", "type": { "text": "string" }, "description": "Custom help text message to display when validity = `valueMissing` due to the user not choosing a menu option when behavior = \"filter\".", "attribute": "setCustomValidityValueMissingFilter" }, { "kind": "field", "name": "touched", "privacy": "private", "type": { "text": "boolean" }, "description": "Indicates whether the combobox is in a dirty state (has been interacted with)." }, { "kind": "field", "name": "triggerIcon", "privacy": "public", "type": { "text": "boolean" }, "description": "If set, the `icon` attribute will be applied to the trigger `auro-input` element.", "attribute": "triggerIcon", "reflects": true }, { "kind": "field", "name": "type", "privacy": "public", "type": { "text": "string" }, "description": "Applies the defined value as the type attribute on `auro-input`.", "attribute": "type", "reflects": true }, { "kind": "field", "name": "typedValue", "privacy": "public", "type": { "text": "string" }, "description": "Specifies the value of the input element within the combobox.", "attribute": "typedValue", "reflects": true }, { "kind": "field", "name": "validity", "privacy": "public", "type": { "text": "string" }, "description": "Specifies the `validityState` this element is in.", "attribute": "validity", "reflects": true }, { "kind": "field", "name": "value", "privacy": "public", "type": { "text": "string" }, "description": "Value selected for the dropdown menu.", "attribute": "value" }, { "kind": "field", "name": "largeFullscreenHeadline", "privacy": "public", "type": { "text": "boolean" }, "description": "If declared, make bib.fullscreen.headline in HeadingDisplay.\nOtherwise, Heading 600", "attribute": "largeFullscreenHeadline", "reflects": true }, { "kind": "field", "name": "fullscreenBreakpoint", "privacy": "public", "type": { "text": "'xs' | 'sm' | 'md' | 'lg' | 'xl' | 'disabled'" }, "description": "Defines the screen size breakpointat which the dropdown switches to fullscreen mode on mobile. `disabled` indicates a dropdown should _never_ enter fullscreen.\n\nWhen expanded, the dropdown will automatically display in fullscreen mode\nif the screen size is equal to or smaller than the selected breakpoint.", "default": "'sm'", "attribute": "fullscreenBreakpoint", "reflects": true }, { "kind": "field", "name": "optionActive", "privacy": "private", "type": { "text": "object" }, "description": "Specifies the currently active option." }, { "kind": "field", "name": "triggerExpandedState", "privacy": "private", "type": { "text": "boolean" }, "description": "Deferred aria-expanded state for the trigger input.\nDelays the \"true\" transition so VoiceOver finishes its character echo\nbefore announcing \"expanded\"." }, { "kind": "field", "name": "componentHasFocus", "description": "Returns true if the element has focus.", "privacy": "private", "return": { "type": { "text": "boolean" } }, "readonly": true, "inheritedFrom": { "name": "AuroElement", "module": "components/layoutElement/src/auroElement.js" } }, { "kind": "method", "name": "resetShapeClasses", "inheritedFrom": { "name": "AuroElement", "module": "components/layoutElement/src/auroElement.js" } }, { "kind": "method", "name": "resetLayoutClasses", "inheritedFrom": { "name": "AuroElement", "module": "components/layoutElement/src/auroElement.js" } }, { "kind": "method", "name": "updateComponentArchitecture", "inheritedFrom": { "name": "AuroElement", "module": "components/layoutElement/src/auroElement.js" } }, { "kind": "field", "name": "shape", "privacy": "public", "type": { "text": "string" }, "attribute": "shape", "reflects": true, "inheritedFrom": { "name": "AuroElement", "module": "components/layoutElement/src/auroElement.js" } }, { "kind": "field", "name": "size", "privacy": "public", "type": { "text": "string" }, "attribute": "size", "reflects": true, "inheritedFrom": { "name": "AuroElement", "module": "components/layoutElement/src/auroElement.js" } } ], "events": [ { "name": "inputValue", "type": { "text": "CustomEvent" }, "description": "Notifies that the components internal HTML5 input value has changed." }, { "name": "input", "type": { "text": "CustomEvent" }, "description": "Notifies that the component has a new value set." }, { "name": "auroCombobox-valueSet", "type": { "text": "CustomEvent" }, "description": "(Deprecated) Notifies that the component has a new value set." }, { "description": "Notifies that the component value(s) have been validated.", "name": "auroFormElement-validated" } ], "attributes": [ { "name": "appearance", "type": { "text": "string" }, "description": "Defines whether the component will be on lighter or darker backgrounds.", "default": "'default'", "fieldName": "appearance" }, { "name": "autocomplete", "type": { "text": "string" }, "description": "An enumerated attribute that defines what the user agent can suggest for autofill. At this time, only `autocomplete=\"off\"` is supported.", "fieldName": "autocomplete" }, { "name": "autoPlacement", "type": { "text": "boolean" }, "description": "If declared, bib's position will be automatically calculated where to appear.", "fieldName": "autoPlacement" }, { "name": "availableOptions", "type": { "text": "array" }, "description": "Array of available options to display in the dropdown.", "fieldName": "availableOptions" }, { "name": "behavior", "type": { "text": "'filter' | 'suggestion'" }, "description": "Sets the behavior of the combobox, \"filter\" or \"suggestion\".\n\"filter\" requires the user to select an option from the menu.\n\"suggestion\" allows the user to enter a value not present in the menu options.", "default": "'suggestion'", "fieldName": "behavior" }, { "name": "checkmark", "type": { "text": "boolean" }, "description": "When attribute is present auro-menu will apply check marks to selected options.", "fieldName": "checkmark" }, { "name": "disabled", "type": { "text": "boolean" }, "description": "If set, disables the combobox.", "fieldName": "disabled" }, { "name": "dvInputOnly", "type": { "text": "boolean" }, "description": "If defined, the display value slot content will only mask the HTML5 input element. The inputs label will not be masked.", "fieldName": "dvInputOnly" }, { "name": "error", "type": { "text": "string" }, "description": "When defined, sets persistent validity to `customError` and sets the validation message to the attribute value.", "fieldName": "error" }, { "name": "format", "type": { "text": "string" }, "description": "Specifies the input mask format.", "fieldName": "format" }, { "name": "inputmode", "type": { "text": "string" }, "description": "Exposes inputmode attribute for input.", "fieldName": "inputmode" }, { "name": "layout", "type": { "text": "string" }, "description": "Sets the layout of the combobox.", "default": "'classic'", "fieldName": "layout", "inheritedFrom": { "name": "AuroElement", "module": "components/layoutElement/src/auroElement.js" } }, { "name": "matchWidth", "type": { "text": "boolean" }, "description": "If declared, the popover and trigger will be set to the same width.", "fieldName": "matchWidth" }, { "name": "noFilter", "type": { "text": "boolean" }, "description": "If set, combobox will not filter menuoptions based on input.", "fieldName": "noFilter" }, { "name": "noFlip", "type": { "text": "boolean" }, "description": "If declared, the bib will NOT flip to an alternate position\nwhen there isn't enough space in the specified `placement`.", "fieldName": "noFlip" }, { "name": "shift", "type": { "text": "boolean" }, "description": "If declared, the dropdown will shift its position to avoid being cut off by the viewport.", "fieldName": "shift" }, { "name": "noValidate", "type": { "text": "boolean" }, "description": "If set, disables auto-validation on blur.", "fieldName": "noValidate" }, { "name": "offset", "type": { "text": "number" }, "description": "Gap between the trigger element and bib.", "default": "0", "fieldName": "offset" }, { "name": "onDark", "type": { "text": "boolean" }, "description": "DEPRECATED - use `appearance=\"inverse\"` instead.", "fieldName": "onDark" }, { "name": "optionSelected", "type": { "text": "HTMLElement" }, "description": "Specifies the current selected option.", "fieldName": "optionSelected" }, { "name": "persistInput", "type": { "text": "boolean" }, "description": "If declared, selecting a menu option will not change the input value. By doing so,\nthe current menu filter will be preserved and the user can continue from their last\nfilter state. It is recommended to use this in combination with the `displayValue` slot.", "fieldName": "persistInput" }, { "name": "placement", "type": { "text": "'top' | 'right' | 'bottom' | 'left' | 'bottom-start' | 'top-start' | 'top-end' | 'right-start' | 'right-end' | 'bottom-end' | 'left-start' | 'left-end'" }, "description": "Position where the bib should appear relative to the trigger.", "default": "'bottom-start'", "fieldName": "placement" }, { "name": "placeholder", "type": { "text": "string" }, "description": "Define custom placeholder text, only supported by date input formats.", "fieldName": "placeholder" }, { "name": "required", "type": { "text": "boolean" }, "description": "Populates the `required` attribute on the input. Used for client-side validation.", "fieldName": "required" }, { "name": "setCustomValidity", "type": { "text": "string" }, "description": "Sets a custom help text message to display for all validityStates.", "fieldName": "setCustomValidity" }, { "name": "setCustomValidityCustomError", "type": { "text": "string" }, "description": "Custom help text message to display when validity = `customError`.", "fieldName": "setCustomValidityCustomError" }, { "name": "setCustomValidityValueMissing", "type": { "text": "string" }, "description": "Custom help text message to display when validity = `valueMissing`.", "fieldName": "setCustomValidityValueMissing" }, { "name": "setCustomValidityValueMissingFilter", "type": { "text": "string" }, "description": "Custom help text message to display when validity = `valueMissing` due to the user not choosing a menu option when behavior = \"filter\".", "fieldName": "setCustomValidityValueMissingFilter" }, { "name": "triggerIcon", "type": { "text": "boolean" }, "description": "If set, the `icon` attribute will be applied to the trigger `auro-input` element.", "fieldName": "triggerIcon" }, { "name": "type", "type": { "text": "string" }, "description": "Applies the defined value as the type attribute on `auro-input`.", "fieldName": "type" }, { "name": "typedValue", "type": { "text": "string" }, "description": "Specifies the value of the input element within the combobox.", "fieldName": "typedValue" }, { "name": "validity", "type": { "text": "string" }, "description": "Specifies the `validityState` this element is in.", "fieldName": "validity" }, { "name": "value", "type": { "text": "string" }, "description": "Value selected for the dropdown menu.", "fieldName": "value" }, { "name": "largeFullscreenHeadline", "type": { "text": "boolean" }, "description": "If declared, make bib.fullscreen.headline in HeadingDisplay.\nOtherwise, Heading 600", "fieldName": "largeFullscreenHeadline" }, { "name": "fullscreenBreakpoint", "type": { "text": "'xs' | 'sm' | 'md' | 'lg' | 'xl' | 'disabled'" }, "description": "Defines the screen size breakpointat which the dropdown switches to fullscreen mode on mobile. `disabled` indicates a dropdown should _never_ enter fullscreen.\n\nWhen expanded, the dropdown will automatically display in fullscreen mode\nif the screen size is equal to or smaller than the selected breakpoint.", "default": "'sm'", "fieldName": "fullscreenBreakpoint" }, { "name": "shape", "type": { "text": "string" }, "fieldName": "shape", "inheritedFrom": { "name": "AuroElement", "module": "components/layoutElement/src/auroElement.js" } }, { "name": "size", "type": { "text": "string" }, "fieldName": "size", "inheritedFrom": { "name": "AuroElement", "module": "components/layoutElement/src/auroElement.js" } }, { "name": "ondark", "type": { "text": "boolean" }, "fieldName": "onDark", "inheritedFrom": { "name": "AuroElement", "module": "components/layoutElement/src/auroElement.js" } } ], "superclass": { "name": "AuroElement", "module": "/components/layoutElement/src/auroElement.js" }, "tagName": "auro-combobox", "customElement": true } ], "exports": [ { "kind": "js", "name": "AuroCombobox", "declaration": { "name": "AuroCombobox", "module": "components/combobox/src/auro-combobox.js" } } ] }, { "kind": "javascript-module", "path": "components/combobox/src/comboboxKeyboardStrategy.js", "declarations": [ { "kind": "variable", "name": "comboboxKeyboardStrategy", "type": { "text": "object" }, "default": "{ async Enter(component, evt) { // If the clear button has focus, let the browser activate it normally. const clearBtn = component.input.shadowRoot.querySelector('.clearBtn'); if (clearBtn && clearBtn.shadowRoot && clearBtn.shadowRoot.activeElement !== null) { return; } if (component.dropdown.isPopoverVisible && component.optionActive) { component.menu.makeSelection(); await component.updateComplete; evt.preventDefault(); evt.stopPropagation(); component.setClearBtnFocus(); } else { component.showBib(); } }, Tab(component) { if (!component.dropdown.isPopoverVisible) { return; } if (component.dropdown.isBibFullscreen) { const clearBtn = component.inputInBib.shadowRoot.querySelector('.clearBtn'); // Use shadowRoot.activeElement to detect focus inside auro-button, // since Safari does not propagate :focus-within through shadow DOM. const clearBtnHasFocus = clearBtn && clearBtn.shadowRoot && clearBtn.shadowRoot.activeElement !== null; // Tab from input: if clear button exists and doesn't have focus, focus it if (clearBtn && !clearBtnHasFocus && component.inputInBib.value) { // Force clear button container visible to work around Safari not // propagating :focus-within through shadow DOM boundaries, which // causes .wrapper:not(:focus-within) to hide .notification.clear. const clearContainer = clearBtn.closest('.clear'); if (clearContainer) { clearContainer.style.display = 'flex'; clearBtn.addEventListener('focusout', () => { // Delay cleanup so :focus-within settles when focus moves // to a sibling (e.g., Shift+Tab back to the input). requestAnimationFrame(() => { clearContainer.style.display = ''; }); }, { once: true }); } // Focus the native button inside auro-button so the browser // treats it as a real focusable element inside the dialog. const nativeBtn = clearBtn.shadowRoot && clearBtn.shadowRoot.querySelector('button'); if (nativeBtn) { nativeBtn.focus(); } else { clearBtn.focus(); } return; } // Tab from clear button (or no clear button / no value) → // select the highlighted option if any, then close if (component.optionActive) { component.menu.makeSelection(); } component.hideBib(); return; } // Non-fullscreen: select + close if (component.menu.optionActive && component.menu.optionActive.value) { component.menu.value = component.menu.optionActive.value; } component.hideBib(); }, ArrowUp(component, evt) { if (component.availableOptions.length > 0) { component.showBib(); } if (component.dropdown.isPopoverVisible) { evt.preventDefault(); navigateArrow(component, 'up'); } }, ArrowDown(component, evt) { if (component.availableOptions.length > 0) { component.showBib(); } if (component.dropdown.isPopoverVisible) { evt.preventDefault(); navigateArrow(component, 'down'); } }, }" } ], "exports": [ { "kind": "js", "name": "comboboxKeyboardStrategy", "declaration": { "name": "comboboxKeyboardStrategy", "module": "components/combobox/src/comboboxKeyboardStrategy.js" } } ] }, { "kind": "javascript-module", "path": "components/combobox/src/index.js", "declarations": [], "exports": [ { "kind": "js", "name": "AuroCombobox", "declaration": { "name": "AuroCombobox", "module": "components/combobox/src/index.js" } } ] }, { "kind": "javascript-module", "path": "components/combobox/src/registered.js", "declarations": [], "exports": [ { "kind": "js", "name": "AuroCombobox", "declaration": { "name": "AuroCombobox", "module": "components/combobox/src/registered.js" } } ] }, { "kind": "javascript-module", "path": "components/counter/src/auro-counter-button.js", "declarations": [ { "kind": "class", "description": "", "name": "AuroCounterButton", "members": [ { "kind": "method", "name": "register", "static": true, "parameters": [ { "name": "name", "default": "\"auro-counter-button\"", "description": "The name of element that you want to register to.", "optional": true, "type": { "text": "string" } } ], "description": "This will register this element with the browser." }, { "kind": "field", "name": "size", "type": { "text": "string" }, "default": "\"sm\"" }, { "kind": "field", "name": "shape", "type": { "text": "string" }, "default": "\"rounded\"" } ], "superclass": { "name": "AuroButton", "package": "@aurodesignsystem/auro-button/class" }, "tagName": "auro-counter-button", "customElement": true } ], "exports": [ { "kind": "js", "name": "AuroCounterButton", "declaration": { "name": "AuroCounterButton", "module": "components/counter/src/auro-counter-button.js" } }, { "kind": "custom-element-definition", "name": "auro-counter-button", "declaration": { "name": "AuroCounterButton", "module": "components/counter/src/auro-counter-button.js" } } ] }, { "kind": "javascript-module", "path": "components/counter/src/auro-counter-group.js", "declarations": [ { "kind": "class", "description": "The `auro-counter-group` element provides a flexible interface for grouping multiple counters, supporting validation, custom validity messages, and disabled states based on the group's value.", "name": "AuroCounterGroup", "slots": [ { "description": "Slot for counter elements.", "name": "default" }, { "description": "Sets aria-label on close button in fullscreen bib", "name": "ariaLabel.bib.close" }, { "description": " Defines the headline to display above menu-options. Only used when `isDropdown` is true. Required.", "name": "bib.fullscreen.headline" }, { "description": " Defines the footer to display at the bottom of fullscreen bib. Only used when `isDropdown` is true.", "name": "bib.fullscreen.footer" }, { "description": "Dropdown label content. Only used when `isDropdown` is true.", "name": "label" }, { "description": "Dropdown value text display. Only used when `isDropdown` is true.", "name": "valueText" }, { "description": "Dropdown help text content. Only used when `isDropdown` is true.", "name": "helpText" } ], "members": [ { "kind": "method", "name": "manageDisabled", "parameters": [ { "name": "counter", "description": "The counter element to potentially disable.", "type": { "text": "HTMLElement" } } ], "description": "Dynamically disables increment/decrement buttons on a counter based on group value.\nThis method checks the total aggregated value against the group's min and max properties.\nIf the total value is at or below the minimum, the counter's decrement button is disabled; if at or above the maximum, the increment button is disabled.", "privacy": "private" }, { "kind": "method", "name": "configureCounters", "description": "Attaches input event listeners to all auro-counter elements within the component.\nThis method selects all `auro-counter` and `[auro-counter]` elements and adds an `input` event listener to each.\nThe listener calls `this.updateValue()` whenever the value of a counter changes.", "privacy": "private" }, { "kind": "method", "name": "renderHelpTextErrors", "parameters": [ { "name": "messages", "description": "The error messages to render.", "type": { "text": "Array" } } ], "description": "Renders help text error messages.", "return": { "type": { "text": "TemplateResult[]" } }, "privacy": "private" }, { "kind": "method", "name": "getInvalidCounters", "parameters": [ { "name": "counters", "description": "The NodeList of counter elements to check.", "type": { "text": "NodeList" } } ], "description": "Gets and returns an array of counters in an invalid state.", "return": { "type": { "text": "Array" } }, "privacy": "private" }, { "kind": "method", "name": "getErrorMessages", "parameters": [ { "name": "invalidCounters", "description": "The NodeList of counter elements to check.", "type": { "text": "NodeList" } } ], "description": "Gets all valid error messages from errored counters.", "return": { "type": { "text": "Array" } }, "privacy": "private" }, { "kind": "method", "name": "updateValidity", "description": "Updates the validity of the counter group based on the validity of its counters.\nThis method checks all counters within the group, determines if any are invalid, and updates the group's validity state and error message accordingly.\nIf any counter is invalid, it generates a combined error message from all invalid counters.", "return": { "type": { "text": "void" } }, "privacy": "private" }, { "kind": "method", "name": "hideBib", "description": "Hides the dropdown bib if its open.", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "showBib", "description": "Shows the dropdown bib if there are options to show.", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "configureDropdownCounters", "description": "Configures the dropdown counters by selecting all `auro-counter` elements,\nappending them to the `auro-counter-wrapper` element within the shadow DOM,\nand setting up keyboard navigation and input event listeners.", "privacy": "private" }, { "kind": "method", "name": "configureBibtemplate", "description": "This sets up a close event listener and moves any slotted `bib.fullscreen.headline` and `bib.fullscreen.footer` content into the bibtemplate.", "privacy": "private" }, { "kind": "method", "name": "handleSlotChange", "parameters": [ { "name": "event", "description": "`slotchange` event.", "type": { "text": "Event" } } ], "description": "Watch for slot changes and recalculate the menuoptions.", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "safeNumberConversion", "parameters": [ { "name": "value", "description": "The value to convert.", "type": { "text": "*" } } ], "description": "Safely converts a value to a number, returning 0 if invalid.", "privacy": "private", "return": { "type": { "text": "number" } } }, { "kind": "method", "name": "updateValue", "description": "Updates the aggregate value based on the values of contained auro-counter components.\nThis method queries for all `auro-counter` elements, sums their values, and updates the component's `value` property.\nAdditionally, it iterates through each counter and calls `manageDisabled()` on it.", "privacy": "private" }, { "kind": "method", "name": "updateValueText", "description": "Updates the value text in the dropdown trigger based on the counters in the counter group.", "privacy": "private" }, { "kind": "method", "name": "validate", "parameters": [ { "name": "force", "default": "false", "description": "Whether to force validation.", "optional": true, "type": { "text": "boolean" } } ], "description": "Validates value." }, { "kind": "method", "name": "register", "static": true, "parameters": [ { "name": "name", "default": "\"auro-counter-group\"", "description": "The name of the element that you want to register.", "optional": true, "type": { "text": "string" } } ], "description": "Registers the custom element with the browser." }, { "kind": "method", "name": "renderHelpText", "description": "Returns HTML for the help text and error message.", "privacy": "private", "return": { "type": { "text": "html" } } }, { "kind": "method", "name": "renderValidationErrorIcon", "description": "Returns HTML for the validation error icon.", "privacy": "private", "return": { "type": { "text": "html" } } }, { "kind": "method", "name": "renderCounterDropdown", "description": "Render the dropdown structure for the counter group.", "return": { "type": { "text": "TemplateResult" } }, "privacy": "private" }, { "kind": "method", "name": "renderDropdownTrigger", "description": "Render the dropdown trigger for the dropdown.", "return": { "type": { "text": "TemplateResult" } }, "privacy": "private" }, { "kind": "method", "name": "renderBibTemplate", "description": "Render the dropdown bib template for the dropdown.", "return": { "type": { "text": "TemplateResult" } }, "privacy": "private" }, { "kind": "method", "name": "renderFullscreenSlots", "description": "Render the fullscreen bib slots for the dropdown.", "return": { "type": { "text": "TemplateResult" } }, "privacy": "private" }, { "kind": "method", "name": "renderCounterGroup", "parameters": [ { "name": "isInDropdown", "default": "this.isDropdown", "description": "Whether the counter group is inside a dropdown.", "type": { "text": "boolean" } } ], "description": "Render the counter group container.", "return": { "type": { "text": "TemplateResult" } }, "privacy": "private" }, { "kind": "method", "name": "renderLayoutClassic", "description": "Render the classic layout.", "return": { "type": { "text": "TemplateResult" } }, "privacy": "private" }, { "kind": "method", "name": "renderLayoutSnowflake", "description": "Render the snowflake layout.", "return": { "type": { "text": "TemplateResult" } }, "privacy": "private" }, { "kind": "method", "name": "renderLayout", "parameters": [ { "name": "ForcedLayout", "description": "Optionally force a specific layout for rendering.", "optional": true, "type": { "text": "string" } } ], "description": "Renders the component by layout type.", "return": { "type": { "text": "TemplateResult" } }, "privacy": "private" }, { "kind": "field", "name": "appearance", "privacy": "public", "type": { "text": "string" }, "description": "Defines whether the component will be on lighter or darker backgrounds.", "default": "\"default\"", "attribute": "appearance", "reflects": true }, { "kind": "field", "name": "max", "privacy": "public", "type": { "text": "number" }, "description": "The maximum value allowed for the whole group of counters.", "default": "undefined", "attribute": "max", "reflects": true }, { "kind": "field", "name": "min", "privacy": "public", "type": { "text": "number" }, "description": "The minimum value allowed for the whole group of counters.", "default": "undefined", "attribute": "min", "reflects": true }, { "kind": "field", "name": "onDark", "privacy": "public", "type": { "text": "boolean" }, "attribute": "onDark", "reflects": true, "description": "DEPRECATED - use `appearance` instead.", "default": "false", "inheritedFrom": { "name": "AuroElement", "module": "components/layoutElement/src/auroElement.js" } }, { "kind": "field", "name": "total", "privacy": "public", "type": { "text": "number" }, "description": "The total value of the counters.", "default": "undefined", "attribute": "total" }, { "kind": "field", "name": "validity", "privacy": "public", "type": { "text": "string" }, "description": "Reflects the validity state.", "default": "undefined", "attribute": "validity", "reflects": true }, { "kind": "field", "name": "value", "privacy": "public", "type": { "text": "object" }, "description": "The current individual values of the nested counters.", "default": "undefined", "attribute": "value" }, { "kind": "field", "name": "matchWidth", "privacy": "public", "type": { "text": "boolean" }, "description": "If declared, the dropdown will expand to the width of its parent container.\nOtherwise, the dropdown width will be determined by its content.", "default": "false", "attribute": "matchWidth", "reflects": true }, { "kind": "field", "name": "isDropdown", "privacy": "public", "type": { "text": "boolean" }, "description": "If true, the counter group is displayed as a dropdown.", "default": "false", "attribute": "isDropdown" }, { "kind": "field", "name": "fullscreenBreakpoint", "privacy": "public", "type": { "text": "string" }, "description": "Defines the screen size breakpoint at which the dropdown switches to fullscreen mode on mobile. `disabled` indicates a dropdown should _never_ enter fullscreen.\n\nWhen expanded, the dropdown will automatically display in fullscreen mode\nif the screen size is equal to or smaller than the selected breakpoint.", "default": "'sm'", "attribute": "fullscreenBreakpoint", "reflects": true }, { "kind": "field", "name": "largeFullscreenHeadline", "privacy": "public", "type": { "text": "boolean" }, "description": "If declared, make bib.fullscreen.headline in HeadingDisplay.\nOtherwise, Heading 600.", "default": "false", "attribute": "largeFullscreenHeadline", "reflects": true }, { "kind": "field", "name": "autoPlacement", "privacy": "public", "type": { "text": "boolean" }, "description": "If declared, bib's position will be automatically calculated where to appear.", "default": "false", "attribute": "autoPlacement", "reflects": true }, { "kind": "field", "name": "noFlip", "privacy": "public", "type": { "text": "boolean" }, "description": "If declared, the bib will NOT flip to an alternate position\nwhen there isn't enough space in the specified `placement`.", "default": "false", "attribute": "noFlip", "reflects": true }, { "kind": "field", "name": "shift", "privacy": "public", "type": { "text": "boolean" }, "description": "If declared, the dropdown will shift its position to avoid being cut off by the viewport.", "default": "false", "attribute": "shift", "reflects": true }, { "kind": "field", "name": "placement", "privacy": "public", "type": { "text": "string" }, "description": "Position where the bib should appear relative to the trigger.", "default": "'bottom-start'", "attribute": "placement", "reflects": true }, { "kind": "field", "name": "counters", "privacy": "private", "default": "undefined" }, { "kind": "field", "name": "dropdown", "privacy": "private", "default": "undefined" }, { "kind": "field", "name": "bibtemplate", "privacy": "private", "default": "undefined" }, { "kind": "field", "name": "validation", "privacy": "private", "default": "new AuroFormValidation()" }, { "kind": "field", "name": "dropdownTag", "description": "Dynamically generated dropdown tag.", "privacy": "private", "type": { "text": "string" } }, { "kind": "field", "name": "bibtemplateTag", "description": "Dynamically generated bibtempalate tag.", "privacy": "private", "type": { "text": "string" } }, { "kind": "field", "name": "helpTextTag", "description": "Dynamically generated helpText tag.", "privacy": "private", "type": { "text": "string" } }, { "kind": "field", "name": "iconTag", "privacy": "private" }, { "kind": "field", "name": "error", "privacy": "public", "type": { "text": "string" }, "description": "The current error message to display when the component is invalid.", "attribute": "error" }, { "kind": "field", "name": "errorMessage", "privacy": "private", "type": { "text": "string" }, "description": "The current error message to display when the component is invalid.\nThis is set by validation and is not available to consumers." }, { "kind": "field", "name": "layout", "privacy": "public", "type": { "text": "string" }, "description": "Determines the layout style of the counter group when it is a dropdown.", "default": "'classic'", "attribute": "layout", "reflects": true, "inheritedFrom": { "name": "AuroElement", "module": "components/layoutElement/src/auroElement.js" } }, { "kind": "field", "name": "offset", "privacy": "public", "type": { "text": "number" }, "description": "Gap between the trigger element and bib.", "default": "0", "attribute": "offset", "reflects": true }, { "kind": "field", "name": "valueText", "privacy": "private", "type": { "text": "string" }, "description": "The current text in the valueText slot." }, { "kind": "field", "name": "componentHasFocus", "description": "Returns true if the element has focus.", "privacy": "private", "return": { "type": { "text": "boolean" } }, "readonly": true, "inheritedFrom": { "name": "AuroElement", "module": "components/layoutElement/src/auroElement.js" } }, { "kind": "method", "name": "resetShapeClasses", "inheritedFrom": { "name": "AuroElement", "module": "components/layoutElement/src/auroElement.js" } }, { "kind": "method", "name": "resetLayoutClasses", "inheritedFrom": { "name": "AuroElement", "module": "components/layoutElement/src/auroElement.js" } }, { "kind": "method", "name": "updateComponentArchitecture", "inheritedFrom": { "name": "AuroElement", "module": "components/layoutElement/src/auroElement.js" } }, { "kind": "field", "name": "shape", "privacy": "public", "type": { "text": "string" }, "attribute": "shape", "reflects": true, "inheritedFrom": { "name": "AuroElement", "module": "components/layoutElement/src/auroElement.js" } }, { "kind": "field", "name": "size", "privacy": "public", "type": { "text": "string" }, "attribute": "size", "reflects": true, "inheritedFrom": { "name": "AuroElement", "module": "components/layoutElement/src/auroElement.js" } } ], "events": [ { "name": "input", "type": { "text": "CustomEvent" } } ], "attributes": [ { "name": "appearance", "type": { "text": "string" }, "description": "Defines whether the component will be on lighter or darker backgrounds.", "default": "\"default\"", "fieldName": "appearance" }, { "name": "autoPlacement", "type": { "text": "boolean" }, "description": "If declared, bib's position will be automatically calculated where to appear.", "default": "false", "fieldName": "autoPlacement" }, { "name": "error", "type": { "text": "string" }, "description": "The current error message to display when the component is invalid.", "fieldName": "error" }, { "name": "fullscreenBreakpoint", "type": { "text": "string" }, "description": "Defines the screen size breakpoint at which the dropdown switches to fullscreen mode on mobile. `disabled` indicates a dropdown should _never_ enter fullscreen.\n\nWhen expanded, the dropdown will automatically display in fullscreen mode\nif the screen size is equal to or smaller than the selected breakpoint.", "default": "'sm'", "fieldName": "fullscreenBreakpoint" }, { "name": "isDropdown", "type": { "text": "boolean" }, "description": "If true, the counter group is displayed as a dropdown.", "default": "false", "fieldName": "isDropdown" }, { "name": "layout", "type": { "text": "string" }, "description": "Determines the layout style of the counter group when it is a dropdown.", "default": "'classic'", "fieldName": "layout", "inheritedFrom": { "name": "AuroElement", "module": "components/layoutElement/src/auroElement.js" } }, { "name": "matchWidth", "type": { "text": "boolean" }, "description": "If declared, the dropdown will expand to the width of its parent container.\nOtherwise, the dropdown width will be determined by its content.", "default": "false", "fieldName": "matchWidth" }, { "name": "max", "type": { "text": "number" }, "description": "The maximum value allowed for the whole group of counters.", "default": "undefined", "fieldName": "max" }, { "name": "min", "type": { "text": "number" }, "description": "The minimum value allowed for the whole group of counters.", "default": "undefined", "fieldName": "min" }, { "name": "largeFullscreenHeadline", "type": { "text": "boolean" }, "description": "If declared, make bib.fullscreen.headline in HeadingDisplay.\nOtherwise, Heading 600.", "default": "false", "fieldName": "largeFullscreenHeadline" }, { "name": "noFlip", "type": { "text": "boolean" }, "description": "If declared, the bib will NOT flip to an alternate position\nwhen there isn't enough space in the specified `placement`.", "default": "false", "fieldName": "noFlip" }, { "name": "shift", "type": { "text": "boolean" }, "description": "If declared, the dropdown will shift its position to avoid being cut off by the viewport.", "default": "false", "fieldName": "shift" }, { "name": "offset", "type": { "text": "number" }, "description": "Gap between the trigger element and bib.", "default": "0", "fieldName": "offset" }, { "name": "onDark", "type": { "text": "boolean" }, "description": "DEPRECATED - use `appearance` instead.", "default": "false", "fieldName": "onDark" }, { "name": "placement", "type": { "text": "string" }, "description": "Position where the bib should appear relative to the trigger.", "default": "'bottom-start'", "fieldName": "placement" }, { "name": "total", "type": { "text": "number" }, "description": "The total value of the counters.", "default": "undefined", "fieldName": "total" }, { "name": "validity", "type": { "text": "string" }, "description": "Reflects the validity state.", "default": "undefined", "fieldName": "validity" }, { "name": "value", "type": { "text": "object" }, "description": "The current individual values of the nested counters.", "default": "undefined", "fieldName": "value" }, { "name": "shape", "type": { "text": "string" }, "fieldName": "shape", "inheritedFrom": { "name": "AuroElement", "module": "components/layoutElement/src/auroElement.js" } }, { "name": "size", "type": { "text": "string" }, "fieldName": "size", "inheritedFrom": { "name": "AuroElement", "module": "components/layoutElement/src/auroElement.js" } }, { "name": "ondark", "type": { "text": "boolean" }, "fieldName": "onDark", "inheritedFrom": { "name": "AuroElement", "module": "components/layoutElement/src/auroElement.js" } } ], "superclass": { "name": "AuroElement", "module": "/components/layoutElement/src/auroElement.js" }, "tagName": "auro-counter-group", "customElement": true } ], "exports": [ { "kind": "js", "name": "AuroCounterGroup", "declaration": { "name": "AuroCounterGroup", "module": "components/counter/src/auro-counter-group.js" } } ] }, { "kind": "javascript-module", "path": "components/counter/src/auro-counter-wrapper.js", "declarations": [ { "kind": "class", "description": "Wrapper element for auro-counter elements in an application to provide layout structure for multiple counters.", "name": "AuroCounterWrapper", "slots": [ { "description": "Slot for counter elements.", "name": "Default" } ], "members": [ { "kind": "method", "name": "register", "static": true, "parameters": [ { "name": "name", "default": "\"auro-counter-wrapper\"", "description": "Custom element name to register.", "optional": true, "type": { "text": "string" } } ], "description": "Registers the custom element with the browser." } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "auro-counter-wrapper", "customElement": true } ], "exports": [ { "kind": "js", "name": "AuroCounterWrapper", "declaration": { "name": "AuroCounterWrapper", "module": "components/counter/src/auro-counter-wrapper.js" } }, { "kind": "custom-element-definition", "name": "auro-counter-wrapper", "declaration": { "name": "AuroCounterWrapper", "module": "components/counter/src/auro-counter-wrapper.js" } } ] }, { "kind": "javascript-module", "path": "components/counter/src/auro-counter.js", "declarations": [ { "kind": "class", "description": "The `auro-counter` element provides a flexible counter interface with increment and decrement buttons, supporting optional sub-labels and disabled states.", "name": "AuroCounter", "slots": [ { "description": "Main label content for the counter.", "name": "default" }, { "description": "Accessible label for the decrement button.", "name": "ariaLabel.minus" }, { "description": "Accessible label for the increment button.", "name": "ariaLabel.plus" }, { "description": "Help text content for the counter.", "name": "helpText" }, { "description": "Descriptive content for the counter.", "name": "description" } ], "members": [ { "kind": "field", "name": "shadowRootOptions", "static": true, "readonly": true }, { "kind": "method", "name": "_initializeDefaults" }, { "kind": "method", "name": "register", "static": true, "parameters": [ { "name": "name", "default": "\"auro-counter\"", "description": "The name of the element that you want to register.", "optional": true, "type": { "text": "string" } } ], "description": "Registers the custom element with the browser." }, { "kind": "method", "name": "increment", "parameters": [ { "name": "value", "description": "The amount to increment by.", "optional": true, "type": { "text": "number" } } ], "description": "Increments the counter value by 1. If a value is provided, it increments by that amount.", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "decrement", "parameters": [ { "name": "value", "description": "The amount to decrement by.", "optional": true, "type": { "text": "number" } } ], "description": "Decrements the value of the counter by 1. If a value is provided, it decrements by that amount.", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "initValue", "description": "Initializes the value of the counter.\nIf the current value is undefined, it sets the value to the minimum value.", "privacy": "private" }, { "kind": "method", "name": "isIncrementDisabled", "parameters": [ { "name": "extrema", "description": "The extreme value (either min or max) to compare against the current value.", "type": { "text": "number" } } ], "description": "Determines if the increment button should be disabled based on the current value and extrema.", "return": { "type": { "text": "boolean" } }, "privacy": "private" }, { "kind": "method", "name": "validate", "parameters": [ { "name": "force", "default": "false", "description": "Whether to force validation.", "optional": true, "type": { "text": "boolean" } } ], "description": "Validates value." }, { "kind": "method", "name": "handleKeyDown", "parameters": [ { "name": "event", "description": "The keyboard event object.", "type": { "text": "KeyboardEvent" } } ], "description": "Handles the keydown event for the counter component.", "return": { "type": { "text": "void" } }, "privacy": "private" }, { "kind": "method", "name": "setTagAttribute", "parameters": [ { "name": "tagName", "description": "The tag name to set as an attribute.", "type": { "text": "string" } } ], "description": "Sets an attribute that matches the default tag name if the tag name is not the default.", "privacy": "private" }, { "kind": "method", "name": "onDefaultSlotChange", "parameters": [ { "name": "event", "description": "The event object representing the slot change event.", "type": { "text": "Event" } } ], "description": "Handles the change event for the default slot.\nUpdates the defaultSlot property with the trimmed text content of the first assigned node.", "privacy": "private" }, { "kind": "method", "name": "renderHelpText", "description": "Returns HTML for the help text and error message.", "privacy": "private", "return": { "type": { "text": "html" } } }, { "kind": "field", "name": "appearance", "privacy": "public", "type": { "text": "'default' | 'inverse'" }, "description": "Defines whether the component will be on lighter or darker backgrounds.", "default": "'default'", "attribute": "appearance", "reflects": true }, { "kind": "field", "name": "defaultSlot", "privacy": "private", "type": { "text": "string" }, "description": "The default slot content.", "attribute": "defaultSlot" }, { "kind": "field", "name": "disabled", "privacy": "public", "type": { "text": "boolean" }, "description": "Indicates if the counter is disabled.", "attribute": "disabled", "reflects": true }, { "kind": "field", "name": "disableMax", "privacy": "private", "type": { "text": "boolean" }, "description": "Group will attach to counter to disable the increment button.", "attribute": "disableMax" }, { "kind": "field", "name": "disableMin", "privacy": "private", "type": { "text": "boolean" }, "description": "Group will attach to counter to disable the decrement button.", "attribute": "disableMin" }, { "kind": "field", "name": "error", "privacy": "public", "type": { "text": "string" }, "description": "Error state and message.\nTrue if set, value is the error message.", "attribute": "error" }, { "kind": "field", "name": "max", "privacy": "public", "type": { "text": "number" }, "description": "The maximum value for the counter.", "attribute": "max", "reflects": true }, { "kind": "field", "name": "min", "privacy": "public", "type": { "text": "number" }, "description": "The minimum value for the counter.", "attribute": "min", "reflects": true }, { "kind": "field", "name": "onDark", "privacy": "public", "type": { "text": "boolean" }, "description": "DEPRECATED - use `appearance=\"inverse\"` instead.", "attribute": "onDark", "reflects": true }, { "kind": "field", "name": "validity", "privacy": "public", "type": { "text": "string" }, "description": "The validity state of the counter.", "attribute": "validity", "reflects": true }, { "kind": "field", "name": "value", "privacy": "public", "type": { "text": "number" }, "description": "The current value of the counter.", "attribute": "value" } ], "events": [ { "name": "input", "type": { "text": "CustomEvent" } } ], "attributes": [ { "name": "appearance", "type": { "text": "'default' | 'inverse'" }, "description": "Defines whether the component will be on lighter or darker backgrounds.", "default": "'default'", "fieldName": "appearance" }, { "name": "defaultSlot", "type": { "text": "string" }, "description": "The default slot content.", "fieldName": "defaultSlot" }, { "name": "disabled", "type": { "text": "boolean" }, "description": "Indicates if the counter is disabled.", "fieldName": "disabled" }, { "name": "disableMax", "type": { "text": "boolean" }, "description": "Group will attach to counter to disable the increment button.", "fieldName": "disableMax" }, { "name": "disableMin", "type": { "text": "boolean" }, "description": "Group will attach to counter to disable the decrement button.", "fieldName": "disableMin" }, { "name": "error", "type": { "text": "string" }, "description": "Error state and message.\nTrue if set, value is the error message.", "fieldName": "error" }, { "name": "max", "type": { "text": "number" }, "description": "The maximum value for the counter.", "fieldName": "max" }, { "name": "min", "type": { "text": "number" }, "description": "The minimum value for the counter.", "fieldName": "min" }, { "name": "onDark", "type": { "text": "boolean" }, "description": "DEPRECATED - use `appearance=\"inverse\"` instead.", "fieldName": "onDark" }, { "name": "validity", "type": { "text": "string" }, "description": "The validity state of the counter.", "fieldName": "validity" }, { "name": "value", "type": { "text": "number" }, "description": "The current value of the counter.", "fieldName": "value" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "auro-counter", "customElement": true } ], "exports": [ { "kind": "js", "name": "AuroCounter", "declaration": { "name": "AuroCounter", "module": "components/counter/src/auro-counter.js" } } ] }, { "kind": "javascript-module", "path": "components/counter/src/buttonVersion.js", "declarations": [], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "12.3.2", "module": "components/counter/src/buttonVersion.js" } } ] }, { "kind": "javascript-module", "path": "components/counter/src/iconVersion.js", "declarations": [], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "9.1.2", "module": "components/counter/src/iconVersion.js" } } ] }, { "kind": "javascript-module", "path": "components/counter/src/index.js", "declarations": [], "exports": [ { "kind": "js", "name": "AuroCounter", "declaration": { "name": "AuroCounter", "module": "components/counter/src/index.js" } }, { "kind": "js", "name": "AuroCounterGroup", "declaration": { "name": "AuroCounterGroup", "module": "components/counter/src/index.js" } } ] }, { "kind": "javascript-module", "path": "components/counter/src/registered.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "components/datepicker/src/auro-calendar-cell.js", "declarations": [ { "kind": "class", "description": "", "name": "AuroCalendarCell", "members": [ { "kind": "field", "name": "locale", "privacy": "public", "type": { "text": "object" }, "attribute": "locale" }, { "kind": "method", "name": "dateChanged", "parameters": [ { "name": "dateFrom", "description": "Depart date.", "type": { "text": "Number" } }, { "name": "dateTo", "description": "Return date.", "type": { "text": "Number" } }, { "name": "hoveredDate", "description": "Hovered date.", "type": { "text": "Number" } }, { "name": "day", "description": "An object containing the dateFrom and day of month values.", "type": { "text": "Object" } } ], "description": "Handles selected and hovered states of the calendar cell when the date changes.", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "handleTap", "description": "Handles user click events and calls datepicker to update the value(s).", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "handleHover", "description": "Handles user hover events and dispatches a custom event.", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "isEnabled", "parameters": [ { "name": "day", "description": "An object containing the dateFrom and day of month values.", "type": { "text": "Object" } }, { "name": "min", "description": "The minimum date value.", "type": { "text": "Number" } }, { "name": "max", "description": "The maximum date value.", "type": { "text": "Number" } }, { "name": "disabledDays", "description": "An array of disabled dates.", "type": { "text": "Array" } } ], "description": "Checks if the current date is a valid date depending on the min and max values.", "privacy": "private", "return": { "type": { "text": "Boolean" } } }, { "kind": "method", "name": "isDepartDate", "parameters": [ { "name": "day", "description": "An object containing the dateFrom and day of month values.", "type": { "text": "Object" } }, { "name": "dateFrom", "description": "Depart date.", "type": { "text": "Number" } } ], "description": "Checks if the current date is the depart date.", "privacy": "private", "return": { "type": { "text": "Boolean" } } }, { "kind": "method", "name": "isReturnDate", "parameters": [ { "name": "day", "description": "An object containing the dateFrom and day of month values.", "type": { "text": "Object" } }, { "name": "dateFrom", "description": "Depart date.", "type": { "text": "Number" } }, { "name": "dateTo", "description": "Return date.", "type": { "text": "Number" } } ], "description": "Checks if the current date is the return date.", "privacy": "private", "return": { "type": { "text": "Boolean" } } }, { "kind": "method", "name": "isInRange", "parameters": [ { "name": "day", "description": "An object containing the dateFrom and day of month values.", "type": { "text": "Object" } }, { "name": "dateFrom", "description": "Depart date.", "type": { "text": "Number" } }, { "name": "dateTo", "description": "Return date.", "type": { "text": "Number" } } ], "description": "Checks if the current date is between dateFrom and dateTo.", "privacy": "private", "return": { "type": { "text": "Boolean" } } }, { "kind": "method", "name": "isLastHoveredDate", "parameters": [ { "name": "day", "description": "An object containing the dateFrom and day of month values.", "type": { "text": "Object" } }, { "name": "dateFrom", "description": "Depart date.", "type": { "text": "Number" } }, { "name": "dateTo", "description": "Return date.", "type": { "text": "Number" } }, { "name": "hoveredDate", "description": "Hovered date.", "type": { "text": "Number" } } ], "description": "Determines the hovered date appearing latest in the calendar.", "privacy": "private", "return": { "type": { "text": "Boolean" } } }, { "kind": "method", "name": "isReferenceDate", "parameters": [ { "name": "dateStr", "description": "The date string in MM_DD_YYYY format.", "type": { "text": "Object" } } ], "description": "Checks if the current date is a highlighted date.", "return": { "type": { "text": "" } } }, { "kind": "method", "name": "getTitle", "parameters": [ { "name": "date", "description": "The date of the auro-calendar-cell.", "type": { "text": "Number" } } ], "description": "Determines the title of the auro-calendar-cell.", "privacy": "private", "return": { "type": { "text": "String" } } }, { "kind": "method", "name": "setDateSlotName", "description": "Gets the name of the date slot.", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "handleSlotContent", "description": "Remove existing cell slot content and clone any current slot content from the root `auro-datepicker` which matches this cells date.", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "field", "name": "day", "privacy": "public", "type": { "text": "null" }, "default": "null", "attribute": "day" }, { "kind": "field", "name": "selected", "privacy": "public", "type": { "text": "boolean" }, "default": "false", "attribute": "selected" }, { "kind": "field", "name": "hovered", "privacy": "public", "type": { "text": "boolean" }, "default": "false", "attribute": "hovered" }, { "kind": "field", "name": "dateTo", "privacy": "public", "type": { "text": "null" }, "default": "null", "attribute": "dateTo" }, { "kind": "field", "name": "dateFrom", "privacy": "public", "type": { "text": "null" }, "default": "null", "attribute": "dateFrom" }, { "kind": "field", "name": "month", "privacy": "public", "type": { "text": "null" }, "default": "null", "attribute": "month" }, { "kind": "field", "name": "min", "privacy": "public", "type": { "text": "null" }, "default": "null", "attribute": "min" }, { "kind": "field", "name": "max", "privacy": "public", "type": { "text": "null" }, "default": "null", "attribute": "max" }, { "kind": "field", "name": "disabled", "privacy": "public", "type": { "text": "boolean" }, "default": "false", "attribute": "disabled", "reflects": true }, { "kind": "field", "name": "disabledDays", "privacy": "public", "type": { "text": "array" }, "default": "[]", "attribute": "disabledDays" }, { "kind": "field", "name": "hoveredDate", "privacy": "public", "type": { "text": "null" }, "default": "null", "attribute": "hoveredDate" }, { "kind": "field", "name": "isCurrentDate", "privacy": "public", "type": { "text": "boolean" }, "default": "false", "attribute": "isCurrentDate" }, { "kind": "field", "name": "_locale", "type": { "text": "null" }, "default": "null" }, { "kind": "field", "name": "dateStr", "privacy": "public", "type": { "text": "null" }, "default": "null", "attribute": "dateStr" }, { "kind": "field", "name": "renderForDateSlot", "privacy": "public", "type": { "text": "boolean" }, "default": "false", "attribute": "renderForDateSlot" }, { "kind": "field", "name": "runtimeUtils", "default": "new AuroLibraryRuntimeUtils()" }, { "kind": "field", "name": "popoverTag" } ], "events": [ { "name": "date-is-hovered", "type": { "text": "CustomEvent" } } ], "attributes": [ { "name": "day", "type": { "text": "null" }, "default": "null", "fieldName": "day" }, { "name": "selected", "type": { "text": "boolean" }, "default": "false", "fieldName": "selected" }, { "name": "hovered", "type": { "text": "boolean" }, "default": "false", "fieldName": "hovered" }, { "name": "dateTo", "type": { "text": "null" }, "default": "null", "fieldName": "dateTo" }, { "name": "dateFrom", "type": { "text": "null" }, "default": "null", "fieldName": "dateFrom" }, { "name": "month", "type": { "text": "null" }, "default": "null", "fieldName": "month" }, { "name": "min", "type": { "text": "null" }, "default": "null", "fieldName": "min" }, { "name": "max", "type": { "text": "null" }, "default": "null", "fieldName": "max" }, { "name": "disabled", "type": { "text": "boolean" }, "default": "false", "fieldName": "disabled" }, { "name": "disabledDays", "type": { "text": "array" }, "default": "[]", "fieldName": "disabledDays" }, { "name": "hoveredDate", "type": { "text": "null" }, "default": "null", "fieldName": "hoveredDate" }, { "name": "isCurrentDate", "type": { "text": "boolean" }, "default": "false", "fieldName": "isCurrentDate" }, { "name": "locale", "type": { "text": "object" }, "fieldName": "locale" }, { "name": "dateStr", "type": { "text": "null" }, "default": "null", "fieldName": "dateStr" }, { "name": "renderForDateSlot", "type": { "text": "boolean" }, "default": "false", "fieldName": "renderForDateSlot" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "auro-formkit-calendar-cell", "customElement": true } ], "exports": [ { "kind": "js", "name": "AuroCalendarCell", "declaration": { "name": "AuroCalendarCell", "module": "components/datepicker/src/auro-calendar-cell.js" } }, { "kind": "custom-element-definition", "name": "auro-formkit-calendar-cell", "declaration": { "name": "AuroCalendarCell", "module": "components/datepicker/src/auro-calendar-cell.js" } } ] }, { "kind": "javascript-module", "path": "components/datepicker/src/auro-calendar-month.js", "declarations": [ { "kind": "class", "description": "", "name": "AuroCalendarMonth", "members": [ { "kind": "method", "name": "computeCurrentMonthName", "parameters": [ { "name": "month", "description": "The month number (1-12).", "type": { "text": "Number" } } ], "description": "Returns month name to be rendered in the calendar header.", "privacy": "private", "return": { "type": { "text": "String" } } }, { "kind": "method", "name": "localeChanged", "description": "Determines the current month name based on locale.\nThis is a rewrite of the function used in the class RangeDatepickerCalendar and should not be removed from here.", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "renderDay", "parameters": [ { "name": "day" } ] }, { "kind": "field", "name": "monthFirst", "privacy": "private", "type": { "text": "boolean" }, "attribute": "monthFirst", "reflects": true } ], "attributes": [ { "name": "monthFirst", "type": { "text": "boolean" }, "fieldName": "monthFirst" } ], "superclass": { "name": "RangeDatepickerCalendar", "module": "/components/datepicker/src/vendor/wc-range-datepicker/range-datepicker-calendar.js" }, "tagName": "auro-formkit-calendar-month", "customElement": true } ], "exports": [ { "kind": "js", "name": "AuroCalendarMonth", "declaration": { "name": "AuroCalendarMonth", "module": "components/datepicker/src/auro-calendar-month.js" } }, { "kind": "custom-element-definition", "name": "auro-formkit-calendar-month", "declaration": { "name": "AuroCalendarMonth", "module": "components/datepicker/src/auro-calendar-month.js" } } ] }, { "kind": "javascript-module", "path": "components/datepicker/src/auro-calendar.js", "declarations": [ { "kind": "class", "description": "", "name": "AuroCalendar", "members": [ { "kind": "method", "name": "handlePrevMonth", "description": "Updates the month and year when the user navigates to the previous calendar month.", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "handleNextMonth", "description": "Updates the month and year when the user navigates to the next calendar month.", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "renderAllCalendars", "description": "Renders all of the auro-calendar-months HTML.", "privacy": "private", "return": { "type": { "text": "Object" } } }, { "kind": "method", "name": "focusCloseButton", "description": "Focuses the close button inside the calendar's bibtemplate.\nUsed by datepicker to set initial focus when the fullscreen dialog opens.", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "scrollMonthIntoView", "parameters": [ { "name": "date", "description": "The date to scroll into view.", "type": { "text": "String" } } ], "description": "Request the calendar be scrolled to a given date.", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "injectSlot", "parameters": [ { "name": "slotName" }, { "name": "nodes" } ] }, { "kind": "field", "name": "util", "privacy": "private", "default": "new AuroDatepickerUtilities()" }, { "kind": "field", "name": "utilCal", "privacy": "private", "default": "new CalendarUtilities()" }, { "kind": "field", "name": "utilCalRender", "privacy": "private", "default": "new UtilitiesCalendarRender()" }, { "kind": "field", "name": "calendarStartDate", "default": "undefined" }, { "kind": "field", "name": "calendarEndDate", "default": "undefined" }, { "kind": "field", "name": "centralDate", "privacy": "public", "type": { "text": "string" }, "description": "The date that determines the currently visible month.", "default": "undefined", "attribute": "centralDate", "reflects": true }, { "kind": "field", "name": "showPrevMonthBtn", "type": { "text": "boolean" }, "default": "true" }, { "kind": "field", "name": "showNextMonthBtn", "type": { "text": "boolean" }, "default": "true" }, { "kind": "field", "name": "visible", "privacy": "public", "type": { "text": "boolean" }, "description": "Flag indicating if the calendar is visible.", "default": "false", "attribute": "visible" }, { "kind": "field", "name": "largeFullscreenHeadline", "privacy": "public", "type": { "text": "boolean" }, "description": "If declared, make bib.fullscreen.headline in HeadingDisplay.\nOtherwise, Heading 600.", "default": "false", "attribute": "largeFullscreenHeadline", "reflects": true }, { "kind": "field", "name": "isFullscreen", "privacy": "public", "type": { "text": "boolean" }, "description": "Flag indicating if the calendar is in fullscreen mode.", "default": "false", "attribute": "isFullscreen", "reflects": true }, { "kind": "field", "name": "firstMonthRenderable", "privacy": "private", "default": "undefined" }, { "kind": "field", "name": "calendarRangeMonths", "type": { "text": "null" }, "privacy": "private", "default": "null" }, { "kind": "field", "name": "numCalendars", "privacy": "private", "type": { "text": "number" }, "description": "Number of calendars to render.", "default": "undefined", "attribute": "numCalendars" }, { "kind": "field", "name": "slots", "type": { "text": "object" }, "privacy": "private", "default": "{}" }, { "kind": "field", "name": "bibtemplateTag", "privacy": "private" }, { "kind": "field", "name": "buttonTag", "privacy": "private" }, { "kind": "field", "name": "dropdown", "privacy": "private", "type": { "text": "object" }, "description": "Dropdown element that contains the calendar.", "default": "undefined", "attribute": "dropdown" }, { "kind": "field", "name": "calendarEndMonth", "privacy": "public", "type": { "text": "string" }, "description": "The last month that may be displayed in the calendar.", "attribute": "calendarEndMonth", "reflects": true }, { "kind": "field", "name": "calendarStartMonth", "privacy": "public", "type": { "text": "string" }, "description": "The first month that may be displayed in the calendar.", "attribute": "calendarStartMonth", "reflects": true }, { "kind": "field", "name": "dateFrom", "privacy": "public", "type": { "text": "string" }, "description": "The starting date of the selected range.", "attribute": "dateFrom" }, { "kind": "field", "name": "dateTo", "privacy": "public", "type": { "text": "string" }, "description": "The ending date of the selected range.", "attribute": "dateTo" }, { "kind": "field", "name": "maxDate", "privacy": "public", "type": { "text": "string" }, "description": "Maximum date. All dates after will be disabled.", "attribute": "maxDate", "reflects": true }, { "kind": "field", "name": "minDate", "privacy": "public", "type": { "text": "string" }, "description": "Minimum date. All dates before will be disabled.", "attribute": "minDate", "reflects": true }, { "kind": "field", "name": "mobileBreakpoint", "privacy": "private", "type": { "text": "number" }, "description": "Mobile breakpoint for responsive design.", "attribute": "mobileBreakpoint" }, { "kind": "field", "name": "monthFirst", "privacy": "private", "type": { "text": "boolean" }, "attribute": "monthFirst" } ], "events": [ { "name": "auroCalendar-dateSelected", "type": { "text": "CustomEvent" }, "description": "Notifies that a date has been selected in the calendar." }, { "name": "narrow-changedProperties", "type": { "text": "CustomEvent" } }, { "description": "Notifies that the visible calendar month(s) have changed.", "name": "auroCalendar-monthChanged" } ], "attributes": [ { "name": "calendarEndMonth", "type": { "text": "string" }, "description": "The last month that may be displayed in the calendar.", "fieldName": "calendarEndMonth" }, { "name": "calendarStartMonth", "type": { "text": "string" }, "description": "The first month that may be displayed in the calendar.", "fieldName": "calendarStartMonth" }, { "name": "centralDate", "type": { "text": "string" }, "description": "The date that determines the currently visible month.", "default": "undefined", "fieldName": "centralDate" }, { "name": "dateFrom", "type": { "text": "string" }, "description": "The starting date of the selected range.", "fieldName": "dateFrom" }, { "name": "dateTo", "type": { "text": "string" }, "description": "The ending date of the selected range.", "fieldName": "dateTo" }, { "name": "dropdown", "type": { "text": "object" }, "description": "Dropdown element that contains the calendar.", "default": "undefined", "fieldName": "dropdown" }, { "name": "isFullscreen", "type": { "text": "boolean" }, "description": "Flag indicating if the calendar is in fullscreen mode.", "default": "false", "fieldName": "isFullscreen" }, { "name": "largeFullscreenHeadline", "type": { "text": "boolean" }, "description": "If declared, make bib.fullscreen.headline in HeadingDisplay.\nOtherwise, Heading 600.", "default": "false", "fieldName": "largeFullscreenHeadline" }, { "name": "maxDate", "type": { "text": "string" }, "description": "Maximum date. All dates after will be disabled.", "fieldName": "maxDate" }, { "name": "minDate", "type": { "text": "string" }, "description": "Minimum date. All dates before will be disabled.", "fieldName": "minDate" }, { "name": "mobileBreakpoint", "type": { "text": "number" }, "description": "Mobile breakpoint for responsive design.", "fieldName": "mobileBreakpoint" }, { "name": "monthFirst", "type": { "text": "boolean" }, "fieldName": "monthFirst" }, { "name": "numCalendars", "type": { "text": "number" }, "description": "Number of calendars to render.", "default": "undefined", "fieldName": "numCalendars" }, { "name": "visible", "type": { "text": "boolean" }, "description": "Flag indicating if the calendar is visible.", "default": "false", "fieldName": "visible" } ], "superclass": { "name": "RangeDatepicker", "module": "/components/datepicker/src/vendor/wc-range-datepicker/range-datepicker.js" }, "tagName": "auro-formkit-calendar", "customElement": true } ], "exports": [ { "kind": "js", "name": "AuroCalendar", "declaration": { "name": "AuroCalendar", "module": "components/datepicker/src/auro-calendar.js" } }, { "kind": "custom-element-definition", "name": "auro-formkit-calendar", "declaration": { "name": "AuroCalendar", "module": "components/datepicker/src/auro-calendar.js" } } ] }, { "kind": "javascript-module", "path": "components/datepicker/src/auro-datepicker.js", "declarations": [ { "kind": "class", "description": "The `auro-datepicker` component provides users with a way to select a date or date range from a calendar popup or fullscreen calendar on mobile.", "name": "AuroDatePicker", "cssParts": [ { "description": "Use for customizing the style of the dropdown.", "name": "dropdown" }, { "description": "Use for customizing the style of the datepicker trigger.", "name": "trigger" }, { "description": "Use for customizing the style of the datepicker inputs.", "name": "input" }, { "description": "Use for customizing the style of the calendar container.", "name": "calendarWrapper" }, { "description": "Use for customizing the style of the calendar.", "name": "calendar" }, { "description": "Use for customizing the style of the datepicker help text span.", "name": "helpTextSpan" }, { "description": "Use for customizing the style of the datepicker help text.", "name": "helpText" } ], "slots": [ { "description": "Defines the content of the helpText.", "name": "helpText" }, { "description": "Sets aria-label on close button in fullscreen bib", "name": "ariaLabel.bib.close" }, { "description": "Sets aria-label on clear button", "name": "ariaLabel.input.clear" }, { "description": "Defines the headline to display above bib.fullscreen.dateLabels in the mobile layout.", "name": "bib.fullscreen.headline" }, { "description": "**DEPRECATED** - Use `bib.fullscreen.fromLabel` instead.", "name": "bib.fullscreen.dateLabel" }, { "description": "Defines the content to display above the first input in the mobile layout.", "name": "bib.fullscreen.fromLabel" }, { "description": "Defines the content to display above the second input in the mobile layout when `range` is true.", "name": "bib.fullscreen.toLabel" }, { "description": "Defines the label content for the entire datepicker when `layout=\"snowflake\"`.", "name": "label" }, { "description": "Defines the label content for the second input when the `range` attribute is used.", "name": "toLabel" }, { "description": "Defines the label content for the first input.", "name": "fromLabel" }, { "description": "Defines the content to display in the auro-calendar-cell for the specified date. The content text is colored using the success state token when the `highlight` attribute is applied to the slot.", "name": "date_MM_DD_YYYY" }, { "description": "Defines the content to display in the auro-calendar-cell popover for the specified date.", "name": "popover_MM_DD_YYYY" } ], "members": [ { "kind": "field", "name": "shadowRootOptions", "static": true, "readonly": true }, { "kind": "method", "name": "register", "static": true, "parameters": [ { "name": "name", "default": "\"auro-datepicker\"", "description": "The name of the element that you want to register.", "optional": true, "type": { "text": "string" } } ], "description": "This will register this element with the browser." }, { "kind": "field", "name": "values", "description": "A convenience wrapper for `value` and `valueEnd`, uses the new Auro \"array value pattern\".", "return": { "type": { "text": "string[]" } }, "readonly": true }, { "kind": "field", "name": "labelHidden", "description": "Whether the label is being hidden currently based on state.", "return": { "type": { "text": "boolean" } }, "privacy": "private", "readonly": true }, { "kind": "field", "name": "dvHidden", "description": "Whether the displayValue container is being hidden currently based on state.", "return": { "type": { "text": "boolean" } }, "privacy": "private", "readonly": true }, { "kind": "field", "name": "displayValueFontClass", "description": "Returns the input font class based on layout and visibility state.", "privacy": "private", "return": { "type": { "text": "string" } }, "readonly": true }, { "kind": "field", "name": "commonDisplayValueWrapperClasses", "privacy": "private", "readonly": true }, { "kind": "method", "name": "checkDisplayValueSlotChange", "description": "Function to determine if there is any displayValue content to render.", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "handleFocusDateChange", "description": "Force the calendar view to the focus date when it changes.", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "generateRandomString", "parameters": [ { "name": "length", "description": "Number of characters for the returned random string.", "type": { "text": "Number" } } ], "privacy": "private", "return": { "type": { "text": "string" } } }, { "kind": "method", "name": "focus", "parameters": [ { "name": "focusInput", "default": "''", "description": "Pass in `endDate` to focus on the return input. No parameter is needed to focus on the depart input.", "type": { "text": "String" } } ], "description": "Focuses the datepicker trigger input.", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "convertToWcValidTime", "parameters": [ { "name": "date", "description": "Date to be converted.", "type": { "text": "Date" } } ], "description": "Converts valid time number to format used by wc-date-range API.", "privacy": "private", "return": { "type": { "text": "Number" } } }, { "kind": "method", "name": "convertWcTimeToDate", "parameters": [ { "name": "time", "description": "Unix timestamp to be converted to a date object.", "type": { "text": "String" } } ], "description": "Converts date object into a string.", "privacy": "private", "return": { "type": { "text": "Date" } } }, { "kind": "method", "name": "notifyValueChanged", "description": "Sends event notifying that the input has changed it's value.", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "handleCentralDateChange", "description": "Changes the calendar's visibility to reflect the value of the central date attribute.", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "notifyDatepickerToggled", "description": "Sends event notifying that the calendar popover has been opened.", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "notifyMonthChanged", "parameters": [ { "name": "event", "description": "Event passed in from auro-calendar when the event triggered this function.", "type": { "text": "Object" } } ], "description": "Sends event notifying that the calendar's visible month has changed.", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "configureDropdown", "description": "Binds all behavior needed to the dropdown after rendering.", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "configureInput", "description": "Binds all behavior needed to the input after rendering.", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "configureCalendar", "description": "Binds all behavior needed to the dropdown after rendering.", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "configureDatepicker", "description": "Binds all behavior needed to the datepicker after rendering.", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "blur", "description": "Blurs the datepicker and hides the dropdown as part of blur action.", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "hideBib", "description": "Hides the dropdown bib if its open.", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "showBib", "description": "Shows the dropdown bib if there are options to show.", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "handleReadOnly", "description": "Sets the readonly attribute on the inputs based on the window width.", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "handleCalendarCentralDateChange", "parameters": [ { "name": "event", "description": "Event received from calendar with the new central date.", "type": { "text": "Number" } } ], "description": "Keep the datepicker in sync with the calendar's central date.", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "handleCellClick", "parameters": [ { "name": "time", "description": "Unix timestamp to be converted to a date.", "type": { "text": "Number" } } ], "description": "Sets the datepicker's values to the auro-calendar-cell that was clicked.", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "pushSlotContent", "description": "Emits an event to notify the calendar cells to fetch their slot content.", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "handleKeydownReset", "parameters": [ { "name": "event", "description": "The keydown event.", "type": { "text": "KeyboardEvent" } } ], "description": "Handle enter/space keydown on the reset button.", "privacy": "private" }, { "kind": "method", "name": "resetInputs", "description": "Resets values without resetting validation." }, { "kind": "method", "name": "reset", "description": "Resets component to initial state.", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "clear", "description": "Clears the current value(s) of the datepicker.", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "validate", "parameters": [ { "name": "force", "default": "false", "description": "Whether to force validation.", "optional": true, "type": { "text": "boolean" } } ], "description": "Validates value." }, { "kind": "method", "name": "setHasValue", "description": "Private method for interacting with the `hasValue` property.", "privacy": "private" }, { "kind": "field", "name": "hasError", "readonly": true }, { "kind": "method", "name": "handleSlotToSlot", "parameters": [ { "name": "event", "description": "The event object containing information about the slot transfer.", "type": { "text": "Event" } } ], "description": "Handles the transfer of content between slots in the component.", "privacy": "private" }, { "kind": "method", "name": "handleClick", "parameters": [ { "name": "event", "description": "The pointer event object.", "type": { "text": "PointerEvent" } } ], "description": "Handles click events on the datepicker.", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "configureClickHandler", "description": "Set up click handling for the datepicker.", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "renderSnowflakeLayout", "description": "Renders the snowflake layout for the datepicker.", "privacy": "private", "return": { "type": { "text": "TemplateResult" } } }, { "kind": "method", "name": "renderClassicLayout", "description": "Renders the snowflake layout for the datepicker.", "privacy": "private", "return": { "type": { "text": "TemplateResult" } } }, { "kind": "method", "name": "renderLayoutFromAttributes", "description": "Renders the layout based on the `layout` attribute.", "privacy": "private", "return": { "type": { "text": "TemplateResult" } } }, { "kind": "method", "name": "formatShortDate", "parameters": [ { "name": "date", "description": "Date format should be in a format Date constructor accepts, like '2023-04-21' or '2023/04/21'.", "type": { "text": "string" } } ], "description": "Simple formatter that ONLY WORKS FOR US DATES.\nReturns formatted date like Apr 21 or Dec 25.", "privacy": "private", "return": { "type": { "text": "string" } } }, { "kind": "method", "name": "renderDisplayTextDate", "parameters": [ { "name": "dateValue", "description": "The date value to format and render.", "type": { "text": "string" } } ], "description": "Format and render the provided date value.", "privacy": "private", "return": { "type": { "text": "TemplateResult" } } }, { "kind": "method", "name": "renderHtmlInputs", "description": "Renders the HTML inputs for the datepicker.", "privacy": "private", "return": { "type": { "text": "TemplateResult" } } }, { "kind": "method", "name": "renderHtmlActionClear", "description": "Renders the clear action button.", "privacy": "private", "return": { "type": { "text": "TemplateResult" } } }, { "kind": "method", "name": "renderHtmlIconError", "description": "Renders the error icon.", "privacy": "private", "return": { "type": { "text": "TemplateResult" } } }, { "kind": "method", "name": "renderHtmlIconCalendar", "description": "Renders the calendar icon.", "privacy": "private", "return": { "type": { "text": "TemplateResult" } } }, { "kind": "method", "name": "renderHtmlHelpText", "description": "Returns HTML for the help text and error message.", "privacy": "private", "return": { "type": { "text": "TemplateResult" } } }, { "kind": "method", "name": "renderCalendar", "description": "Separate method for rendering the calendar.", "privacy": "private", "return": { "type": { "text": "TemplateResult" } } }, { "kind": "field", "name": "util", "privacy": "private", "default": "new AuroDatepickerUtilities()" }, { "kind": "field", "name": "calendarRenderUtil", "privacy": "private", "default": "new UtilitiesCalendarRender()" }, { "kind": "field", "name": "appearance", "privacy": "public", "type": { "text": "string" }, "description": "Defines whether the component will be on lighter or darker backgrounds.", "default": "\"default\"", "attribute": "appearance", "reflects": true }, { "kind": "field", "name": "touched", "privacy": "private", "type": { "text": "boolean" }, "description": "Indicates whether the datepicker is in a dirty state (has been interacted with).", "default": "false" }, { "kind": "field", "name": "disabled", "privacy": "public", "type": { "text": "boolean" }, "description": "If set, disables the datepicker.", "default": "false", "attribute": "disabled", "reflects": true }, { "kind": "field", "name": "dvInputOnly", "privacy": "public", "type": { "text": "boolean" }, "description": "If defined, the display value slot content will only mask the HTML5 input element. The input's label will not be masked.", "default": "false", "attribute": "dvInputOnly", "reflects": true }, { "kind": "field", "name": "required", "privacy": "public", "type": { "text": "boolean" }, "description": "Populates the `required` attribute on the input. Used for client-side validation.", "default": "false", "attribute": "required", "reflects": true }, { "kind": "field", "name": "onDark", "privacy": "public", "type": { "text": "boolean" }, "attribute": "onDark", "reflects": true, "description": "DEPRECATED - use `appearance=\"inverse\"` instead.", "default": "false", "inheritedFrom": { "name": "AuroElement", "module": "components/layoutElement/src/auroElement.js" } }, { "kind": "field", "name": "range", "privacy": "public", "type": { "text": "boolean" }, "description": "If set, turns on date range functionality in auro-calendar.", "default": "false", "attribute": "range", "reflects": true }, { "kind": "field", "name": "stacked", "privacy": "public", "type": { "text": "boolean" }, "description": "Set true to make datepicker stacked style.", "default": "false", "attribute": "stacked", "reflects": true }, { "kind": "field", "name": "noValidate", "privacy": "public", "type": { "text": "boolean" }, "description": "If set, disables auto-validation on blur.", "default": "false", "attribute": "noValidate", "reflects": true }, { "kind": "field", "name": "validity", "privacy": "public", "type": { "text": "string" }, "description": "Specifies the `validityState` this element is in.", "default": "undefined", "attribute": "validity", "reflects": true }, { "kind": "field", "name": "value", "privacy": "public", "type": { "text": "string" }, "description": "Value selected for the datepicker.", "default": "undefined", "attribute": "value" }, { "kind": "field", "name": "valueEnd", "privacy": "public", "type": { "text": "string" }, "description": "Value selected for the second datepicker when using date range.", "default": "undefined", "attribute": "valueEnd" }, { "kind": "field", "name": "calendarStartDate", "privacy": "public", "type": { "text": "string" }, "description": "The first date that may be displayed in the calendar.", "default": "undefined", "attribute": "calendarStartDate", "reflects": true }, { "kind": "field", "name": "calendarEndDate", "privacy": "public", "type": { "text": "string" }, "description": "The last date that may be displayed in the calendar.", "default": "undefined", "attribute": "calendarEndDate", "reflects": true }, { "kind": "field", "name": "calendarFocusDate", "privacy": "public", "type": { "text": "string" }, "description": "The date that will first be visually rendered to the user in the calendar.", "attribute": "calendarFocusDate", "reflects": true }, { "kind": "field", "name": "format", "privacy": "public", "type": { "text": "string" }, "description": "Specifies the date format. The default is `mm/dd/yyyy`.", "default": "'mm/dd/yyyy'", "attribute": "format", "reflects": true }, { "kind": "field", "name": "fullscreenBreakpoint", "privacy": "public", "type": { "text": "string" }, "description": "Defines the screen size breakpoint at which the dropdown switches to fullscreen mode on mobile. `disabled` indicates a dropdown should _never_ enter fullscreen.\n\nWhen expanded, the dropdown will automatically display in fullscreen mode\nif the screen size is equal to or smaller than the selected breakpoint.", "default": "'sm'", "attribute": "fullscreenBreakpoint", "reflects": true }, { "kind": "field", "name": "monthNames", "privacy": "public", "type": { "text": "array" }, "description": "Names of all 12 months to render in the calendar, used for localization of date string in mobile layout.", "default": "[ 'January', 'February', 'March', 'April', 'May', 'June', 'July', 'August', 'September', 'October', 'November', 'December' ]", "attribute": "monthNames" }, { "kind": "field", "name": "placement", "privacy": "public", "type": { "text": "string" }, "description": "Position where the bib should appear relative to the trigger.", "default": "'bottom-start'", "attribute": "placement", "reflects": true }, { "kind": "field", "name": "offset", "privacy": "public", "type": { "text": "number" }, "description": "Gap between the trigger element and bib.", "default": "0", "attribute": "offset", "reflects": true }, { "kind": "field", "name": "noFlip", "privacy": "public", "type": { "text": "boolean" }, "description": "If declared, the bib will NOT flip to an alternate position\nwhen there isn't enough space in the specified `placement`.", "default": "false", "attribute": "noFlip", "reflects": true }, { "kind": "field", "name": "shift", "privacy": "public", "type": { "text": "boolean" }, "description": "If declared, the dropdown will shift its position to avoid being cut off by the viewport.", "default": "false", "attribute": "shift", "reflects": true }, { "kind": "field", "name": "autoPlacement", "privacy": "public", "type": { "text": "boolean" }, "description": "If declared, bib's position will be automatically calculated where to appear.", "default": "false", "attribute": "autoPlacement", "reflects": true }, { "kind": "field", "name": "largeFullscreenHeadline", "privacy": "public", "type": { "text": "boolean" }, "description": "If declared, make bib.fullscreen.headline in HeadingDisplay.\nOtherwise, Heading 600.", "default": "false", "attribute": "largeFullscreenHeadline", "reflects": true }, { "kind": "field", "name": "dateSlotContent", "type": { "text": "array" }, "privacy": "private", "default": "[]" }, { "kind": "field", "name": "hasDisplayValueContent", "type": { "text": "boolean" }, "privacy": "private", "default": "true" }, { "kind": "field", "name": "hasFocus", "privacy": "private", "type": { "text": "boolean" }, "default": "false", "attribute": "hasFocus" }, { "kind": "field", "name": "hasValue", "privacy": "private", "type": { "text": "boolean" }, "default": "false", "attribute": "hasValue" }, { "kind": "field", "name": "hasAllValues", "privacy": "private", "type": { "text": "boolean" }, "default": "false", "attribute": "hasAllValues" }, { "kind": "field", "name": "validation", "privacy": "private", "default": "new AuroFormValidation()" }, { "kind": "field", "name": "runtimeUtils", "privacy": "private", "default": "new AuroLibraryRuntimeUtils()" }, { "kind": "field", "name": "forceScrollOnNextMobileCalendarRender", "type": { "text": "boolean" }, "privacy": "private", "default": "false" }, { "kind": "field", "name": "dropdownTag", "privacy": "private" }, { "kind": "field", "name": "buttonTag", "privacy": "private" }, { "kind": "field", "name": "iconTag", "privacy": "private" }, { "kind": "field", "name": "inputTag", "privacy": "private" }, { "kind": "field", "name": "helpTextTag", "privacy": "private" }, { "kind": "field", "name": "layout", "privacy": "public", "type": { "text": "string" }, "description": "Sets the layout of the datepicker.", "default": "'classic'", "attribute": "layout", "reflects": true, "inheritedFrom": { "name": "AuroElement", "module": "components/layoutElement/src/auroElement.js" } }, { "kind": "field", "name": "shape", "privacy": "public", "type": { "text": "string" }, "attribute": "shape", "reflects": true, "default": "'classic'", "inheritedFrom": { "name": "AuroElement", "module": "components/layoutElement/src/auroElement.js" } }, { "kind": "field", "name": "size", "privacy": "public", "type": { "text": "string" }, "attribute": "size", "reflects": true, "default": "'lg'", "inheritedFrom": { "name": "AuroElement", "module": "components/layoutElement/src/auroElement.js" } }, { "kind": "field", "name": "centralDate", "privacy": "public", "type": { "text": "string" }, "description": "The date that determines the currently visible month.", "attribute": "centralDate" }, { "kind": "field", "name": "error", "privacy": "public", "type": { "text": "string" }, "description": "When defined, sets persistent validity to `customError` and sets the validation message to the attribute value.", "attribute": "error", "reflects": true }, { "kind": "field", "name": "inputmode", "privacy": "public", "type": { "text": "string" }, "description": "Exposes inputmode attribute for input.", "attribute": "inputmode", "reflects": true }, { "kind": "field", "name": "maxDate", "privacy": "public", "type": { "text": "string" }, "description": "Maximum date. All dates after will be disabled.", "attribute": "maxDate", "reflects": true }, { "kind": "field", "name": "minDate", "privacy": "public", "type": { "text": "string" }, "description": "Minimum date. All dates before will be disabled.", "attribute": "minDate", "reflects": true }, { "kind": "field", "name": "monthFirst", "privacy": "private", "type": { "text": "boolean" }, "attribute": "monthFirst" }, { "kind": "field", "name": "placeholder", "privacy": "public", "type": { "text": "string" }, "description": "Placeholder text to display in the input(s) when no value is set.", "attribute": "placeholder", "reflects": true }, { "kind": "field", "name": "placeholderEndDate", "privacy": "public", "type": { "text": "string" }, "description": "Optional placeholder text to display in the second input when using date range.\nBy default, datepicker will use `placeholder` for both inputs if placeholder is\nspecified, but placeholderendDate is not.", "attribute": "placeholderEndDate", "reflects": true }, { "kind": "field", "name": "referenceDates", "privacy": "public", "type": { "text": "array" }, "description": "Dates that the user should have for reference as part of their decision making when selecting a date.\nThis should be a JSON string array of dates in the format of `MM-DD-YYYY`.", "attribute": "referenceDates", "reflects": true }, { "kind": "field", "name": "setCustomValidity", "privacy": "public", "type": { "text": "string" }, "description": "Sets a custom help text message to display for all validityStates.", "attribute": "setCustomValidity" }, { "kind": "field", "name": "setCustomValidityCustomError", "privacy": "public", "type": { "text": "string" }, "description": "Custom help text message to display when validity = `customError`.", "attribute": "setCustomValidityCustomError" }, { "kind": "field", "name": "setCustomValidityRangeOverflow", "privacy": "public", "type": { "text": "string" }, "description": "Custom help text message to display when validity = `rangeOverflow`.", "attribute": "setCustomValidityRangeOverflow" }, { "kind": "field", "name": "setCustomValidityRangeUnderflow", "privacy": "public", "type": { "text": "string" }, "description": "Custom help text message to display when validity = `rangeUnderflow`.", "attribute": "setCustomValidityRangeUnderflow" }, { "kind": "field", "name": "setCustomValidityValueMissing", "privacy": "public", "type": { "text": "string" }, "description": "Custom help text message to display when validity = `valueMissing`.", "attribute": "setCustomValidityValueMissing" }, { "kind": "field", "name": "componentHasFocus", "description": "Returns true if the element has focus.", "privacy": "private", "return": { "type": { "text": "boolean" } }, "readonly": true, "inheritedFrom": { "name": "AuroElement", "module": "components/layoutElement/src/auroElement.js" } }, { "kind": "method", "name": "resetShapeClasses", "inheritedFrom": { "name": "AuroElement", "module": "components/layoutElement/src/auroElement.js" } }, { "kind": "method", "name": "resetLayoutClasses", "inheritedFrom": { "name": "AuroElement", "module": "components/layoutElement/src/auroElement.js" } }, { "kind": "method", "name": "updateComponentArchitecture", "inheritedFrom": { "name": "AuroElement", "module": "components/layoutElement/src/auroElement.js" } } ], "events": [ { "name": "auroDatePicker-toggled", "type": { "text": "CustomEvent" }, "description": "Notifies that the calendar dropdown has been opened/closed." }, { "name": "auroDatePicker-monthChanged", "type": { "text": "CustomEvent" }, "description": "Notifies that the visible calendar month(s) have changed." }, { "name": "auroDatePicker-newSlotContent", "type": { "text": "CustomEvent" }, "description": "Notifies that new slot content has been added to the datepicker." }, { "description": "Notifies that the component has a new value set.", "name": "auroDatePicker-valueSet" }, { "description": "Notifies that the component value(s) have been validated.", "name": "auroFormElement-validated" } ], "attributes": [ { "name": "appearance", "type": { "text": "string" }, "description": "Defines whether the component will be on lighter or darker backgrounds.", "default": "\"default\"", "fieldName": "appearance" }, { "name": "autoPlacement", "type": { "text": "boolean" }, "description": "If declared, bib's position will be automatically calculated where to appear.", "default": "false", "fieldName": "autoPlacement" }, { "name": "calendarEndDate", "type": { "text": "string" }, "description": "The last date that may be displayed in the calendar.", "default": "undefined", "fieldName": "calendarEndDate" }, { "name": "calendarFocusDate", "type": { "text": "string" }, "description": "The date that will first be visually rendered to the user in the calendar.", "fieldName": "calendarFocusDate" }, { "name": "calendarStartDate", "type": { "text": "string" }, "description": "The first date that may be displayed in the calendar.", "default": "undefined", "fieldName": "calendarStartDate" }, { "name": "centralDate", "type": { "text": "string" }, "description": "The date that determines the currently visible month.", "fieldName": "centralDate" }, { "name": "disabled", "type": { "text": "boolean" }, "description": "If set, disables the datepicker.", "default": "false", "fieldName": "disabled" }, { "name": "dvInputOnly", "type": { "text": "boolean" }, "description": "If defined, the display value slot content will only mask the HTML5 input element. The input's label will not be masked.", "default": "false", "fieldName": "dvInputOnly" }, { "name": "error", "type": { "text": "string" }, "description": "When defined, sets persistent validity to `customError` and sets the validation message to the attribute value.", "fieldName": "error" }, { "name": "hasFocus", "type": { "text": "boolean" }, "default": "false", "fieldName": "hasFocus" }, { "name": "hasValue", "type": { "text": "boolean" }, "default": "false", "fieldName": "hasValue" }, { "name": "hasAllValues", "type": { "text": "boolean" }, "default": "false", "fieldName": "hasAllValues" }, { "name": "format", "type": { "text": "string" }, "description": "Specifies the date format. The default is `mm/dd/yyyy`.", "default": "'mm/dd/yyyy'", "fieldName": "format" }, { "name": "fullscreenBreakpoint", "type": { "text": "string" }, "description": "Defines the screen size breakpoint at which the dropdown switches to fullscreen mode on mobile. `disabled` indicates a dropdown should _never_ enter fullscreen.\n\nWhen expanded, the dropdown will automatically display in fullscreen mode\nif the screen size is equal to or smaller than the selected breakpoint.", "default": "'sm'", "fieldName": "fullscreenBreakpoint" }, { "name": "inputmode", "type": { "text": "string" }, "description": "Exposes inputmode attribute for input.", "fieldName": "inputmode" }, { "name": "largeFullscreenHeadline", "type": { "text": "boolean" }, "description": "If declared, make bib.fullscreen.headline in HeadingDisplay.\nOtherwise, Heading 600.", "default": "false", "fieldName": "largeFullscreenHeadline" }, { "name": "layout", "type": { "text": "string" }, "description": "Sets the layout of the datepicker.", "default": "'classic'", "fieldName": "layout", "inheritedFrom": { "name": "AuroElement", "module": "components/layoutElement/src/auroElement.js" } }, { "name": "maxDate", "type": { "text": "string" }, "description": "Maximum date. All dates after will be disabled.", "fieldName": "maxDate" }, { "name": "minDate", "type": { "text": "string" }, "description": "Minimum date. All dates before will be disabled.", "fieldName": "minDate" }, { "name": "monthNames", "type": { "text": "array" }, "description": "Names of all 12 months to render in the calendar, used for localization of date string in mobile layout.", "default": "[ 'January', 'February', 'March', 'April', 'May', 'June', 'July', 'August', 'September', 'October', 'November', 'December' ]", "fieldName": "monthNames" }, { "name": "monthFirst", "type": { "text": "boolean" }, "fieldName": "monthFirst" }, { "name": "noFlip", "type": { "text": "boolean" }, "description": "If declared, the bib will NOT flip to an alternate position\nwhen there isn't enough space in the specified `placement`.", "default": "false", "fieldName": "noFlip" }, { "name": "shift", "type": { "text": "boolean" }, "description": "If declared, the dropdown will shift its position to avoid being cut off by the viewport.", "default": "false", "fieldName": "shift" }, { "name": "noValidate", "type": { "text": "boolean" }, "description": "If set, disables auto-validation on blur.", "default": "false", "fieldName": "noValidate" }, { "name": "offset", "type": { "text": "number" }, "description": "Gap between the trigger element and bib.", "default": "0", "fieldName": "offset" }, { "name": "onDark", "type": { "text": "boolean" }, "description": "DEPRECATED - use `appearance=\"inverse\"` instead.", "default": "false", "fieldName": "onDark" }, { "name": "placeholder", "type": { "text": "string" }, "description": "Placeholder text to display in the input(s) when no value is set.", "fieldName": "placeholder" }, { "name": "placeholderEndDate", "type": { "text": "string" }, "description": "Optional placeholder text to display in the second input when using date range.\nBy default, datepicker will use `placeholder` for both inputs if placeholder is\nspecified, but placeholderendDate is not.", "fieldName": "placeholderEndDate" }, { "name": "placement", "type": { "text": "string" }, "description": "Position where the bib should appear relative to the trigger.", "default": "'bottom-start'", "fieldName": "placement" }, { "name": "range", "type": { "text": "boolean" }, "description": "If set, turns on date range functionality in auro-calendar.", "default": "false", "fieldName": "range" }, { "name": "referenceDates", "type": { "text": "array" }, "description": "Dates that the user should have for reference as part of their decision making when selecting a date.\nThis should be a JSON string array of dates in the format of `MM-DD-YYYY`.", "fieldName": "referenceDates" }, { "name": "required", "type": { "text": "boolean" }, "description": "Populates the `required` attribute on the input. Used for client-side validation.", "default": "false", "fieldName": "required" }, { "name": "setCustomValidity", "type": { "text": "string" }, "description": "Sets a custom help text message to display for all validityStates.", "fieldName": "setCustomValidity" }, { "name": "setCustomValidityCustomError", "type": { "text": "string" }, "description": "Custom help text message to display when validity = `customError`.", "fieldName": "setCustomValidityCustomError" }, { "name": "setCustomValidityRangeOverflow", "type": { "text": "string" }, "description": "Custom help text message to display when validity = `rangeOverflow`.", "fieldName": "setCustomValidityRangeOverflow" }, { "name": "setCustomValidityRangeUnderflow", "type": { "text": "string" }, "description": "Custom help text message to display when validity = `rangeUnderflow`.", "fieldName": "setCustomValidityRangeUnderflow" }, { "name": "setCustomValidityValueMissing", "type": { "text": "string" }, "description": "Custom help text message to display when validity = `valueMissing`.", "fieldName": "setCustomValidityValueMissing" }, { "name": "stacked", "type": { "text": "boolean" }, "description": "Set true to make datepicker stacked style.", "default": "false", "fieldName": "stacked" }, { "name": "validity", "type": { "text": "string" }, "description": "Specifies the `validityState` this element is in.", "default": "undefined", "fieldName": "validity" }, { "name": "value", "type": { "text": "string" }, "description": "Value selected for the datepicker.", "default": "undefined", "fieldName": "value" }, { "name": "valueEnd", "type": { "text": "string" }, "description": "Value selected for the second datepicker when using date range.", "default": "undefined", "fieldName": "valueEnd" }, { "name": "shape", "type": { "text": "string" }, "fieldName": "shape", "inheritedFrom": { "name": "AuroElement", "module": "components/layoutElement/src/auroElement.js" } }, { "name": "size", "type": { "text": "string" }, "fieldName": "size", "inheritedFrom": { "name": "AuroElement", "module": "components/layoutElement/src/auroElement.js" } }, { "name": "ondark", "type": { "text": "boolean" }, "fieldName": "onDark", "inheritedFrom": { "name": "AuroElement", "module": "components/layoutElement/src/auroElement.js" } } ], "superclass": { "name": "AuroElement", "package": "@aurodesignsystem/auro-layout-element" }, "tagName": "auro-datepicker", "customElement": true } ], "exports": [ { "kind": "js", "name": "AuroDatePicker", "declaration": { "name": "AuroDatePicker", "module": "components/datepicker/src/auro-datepicker.js" } } ] }, { "kind": "javascript-module", "path": "components/datepicker/src/buttonVersion.js", "declarations": [], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "12.3.2", "module": "components/datepicker/src/buttonVersion.js" } } ] }, { "kind": "javascript-module", "path": "components/datepicker/src/iconVersion.js", "declarations": [], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "9.1.2", "module": "components/datepicker/src/iconVersion.js" } } ] }, { "kind": "javascript-module", "path": "components/datepicker/src/index.js", "declarations": [], "exports": [ { "kind": "js", "name": "AuroDatePicker", "declaration": { "name": "AuroDatePicker", "module": "components/datepicker/src/index.js" } } ] }, { "kind": "javascript-module", "path": "components/datepicker/src/popoverVersion.js", "declarations": [], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "6.0.1", "module": "components/datepicker/src/popoverVersion.js" } } ] }, { "kind": "javascript-module", "path": "components/datepicker/src/registered.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "components/datepicker/src/utilities.js", "declarations": [ { "kind": "class", "description": "", "name": "AuroDatepickerUtilities", "members": [ { "kind": "method", "name": "validDateStr", "parameters": [ { "name": "date", "description": "Date to validate.", "type": { "text": "String" } }, { "name": "format", "description": "Date format to validate against.", "type": { "text": "String" } } ], "description": "Returns true if value passed in is a valid date.", "privacy": "private", "return": { "type": { "text": "Boolean" } } }, { "kind": "method", "name": "toNorthAmericanFormat", "parameters": [ { "name": "dateStr", "description": "Date to validate.", "type": { "text": "String" } }, { "name": "format", "description": "Date format to validate against.", "type": { "text": "String" } } ], "description": "Converts a date string to a North American date format.", "privacy": "private", "return": { "type": { "text": "Boolean" } } }, { "kind": "method", "name": "parseDate", "parameters": [ { "name": "dateStr", "description": "Date string to parse.", "type": { "text": "string" } }, { "name": "format", "description": "Date format to parse.", "type": { "text": "string" } } ], "description": "Parses a date string into its components.", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "toCustomFormat", "parameters": [ { "name": "dateStr", "description": "Date string to parse.", "type": { "text": "string" } }, { "name": "format", "description": "Date format to parse.", "type": { "text": "string" } } ], "description": "Converts a date string to a custom date format.", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "convertDateToFirstOfMonth", "parameters": [ { "name": "date", "description": "Date to convert to the first day of the month.", "type": { "text": "Object" } } ], "description": "Converts any date object to a date object representing the first day of the month.", "return": { "type": { "text": "Object" } } }, { "kind": "method", "name": "monthDiff", "parameters": [ { "name": "date1", "description": "First date to compare.", "type": { "text": "Object" } }, { "name": "date2", "description": "Second date to compare.", "type": { "text": "Object" } } ], "description": "Calculate the number of months between two dates.", "return": { "type": { "text": "Number" } } }, { "kind": "method", "name": "getDateAsString", "parameters": [ { "name": "date", "description": "Date to convert to string.", "type": { "text": "Object" } } ], "description": "Convert a date object to string format.", "privacy": "private", "return": { "type": { "text": "Object" } } }, { "kind": "method", "name": "formatTwoDigits", "parameters": [ { "name": "num", "description": "Number to format.", "type": { "text": "Number" } } ], "description": "Function to format a number to two digits.", "privacy": "private", "return": { "type": { "text": "String" } } }, { "kind": "method", "name": "generateIconHtml", "parameters": [ { "name": "icon", "description": "Icon object containing the SVG.", "type": { "text": "Object" } } ], "description": "Function to generate checkmark svg.", "privacy": "private", "return": { "type": { "text": "Object" } } }, { "kind": "method", "name": "datesMatch", "parameters": [ { "name": "date1", "description": "First date to compare.", "type": { "text": "Object" } }, { "name": "date2", "description": "Second date to compare.", "type": { "text": "Object" } } ], "description": "Compares two dates to see if they match.", "privacy": "private", "return": { "type": { "text": "Boolean" } } } ] } ], "exports": [ { "kind": "js", "name": "AuroDatepickerUtilities", "declaration": { "name": "AuroDatepickerUtilities", "module": "components/datepicker/src/utilities.js" } } ] }, { "kind": "javascript-module", "path": "components/datepicker/src/utilitiesCalendar.js", "declarations": [ { "kind": "class", "description": "", "name": "CalendarUtilities", "members": [ { "kind": "method", "name": "scrollMonthIntoView", "parameters": [ { "name": "elem", "description": "The calendar element.", "type": { "text": "Object" } }, { "name": "date", "description": "The date to scroll into view.", "type": { "text": "String" } }, { "name": "format", "description": "The format of the date.", "type": { "text": "String" } } ], "description": "Scroll the calendar month list to a given valid date if in mobile view.", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "requestDismiss", "description": "Sends an event requesting the dropdown bib be closed.", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "assessNavigationButtonVisibility", "parameters": [ { "name": "elem", "description": "The auro-calendar element.", "type": { "text": "Object" } } ], "description": "Handles the visibility of the previous and next month buttons.", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "centralDateChanged", "parameters": [ { "name": "elem", "description": "The auro-calendar element.", "type": { "text": "Object" } } ], "description": "Handles the change of the centralDate property.", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "handleMonthChange", "parameters": [ { "name": "elem", "description": "The auro-calendar element.", "type": { "text": "Object" } }, { "name": "direction", "description": "The direction the user is navigating.", "type": { "text": "String" } } ], "description": "Updates the month and year when the user navigates to a different calendar month.", "return": { "type": { "text": "void" } } }, { "kind": "field", "name": "util", "default": "new AuroDatepickerUtilities()" } ], "events": [ { "name": "auroCalendar-dismissRequest", "type": { "text": "CustomEvent" } } ] } ], "exports": [ { "kind": "js", "name": "CalendarUtilities", "declaration": { "name": "CalendarUtilities", "module": "components/datepicker/src/utilitiesCalendar.js" } } ] }, { "kind": "javascript-module", "path": "components/datepicker/src/utilitiesCalendarRender.js", "declarations": [ { "kind": "class", "description": "", "name": "UtilitiesCalendarRender", "members": [ { "kind": "method", "name": "updateCentralDate", "parameters": [ { "name": "elem", "description": "The element to set the centralDate on.", "type": { "text": "Object" } }, { "name": "date", "description": "The date to set the centralDate to.", "type": { "text": "String" } } ], "description": "Attempt to update the central date but only if the date is a valid date.", "privacy": "private" }, { "kind": "method", "name": "determineDefinedCalendarRange", "parameters": [ { "name": "elem", "description": "The auro-calendar element.", "type": { "text": "Object" } } ], "description": "Determine how many months to render based on the defined calendar range.", "privacy": "private", "return": { "type": { "text": "Number" } } }, { "kind": "method", "name": "maximumRenderableMonths", "parameters": [ { "name": "elem", "description": "The auro-calendar element.", "type": { "text": "Object" } }, { "name": "isMobile", "description": "True if it's to render for mobile view.", "type": { "text": "Boolean" } } ], "description": "Determines how many calendar months can be rendered based on the screen size and defined range.", "privacy": "private", "return": { "type": { "text": "Number" } } }, { "kind": "method", "name": "determineNumCalendarsToRender", "parameters": [ { "name": "elem", "description": "The auro-calendar element.", "type": { "text": "Object" } }, { "name": "isMobile", "description": "True if it's to render for mobile view.", "type": { "text": "Boolean" } } ], "description": "Determines the number of months rendered inside the calendar.", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "setFirstRenderableMonthDate", "parameters": [ { "name": "elem", "description": "The auro-calendar element.", "type": { "text": "Object" } } ], "description": "Determine which month is to be rendered first.", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "renderCalendar", "parameters": [ { "name": "elem", "description": "The auro-calendar element.", "type": { "text": "Object" } }, { "name": "month", "description": "Month the calendar displays.", "type": { "text": "Number" } }, { "name": "year", "description": "Year the calendar displays.", "type": { "text": "Number" } } ], "description": "Renders one auro-calendar-month HTML for the given month/date combination.", "privacy": "private", "return": { "type": { "text": "Object" } } }, { "kind": "field", "name": "util", "default": "new AuroDatepickerUtilities()" } ] } ], "exports": [ { "kind": "js", "name": "UtilitiesCalendarRender", "declaration": { "name": "UtilitiesCalendarRender", "module": "components/datepicker/src/utilitiesCalendarRender.js" } } ] }, { "kind": "javascript-module", "path": "components/dropdown/src/auro-dropdown.js", "declarations": [ { "kind": "class", "description": "The `auro-dropdown` element provides a way to place content in a bib that can be toggled.", "name": "AuroDropdown", "cssParts": [ { "description": "The trigger content container.", "name": "trigger" }, { "description": "The collapsed/expanded state icon container.", "name": "chevron" }, { "description": "The size of the dropdown bib. (height, width, maxHeight, maxWidth only)", "name": "size" }, { "description": "The helpText content container.", "name": "helpText" } ], "slots": [ { "description": "Default slot for the dropdown bib content.", "name": "" }, { "description": "Defines the content of the helpText.", "name": "helpText" }, { "description": "Defines the content of the trigger.", "name": "trigger" } ], "members": [ { "kind": "field", "name": "shadowRootOptions", "static": true, "readonly": true }, { "kind": "field", "name": "commonWrapperClasses", "privacy": "private", "return": { "type": { "text": "object" } }, "readonly": true }, { "kind": "method", "name": "_intializeDefaults", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "hide", "description": "Public method to hide the dropdown.", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "show", "description": "Public method to show the dropdown.", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "focus", "description": "When bib is open, focus on the first element inside of bib.\nIf not, trigger element will get focus." }, { "kind": "method", "name": "setActiveDescendant", "parameters": [ { "name": "element", "description": "The element to set as the active descendant, or null to clear.", "type": { "text": "HTMLElement|null" } } ], "description": "Sets the active descendant element for accessibility.\nUses ariaActiveDescendantElement to cross shadow DOM boundaries.\nThis function is used in components that contain `auro-dropdown` to set the active descendant.", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "register", "static": true, "parameters": [ { "name": "name", "default": "\"auro-dropdown\"", "description": "The name of the element that you want to register.", "optional": true, "type": { "text": "string" } } ], "description": "This will register this element with the browser." }, { "kind": "field", "name": "focusableEntityQuery", "description": "Accessor for reusing the focusable entity query string.", "privacy": "private", "return": { "type": { "text": "string" } }, "readonly": true }, { "kind": "method", "name": "handleDropdownToggle", "parameters": [ { "name": "event", "description": "The custom event that contains the dropdown toggle information.", "type": { "text": "CustomEvent" } } ], "description": "Handles the custom event `auroDropdown-toggled` to update the visibility of the dropdown bib.", "privacy": "private" }, { "kind": "method", "name": "exposeCssParts", "description": "Exposes CSS parts for styling from parent components.", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "isCustomSlotContent", "parameters": [ { "name": "element", "description": "The element to check.", "type": { "text": "HTMLElement" } } ], "description": "Determines if content is within a custom slot.", "privacy": "private", "return": { "type": { "text": "Boolean" } } }, { "kind": "method", "name": "handleFocusin", "description": "Function to support", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "updateFocusTrap", "privacy": "private" }, { "kind": "method", "name": "handleFocusout", "description": "Function to support", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "bindFocusEventToTrigger", "parameters": [ { "name": "event", "description": "The original focus event.", "type": { "text": "Event" } } ], "description": "Creates and dispatches a duplicate focus event on the trigger element.", "privacy": "private" }, { "kind": "method", "name": "setupTriggerFocusEventBinding", "description": "Sets up event listeners to deliver focus and blur events from nested Auro components within the trigger slot to trigger.\nThis ensures that focus/blur events originating from within these components are propagated to the trigger element itself.", "privacy": "private" }, { "kind": "method", "name": "clearTriggerFocusEventBinding", "description": "Clears focus and blur event listeners from nested Auro components within the trigger slot.", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "clearTriggerA11yAttributes", "parameters": [ { "name": "triggerElement" } ] }, { "kind": "method", "name": "handleTriggerContentSlotChange", "parameters": [ { "name": "event", "description": "Native slotchange event.", "type": { "text": "Event" } } ], "description": "Handles changes to the trigger content slot and updates related properties.\n\nIt first updates the floater settings\nThen, it retrieves the assigned nodes from the event target and checks if any of\nthe nodes contain non-empty text content, updating the `hasTriggerContent` property accordingly.", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "handleDefaultSlot", "description": "Handles the default slot change event and updates the content.\n\nThis method retrieves all nodes assigned to the default slot of the event target and appends them\nto the `bibContent` element. If a callback function `onSlotChange` is defined, it is invoked to\nnotify about the slot change.", "privacy": "private" }, { "kind": "method", "name": "renderBasicHtml", "parameters": [ { "name": "helpTextClasses", "description": "Classes to apply to the help text container.", "type": { "text": "Object" } } ], "description": "Returns HTML for the common portion of the layouts.", "privacy": "private", "return": { "type": { "text": "html" } } }, { "kind": "method", "name": "renderLayoutClassic", "description": "Returns HTML for the classic layout. Does not support type=\"*\".", "privacy": "private", "return": { "type": { "text": "html" } } }, { "kind": "method", "name": "renderLayoutSnowflake", "description": "Returns HTML for the snowflake layout. Does not support type=\"*\".", "privacy": "private", "return": { "type": { "text": "html" } } }, { "kind": "method", "name": "renderLayoutEmphasized", "description": "Returns HTML for the emphasized layout. Does not support type=\"*\".", "privacy": "private", "return": { "type": { "text": "html" } } }, { "kind": "method", "name": "renderLayout", "parameters": [ { "name": "ForcedLayout", "description": "Used to force a specific layout, pass in the layout name to use.", "optional": true, "type": { "text": "string" } } ], "description": "Logic to determine the layout of the component.", "privacy": "private", "return": { "type": { "text": "HTMLCollection" } } }, { "kind": "field", "name": "isPopoverVisible", "privacy": "public", "type": { "text": "boolean" }, "description": "If true, the dropdown bib is displayed.", "default": "false", "attribute": "open", "reflects": true }, { "kind": "field", "name": "isBibFullscreen", "privacy": "public", "type": { "text": "boolean" }, "description": "If true, the dropdown bib is taking the fullscreen when it's open.", "default": "false", "attribute": "isBibFullscreen", "reflects": true }, { "kind": "field", "name": "matchWidth", "privacy": "public", "type": { "text": "boolean" }, "description": "If declared, the popover and trigger will be set to the same width.", "default": "false", "attribute": "matchWidth", "reflects": true }, { "kind": "field", "name": "noHideOnThisFocusLoss", "privacy": "public", "type": { "text": "boolean" }, "description": "If declared, the dropdown will not hide when moving focus outside the element.", "default": "false", "attribute": "noHideOnThisFocusLoss", "reflects": true }, { "kind": "field", "name": "errorMessage", "privacy": "public", "type": { "text": "string" }, "description": "Contains the help text message for the current validity error.", "default": "undefined", "attribute": "errorMessage" }, { "kind": "field", "name": "layout", "privacy": "public", "type": { "text": "string" }, "description": "Sets the layout of the dropdown.", "default": "undefined", "attribute": "layout", "reflects": true, "inheritedFrom": { "name": "AuroElement", "module": "components/layoutElement/src/auroElement.js" } }, { "kind": "field", "name": "shape", "privacy": "public", "type": { "text": "string" }, "attribute": "shape", "reflects": true, "default": "undefined", "inheritedFrom": { "name": "AuroElement", "module": "components/layoutElement/src/auroElement.js" } }, { "kind": "field", "name": "size", "privacy": "public", "type": { "text": "string" }, "attribute": "size", "reflects": true, "default": "undefined", "inheritedFrom": { "name": "AuroElement", "module": "components/layoutElement/src/auroElement.js" } }, { "kind": "field", "name": "parentBorder", "privacy": "private", "type": { "text": "boolean" }, "description": "Defines if the trigger should size based on the parent element providing the border UI.", "default": "false", "attribute": "parentBorder", "reflects": true }, { "kind": "field", "name": "bibElement", "privacy": "private" }, { "kind": "field", "name": "a11yRole", "privacy": "public", "type": { "text": "string" }, "description": "The value for the role attribute of the trigger element." }, { "kind": "field", "name": "appearance", "privacy": "public", "type": { "text": "'default' | 'inverse'" }, "description": "Defines whether the component will be on lighter or darker backgrounds.", "default": "'default'", "attribute": "appearance", "reflects": true }, { "kind": "field", "name": "autoPlacement", "privacy": "public", "type": { "text": "boolean" }, "description": "If declared, bib's position will be automatically calculated where to appear.", "attribute": "autoPlacement", "reflects": true }, { "kind": "field", "name": "disableEventShow", "privacy": "public", "type": { "text": "boolean" }, "description": "If declared, the dropdown will only show by calling the API .show() public method.", "attribute": "disableEventShow", "reflects": true }, { "kind": "field", "name": "simple", "privacy": "public", "type": { "text": "boolean" }, "description": "If declared, applies a border around the trigger slot.", "attribute": "simple", "reflects": true }, { "kind": "field", "name": "chevron", "privacy": "public", "type": { "text": "boolean" }, "description": "If declared, the dropdown displays a chevron on the right.", "attribute": "chevron", "reflects": true }, { "kind": "field", "name": "disabled", "privacy": "public", "type": { "text": "boolean" }, "description": "If declared, the dropdown is not interactive.", "attribute": "disabled", "reflects": true }, { "kind": "field", "name": "disableFocusTrap", "privacy": "public", "type": { "text": "boolean" }, "description": "If declared, the focus trap inside of bib will be turned off.", "attribute": "disableFocusTrap", "reflects": true }, { "kind": "field", "name": "dropdownWidth", "privacy": "private", "type": { "text": "number" }, "attribute": "dropdownWidth" }, { "kind": "field", "name": "dropdownId", "privacy": "private", "type": { "text": "string" }, "description": "The unique ID for the dropdown bib element." }, { "kind": "field", "name": "error", "privacy": "public", "type": { "text": "boolean" }, "description": "If declared, will apply error UI to the dropdown.", "attribute": "error", "reflects": true }, { "kind": "field", "name": "focusShow", "privacy": "public", "type": { "text": "boolean" }, "description": "If declared, the bib will display when focus is applied to the trigger.", "attribute": "focusShow", "reflects": true }, { "kind": "field", "name": "hoverToggle", "privacy": "public", "type": { "text": "boolean" }, "description": "If declared, the trigger will toggle the dropdown on mouseover/mouseout.", "attribute": "hoverToggle", "reflects": true }, { "kind": "field", "name": "hasTriggerContent", "privacy": "private", "type": { "text": "boolean" }, "attribute": "hasTriggerContent" }, { "kind": "field", "name": "fullscreenBreakpoint", "privacy": "public", "type": { "text": "'xs' | 'sm' | 'md' | 'lg' | 'xl' | 'disabled'" }, "description": "Defines the screen size breakpoint at which the dropdown switches to fullscreen mode on mobile. `disabled` indicates a dropdown should _never_ enter fullscreen.\n\nWhen expanded, the dropdown will automatically display in fullscreen mode\nif the screen size is equal to or smaller than the selected breakpoint.", "default": "'sm'", "attribute": "fullscreenBreakpoint", "reflects": true }, { "kind": "field", "name": "noFlip", "privacy": "public", "type": { "text": "boolean" }, "description": "If declared, the bib will NOT flip to an alternate position\nwhen there isn't enough space in the specified `placement`.", "attribute": "noFlip", "reflects": true }, { "kind": "field", "name": "shift", "privacy": "public", "type": { "text": "boolean" }, "description": "If declared, the dropdown will shift its position to avoid being cut off by the viewport.", "attribute": "shift", "reflects": true }, { "kind": "field", "name": "noToggle", "privacy": "public", "type": { "text": "boolean" }, "description": "If declared, the trigger will only show the dropdown bib.", "attribute": "noToggle", "reflects": true }, { "kind": "field", "name": "offset", "privacy": "public", "type": { "text": "number" }, "description": "Gap between the trigger element and bib.", "default": "0", "attribute": "offset", "reflects": true }, { "kind": "field", "name": "onDark", "privacy": "public", "type": { "text": "boolean" }, "attribute": "onDark", "reflects": true, "description": "DEPRECATED - use `appearance=\"inverse\"` instead.", "inheritedFrom": { "name": "AuroElement", "module": "components/layoutElement/src/auroElement.js" } }, { "kind": "field", "name": "onSlotChange", "privacy": "public", "type": { "text": "function" }, "description": "If declared, and a function is set, that function will execute when the slot content is updated.", "attribute": "onSlotChange" }, { "kind": "field", "name": "placement", "privacy": "public", "type": { "text": "'top' | 'right' | 'bottom' | 'left' | 'bottom-start' | 'top-start' | 'top-end' | 'right-start' | 'right-end' | 'bottom-end' | 'left-start' | 'left-end'" }, "description": "Position where the bib should appear relative to the trigger.", "default": "'bottom-start'", "attribute": "placement", "reflects": true }, { "kind": "field", "name": "tabIndex", "privacy": "private", "type": { "text": "number" }, "attribute": "tabIndex" }, { "kind": "field", "name": "bibDialogLabel", "privacy": "private", "type": { "text": "string" }, "description": "Accessible label for the dropdown bib dialog element." }, { "kind": "field", "name": "componentHasFocus", "description": "Returns true if the element has focus.", "privacy": "private", "return": { "type": { "text": "boolean" } }, "readonly": true, "inheritedFrom": { "name": "AuroElement", "module": "components/layoutElement/src/auroElement.js" } }, { "kind": "method", "name": "resetShapeClasses", "inheritedFrom": { "name": "AuroElement", "module": "components/layoutElement/src/auroElement.js" } }, { "kind": "method", "name": "resetLayoutClasses", "inheritedFrom": { "name": "AuroElement", "module": "components/layoutElement/src/auroElement.js" } }, { "kind": "method", "name": "updateComponentArchitecture", "inheritedFrom": { "name": "AuroElement", "module": "components/layoutElement/src/auroElement.js" } } ], "events": [ { "name": "auroDropdown-idAdded", "type": { "text": "Object provides, so we call .click()\n directly when Enter is pressed on a button-like element.\n\n- Tab: Intercepted and re-dispatched so parent components\n (select/combobox) can select the active option and close the\n dialog. The provides containment and isolation\n (inert background, VoiceOver focus trapping, top layer), while\n the content inside is a role=\"listbox\" navigated via\n aria-activedescendant (options are not focusable). Tab keyboard\n behavior follows listbox conventions (select + close) because\n the dialog's native Tab trap only cycles between the close\n button and browser chrome.\n\n- Escape: The native fires a `cancel` event on ESC\n (handled by _setupCancelHandler), so the re-dispatched Escape\n is a secondary path for parent components that also listen for\n Escape keydown.", "privacy": "private" }, { "kind": "method", "name": "_lockTouchScroll", "description": "Blocks touch-driven page scroll while a fullscreen modal dialog is open.\n\nThe showModal() function places the dialog in the browser's **top layer**,\nwhich is a separate rendering layer above the normal DOM. On mobile, the\ncompositor processes visual-viewport panning before top-layer touch\nhandling. This means the entire viewport — including the top-layer dialog\n— can be panned by a touch gesture, causing the page behind the dialog to\nscroll into view. To prevent this, we add a touchmove listener that cancels\nthe event if the touch started outside the dialog or any scrollable child within it.", "privacy": "private" }, { "kind": "method", "name": "_unlockTouchScroll", "description": "Removes the touchmove listener added by _lockTouchScroll().", "privacy": "private" }, { "kind": "method", "name": "open", "parameters": [ { "name": "modal", "default": "true" } ] }, { "kind": "method", "name": "close", "description": "Closes the dialog." }, { "kind": "field", "name": "_mobileBreakpointValue", "privacy": "private", "default": "undefined" }, { "kind": "field", "name": "shape", "privacy": "public", "type": { "text": "string" }, "default": "\"rounded\"", "attribute": "shape", "reflects": true }, { "kind": "field", "name": "matchWidth", "privacy": "private", "type": { "text": "boolean" }, "description": "If declared, the bib width will match the trigger width.", "default": "false", "attribute": "matchWidth", "reflects": true }, { "type": { "text": "String" }, "description": "Defines the screen size breakpoint (`lg`, `md`, `sm`, or `xs`) at which the dropdown switches to fullscreen mode on mobile. When expanded, the dropdown will automatically display in fullscreen mode if the screen size is equal to or smaller than the selected breakpoint.", "name": "fullscreenBreakpoint", "kind": "field" }, { "kind": "field", "name": "isFullscreen", "privacy": "public", "type": { "text": "boolean" }, "description": "If declared, will take the fullscreen when the bib is displayed.", "attribute": "isFullscreen", "reflects": true }, { "kind": "field", "name": "common", "privacy": "public", "type": { "text": "boolean" }, "description": "If declared, will apply all styles for the common theme.", "attribute": "common", "reflects": true }, { "kind": "field", "name": "inset", "privacy": "public", "type": { "text": "boolean" }, "description": "If declared, will apply extra padding to bib content.", "attribute": "inset", "reflects": true }, { "kind": "field", "name": "rounded", "privacy": "public", "type": { "text": "boolean" }, "description": "If declared, will apply border-radius to the bib.", "attribute": "rounded", "reflects": true }, { "kind": "field", "name": "bibTemplate", "privacy": "public", "type": { "text": "object" }, "description": "A reference to the associated bib template element.", "attribute": "bibTemplate" }, { "kind": "field", "name": "dialogLabel", "privacy": "private", "type": { "text": "string" }, "description": "Accessible label for the dialog element, used when displayed as a modal.\nApplied via aria-labelledby on a visually hidden element rather than\naria-label because iOS VoiceOver does not reliably read aria-label\non elements.", "attribute": "dialogLabel" }, { "kind": "field", "name": "dialogRole", "privacy": "private", "type": { "text": "string" }, "description": "Overrides the native role of the dialog element.\nFor example, set to `\"presentation\"` on desktop combobox to prevent\nVoiceOver from announcing \"listbox inside of a dialog\".\nWhen `undefined`, the dialog keeps its native role.", "attribute": "dialogRole" } ], "events": [ { "name": "auro-dropdownbib-connected", "type": { "text": "CustomEvent" } }, { "name": "auro-bib-cancel", "type": { "text": "CustomEvent" } } ], "attributes": [ { "name": "isFullscreen", "type": { "text": "boolean" }, "description": "If declared, will take the fullscreen when the bib is displayed.", "fieldName": "isFullscreen" }, { "name": "common", "type": { "text": "boolean" }, "description": "If declared, will apply all styles for the common theme.", "fieldName": "common" }, { "name": "inset", "type": { "text": "boolean" }, "description": "If declared, will apply extra padding to bib content.", "fieldName": "inset" }, { "name": "matchWidth", "type": { "text": "boolean" }, "description": "If declared, the bib width will match the trigger width.", "default": "false", "fieldName": "matchWidth" }, { "name": "rounded", "type": { "text": "boolean" }, "description": "If declared, will apply border-radius to the bib.", "fieldName": "rounded" }, { "name": "bibTemplate", "type": { "text": "object" }, "description": "A reference to the associated bib template element.", "fieldName": "bibTemplate" }, { "name": "shape", "type": { "text": "string" }, "default": "\"rounded\"", "fieldName": "shape" }, { "name": "dialogLabel", "type": { "text": "string" }, "description": "Accessible label for the dialog element, used when displayed as a modal.\nApplied via aria-labelledby on a visually hidden element rather than\naria-label because iOS VoiceOver does not reliably read aria-label\non elements.", "fieldName": "dialogLabel" }, { "name": "dialogRole", "type": { "text": "string" }, "description": "Overrides the native role of the dialog element.\nFor example, set to `\"presentation\"` on desktop combobox to prevent\nVoiceOver from announcing \"listbox inside of a dialog\".\nWhen `undefined`, the dialog keeps its native role.", "fieldName": "dialogRole" } ], "superclass": { "name": "LitElement", "package": "lit" }, "customElement": true } ], "exports": [ { "kind": "js", "name": "AuroDropdownBib", "declaration": { "name": "AuroDropdownBib", "module": "components/dropdown/src/auro-dropdownBib.js" } } ] }, { "kind": "javascript-module", "path": "components/dropdown/src/iconVersion.js", "declarations": [], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "9.1.2", "module": "components/dropdown/src/iconVersion.js" } } ] }, { "kind": "javascript-module", "path": "components/dropdown/src/index.js", "declarations": [], "exports": [ { "kind": "js", "name": "AuroDropdown", "declaration": { "name": "AuroDropdown", "module": "components/dropdown/src/index.js" } } ] }, { "kind": "javascript-module", "path": "components/dropdown/src/keyboardUtils.js", "declarations": [ { "kind": "function", "name": "applyKeyboardStrategy", "parameters": [ { "name": "component", "description": "The component to attach the listener to.", "type": { "text": "HTMLElement" } }, { "name": "strategy", "description": "Map of key names to handler functions.", "type": { "text": "Object" } } ], "description": "Wires up a keydown listener that dispatches to strategy[evt.key] or strategy.default.\nHandles both sync and async handlers." }, { "kind": "function", "name": "navigateArrow", "parameters": [ { "name": "component", "description": "The component with dropdown and menu references.", "type": { "text": "HTMLElement" } }, { "name": "direction", "description": "'up' or 'down'.", "type": { "text": "string" } }, { "name": "options", "default": "{}", "description": "Optional config.", "optional": true, "type": { "text": "@param {Function} [options.showFn] - Called to open the dropdown when closed.\n " } } ], "description": "Shared arrow navigation. Calls menu.navigateOptions(direction) if visible.\nOptionally opens dropdown via showFn when closed." } ], "exports": [ { "kind": "js", "name": "applyKeyboardStrategy", "declaration": { "name": "applyKeyboardStrategy", "module": "components/dropdown/src/keyboardUtils.js" } }, { "kind": "js", "name": "navigateArrow", "declaration": { "name": "navigateArrow", "module": "components/dropdown/src/keyboardUtils.js" } } ] }, { "kind": "javascript-module", "path": "components/dropdown/src/registered.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "components/form/src/auro-form.js", "declarations": [ { "kind": "class", "description": "The `auro-form` element provides users a way to create and manage forms in a consistent manner.", "name": "AuroForm", "slots": [ { "description": "The default slot for form elements.", "name": "default" } ], "members": [ { "kind": "field", "name": "formElementTags", "static": true, "readonly": true }, { "kind": "method", "name": "_isElementTag", "parameters": [ { "name": "elementTag", "description": "The HTML tag name like `auro-datepicker`.", "type": { "text": "string" } }, { "name": "element", "description": "The actual HTML element to compare.", "type": { "text": "HTMLElement" } } ], "description": "Compare tag name with element to identify it (for API purposes).", "return": { "type": { "text": "boolean" } }, "privacy": "private" }, { "kind": "method", "name": "_isInElementCollection", "parameters": [ { "name": "collection", "description": "The array to use for tag name search.", "type": { "text": "string[]" } }, { "name": "element", "description": "The element to compare against the master list.", "type": { "text": "HTMLElement" } } ], "description": "Shared code for determining if an element is something we care about (submit, form element, etc.).", "return": { "type": { "text": "boolean" } }, "privacy": "private" }, { "kind": "method", "name": "isFormElement", "parameters": [ { "name": "element", "description": "The element to check (attr or tag name).", "type": { "text": "HTMLElement" } } ], "description": "Check if the tag name is a form element.", "return": { "type": { "text": "boolean" } }, "privacy": "private" }, { "kind": "method", "name": "_eventIsValidFormEvent", "parameters": [ { "name": "event", "description": "The event to validate.", "type": { "text": "Event" } } ], "description": "Validates if an event is from a valid form element with a name.", "return": { "type": { "text": "boolean" } }, "privacy": "private" }, { "kind": "field", "name": "buttonElementTags", "static": true, "readonly": true }, { "kind": "method", "name": "isButtonElement", "parameters": [ { "name": "element", "description": "The element to check.", "type": { "text": "HTMLElement" } } ], "description": "Check if the tag name is a button element.", "return": { "type": { "text": "boolean" } }, "privacy": "private" }, { "kind": "field", "name": "value", "description": "Returns the current values of all named form elements as a key-value object, keyed by each element's `name` attribute.", "return": { "type": { "text": "Record" } }, "readonly": true }, { "kind": "field", "name": "submitElements", "description": "Getter for internal _submitElements.", "return": { "type": { "text": "HTMLButtonElement[]" } }, "privacy": "private", "readonly": true }, { "kind": "field", "name": "resetElements", "description": "Returns a collection of elements that will reset the form.", "return": { "type": { "text": "HTMLButtonElement[]" } }, "privacy": "private", "readonly": true }, { "kind": "method", "name": "_calculateValidity", "description": "Infer validity status based on current formState.", "privacy": "private" }, { "kind": "field", "name": "validity", "description": "Returns `'valid'` if all required and interacted-with form elements are valid, `'invalid'` if any are not, or `null` if the form has not been interacted with yet.", "return": { "type": { "text": "\"valid\" | \"invalid\" | null" } }, "readonly": true }, { "kind": "method", "name": "_setInitialState", "description": "Determines whether the form is in its initial (untouched) state and updates `_isInitialState` accordingly.", "return": { "type": { "text": "void" } }, "privacy": "private" }, { "kind": "field", "name": "isInitialState", "description": "Returns `true` if no form element has been interacted with or had its value changed since the form was initialized or last reset.", "return": { "type": { "text": "boolean" } }, "readonly": true }, { "kind": "method", "name": "setDisabledStateOnButtons", "description": "Enables or disables submit and reset buttons based on the current form state and validity.", "return": { "type": { "text": "void" } }, "privacy": "private" }, { "kind": "method", "name": "queryAuroElements", "description": "Construct the query strings from elements, append them together, execute, and return the NodeList.", "return": { "type": { "text": "NodeList" } }, "privacy": "private" }, { "kind": "method", "name": "_addElementToState", "parameters": [ { "name": "element", "description": "The element to add to our state.", "type": { "text": "HTMLElement" } } ], "description": "Store an element in state and on the _elements array.", "privacy": "private" }, { "kind": "method", "name": "initializeState", "description": "Initialize (or reinitialize) the form state.", "return": { "type": { "text": "void" } }, "privacy": "private" }, { "kind": "method", "name": "reset", "description": "Resets all form elements to their initial state and fires a `reset` event. The event's `detail.previousValue` contains the form values captured immediately before the reset.", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "submit", "description": "Validates all form elements. If all are valid, fires a `submit` event with `detail.value` containing the current form values. If any element is invalid, its error state is surfaced and the `submit` event is not fired.", "return": { "type": { "text": "Promise" } } }, { "kind": "method", "name": "register", "static": true, "parameters": [ { "name": "name", "default": "\"auro-form\"", "description": "The custom element tag name to register.", "optional": true, "type": { "text": "string" } } ], "description": "Registers the `auro-form` custom element with the browser under a given tag name." }, { "kind": "method", "name": "sharedInputListener", "parameters": [ { "name": "event", "description": "The event that is fired from the form element.", "type": { "text": "Event" } } ], "description": "Shared input listener for all form elements.", "privacy": "private" }, { "kind": "method", "name": "sharedValidationListener", "parameters": [ { "name": "event", "description": "The event that is fired from the form element.", "type": { "text": "Event" } } ], "description": "Shared validation listener for all form elements.", "privacy": "private" }, { "kind": "method", "name": "handleKeyDown", "parameters": [ { "name": "event", "description": "The keyboard event.", "type": { "text": "KeyboardEvent" } } ], "description": "Handle Enter key press on form elements.", "privacy": "private" }, { "kind": "method", "name": "_attachEventListeners", "description": "Attaches input, validation, and keydown listeners to all tracked form and button elements.\nRemoves existing listeners first to avoid duplicates on re-initialization.", "return": { "type": { "text": "void" } }, "privacy": "private" }, { "kind": "method", "name": "mutationEventListener", "description": "Mutation observer for form elements. Slot change does not trigger unless\nroot-level elements are added/removed. This is a workaround to ensure\nnested form elements are also observed.", "return": { "type": { "text": "void" } }, "privacy": "private" }, { "kind": "method", "name": "onSlotChange", "parameters": [ { "name": "event", "description": "The slot change event.", "type": { "text": "Event" } } ], "description": "Slot change event listener. This is the main entry point for the form element.", "return": { "type": { "text": "void" } }, "privacy": "private" }, { "kind": "field", "name": "formState", "privacy": "private", "type": { "text": "FormState" }, "default": "{}" }, { "kind": "field", "name": "_validity", "privacy": "private", "type": { "text": "\"valid\" | \"invalid\" | null" }, "default": "null" }, { "kind": "field", "name": "_isInitialState", "privacy": "private", "type": { "text": "boolean" }, "default": "true" }, { "kind": "field", "name": "_elements", "privacy": "private", "type": { "text": "(HTMLElement & {reset: () => void})[]" }, "default": "[]" }, { "kind": "field", "name": "_submitelements", "type": { "text": "HTMLButtonElement[]" }, "privacy": "private", "default": "[]" }, { "kind": "field", "name": "_resetElements", "privacy": "private", "type": { "text": "HTMLButtonElement[]" }, "default": "[]" }, { "kind": "field", "name": "mutationObservers", "type": { "text": "MutationObserver[]" }, "privacy": "private", "default": "[]" }, { "kind": "field", "name": "_submitElements", "privacy": "private", "type": { "text": "array" } } ], "events": [ { "name": "change", "type": { "text": "Event" }, "description": "Fires when a child form element's value changes or the form is initialized." }, { "name": "reset", "type": { "text": "CustomEvent" }, "description": "Fires when the form is reset. The event detail contains the previous value of the form before reset." }, { "name": "submit", "type": { "text": "CustomEvent" }, "description": "Fires when the form is submitted. The event detail contains the current value of the form." }, { "description": "Fires when a child form element receives user input.", "name": "input" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "auro-form", "customElement": true } ], "exports": [ { "kind": "js", "name": "AuroForm", "declaration": { "name": "AuroForm", "module": "components/form/src/auro-form.js" } } ] }, { "kind": "javascript-module", "path": "components/form/src/index.js", "declarations": [], "exports": [ { "kind": "js", "name": "AuroForm", "declaration": { "name": "AuroForm", "module": "components/form/src/index.js" } } ] }, { "kind": "javascript-module", "path": "components/form/src/registered.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "components/helptext/src/auro-helptext.js", "declarations": [ { "kind": "class", "description": "Displays help text or error messages within form elements - Internal Use Only.", "name": "AuroHelpText", "members": [ { "kind": "method", "name": "register", "static": true, "parameters": [ { "name": "name", "default": "\"auro-helptext\"", "description": "The name of element that you want to register to.", "optional": true, "type": { "text": "string" } } ], "description": "This will register this element with the browser." }, { "kind": "method", "name": "handleSlotChange", "parameters": [ { "name": "event" } ] }, { "kind": "method", "name": "checkSlotsForContent", "parameters": [ { "name": "nodes", "description": "The list of nodes to check for content.", "type": { "text": "NodeList|Array" } } ], "description": "Checks if any of the provided nodes or their nested slot nodes contain non-empty text content.", "return": { "type": { "text": "boolean" } }, "privacy": "private" }, { "kind": "field", "name": "error", "privacy": "public", "type": { "text": "boolean" }, "description": "If declared, make font color red.", "default": "false", "attribute": "error", "reflects": true }, { "kind": "field", "name": "appearance", "privacy": "public", "type": { "text": "string" }, "description": "Defines whether the component will be on lighter or darker backgrounds.", "default": "\"default\"", "attribute": "appearance", "reflects": true }, { "kind": "field", "name": "onDark", "privacy": "public", "type": { "text": "boolean" }, "description": "DEPRECATED - use `appearance` instead.", "default": "false", "attribute": "onDark", "reflects": true }, { "kind": "field", "name": "hasTextContent", "privacy": "private", "type": { "text": "boolean" }, "default": "false", "attribute": "hasTextContent" }, { "kind": "field", "name": "slotNodes", "privacy": "private", "type": { "text": "boolean" }, "attribute": "slotNodes" } ], "attributes": [ { "name": "appearance", "type": { "text": "string" }, "description": "Defines whether the component will be on lighter or darker backgrounds.", "default": "\"default\"", "fieldName": "appearance" }, { "name": "slotNodes", "type": { "text": "boolean" }, "fieldName": "slotNodes" }, { "name": "hasTextContent", "type": { "text": "boolean" }, "default": "false", "fieldName": "hasTextContent" }, { "name": "error", "type": { "text": "boolean" }, "description": "If declared, make font color red.", "default": "false", "fieldName": "error" }, { "name": "onDark", "type": { "text": "boolean" }, "description": "DEPRECATED - use `appearance` instead.", "default": "false", "fieldName": "onDark" } ], "superclass": { "name": "LitElement", "package": "lit" }, "customElement": true } ], "exports": [ { "kind": "js", "name": "AuroHelpText", "declaration": { "name": "AuroHelpText", "module": "components/helptext/src/auro-helptext.js" } } ] }, { "kind": "javascript-module", "path": "components/helptext/src/index.js", "declarations": [], "exports": [ { "kind": "js", "name": "AuroHelpText", "declaration": { "name": "AuroHelpText", "module": "components/helptext/src/index.js" } } ] }, { "kind": "javascript-module", "path": "components/helptext/src/registered.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "components/input/src/auro-input.js", "declarations": [ { "kind": "class", "description": "The `auro-input` element provides users a way to enter data into a text field.", "name": "AuroInput", "cssParts": [ { "description": "Use for customizing the style of the root element", "name": "wrapper" }, { "description": "Use for customizing the style of the label element", "name": "label" }, { "description": "Use for customizing the style of the helpText element", "name": "helpText" }, { "description": "Use for customizing the style of the input element", "name": "input" }, { "description": "Use for customizing the style of the accentIcon element (e.g. credit card icon, calendar icon)", "name": "accentIcon" }, { "description": "Use for customizing the style of the iconContainer (e.g. X icon for clearing input value)", "name": "iconContainer" }, { "description": "Use for customizing the style of the left accent element (e.g. padding, margin)", "name": "accent-left" }, { "description": "Use for customizing the style of the right accent element (e.g. padding, margin)", "name": "accent-right" }, { "description": "Use for customizing the style of the displayValue element", "name": "displayValue" }, { "description": "Use for customizing the style of the input help text wrapper", "name": "inputHelpText" } ], "slots": [ { "description": "Sets aria-label on clear button for screen reader to read", "name": "ariaLabel.clear" }, { "description": "Sets aria-label on password button to toggle on showing password", "name": "ariaLabel.password.show" }, { "description": "Sets aria-label on password button to toggle off showing password", "name": "ariaLabel.password.hide" }, { "description": "Sets the help text displayed below the input.", "name": "helpText" }, { "description": "Sets the label text for the input.", "name": "label" }, { "description": "Allows overriding the optional display text \"(optional)\", which appears next to the label.", "name": "optionalLabel" }, { "description": "Allows custom HTML content to display in place of the value when the input is not focused.", "name": "displayValue" } ], "members": [ { "kind": "field", "name": "inputHidden", "description": "Determines if the HTML input element should be visually hidden.\nReturns true when display value content exists without focus and has a value,\nor when the input has no value, is not focused, and has no placeholder text.", "return": { "type": { "text": "boolean" } }, "privacy": "private", "readonly": true }, { "kind": "field", "name": "noFocusOrValue", "description": "Determines if the input should display in a state with no focus or value indication.\nReturns true when the input has display content without focus and has a value,\nor when the input has no value and is not focused.", "return": { "type": { "text": "boolean" } }, "privacy": "private", "readonly": true }, { "kind": "field", "name": "labelHidden", "description": "Whether the label is being hidden currently based on state.", "return": { "type": { "text": "boolean" } }, "privacy": "private", "readonly": true }, { "kind": "field", "name": "labelFontClass", "description": "Returns the label font class based on layout and visibility state.", "privacy": "private", "return": { "type": { "text": "string" } }, "readonly": true }, { "kind": "field", "name": "inputFontClass", "description": "Returns the input font class based on layout and visibility state.", "privacy": "private", "return": { "type": { "text": "string" } }, "readonly": true }, { "kind": "field", "name": "commonLabelClasses", "description": "Returns classmap configuration for html5 input labels in all layouts.", "privacy": "private", "return": { "type": { "text": "Record" } }, "readonly": true }, { "kind": "field", "name": "commonInputClasses", "description": "Returns classmap configuration for html5 inputs in all layouts.", "privacy": "private", "return": { "type": { "text": "Record" } }, "readonly": true }, { "kind": "field", "name": "commonDisplayValueWrapperClasses", "description": "Common display value wrapper classes.", "privacy": "private", "return": { "type": { "text": "Record" } }, "readonly": true }, { "kind": "field", "name": "legacyInputClasses", "description": "Returns classmap configuration for html5 inputs in each layout.", "privacy": "private", "return": { "type": { "text": "object" } }, "readonly": true }, { "kind": "field", "name": "commonWrapperClasses", "description": "Returns classmap configuration for wrapper elements in each layout.", "privacy": "private", "return": { "type": { "text": "object" } }, "readonly": true }, { "kind": "field", "name": "helpTextClasses", "description": "Returns classmap configuration for helpText elements in each layout.", "privacy": "private", "return": { "type": { "text": "object" } }, "readonly": true }, { "kind": "method", "name": "register", "static": true, "parameters": [ { "name": "name", "default": "\"auro-input\"", "description": "The name of the element that you want to register.", "optional": true, "type": { "text": "string" } } ], "description": "This will register this element with the browser." }, { "kind": "method", "name": "hasTypeIcon", "description": "Function to determine if the input is meant to render an icon visualizing the input type.", "privacy": "private", "return": { "type": { "text": "boolean" } } }, { "kind": "method", "name": "checkDisplayValueSlotChange", "description": "Function to determine if there is any displayValue content to render.", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "renderValidationErrorIconHtml", "description": "Returns HTML for the validation error icon.", "privacy": "private", "return": { "type": { "text": "html" } } }, { "kind": "method", "name": "renderHtmlInput", "parameters": [ { "name": "useLegacyHiddenState", "default": "false", "description": "If true, the input will be visually hidden when not focused and has no value.", "optional": true, "type": { "text": "boolean" } } ], "description": "Returns HTML for the HTML5 input element.", "privacy": "private", "return": { "type": { "text": "html" } } }, { "kind": "method", "name": "renderHtmlActionClear", "description": "Returns HTML for the clear action button.", "privacy": "private", "return": { "type": { "text": "html" } } }, { "kind": "method", "name": "renderHtmlNotificationPassword", "description": "Returns HTML for the show password button.", "privacy": "private", "return": { "type": { "text": "html" } } }, { "kind": "method", "name": "renderHtmlTypeIcon", "description": "Returns HTML for the input type icon.", "privacy": "private", "return": { "type": { "text": "html" } } }, { "kind": "method", "name": "renderHtmlHelpText", "description": "Returns HTML for the help text and error message.", "privacy": "private", "return": { "type": { "text": "html" } } }, { "kind": "method", "name": "renderLayoutClassic", "description": "Returns HTML for the classic layout.", "privacy": "private", "return": { "type": { "text": "TemplateResult" } } }, { "kind": "method", "name": "renderLayoutEmphasized", "description": "Returns HTML for the emphasized layout. Does not support type=\"*\".", "privacy": "private", "return": { "type": { "text": "html" } } }, { "kind": "method", "name": "renderLayoutSnowflake", "description": "Returns HTML for the emphasized layout. Does not support type=\"*\".", "privacy": "private", "return": { "type": { "text": "html" } } }, { "kind": "method", "name": "renderLayout", "parameters": [ { "name": "ForcedLayout", "description": "Used to force a specific layout, pass in the layout name to use.", "optional": true, "type": { "text": "string" } } ], "description": "Logic to determine the layout of the component.", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "field", "name": "buttonTag", "privacy": "private" }, { "kind": "field", "name": "hasDisplayValueContent", "type": { "text": "boolean" }, "privacy": "private", "default": "false" }, { "kind": "field", "name": "helpTextTag", "privacy": "private" }, { "kind": "field", "name": "iconTag", "privacy": "private" }, { "kind": "field", "name": "shadowRootOptions", "static": true, "readonly": true, "inheritedFrom": { "name": "BaseInput", "module": "components/input/src/base-input.js" } }, { "kind": "method", "name": "_initializeDefaults", "description": "Internal Defaults.", "privacy": "private", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "BaseInput", "module": "components/input/src/base-input.js" } }, { "kind": "method", "name": "patchInputEvent", "parameters": [ { "name": "input", "description": "The input element to patch.", "type": { "text": "HTMLInputElement" } } ], "description": "Patches the input element to dispatch an 'input' event whenever its value is set programmatically.\nThis ensures that changes to the input's value are consistently communicated, even if not triggered by user input.", "return": { "type": { "text": "void" } }, "privacy": "private", "inheritedFrom": { "name": "BaseInput", "module": "components/input/src/base-input.js" } }, { "kind": "method", "name": "setCustomHelpTextMessage", "privacy": "private", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "BaseInput", "module": "components/input/src/base-input.js" } }, { "kind": "method", "name": "notifyValidityChange", "privacy": "private", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "BaseInput", "module": "components/input/src/base-input.js" } }, { "kind": "method", "name": "configureAutoFormatting", "description": "Sets up IMasks and logic based on auto-formatting requirements.", "privacy": "private", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "BaseInput", "module": "components/input/src/base-input.js" } }, { "kind": "method", "name": "definePattern", "privacy": "private", "return": { "type": { "text": "string" } }, "inheritedFrom": { "name": "BaseInput", "module": "components/input/src/base-input.js" } }, { "kind": "method", "name": "getIconAsHtml", "parameters": [ { "name": "icon", "description": "HTML string for requested icon.", "type": { "text": "string" } } ], "description": "Required to convert SVG icons from data to HTML string.", "privacy": "private", "return": { "type": { "text": "object" } }, "inheritedFrom": { "name": "BaseInput", "module": "components/input/src/base-input.js" } }, { "kind": "method", "name": "notifyValueChanged", "description": "Sends event notifying that the input has changed it's value.", "privacy": "private", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "BaseInput", "module": "components/input/src/base-input.js" } }, { "kind": "method", "name": "handleClick", "description": "Handles clicking on the auro-input anywhere outside of the HTML5 input and still moving focus in.", "privacy": "private", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "BaseInput", "module": "components/input/src/base-input.js" } }, { "kind": "method", "name": "focus", "description": "Function to set element focus.", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "BaseInput", "module": "components/input/src/base-input.js" } }, { "kind": "method", "name": "handleClickClear", "description": "Handles event of clearing input content by clicking the X icon.", "privacy": "private", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "BaseInput", "module": "components/input/src/base-input.js" } }, { "kind": "method", "name": "handleInput", "parameters": [ { "name": "event", "description": "The input event.", "type": { "text": "Event" } } ], "privacy": "private", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "BaseInput", "module": "components/input/src/base-input.js" } }, { "kind": "method", "name": "handleFocusin", "description": "Function to support", "privacy": "private", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "BaseInput", "module": "components/input/src/base-input.js" } }, { "kind": "method", "name": "handleFocusout", "description": "Function to support", "privacy": "private", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "BaseInput", "module": "components/input/src/base-input.js" } }, { "kind": "method", "name": "handleBlur", "description": "Function to support", "privacy": "private", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "BaseInput", "module": "components/input/src/base-input.js" } }, { "kind": "method", "name": "getActiveElement", "parameters": [ { "name": "root", "default": "document", "description": "Element to check for focus.", "type": { "text": "Object" } } ], "description": "Returns focused element, even if it's in the shadow DOM.", "privacy": "private", "return": { "type": { "text": "Object" } }, "inheritedFrom": { "name": "BaseInput", "module": "components/input/src/base-input.js" } }, { "kind": "method", "name": "setActiveDescendant", "parameters": [ { "name": "element", "description": "The element to set as the active descendant, or null to clear.", "type": { "text": "HTMLElement|null" } } ], "description": "Sets the active descendant element for accessibility.\nUses ariaActiveDescendantElement to cross shadow DOM boundaries.\nThis function is used in components that contain `auro-input` to set the active descendant.", "privacy": "private", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "BaseInput", "module": "components/input/src/base-input.js" } }, { "kind": "method", "name": "validate", "parameters": [ { "name": "force", "default": "false", "description": "Whether to force validation.", "optional": true, "type": { "text": "boolean" } } ], "description": "Validates value.", "inheritedFrom": { "name": "BaseInput", "module": "components/input/src/base-input.js" } }, { "kind": "method", "name": "reset", "description": "Resets component to initial state, including resetting the touched state and validity.", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "BaseInput", "module": "components/input/src/base-input.js" } }, { "kind": "method", "name": "clear", "description": "Clears the input value.", "inheritedFrom": { "name": "BaseInput", "module": "components/input/src/base-input.js" } }, { "kind": "method", "name": "configureDataForType", "description": "Sets configuration data used elsewhere based on the `type` attribute.", "privacy": "private", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "BaseInput", "module": "components/input/src/base-input.js" } }, { "kind": "method", "name": "getInputType", "parameters": [ { "name": "type", "description": "Value entered into component prop.", "type": { "text": "string" } } ], "description": "Validates against list of supported this.allowedInputTypes; return type=text if invalid request.", "privacy": "private", "return": { "type": { "text": "string" } }, "inheritedFrom": { "name": "BaseInput", "module": "components/input/src/base-input.js" } }, { "kind": "method", "name": "getHelpText", "description": "Determines default help text string.", "privacy": "private", "return": { "type": { "text": "string" } }, "inheritedFrom": { "name": "BaseInput", "module": "components/input/src/base-input.js" } }, { "kind": "method", "name": "handleClickShowPassword", "description": "Function to support show-password feature.", "privacy": "private", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "BaseInput", "module": "components/input/src/base-input.js" } }, { "kind": "field", "name": "placeholderStr", "description": "Support placeholder text.", "privacy": "private", "return": { "type": { "text": "void" } }, "readonly": true, "inheritedFrom": { "name": "BaseInput", "module": "components/input/src/base-input.js" } }, { "kind": "method", "name": "defineInputIcon", "description": "Defines placement of input icon based on type, used with classMap.", "privacy": "private", "return": { "type": { "text": "boolean" } }, "inheritedFrom": { "name": "BaseInput", "module": "components/input/src/base-input.js" } }, { "kind": "method", "name": "defineLabelPadding", "description": "Defines padding of input label based on type, used with classMap.", "privacy": "private", "return": { "type": { "text": "boolean" } }, "inheritedFrom": { "name": "BaseInput", "module": "components/input/src/base-input.js" } }, { "kind": "method", "name": "processCreditCard", "description": "Function to support credit-card feature type.", "privacy": "private", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "BaseInput", "module": "components/input/src/base-input.js" } }, { "kind": "method", "name": "matchInputValueToCreditCard", "description": "Function to support credit-card feature type.", "privacy": "private", "return": { "type": { "text": "object" } }, "inheritedFrom": { "name": "BaseInput", "module": "components/input/src/base-input.js" } }, { "kind": "field", "name": "a11yRole", "privacy": "public", "type": { "text": "string" }, "description": "The value for the role attribute.", "attribute": "a11yRole", "reflects": true, "inheritedFrom": { "name": "BaseInput", "module": "components/input/src/base-input.js" } }, { "kind": "field", "name": "a11yControls", "privacy": "public", "type": { "text": "string" }, "description": "The value for the aria-controls attribute.", "attribute": "a11yControls", "reflects": true, "inheritedFrom": { "name": "BaseInput", "module": "components/input/src/base-input.js" } }, { "kind": "field", "name": "a11yExpanded", "privacy": "public", "type": { "text": "boolean" }, "description": "The value for the aria-expanded attribute.", "attribute": "a11yExpanded", "reflects": true, "inheritedFrom": { "name": "BaseInput", "module": "components/input/src/base-input.js" } }, { "kind": "field", "name": "a11yActivedescendant", "privacy": "public", "type": { "text": "string" }, "description": "The value for the aria-activedescendant attribute.\nPoints to the ID of the currently active/highlighted option in a listbox.", "attribute": "a11yActivedescendant", "reflects": true, "inheritedFrom": { "name": "BaseInput", "module": "components/input/src/base-input.js" } }, { "kind": "field", "name": "activeLabel", "privacy": "public", "type": { "text": "boolean" }, "description": "If set, the label will remain fixed in the active position.", "attribute": "activeLabel", "reflects": true, "inheritedFrom": { "name": "BaseInput", "module": "components/input/src/base-input.js" } }, { "kind": "field", "name": "appearance", "privacy": "public", "type": { "text": "'default' | 'inverse'" }, "description": "Defines whether the component will be on lighter or darker backgrounds.", "default": "'default'", "attribute": "appearance", "reflects": true, "inheritedFrom": { "name": "BaseInput", "module": "components/input/src/base-input.js" } }, { "kind": "field", "name": "autocapitalize", "privacy": "public", "type": { "text": "string" }, "description": "An enumerated attribute that controls whether and how text input is automatically capitalized as it is entered/edited by the user. [off/none, on/sentences, words, characters].", "attribute": "autocapitalize", "reflects": true, "inheritedFrom": { "name": "BaseInput", "module": "components/input/src/base-input.js" } }, { "kind": "field", "name": "autocomplete", "privacy": "public", "type": { "text": "string" }, "description": "An enumerated attribute that defines what the user agent can suggest for autofill. At this time, only `autocomplete=\"off\"` is supported.", "attribute": "autocomplete", "reflects": true, "inheritedFrom": { "name": "BaseInput", "module": "components/input/src/base-input.js" } }, { "kind": "field", "name": "autocorrect", "privacy": "public", "type": { "text": "string" }, "description": "When set to `off`, stops iOS from auto-correcting words when typed into a text box.", "attribute": "autocorrect", "reflects": true, "inheritedFrom": { "name": "BaseInput", "module": "components/input/src/base-input.js" } }, { "kind": "field", "name": "customValidityTypeEmail", "privacy": "public", "type": { "text": "string" }, "description": "Custom help text message for email type validity.", "attribute": "customValidityTypeEmail", "inheritedFrom": { "name": "BaseInput", "module": "components/input/src/base-input.js" } }, { "kind": "field", "name": "disabled", "privacy": "public", "type": { "text": "boolean" }, "description": "If set, disables the input.", "attribute": "disabled", "reflects": true, "inheritedFrom": { "name": "BaseInput", "module": "components/input/src/base-input.js" } }, { "kind": "field", "name": "dvInputOnly", "privacy": "public", "type": { "text": "boolean" }, "description": "If defined, the display value slot content will only mask the HTML5 input element. The input's label will not be masked.", "attribute": "dvInputOnly", "reflects": true, "inheritedFrom": { "name": "BaseInput", "module": "components/input/src/base-input.js" } }, { "kind": "field", "name": "error", "privacy": "public", "type": { "text": "string" }, "description": "When defined, sets persistent validity to `customError` and sets `setCustomValidity` = attribute value.", "attribute": "error", "reflects": true, "inheritedFrom": { "name": "BaseInput", "module": "components/input/src/base-input.js" } }, { "kind": "field", "name": "errorMessage", "privacy": "public", "type": { "text": "string" }, "description": "Contains the help text message for the current validity error.", "attribute": "errorMessage", "inheritedFrom": { "name": "BaseInput", "module": "components/input/src/base-input.js" } }, { "kind": "field", "name": "format", "privacy": "public", "type": { "text": "string" }, "description": "Specifies the input mask format.", "attribute": "format", "reflects": true, "inheritedFrom": { "name": "BaseInput", "module": "components/input/src/base-input.js" } }, { "kind": "field", "name": "hasFocus", "privacy": "public", "type": { "text": "boolean" }, "description": "Flag to indicate if the input currently has focus.", "inheritedFrom": { "name": "BaseInput", "module": "components/input/src/base-input.js" } }, { "kind": "field", "name": "hasValue", "privacy": "public", "type": { "text": "boolean" }, "description": "Flag to indicate if the input currently has value.", "inheritedFrom": { "name": "BaseInput", "module": "components/input/src/base-input.js" } }, { "kind": "field", "name": "hideLabelVisually", "privacy": "private", "type": { "text": "boolean" }, "description": "If set, the label will be hidden visually but still accessible to assistive technologies.", "attribute": "hideLabelVisually", "reflects": true, "inheritedFrom": { "name": "BaseInput", "module": "components/input/src/base-input.js" } }, { "kind": "field", "name": "icon", "privacy": "public", "type": { "text": "boolean" }, "description": "If set, will render an icon inside the input to the left of the value. Support is limited to auro-input instances with credit card format.", "attribute": "icon", "reflects": true, "inheritedFrom": { "name": "BaseInput", "module": "components/input/src/base-input.js" } }, { "kind": "field", "name": "id", "privacy": "public", "type": { "text": "string" }, "description": "The id global attribute defines an identifier (ID) which must be unique in the whole document.", "attribute": "id", "inheritedFrom": { "name": "BaseInput", "module": "components/input/src/base-input.js" } }, { "kind": "field", "name": "inputId", "privacy": "private", "type": { "text": "string" }, "description": "The id for input node.", "inheritedFrom": { "name": "BaseInput", "module": "components/input/src/base-input.js" } }, { "kind": "field", "name": "inputmode", "privacy": "public", "type": { "text": "string" }, "description": "Exposes inputmode attribute for input.", "attribute": "inputmode", "reflects": true, "inheritedFrom": { "name": "BaseInput", "module": "components/input/src/base-input.js" } }, { "kind": "field", "name": "lang", "privacy": "public", "type": { "text": "string" }, "description": "Defines the language of an element.", "attribute": "lang", "reflects": true, "inheritedFrom": { "name": "BaseInput", "module": "components/input/src/base-input.js" } }, { "kind": "field", "name": "max", "privacy": "public", "type": { "text": "string" }, "description": "The maximum value allowed. This only applies for inputs with a type of `number` and all date formats.", "attribute": "max", "inheritedFrom": { "name": "BaseInput", "module": "components/input/src/base-input.js" } }, { "kind": "field", "name": "maxLength", "privacy": "public", "type": { "text": "number" }, "description": "The maximum number of characters the user can enter into the text input. This must be an integer value `0` or higher.\n**Note**: This attribute is not intended to be used with a `type` or `format` that already has a defined length, such as credit-cards, dates or phone numbers.", "attribute": "maxLength", "reflects": true, "inheritedFrom": { "name": "BaseInput", "module": "components/input/src/base-input.js" } }, { "kind": "field", "name": "min", "privacy": "public", "type": { "text": "string" }, "description": "The minimum value allowed. This only applies for inputs with a type of `number` and all date formats.", "attribute": "min", "inheritedFrom": { "name": "BaseInput", "module": "components/input/src/base-input.js" } }, { "kind": "field", "name": "minLength", "privacy": "public", "type": { "text": "number" }, "description": "The minimum number of characters the user can enter into the text input. This must be a non-negative integer value smaller than or equal to the value specified by `maxlength`.", "attribute": "minLength", "reflects": true, "inheritedFrom": { "name": "BaseInput", "module": "components/input/src/base-input.js" } }, { "kind": "field", "name": "name", "privacy": "public", "type": { "text": "string" }, "description": "Populates the `name` attribute on the input.", "attribute": "name", "reflects": true, "inheritedFrom": { "name": "BaseInput", "module": "components/input/src/base-input.js" } }, { "kind": "field", "name": "nested", "privacy": "public", "type": { "text": "boolean" }, "description": "Sets styles for nested operation - removes borders, hides help + error text, and\nhides accents.", "attribute": "nested", "reflects": true, "inheritedFrom": { "name": "BaseInput", "module": "components/input/src/base-input.js" } }, { "kind": "field", "name": "noValidate", "privacy": "public", "type": { "text": "boolean" }, "description": "If set, disables auto-validation on blur.", "attribute": "noValidate", "reflects": true, "inheritedFrom": { "name": "BaseInput", "module": "components/input/src/base-input.js" } }, { "kind": "field", "name": "onDark", "privacy": "public", "type": { "text": "boolean" }, "attribute": "onDark", "reflects": true, "description": "DEPRECATED - use `appearance=\"inverse\"` instead.", "inheritedFrom": { "name": "AuroElement", "module": "components/layoutElement/src/auroElement.js" } }, { "kind": "field", "name": "pattern", "privacy": "public", "type": { "text": "string" }, "description": "Specifies a regular expression the form control's value should match.", "attribute": "pattern", "reflects": true, "inheritedFrom": { "name": "BaseInput", "module": "components/input/src/base-input.js" } }, { "kind": "field", "name": "placeholder", "privacy": "public", "type": { "text": "string" }, "description": "Define custom placeholder text.", "attribute": "placeholder", "reflects": true, "inheritedFrom": { "name": "BaseInput", "module": "components/input/src/base-input.js" } }, { "kind": "field", "name": "readonly", "privacy": "public", "type": { "text": "boolean" }, "description": "Makes the input read-only, but can be set programmatically.", "attribute": "readonly", "reflects": true, "inheritedFrom": { "name": "BaseInput", "module": "components/input/src/base-input.js" } }, { "kind": "field", "name": "required", "privacy": "public", "type": { "text": "boolean" }, "description": "Populates the `required` attribute on the input. Used for client-side validation.", "attribute": "required", "reflects": true, "inheritedFrom": { "name": "BaseInput", "module": "components/input/src/base-input.js" } }, { "kind": "field", "name": "setCustomValidity", "privacy": "public", "type": { "text": "string" }, "description": "Sets a custom help text message to display for all validityStates.", "attribute": "setCustomValidity", "inheritedFrom": { "name": "BaseInput", "module": "components/input/src/base-input.js" } }, { "kind": "field", "name": "setCustomValidityBadInput", "privacy": "public", "type": { "text": "string" }, "description": "Custom help text message to display when validity = `badInput`.", "attribute": "setCustomValidityBadInput", "inheritedFrom": { "name": "BaseInput", "module": "components/input/src/base-input.js" } }, { "kind": "field", "name": "setCustomValidityCustomError", "privacy": "public", "type": { "text": "string" }, "description": "Custom help text message to display when validity = `customError`.", "attribute": "setCustomValidityCustomError", "inheritedFrom": { "name": "BaseInput", "module": "components/input/src/base-input.js" } }, { "kind": "field", "name": "setCustomValidityForType", "privacy": "public", "type": { "text": "string" }, "description": "Custom help text message to display for the declared element `type` and type validity fails.", "attribute": "setCustomValidityForType", "inheritedFrom": { "name": "BaseInput", "module": "components/input/src/base-input.js" } }, { "kind": "field", "name": "setCustomValidityRangeOverflow", "privacy": "public", "type": { "text": "string" }, "description": "Custom help text message to display when validity = `rangeOverflow`.", "attribute": "setCustomValidityRangeOverflow", "inheritedFrom": { "name": "BaseInput", "module": "components/input/src/base-input.js" } }, { "kind": "field", "name": "setCustomValidityRangeUnderflow", "privacy": "public", "type": { "text": "string" }, "description": "Custom help text message to display when validity = `rangeUnderflow`.", "attribute": "setCustomValidityRangeUnderflow", "inheritedFrom": { "name": "BaseInput", "module": "components/input/src/base-input.js" } }, { "kind": "field", "name": "setCustomValidityTooLong", "privacy": "public", "type": { "text": "string" }, "description": "Custom help text message to display when validity = `tooLong`.", "attribute": "setCustomValidityTooLong", "inheritedFrom": { "name": "BaseInput", "module": "components/input/src/base-input.js" } }, { "kind": "field", "name": "setCustomValidityTooShort", "privacy": "public", "type": { "text": "string" }, "description": "Custom help text message to display when validity = `tooShort`.", "attribute": "setCustomValidityTooShort", "inheritedFrom": { "name": "BaseInput", "module": "components/input/src/base-input.js" } }, { "kind": "field", "name": "setCustomValidityValueMissing", "privacy": "public", "type": { "text": "string" }, "description": "Custom help text message to display when validity = `valueMissing`.", "attribute": "setCustomValidityValueMissing", "inheritedFrom": { "name": "BaseInput", "module": "components/input/src/base-input.js" } }, { "kind": "field", "name": "showPassword", "privacy": "public", "attribute": "showPassword", "inheritedFrom": { "name": "BaseInput", "module": "components/input/src/base-input.js" } }, { "kind": "field", "name": "simple", "privacy": "public", "type": { "text": "boolean" }, "description": "Simple makes the input render without a border.", "attribute": "simple", "reflects": true, "inheritedFrom": { "name": "BaseInput", "module": "components/input/src/base-input.js" } }, { "kind": "field", "name": "spellcheck", "privacy": "public", "type": { "text": "string" }, "description": "An enumerated attribute defines whether the element may be checked for spelling errors. [true, false]. When set to `false` the attribute `autocorrect` is set to `off` and `autocapitalize` is set to `none`.", "attribute": "spellcheck", "reflects": true, "inheritedFrom": { "name": "BaseInput", "module": "components/input/src/base-input.js" } }, { "kind": "field", "name": "touched", "privacy": "private", "type": { "text": "boolean" }, "description": "Indicates whether the input is in a dirty state (has been interacted with).", "inheritedFrom": { "name": "BaseInput", "module": "components/input/src/base-input.js" } }, { "kind": "field", "name": "type", "privacy": "public", "type": { "text": "'text' | 'password' | 'email' | 'credit-card' | 'tel' | 'number'" }, "description": "Populates the `type` attribute on the input.", "default": "'text'", "attribute": "type", "reflects": true, "inheritedFrom": { "name": "BaseInput", "module": "components/input/src/base-input.js" } }, { "kind": "field", "name": "validateOnInput", "privacy": "public", "type": { "text": "boolean" }, "description": "Sets validation mode to re-eval with each input.", "attribute": "validateOnInput", "inheritedFrom": { "name": "BaseInput", "module": "components/input/src/base-input.js" } }, { "kind": "field", "name": "validity", "privacy": "public", "type": { "text": "string" }, "description": "Specifies the `validityState` this element is in.", "attribute": "validity", "reflects": true, "inheritedFrom": { "name": "BaseInput", "module": "components/input/src/base-input.js" } }, { "kind": "field", "name": "value", "privacy": "public", "type": { "text": "string" }, "description": "Populates the `value` attribute on the input. Can also be read to retrieve the current value of the input.", "attribute": "value", "inheritedFrom": { "name": "BaseInput", "module": "components/input/src/base-input.js" } }, { "kind": "field", "name": "componentHasFocus", "description": "Returns true if the element has focus.", "privacy": "private", "return": { "type": { "text": "boolean" } }, "readonly": true, "inheritedFrom": { "name": "AuroElement", "module": "components/layoutElement/src/auroElement.js" } }, { "kind": "method", "name": "resetShapeClasses", "inheritedFrom": { "name": "AuroElement", "module": "components/layoutElement/src/auroElement.js" } }, { "kind": "method", "name": "resetLayoutClasses", "inheritedFrom": { "name": "AuroElement", "module": "components/layoutElement/src/auroElement.js" } }, { "kind": "method", "name": "updateComponentArchitecture", "inheritedFrom": { "name": "AuroElement", "module": "components/layoutElement/src/auroElement.js" } }, { "kind": "field", "name": "layout", "privacy": "public", "type": { "text": "string" }, "description": "Defines the language of an element.", "default": "{'default'}", "attribute": "layout", "reflects": true, "inheritedFrom": { "name": "AuroElement", "module": "components/layoutElement/src/auroElement.js" } }, { "kind": "field", "name": "shape", "privacy": "public", "type": { "text": "string" }, "attribute": "shape", "reflects": true, "inheritedFrom": { "name": "AuroElement", "module": "components/layoutElement/src/auroElement.js" } }, { "kind": "field", "name": "size", "privacy": "public", "type": { "text": "string" }, "attribute": "size", "reflects": true, "inheritedFrom": { "name": "AuroElement", "module": "components/layoutElement/src/auroElement.js" } } ], "superclass": { "name": "BaseInput", "module": "/components/input/src/base-input.js" }, "tagName": "auro-input", "customElement": true, "attributes": [ { "name": "a11yRole", "type": { "text": "string" }, "description": "The value for the role attribute.", "fieldName": "a11yRole", "inheritedFrom": { "name": "BaseInput", "module": "components/input/src/base-input.js" } }, { "name": "a11yControls", "type": { "text": "string" }, "description": "The value for the aria-controls attribute.", "fieldName": "a11yControls", "inheritedFrom": { "name": "BaseInput", "module": "components/input/src/base-input.js" } }, { "name": "a11yExpanded", "type": { "text": "boolean" }, "description": "The value for the aria-expanded attribute.", "fieldName": "a11yExpanded", "inheritedFrom": { "name": "BaseInput", "module": "components/input/src/base-input.js" } }, { "name": "a11yActivedescendant", "type": { "text": "string" }, "description": "The value for the aria-activedescendant attribute.\nPoints to the ID of the currently active/highlighted option in a listbox.", "fieldName": "a11yActivedescendant", "inheritedFrom": { "name": "BaseInput", "module": "components/input/src/base-input.js" } }, { "name": "activeLabel", "type": { "text": "boolean" }, "description": "If set, the label will remain fixed in the active position.", "fieldName": "activeLabel", "inheritedFrom": { "name": "BaseInput", "module": "components/input/src/base-input.js" } }, { "name": "appearance", "type": { "text": "'default' | 'inverse'" }, "description": "Defines whether the component will be on lighter or darker backgrounds.", "default": "'default'", "fieldName": "appearance", "inheritedFrom": { "name": "BaseInput", "module": "components/input/src/base-input.js" } }, { "name": "autocapitalize", "type": { "text": "string" }, "description": "An enumerated attribute that controls whether and how text input is automatically capitalized as it is entered/edited by the user. [off/none, on/sentences, words, characters].", "fieldName": "autocapitalize", "inheritedFrom": { "name": "BaseInput", "module": "components/input/src/base-input.js" } }, { "name": "autocomplete", "type": { "text": "string" }, "description": "An enumerated attribute that defines what the user agent can suggest for autofill. At this time, only `autocomplete=\"off\"` is supported.", "fieldName": "autocomplete", "inheritedFrom": { "name": "BaseInput", "module": "components/input/src/base-input.js" } }, { "name": "autocorrect", "type": { "text": "string" }, "description": "When set to `off`, stops iOS from auto-correcting words when typed into a text box.", "fieldName": "autocorrect", "inheritedFrom": { "name": "BaseInput", "module": "components/input/src/base-input.js" } }, { "name": "customValidityTypeEmail", "type": { "text": "string" }, "description": "Custom help text message for email type validity.", "fieldName": "customValidityTypeEmail", "inheritedFrom": { "name": "BaseInput", "module": "components/input/src/base-input.js" } }, { "name": "disabled", "type": { "text": "boolean" }, "description": "If set, disables the input.", "fieldName": "disabled", "inheritedFrom": { "name": "BaseInput", "module": "components/input/src/base-input.js" } }, { "name": "dvInputOnly", "type": { "text": "boolean" }, "description": "If defined, the display value slot content will only mask the HTML5 input element. The input's label will not be masked.", "fieldName": "dvInputOnly", "inheritedFrom": { "name": "BaseInput", "module": "components/input/src/base-input.js" } }, { "name": "error", "type": { "text": "string" }, "description": "When defined, sets persistent validity to `customError` and sets `setCustomValidity` = attribute value.", "fieldName": "error", "inheritedFrom": { "name": "BaseInput", "module": "components/input/src/base-input.js" } }, { "name": "errorMessage", "type": { "text": "string" }, "description": "Contains the help text message for the current validity error.", "fieldName": "errorMessage", "inheritedFrom": { "name": "BaseInput", "module": "components/input/src/base-input.js" } }, { "name": "format", "type": { "text": "string" }, "description": "Specifies the input mask format.", "fieldName": "format", "inheritedFrom": { "name": "BaseInput", "module": "components/input/src/base-input.js" } }, { "name": "hideLabelVisually", "type": { "text": "boolean" }, "description": "If set, the label will be hidden visually but still accessible to assistive technologies.", "fieldName": "hideLabelVisually", "inheritedFrom": { "name": "BaseInput", "module": "components/input/src/base-input.js" } }, { "name": "icon", "type": { "text": "boolean" }, "description": "If set, will render an icon inside the input to the left of the value. Support is limited to auro-input instances with credit card format.", "fieldName": "icon", "inheritedFrom": { "name": "BaseInput", "module": "components/input/src/base-input.js" } }, { "name": "id", "type": { "text": "string" }, "description": "The id global attribute defines an identifier (ID) which must be unique in the whole document.", "fieldName": "id", "inheritedFrom": { "name": "BaseInput", "module": "components/input/src/base-input.js" } }, { "name": "inputmode", "type": { "text": "string" }, "description": "Exposes inputmode attribute for input.", "fieldName": "inputmode", "inheritedFrom": { "name": "BaseInput", "module": "components/input/src/base-input.js" } }, { "name": "lang", "type": { "text": "string" }, "description": "Defines the language of an element.", "fieldName": "lang", "inheritedFrom": { "name": "BaseInput", "module": "components/input/src/base-input.js" } }, { "name": "max", "type": { "text": "string" }, "description": "The maximum value allowed. This only applies for inputs with a type of `number` and all date formats.", "fieldName": "max", "inheritedFrom": { "name": "BaseInput", "module": "components/input/src/base-input.js" } }, { "name": "maxLength", "type": { "text": "number" }, "description": "The maximum number of characters the user can enter into the text input. This must be an integer value `0` or higher.\n**Note**: This attribute is not intended to be used with a `type` or `format` that already has a defined length, such as credit-cards, dates or phone numbers.", "fieldName": "maxLength", "inheritedFrom": { "name": "BaseInput", "module": "components/input/src/base-input.js" } }, { "name": "min", "type": { "text": "string" }, "description": "The minimum value allowed. This only applies for inputs with a type of `number` and all date formats.", "fieldName": "min", "inheritedFrom": { "name": "BaseInput", "module": "components/input/src/base-input.js" } }, { "name": "minLength", "type": { "text": "number" }, "description": "The minimum number of characters the user can enter into the text input. This must be a non-negative integer value smaller than or equal to the value specified by `maxlength`.", "fieldName": "minLength", "inheritedFrom": { "name": "BaseInput", "module": "components/input/src/base-input.js" } }, { "name": "name", "type": { "text": "string" }, "description": "Populates the `name` attribute on the input.", "fieldName": "name", "inheritedFrom": { "name": "BaseInput", "module": "components/input/src/base-input.js" } }, { "name": "nested", "type": { "text": "boolean" }, "description": "Sets styles for nested operation - removes borders, hides help + error text, and\nhides accents.", "fieldName": "nested", "inheritedFrom": { "name": "BaseInput", "module": "components/input/src/base-input.js" } }, { "name": "noValidate", "type": { "text": "boolean" }, "description": "If set, disables auto-validation on blur.", "fieldName": "noValidate", "inheritedFrom": { "name": "BaseInput", "module": "components/input/src/base-input.js" } }, { "name": "onDark", "type": { "text": "boolean" }, "description": "DEPRECATED - use `appearance=\"inverse\"` instead.", "fieldName": "onDark", "inheritedFrom": { "name": "BaseInput", "module": "components/input/src/base-input.js" } }, { "name": "pattern", "type": { "text": "string" }, "description": "Specifies a regular expression the form control's value should match.", "fieldName": "pattern", "inheritedFrom": { "name": "BaseInput", "module": "components/input/src/base-input.js" } }, { "name": "placeholder", "type": { "text": "string" }, "description": "Define custom placeholder text.", "fieldName": "placeholder", "inheritedFrom": { "name": "BaseInput", "module": "components/input/src/base-input.js" } }, { "name": "readonly", "type": { "text": "boolean" }, "description": "Makes the input read-only, but can be set programmatically.", "fieldName": "readonly", "inheritedFrom": { "name": "BaseInput", "module": "components/input/src/base-input.js" } }, { "name": "required", "type": { "text": "boolean" }, "description": "Populates the `required` attribute on the input. Used for client-side validation.", "fieldName": "required", "inheritedFrom": { "name": "BaseInput", "module": "components/input/src/base-input.js" } }, { "name": "setCustomValidity", "type": { "text": "string" }, "description": "Sets a custom help text message to display for all validityStates.", "fieldName": "setCustomValidity", "inheritedFrom": { "name": "BaseInput", "module": "components/input/src/base-input.js" } }, { "name": "setCustomValidityBadInput", "type": { "text": "string" }, "description": "Custom help text message to display when validity = `badInput`.", "fieldName": "setCustomValidityBadInput", "inheritedFrom": { "name": "BaseInput", "module": "components/input/src/base-input.js" } }, { "name": "setCustomValidityCustomError", "type": { "text": "string" }, "description": "Custom help text message to display when validity = `customError`.", "fieldName": "setCustomValidityCustomError", "inheritedFrom": { "name": "BaseInput", "module": "components/input/src/base-input.js" } }, { "name": "setCustomValidityForType", "type": { "text": "string" }, "description": "Custom help text message to display for the declared element `type` and type validity fails.", "fieldName": "setCustomValidityForType", "inheritedFrom": { "name": "BaseInput", "module": "components/input/src/base-input.js" } }, { "name": "setCustomValidityRangeOverflow", "type": { "text": "string" }, "description": "Custom help text message to display when validity = `rangeOverflow`.", "fieldName": "setCustomValidityRangeOverflow", "inheritedFrom": { "name": "BaseInput", "module": "components/input/src/base-input.js" } }, { "name": "setCustomValidityRangeUnderflow", "type": { "text": "string" }, "description": "Custom help text message to display when validity = `rangeUnderflow`.", "fieldName": "setCustomValidityRangeUnderflow", "inheritedFrom": { "name": "BaseInput", "module": "components/input/src/base-input.js" } }, { "name": "setCustomValidityTooLong", "type": { "text": "string" }, "description": "Custom help text message to display when validity = `tooLong`.", "fieldName": "setCustomValidityTooLong", "inheritedFrom": { "name": "BaseInput", "module": "components/input/src/base-input.js" } }, { "name": "setCustomValidityTooShort", "type": { "text": "string" }, "description": "Custom help text message to display when validity = `tooShort`.", "fieldName": "setCustomValidityTooShort", "inheritedFrom": { "name": "BaseInput", "module": "components/input/src/base-input.js" } }, { "name": "setCustomValidityValueMissing", "type": { "text": "string" }, "description": "Custom help text message to display when validity = `valueMissing`.", "fieldName": "setCustomValidityValueMissing", "inheritedFrom": { "name": "BaseInput", "module": "components/input/src/base-input.js" } }, { "name": "showPassword", "fieldName": "showPassword", "inheritedFrom": { "name": "BaseInput", "module": "components/input/src/base-input.js" } }, { "name": "simple", "type": { "text": "boolean" }, "description": "Simple makes the input render without a border.", "fieldName": "simple", "inheritedFrom": { "name": "BaseInput", "module": "components/input/src/base-input.js" } }, { "name": "spellcheck", "type": { "text": "string" }, "description": "An enumerated attribute defines whether the element may be checked for spelling errors. [true, false]. When set to `false` the attribute `autocorrect` is set to `off` and `autocapitalize` is set to `none`.", "fieldName": "spellcheck", "inheritedFrom": { "name": "BaseInput", "module": "components/input/src/base-input.js" } }, { "name": "type", "type": { "text": "'text' | 'password' | 'email' | 'credit-card' | 'tel' | 'number'" }, "description": "Populates the `type` attribute on the input.", "default": "'text'", "fieldName": "type", "inheritedFrom": { "name": "BaseInput", "module": "components/input/src/base-input.js" } }, { "name": "validateOnInput", "type": { "text": "boolean" }, "description": "Sets validation mode to re-eval with each input.", "fieldName": "validateOnInput", "inheritedFrom": { "name": "BaseInput", "module": "components/input/src/base-input.js" } }, { "name": "validity", "type": { "text": "string" }, "description": "Specifies the `validityState` this element is in.", "fieldName": "validity", "inheritedFrom": { "name": "BaseInput", "module": "components/input/src/base-input.js" } }, { "name": "value", "type": { "text": "string" }, "description": "Populates the `value` attribute on the input. Can also be read to retrieve the current value of the input.", "fieldName": "value", "inheritedFrom": { "name": "BaseInput", "module": "components/input/src/base-input.js" } }, { "name": "layout", "type": { "text": "string" }, "description": "Defines the language of an element.", "default": "{'default'}", "fieldName": "layout", "inheritedFrom": { "name": "AuroElement", "module": "components/layoutElement/src/auroElement.js" } }, { "name": "shape", "type": { "text": "string" }, "fieldName": "shape", "inheritedFrom": { "name": "AuroElement", "module": "components/layoutElement/src/auroElement.js" } }, { "name": "size", "type": { "text": "string" }, "fieldName": "size", "inheritedFrom": { "name": "AuroElement", "module": "components/layoutElement/src/auroElement.js" } }, { "name": "ondark", "type": { "text": "boolean" }, "fieldName": "onDark", "inheritedFrom": { "name": "AuroElement", "module": "components/layoutElement/src/auroElement.js" } } ], "events": [ { "name": "auroInput-validityChange", "type": { "text": "CustomEvent" }, "inheritedFrom": { "name": "BaseInput", "module": "components/input/src/base-input.js" } }, { "description": "Event fires when the value of an `auro-input` has been changed.", "name": "input", "inheritedFrom": { "name": "BaseInput", "module": "components/input/src/base-input.js" } }, { "description": "Notifies that the `validity` and `errorMessage` value has changed.", "name": "auroFormElement-validated", "inheritedFrom": { "name": "BaseInput", "module": "components/input/src/base-input.js" } } ] } ], "exports": [ { "kind": "js", "name": "AuroInput", "declaration": { "name": "AuroInput", "module": "components/input/src/auro-input.js" } } ] }, { "kind": "javascript-module", "path": "components/input/src/base-input.js", "declarations": [ { "kind": "class", "description": "Base class for auro-input component that provides core input functionality.", "name": "BaseInput", "members": [ { "kind": "field", "name": "shadowRootOptions", "static": true, "readonly": true }, { "kind": "method", "name": "_initializeDefaults", "description": "Internal Defaults.", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "patchInputEvent", "parameters": [ { "name": "input", "description": "The input element to patch.", "type": { "text": "HTMLInputElement" } } ], "description": "Patches the input element to dispatch an 'input' event whenever its value is set programmatically.\nThis ensures that changes to the input's value are consistently communicated, even if not triggered by user input.", "return": { "type": { "text": "void" } }, "privacy": "private" }, { "kind": "method", "name": "setCustomHelpTextMessage", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "notifyValidityChange", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "configureAutoFormatting", "description": "Sets up IMasks and logic based on auto-formatting requirements.", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "definePattern", "privacy": "private", "return": { "type": { "text": "string" } } }, { "kind": "method", "name": "getIconAsHtml", "parameters": [ { "name": "icon", "description": "HTML string for requested icon.", "type": { "text": "string" } } ], "description": "Required to convert SVG icons from data to HTML string.", "privacy": "private", "return": { "type": { "text": "object" } } }, { "kind": "method", "name": "notifyValueChanged", "description": "Sends event notifying that the input has changed it's value.", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "handleClick", "description": "Handles clicking on the auro-input anywhere outside of the HTML5 input and still moving focus in.", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "focus", "description": "Function to set element focus.", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "handleClickClear", "description": "Handles event of clearing input content by clicking the X icon.", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "handleInput", "parameters": [ { "name": "event", "description": "The input event.", "type": { "text": "Event" } } ], "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "handleFocusin", "description": "Function to support", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "handleFocusout", "description": "Function to support", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "handleBlur", "description": "Function to support", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "getActiveElement", "parameters": [ { "name": "root", "default": "document", "description": "Element to check for focus.", "type": { "text": "Object" } } ], "description": "Returns focused element, even if it's in the shadow DOM.", "privacy": "private", "return": { "type": { "text": "Object" } } }, { "kind": "method", "name": "setActiveDescendant", "parameters": [ { "name": "element", "description": "The element to set as the active descendant, or null to clear.", "type": { "text": "HTMLElement|null" } } ], "description": "Sets the active descendant element for accessibility.\nUses ariaActiveDescendantElement to cross shadow DOM boundaries.\nThis function is used in components that contain `auro-input` to set the active descendant.", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "validate", "parameters": [ { "name": "force", "default": "false", "description": "Whether to force validation.", "optional": true, "type": { "text": "boolean" } } ], "description": "Validates value." }, { "kind": "method", "name": "reset", "description": "Resets component to initial state, including resetting the touched state and validity.", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "clear", "description": "Clears the input value." }, { "kind": "method", "name": "configureDataForType", "description": "Sets configuration data used elsewhere based on the `type` attribute.", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "getInputType", "parameters": [ { "name": "type", "description": "Value entered into component prop.", "type": { "text": "string" } } ], "description": "Validates against list of supported this.allowedInputTypes; return type=text if invalid request.", "privacy": "private", "return": { "type": { "text": "string" } } }, { "kind": "method", "name": "getHelpText", "description": "Determines default help text string.", "privacy": "private", "return": { "type": { "text": "string" } } }, { "kind": "method", "name": "handleClickShowPassword", "description": "Function to support show-password feature.", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "field", "name": "placeholderStr", "description": "Support placeholder text.", "privacy": "private", "return": { "type": { "text": "void" } }, "readonly": true }, { "kind": "method", "name": "defineInputIcon", "description": "Defines placement of input icon based on type, used with classMap.", "privacy": "private", "return": { "type": { "text": "boolean" } } }, { "kind": "method", "name": "defineLabelPadding", "description": "Defines padding of input label based on type, used with classMap.", "privacy": "private", "return": { "type": { "text": "boolean" } } }, { "kind": "method", "name": "processCreditCard", "description": "Function to support credit-card feature type.", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "matchInputValueToCreditCard", "description": "Function to support credit-card feature type.", "privacy": "private", "return": { "type": { "text": "object" } } }, { "kind": "field", "name": "a11yRole", "privacy": "public", "type": { "text": "string" }, "description": "The value for the role attribute.", "attribute": "a11yRole", "reflects": true }, { "kind": "field", "name": "a11yControls", "privacy": "public", "type": { "text": "string" }, "description": "The value for the aria-controls attribute.", "attribute": "a11yControls", "reflects": true }, { "kind": "field", "name": "a11yExpanded", "privacy": "public", "type": { "text": "boolean" }, "description": "The value for the aria-expanded attribute.", "attribute": "a11yExpanded", "reflects": true }, { "kind": "field", "name": "a11yActivedescendant", "privacy": "public", "type": { "text": "string" }, "description": "The value for the aria-activedescendant attribute.\nPoints to the ID of the currently active/highlighted option in a listbox.", "attribute": "a11yActivedescendant", "reflects": true }, { "kind": "field", "name": "activeLabel", "privacy": "public", "type": { "text": "boolean" }, "description": "If set, the label will remain fixed in the active position.", "attribute": "activeLabel", "reflects": true }, { "kind": "field", "name": "appearance", "privacy": "public", "type": { "text": "'default' | 'inverse'" }, "description": "Defines whether the component will be on lighter or darker backgrounds.", "default": "'default'", "attribute": "appearance", "reflects": true }, { "kind": "field", "name": "autocapitalize", "privacy": "public", "type": { "text": "string" }, "description": "An enumerated attribute that controls whether and how text input is automatically capitalized as it is entered/edited by the user. [off/none, on/sentences, words, characters].", "attribute": "autocapitalize", "reflects": true }, { "kind": "field", "name": "autocomplete", "privacy": "public", "type": { "text": "string" }, "description": "An enumerated attribute that defines what the user agent can suggest for autofill. At this time, only `autocomplete=\"off\"` is supported.", "attribute": "autocomplete", "reflects": true }, { "kind": "field", "name": "autocorrect", "privacy": "public", "type": { "text": "string" }, "description": "When set to `off`, stops iOS from auto-correcting words when typed into a text box.", "attribute": "autocorrect", "reflects": true }, { "kind": "field", "name": "customValidityTypeEmail", "privacy": "public", "type": { "text": "string" }, "description": "Custom help text message for email type validity.", "attribute": "customValidityTypeEmail" }, { "kind": "field", "name": "disabled", "privacy": "public", "type": { "text": "boolean" }, "description": "If set, disables the input.", "attribute": "disabled", "reflects": true }, { "kind": "field", "name": "dvInputOnly", "privacy": "public", "type": { "text": "boolean" }, "description": "If defined, the display value slot content will only mask the HTML5 input element. The input's label will not be masked.", "attribute": "dvInputOnly", "reflects": true }, { "kind": "field", "name": "error", "privacy": "public", "type": { "text": "string" }, "description": "When defined, sets persistent validity to `customError` and sets `setCustomValidity` = attribute value.", "attribute": "error", "reflects": true }, { "kind": "field", "name": "errorMessage", "privacy": "public", "type": { "text": "string" }, "description": "Contains the help text message for the current validity error.", "attribute": "errorMessage" }, { "kind": "field", "name": "format", "privacy": "public", "type": { "text": "string" }, "description": "Specifies the input mask format.", "attribute": "format", "reflects": true }, { "kind": "field", "name": "hasFocus", "privacy": "public", "type": { "text": "boolean" }, "description": "Flag to indicate if the input currently has focus." }, { "kind": "field", "name": "hasValue", "privacy": "public", "type": { "text": "boolean" }, "description": "Flag to indicate if the input currently has value." }, { "kind": "field", "name": "hideLabelVisually", "privacy": "private", "type": { "text": "boolean" }, "description": "If set, the label will be hidden visually but still accessible to assistive technologies.", "attribute": "hideLabelVisually", "reflects": true }, { "kind": "field", "name": "icon", "privacy": "public", "type": { "text": "boolean" }, "description": "If set, will render an icon inside the input to the left of the value. Support is limited to auro-input instances with credit card format.", "attribute": "icon", "reflects": true }, { "kind": "field", "name": "id", "privacy": "public", "type": { "text": "string" }, "description": "The id global attribute defines an identifier (ID) which must be unique in the whole document.", "attribute": "id" }, { "kind": "field", "name": "inputId", "privacy": "private", "type": { "text": "string" }, "description": "The id for input node." }, { "kind": "field", "name": "inputmode", "privacy": "public", "type": { "text": "string" }, "description": "Exposes inputmode attribute for input.", "attribute": "inputmode", "reflects": true }, { "kind": "field", "name": "lang", "privacy": "public", "type": { "text": "string" }, "description": "Defines the language of an element.", "attribute": "lang", "reflects": true }, { "kind": "field", "name": "max", "privacy": "public", "type": { "text": "string" }, "description": "The maximum value allowed. This only applies for inputs with a type of `number` and all date formats.", "attribute": "max" }, { "kind": "field", "name": "maxLength", "privacy": "public", "type": { "text": "number" }, "description": "The maximum number of characters the user can enter into the text input. This must be an integer value `0` or higher.\n**Note**: This attribute is not intended to be used with a `type` or `format` that already has a defined length, such as credit-cards, dates or phone numbers.", "attribute": "maxLength", "reflects": true }, { "kind": "field", "name": "min", "privacy": "public", "type": { "text": "string" }, "description": "The minimum value allowed. This only applies for inputs with a type of `number` and all date formats.", "attribute": "min" }, { "kind": "field", "name": "minLength", "privacy": "public", "type": { "text": "number" }, "description": "The minimum number of characters the user can enter into the text input. This must be a non-negative integer value smaller than or equal to the value specified by `maxlength`.", "attribute": "minLength", "reflects": true }, { "kind": "field", "name": "name", "privacy": "public", "type": { "text": "string" }, "description": "Populates the `name` attribute on the input.", "attribute": "name", "reflects": true }, { "kind": "field", "name": "nested", "privacy": "public", "type": { "text": "boolean" }, "description": "Sets styles for nested operation - removes borders, hides help + error text, and\nhides accents.", "attribute": "nested", "reflects": true }, { "kind": "field", "name": "noValidate", "privacy": "public", "type": { "text": "boolean" }, "description": "If set, disables auto-validation on blur.", "attribute": "noValidate", "reflects": true }, { "kind": "field", "name": "onDark", "privacy": "public", "type": { "text": "boolean" }, "attribute": "onDark", "reflects": true, "description": "DEPRECATED - use `appearance=\"inverse\"` instead.", "inheritedFrom": { "name": "AuroElement", "module": "components/layoutElement/src/auroElement.js" } }, { "kind": "field", "name": "pattern", "privacy": "public", "type": { "text": "string" }, "description": "Specifies a regular expression the form control's value should match.", "attribute": "pattern", "reflects": true }, { "kind": "field", "name": "placeholder", "privacy": "public", "type": { "text": "string" }, "description": "Define custom placeholder text.", "attribute": "placeholder", "reflects": true }, { "kind": "field", "name": "readonly", "privacy": "public", "type": { "text": "boolean" }, "description": "Makes the input read-only, but can be set programmatically.", "attribute": "readonly", "reflects": true }, { "kind": "field", "name": "required", "privacy": "public", "type": { "text": "boolean" }, "description": "Populates the `required` attribute on the input. Used for client-side validation.", "attribute": "required", "reflects": true }, { "kind": "field", "name": "setCustomValidity", "privacy": "public", "type": { "text": "string" }, "description": "Sets a custom help text message to display for all validityStates.", "attribute": "setCustomValidity" }, { "kind": "field", "name": "setCustomValidityBadInput", "privacy": "public", "type": { "text": "string" }, "description": "Custom help text message to display when validity = `badInput`.", "attribute": "setCustomValidityBadInput" }, { "kind": "field", "name": "setCustomValidityCustomError", "privacy": "public", "type": { "text": "string" }, "description": "Custom help text message to display when validity = `customError`.", "attribute": "setCustomValidityCustomError" }, { "kind": "field", "name": "setCustomValidityForType", "privacy": "public", "type": { "text": "string" }, "description": "Custom help text message to display for the declared element `type` and type validity fails.", "attribute": "setCustomValidityForType" }, { "kind": "field", "name": "setCustomValidityRangeOverflow", "privacy": "public", "type": { "text": "string" }, "description": "Custom help text message to display when validity = `rangeOverflow`.", "attribute": "setCustomValidityRangeOverflow" }, { "kind": "field", "name": "setCustomValidityRangeUnderflow", "privacy": "public", "type": { "text": "string" }, "description": "Custom help text message to display when validity = `rangeUnderflow`.", "attribute": "setCustomValidityRangeUnderflow" }, { "kind": "field", "name": "setCustomValidityTooLong", "privacy": "public", "type": { "text": "string" }, "description": "Custom help text message to display when validity = `tooLong`.", "attribute": "setCustomValidityTooLong" }, { "kind": "field", "name": "setCustomValidityTooShort", "privacy": "public", "type": { "text": "string" }, "description": "Custom help text message to display when validity = `tooShort`.", "attribute": "setCustomValidityTooShort" }, { "kind": "field", "name": "setCustomValidityValueMissing", "privacy": "public", "type": { "text": "string" }, "description": "Custom help text message to display when validity = `valueMissing`.", "attribute": "setCustomValidityValueMissing" }, { "kind": "field", "name": "showPassword", "privacy": "public", "attribute": "showPassword" }, { "kind": "field", "name": "simple", "privacy": "public", "type": { "text": "boolean" }, "description": "Simple makes the input render without a border.", "attribute": "simple", "reflects": true }, { "kind": "field", "name": "spellcheck", "privacy": "public", "type": { "text": "string" }, "description": "An enumerated attribute defines whether the element may be checked for spelling errors. [true, false]. When set to `false` the attribute `autocorrect` is set to `off` and `autocapitalize` is set to `none`.", "attribute": "spellcheck", "reflects": true }, { "kind": "field", "name": "touched", "privacy": "private", "type": { "text": "boolean" }, "description": "Indicates whether the input is in a dirty state (has been interacted with)." }, { "kind": "field", "name": "type", "privacy": "public", "type": { "text": "'text' | 'password' | 'email' | 'credit-card' | 'tel' | 'number'" }, "description": "Populates the `type` attribute on the input.", "default": "'text'", "attribute": "type", "reflects": true }, { "kind": "field", "name": "validateOnInput", "privacy": "public", "type": { "text": "boolean" }, "description": "Sets validation mode to re-eval with each input.", "attribute": "validateOnInput" }, { "kind": "field", "name": "validity", "privacy": "public", "type": { "text": "string" }, "description": "Specifies the `validityState` this element is in.", "attribute": "validity", "reflects": true }, { "kind": "field", "name": "value", "privacy": "public", "type": { "text": "string" }, "description": "Populates the `value` attribute on the input. Can also be read to retrieve the current value of the input.", "attribute": "value" }, { "kind": "field", "name": "componentHasFocus", "description": "Returns true if the element has focus.", "privacy": "private", "return": { "type": { "text": "boolean" } }, "readonly": true, "inheritedFrom": { "name": "AuroElement", "module": "components/layoutElement/src/auroElement.js" } }, { "kind": "method", "name": "resetShapeClasses", "inheritedFrom": { "name": "AuroElement", "module": "components/layoutElement/src/auroElement.js" } }, { "kind": "method", "name": "resetLayoutClasses", "inheritedFrom": { "name": "AuroElement", "module": "components/layoutElement/src/auroElement.js" } }, { "kind": "method", "name": "updateComponentArchitecture", "inheritedFrom": { "name": "AuroElement", "module": "components/layoutElement/src/auroElement.js" } }, { "kind": "field", "name": "layout", "privacy": "public", "type": { "text": "string" }, "description": "Defines the language of an element.", "default": "{'default'}", "attribute": "layout", "reflects": true, "inheritedFrom": { "name": "AuroElement", "module": "components/layoutElement/src/auroElement.js" } }, { "kind": "field", "name": "shape", "privacy": "public", "type": { "text": "string" }, "attribute": "shape", "reflects": true, "inheritedFrom": { "name": "AuroElement", "module": "components/layoutElement/src/auroElement.js" } }, { "kind": "field", "name": "size", "privacy": "public", "type": { "text": "string" }, "attribute": "size", "reflects": true, "inheritedFrom": { "name": "AuroElement", "module": "components/layoutElement/src/auroElement.js" } } ], "events": [ { "name": "auroInput-validityChange", "type": { "text": "CustomEvent" } }, { "description": "Event fires when the value of an `auro-input` has been changed.", "name": "input" }, { "description": "Notifies that the `validity` and `errorMessage` value has changed.", "name": "auroFormElement-validated" } ], "attributes": [ { "name": "a11yRole", "type": { "text": "string" }, "description": "The value for the role attribute.", "fieldName": "a11yRole" }, { "name": "a11yControls", "type": { "text": "string" }, "description": "The value for the aria-controls attribute.", "fieldName": "a11yControls" }, { "name": "a11yExpanded", "type": { "text": "boolean" }, "description": "The value for the aria-expanded attribute.", "fieldName": "a11yExpanded" }, { "name": "a11yActivedescendant", "type": { "text": "string" }, "description": "The value for the aria-activedescendant attribute.\nPoints to the ID of the currently active/highlighted option in a listbox.", "fieldName": "a11yActivedescendant" }, { "name": "activeLabel", "type": { "text": "boolean" }, "description": "If set, the label will remain fixed in the active position.", "fieldName": "activeLabel" }, { "name": "appearance", "type": { "text": "'default' | 'inverse'" }, "description": "Defines whether the component will be on lighter or darker backgrounds.", "default": "'default'", "fieldName": "appearance" }, { "name": "autocapitalize", "type": { "text": "string" }, "description": "An enumerated attribute that controls whether and how text input is automatically capitalized as it is entered/edited by the user. [off/none, on/sentences, words, characters].", "fieldName": "autocapitalize" }, { "name": "autocomplete", "type": { "text": "string" }, "description": "An enumerated attribute that defines what the user agent can suggest for autofill. At this time, only `autocomplete=\"off\"` is supported.", "fieldName": "autocomplete" }, { "name": "autocorrect", "type": { "text": "string" }, "description": "When set to `off`, stops iOS from auto-correcting words when typed into a text box.", "fieldName": "autocorrect" }, { "name": "customValidityTypeEmail", "type": { "text": "string" }, "description": "Custom help text message for email type validity.", "fieldName": "customValidityTypeEmail" }, { "name": "disabled", "type": { "text": "boolean" }, "description": "If set, disables the input.", "fieldName": "disabled" }, { "name": "dvInputOnly", "type": { "text": "boolean" }, "description": "If defined, the display value slot content will only mask the HTML5 input element. The input's label will not be masked.", "fieldName": "dvInputOnly" }, { "name": "error", "type": { "text": "string" }, "description": "When defined, sets persistent validity to `customError` and sets `setCustomValidity` = attribute value.", "fieldName": "error" }, { "name": "errorMessage", "type": { "text": "string" }, "description": "Contains the help text message for the current validity error.", "fieldName": "errorMessage" }, { "name": "format", "type": { "text": "string" }, "description": "Specifies the input mask format.", "fieldName": "format" }, { "name": "hideLabelVisually", "type": { "text": "boolean" }, "description": "If set, the label will be hidden visually but still accessible to assistive technologies.", "fieldName": "hideLabelVisually" }, { "name": "icon", "type": { "text": "boolean" }, "description": "If set, will render an icon inside the input to the left of the value. Support is limited to auro-input instances with credit card format.", "fieldName": "icon" }, { "name": "id", "type": { "text": "string" }, "description": "The id global attribute defines an identifier (ID) which must be unique in the whole document.", "fieldName": "id" }, { "name": "inputmode", "type": { "text": "string" }, "description": "Exposes inputmode attribute for input.", "fieldName": "inputmode" }, { "name": "lang", "type": { "text": "string" }, "description": "Defines the language of an element.", "fieldName": "lang" }, { "name": "max", "type": { "text": "string" }, "description": "The maximum value allowed. This only applies for inputs with a type of `number` and all date formats.", "fieldName": "max" }, { "name": "maxLength", "type": { "text": "number" }, "description": "The maximum number of characters the user can enter into the text input. This must be an integer value `0` or higher.\n**Note**: This attribute is not intended to be used with a `type` or `format` that already has a defined length, such as credit-cards, dates or phone numbers.", "fieldName": "maxLength" }, { "name": "min", "type": { "text": "string" }, "description": "The minimum value allowed. This only applies for inputs with a type of `number` and all date formats.", "fieldName": "min" }, { "name": "minLength", "type": { "text": "number" }, "description": "The minimum number of characters the user can enter into the text input. This must be a non-negative integer value smaller than or equal to the value specified by `maxlength`.", "fieldName": "minLength" }, { "name": "name", "type": { "text": "string" }, "description": "Populates the `name` attribute on the input.", "fieldName": "name" }, { "name": "nested", "type": { "text": "boolean" }, "description": "Sets styles for nested operation - removes borders, hides help + error text, and\nhides accents.", "fieldName": "nested" }, { "name": "noValidate", "type": { "text": "boolean" }, "description": "If set, disables auto-validation on blur.", "fieldName": "noValidate" }, { "name": "onDark", "type": { "text": "boolean" }, "description": "DEPRECATED - use `appearance=\"inverse\"` instead.", "fieldName": "onDark" }, { "name": "pattern", "type": { "text": "string" }, "description": "Specifies a regular expression the form control's value should match.", "fieldName": "pattern" }, { "name": "placeholder", "type": { "text": "string" }, "description": "Define custom placeholder text.", "fieldName": "placeholder" }, { "name": "readonly", "type": { "text": "boolean" }, "description": "Makes the input read-only, but can be set programmatically.", "fieldName": "readonly" }, { "name": "required", "type": { "text": "boolean" }, "description": "Populates the `required` attribute on the input. Used for client-side validation.", "fieldName": "required" }, { "name": "setCustomValidity", "type": { "text": "string" }, "description": "Sets a custom help text message to display for all validityStates.", "fieldName": "setCustomValidity" }, { "name": "setCustomValidityBadInput", "type": { "text": "string" }, "description": "Custom help text message to display when validity = `badInput`.", "fieldName": "setCustomValidityBadInput" }, { "name": "setCustomValidityCustomError", "type": { "text": "string" }, "description": "Custom help text message to display when validity = `customError`.", "fieldName": "setCustomValidityCustomError" }, { "name": "setCustomValidityForType", "type": { "text": "string" }, "description": "Custom help text message to display for the declared element `type` and type validity fails.", "fieldName": "setCustomValidityForType" }, { "name": "setCustomValidityRangeOverflow", "type": { "text": "string" }, "description": "Custom help text message to display when validity = `rangeOverflow`.", "fieldName": "setCustomValidityRangeOverflow" }, { "name": "setCustomValidityRangeUnderflow", "type": { "text": "string" }, "description": "Custom help text message to display when validity = `rangeUnderflow`.", "fieldName": "setCustomValidityRangeUnderflow" }, { "name": "setCustomValidityTooLong", "type": { "text": "string" }, "description": "Custom help text message to display when validity = `tooLong`.", "fieldName": "setCustomValidityTooLong" }, { "name": "setCustomValidityTooShort", "type": { "text": "string" }, "description": "Custom help text message to display when validity = `tooShort`.", "fieldName": "setCustomValidityTooShort" }, { "name": "setCustomValidityValueMissing", "type": { "text": "string" }, "description": "Custom help text message to display when validity = `valueMissing`.", "fieldName": "setCustomValidityValueMissing" }, { "name": "showPassword", "fieldName": "showPassword" }, { "name": "simple", "type": { "text": "boolean" }, "description": "Simple makes the input render without a border.", "fieldName": "simple" }, { "name": "spellcheck", "type": { "text": "string" }, "description": "An enumerated attribute defines whether the element may be checked for spelling errors. [true, false]. When set to `false` the attribute `autocorrect` is set to `off` and `autocapitalize` is set to `none`.", "fieldName": "spellcheck" }, { "name": "type", "type": { "text": "'text' | 'password' | 'email' | 'credit-card' | 'tel' | 'number'" }, "description": "Populates the `type` attribute on the input.", "default": "'text'", "fieldName": "type" }, { "name": "validateOnInput", "type": { "text": "boolean" }, "description": "Sets validation mode to re-eval with each input.", "fieldName": "validateOnInput" }, { "name": "validity", "type": { "text": "string" }, "description": "Specifies the `validityState` this element is in.", "fieldName": "validity" }, { "name": "value", "type": { "text": "string" }, "description": "Populates the `value` attribute on the input. Can also be read to retrieve the current value of the input.", "fieldName": "value" }, { "name": "layout", "type": { "text": "string" }, "description": "Defines the language of an element.", "default": "{'default'}", "fieldName": "layout", "inheritedFrom": { "name": "AuroElement", "module": "components/layoutElement/src/auroElement.js" } }, { "name": "shape", "type": { "text": "string" }, "fieldName": "shape", "inheritedFrom": { "name": "AuroElement", "module": "components/layoutElement/src/auroElement.js" } }, { "name": "size", "type": { "text": "string" }, "fieldName": "size", "inheritedFrom": { "name": "AuroElement", "module": "components/layoutElement/src/auroElement.js" } }, { "name": "ondark", "type": { "text": "boolean" }, "fieldName": "onDark", "inheritedFrom": { "name": "AuroElement", "module": "components/layoutElement/src/auroElement.js" } } ], "superclass": { "name": "AuroElement", "module": "/components/layoutElement/src/auroElement.js" } } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "BaseInput", "module": "components/input/src/base-input.js" } } ] }, { "kind": "javascript-module", "path": "components/input/src/buttonVersion.js", "declarations": [], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "12.3.2", "module": "components/input/src/buttonVersion.js" } } ] }, { "kind": "javascript-module", "path": "components/input/src/i18n.js", "declarations": [ { "kind": "function", "name": "i18n", "parameters": [ { "name": "lang", "description": "Requested lang for content return.", "type": { "text": "string" } }, { "name": "requestedString", "description": "String requested in context.", "type": { "text": "string" } } ], "description": "Function to support the selected of a string in the set lang.", "privacy": "private", "return": { "type": { "text": "string" } } }, { "kind": "function", "name": "notifyOnLangChange", "parameters": [ { "name": "element", "description": "Pass in the scope of the element in use.", "type": { "text": "object" } } ], "privacy": "private" }, { "kind": "function", "name": "stopNotifyingOnLangChange", "parameters": [ { "name": "element", "description": "Pass in the scope of the element in use.", "type": { "text": "object" } } ], "privacy": "private" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "i18n", "module": "components/input/src/i18n.js" } }, { "kind": "js", "name": "notifyOnLangChange", "declaration": { "name": "notifyOnLangChange", "module": "components/input/src/i18n.js" } }, { "kind": "js", "name": "stopNotifyingOnLangChange", "declaration": { "name": "stopNotifyingOnLangChange", "module": "components/input/src/i18n.js" } } ] }, { "kind": "javascript-module", "path": "components/input/src/iconVersion.js", "declarations": [], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "9.1.2", "module": "components/input/src/iconVersion.js" } } ] }, { "kind": "javascript-module", "path": "components/input/src/index.js", "declarations": [], "exports": [ { "kind": "js", "name": "AuroInput", "declaration": { "name": "AuroInput", "module": "components/input/src/index.js" } } ] }, { "kind": "javascript-module", "path": "components/input/src/registered.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "components/input/src/utilities.js", "declarations": [ { "kind": "class", "description": "", "name": "AuroInputUtilities", "members": [ { "kind": "method", "name": "getMaskOptions", "parameters": [ { "name": "type", "description": "The input type.", "type": { "text": "string" } }, { "name": "format", "description": "The format of the mask to apply.", "type": { "text": "string" } } ], "description": "Configures the mask to be used on the input element based on format and/or type.\nIMask tool documentation: https://imask.js.org/.", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "toNorthAmericanFormat", "parameters": [ { "name": "dateStr", "description": "Date string to format.", "type": { "text": "string" } }, { "name": "format", "description": "Date format to use.", "type": { "text": "string" } } ], "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "parseDate", "parameters": [ { "name": "dateStr", "description": "Date string to parse.", "type": { "text": "string" } }, { "name": "format", "description": "Date format to parse.", "type": { "text": "string" } } ], "privacy": "private", "return": { "type": { "text": "void" } } } ] } ], "exports": [ { "kind": "js", "name": "AuroInputUtilities", "declaration": { "name": "AuroInputUtilities", "module": "components/input/src/utilities.js" } } ] }, { "kind": "javascript-module", "path": "components/layoutElement/src/auroElement.js", "declarations": [ { "kind": "class", "description": "", "name": "AuroElement", "members": [ { "kind": "field", "name": "componentHasFocus", "description": "Returns true if the element has focus.", "privacy": "private", "return": { "type": { "text": "boolean" } }, "readonly": true }, { "kind": "method", "name": "resetShapeClasses" }, { "kind": "method", "name": "resetLayoutClasses" }, { "kind": "method", "name": "updateComponentArchitecture" }, { "kind": "field", "name": "layout", "privacy": "public", "type": { "text": "string" }, "description": "Defines the language of an element.", "default": "{'default'}", "attribute": "layout", "reflects": true }, { "kind": "field", "name": "shape", "privacy": "public", "type": { "text": "string" }, "attribute": "shape", "reflects": true }, { "kind": "field", "name": "size", "privacy": "public", "type": { "text": "string" }, "attribute": "size", "reflects": true }, { "kind": "field", "name": "onDark", "privacy": "public", "type": { "text": "boolean" }, "attribute": "ondark", "reflects": true } ], "attributes": [ { "name": "layout", "type": { "text": "string" }, "description": "Defines the language of an element.", "default": "{'default'}", "fieldName": "layout" }, { "name": "shape", "type": { "text": "string" }, "fieldName": "shape" }, { "name": "size", "type": { "text": "string" }, "fieldName": "size" }, { "name": "ondark", "type": { "text": "boolean" }, "fieldName": "onDark" } ], "superclass": { "name": "LitElement", "package": "lit" }, "customElement": true } ], "exports": [ { "kind": "js", "name": "AuroElement", "declaration": { "name": "AuroElement", "module": "components/layoutElement/src/auroElement.js" } } ] }, { "kind": "javascript-module", "path": "components/layoutElement/src/index.js", "declarations": [], "exports": [ { "kind": "js", "name": "AuroElement", "declaration": { "name": "AuroElement", "module": "components/layoutElement/src/index.js" } } ] }, { "kind": "javascript-module", "path": "components/layoutElement/src/registered.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "components/menu/src/auro-menu-utils.js", "declarations": [ { "kind": "function", "name": "arrayConverter", "parameters": [ { "name": "value", "description": "The value to be converted. Can be a string, array, or undefined.", "type": { "text": "any" } } ], "description": "Converts value to an array.\nIf the value is a JSON string representing an array, it will be parsed.\nIf the value is already an array, it is returned.\nIf the value is undefined, it returns undefined.", "privacy": "private", "return": { "type": { "text": "Array|undefined" } } }, { "kind": "function", "name": "arraysAreEqual", "parameters": [ { "name": "arr1", "description": "First array to compare.", "type": { "text": "Array" } }, { "name": "arr2", "description": "Second array to compare.", "type": { "text": "Array" } } ], "description": "Compare two arrays for equality.", "privacy": "private", "return": { "type": { "text": "boolean" } } }, { "kind": "function", "name": "isOptionInteractive", "parameters": [ { "name": "option", "description": "The option to check.", "type": { "text": "HTMLElement" } } ], "description": "Validates if an option can be interacted with.", "privacy": "private", "return": { "type": { "text": "boolean" } } }, { "kind": "function", "name": "dispatchMenuEvent", "parameters": [ { "name": "element", "description": "Element to dispatch event from.", "type": { "text": "HTMLElement" } }, { "name": "eventName", "description": "Name of the event to dispatch.", "type": { "text": "string" } }, { "name": "detail", "default": "null", "description": "Optional detail object to include with the event.", "optional": true, "type": { "text": "Object" } } ], "description": "Helper method to dispatch custom events." } ], "exports": [ { "kind": "js", "name": "arrayConverter", "declaration": { "name": "arrayConverter", "module": "components/menu/src/auro-menu-utils.js" } }, { "kind": "js", "name": "arraysAreEqual", "declaration": { "name": "arraysAreEqual", "module": "components/menu/src/auro-menu-utils.js" } }, { "kind": "js", "name": "isOptionInteractive", "declaration": { "name": "isOptionInteractive", "module": "components/menu/src/auro-menu-utils.js" } }, { "kind": "js", "name": "dispatchMenuEvent", "declaration": { "name": "dispatchMenuEvent", "module": "components/menu/src/auro-menu-utils.js" } } ] }, { "kind": "javascript-module", "path": "components/menu/src/auro-menu.context.js", "declarations": [ { "kind": "class", "description": "", "name": "MenuService", "members": [ { "kind": "field", "name": "menuOptions", "description": "Gets the list of registered menu options.", "return": { "type": { "text": "AuroMenuOption[]" } }, "readonly": true }, { "kind": "field", "name": "highlightedOption", "description": "Gets the currently highlighted option.", "return": { "type": { "text": "AuroMenuOption|null" } }, "readonly": true }, { "kind": "field", "name": "currentValue", "description": "Gets the current value(s) of the selected option(s).", "return": { "type": { "text": "string|string[]|undefined" } }, "readonly": true }, { "kind": "field", "name": "currentLabel", "description": "Gets the label(s) of the currently selected option(s).", "return": { "type": { "text": "string" } }, "readonly": true }, { "kind": "field", "name": "stringValue", "description": "Gets the string representation of the current value(s).\nFor multi-select, this is a JSON stringified array.", "return": { "type": { "text": "string|undefined" } }, "readonly": true }, { "kind": "field", "name": "currentKeys", "description": "Gets the key(s) of the currently selected option(s).", "return": { "type": { "text": "string|string[]|undefined" } }, "readonly": true }, { "kind": "method", "name": "hostUpdated", "description": "Handles host updates.\nThis is a lit reactive lifecycle method.\nThis comes from the Lit controller interface provided by adding this service as a controller to the host.\nSee constructor for `this.host.addController(this)`\nYou can read more about Lit reactive controllers here: https://lit.dev/docs/composition/controllers/" }, { "kind": "method", "name": "hostDisconnected", "description": "Handles host disconnection and memory cleanup." }, { "kind": "method", "name": "setProperty", "parameters": [ { "name": "property", "type": { "text": "string" } }, { "name": "value", "type": { "text": "any" } } ], "description": "Sets a property value if it exists on the instance and the value has changed." }, { "kind": "method", "name": "setProperties", "parameters": [ { "name": "properties", "description": "Key-value pairs of properties to set.", "type": { "text": "Object" } } ], "description": "Sets multiple properties on the instance." }, { "kind": "method", "name": "highlightNext", "description": "Highlights the next active option in the menu." }, { "kind": "method", "name": "highlightPrevious", "description": "Highlights the previous active option in the menu." }, { "kind": "method", "name": "moveHighlightedOption", "parameters": [ { "name": "direction", "description": "The direction to move the highlight (\"next\" or \"previous\").", "type": { "text": "string" } } ], "description": "Moves the highlighted option in the specified direction." }, { "kind": "method", "name": "setHighlightedOption", "parameters": [ { "name": "option", "description": "The option to highlight.", "type": { "text": "AuroMenuOption" } } ], "description": "Sets the highlighted index to the specified option." }, { "kind": "method", "name": "setHighlightedIndex", "parameters": [ { "name": "index", "type": { "text": "number" } } ], "description": "Sets the highlighted option to the option at the specified index if it exists." }, { "kind": "method", "name": "selectHighlightedOption", "description": "Selects the currently highlighted option." }, { "kind": "method", "name": "selectOptions", "parameters": [ { "name": "options", "description": "Single option or array of options to select", "type": { "text": "AuroMenuOption|AuroMenuOption[]" } } ], "description": "Selects one or more options in a batch operation" }, { "kind": "method", "name": "deselectOptions", "parameters": [ { "name": "options", "description": "Single option or array of options to deselect", "type": { "text": "AuroMenuOption|AuroMenuOption[]" } } ], "description": "Deselects one or more options in a batch operation" }, { "kind": "method", "name": "selectOption", "parameters": [ { "name": "option", "type": { "text": "AuroMenuOption" } } ], "description": "Selects a single option." }, { "kind": "method", "name": "deselectOption", "parameters": [ { "name": "option", "type": { "text": "AuroMenuOption" } } ], "description": "Deselects a single option." }, { "kind": "method", "name": "toggleOption", "parameters": [ { "name": "option", "type": { "text": "AuroMenuOption" } } ], "description": "Toggles the selection state of a single option." }, { "kind": "method", "name": "selectByValue", "parameters": [ { "name": "value", "description": "The value(s) to select.", "type": { "text": "string|number|Array" } } ], "description": "Selects options based on their value(s) when compared to a passed value or values.\nValue or values are normalized to an array of strings that can be matched to option keys." }, { "kind": "method", "name": "reset", "description": "Resets the selected options to an empty array." }, { "kind": "method", "name": "subscribe", "parameters": [ { "name": "callback", "description": "The callback to invoke on events.", "type": { "text": "Function" } } ], "description": "Subscribes a callback to menu service events." }, { "kind": "method", "name": "unsubscribe", "parameters": [ { "name": "callback", "type": { "text": "Function" } } ], "description": "Remove a previously subscribed callback from menu service events." }, { "kind": "method", "name": "stageUpdate", "description": "Stages an update to notify subscribers of state and value changes." }, { "kind": "method", "name": "notify", "parameters": [ { "name": "event", "description": "The event to send to subscribers.", "type": { "text": "string" } } ], "description": "Notifies subscribers of a menu service event.\nAll notifications are sent to all subscribers." }, { "kind": "method", "name": "notifyStateChange", "description": "Notifies subscribers of a state change (selected options has changed)." }, { "kind": "method", "name": "notifyValueChange", "description": "Notifies subscribers of a value change (current value has changed)." }, { "kind": "method", "name": "dispatchChangeEvent", "parameters": [ { "name": "eventName", "type": { "text": "string" } }, { "name": "detail", "type": { "text": "any" } } ], "description": "Dispatches a custom event from the host element." }, { "kind": "method", "name": "addMenuOption", "parameters": [ { "name": "option", "description": "the option to track", "type": { "text": "AuroMenuOption" } } ], "description": "Adds a menu option to the service's list." }, { "kind": "method", "name": "removeMenuOption", "parameters": [ { "name": "option", "description": "the option to remove", "type": { "text": "AuroMenuOption" } } ], "description": "Removes a menu option from the service's list." }, { "kind": "method", "name": "_getNormalizedValues", "parameters": [ { "name": "value", "description": "The value(s) to normalize.", "type": { "text": "string|number|Array" } } ], "description": "Normalizes a value or array of values into an array of strings for option selection.\nThis function ensures that input values are consistently formatted for matching menu options.", "return": { "type": { "text": "Array" } } }, { "kind": "method", "name": "optionsArraysMatch", "parameters": [ { "name": "arr1", "description": "First array of options.", "type": { "text": "AuroMenuOption[]" } }, { "name": "arr2", "description": "Second array of options.", "type": { "text": "AuroMenuOption[]" } } ], "description": "Returns whether two arrays of options contain the same elements.", "return": { "type": { "text": "boolean" } } }, { "kind": "field", "name": "host", "default": "host" }, { "kind": "field", "name": "size", "default": "undefined" }, { "kind": "field", "name": "shape", "default": "undefined" }, { "kind": "field", "name": "noCheckmark", "default": "undefined" }, { "kind": "field", "name": "disabled", "default": "undefined" }, { "kind": "field", "name": "matchWord", "default": "undefined" }, { "kind": "field", "name": "multiSelect", "default": "undefined" }, { "kind": "field", "name": "allowDeselect", "default": "undefined" }, { "kind": "field", "name": "selectAllMatchingOptions", "default": "undefined" }, { "kind": "field", "name": "highlightedIndex", "type": { "text": "number" }, "default": "-1" }, { "kind": "field", "name": "_menuOptions", "type": { "text": "array" }, "default": "[]" }, { "kind": "field", "name": "_subscribers", "type": { "text": "array" }, "default": "[]" }, { "kind": "field", "name": "internalUpdateInProgress", "type": { "text": "boolean" }, "default": "false" }, { "kind": "field", "name": "selectedOptions", "type": { "text": "array" }, "default": "[]" } ] }, { "kind": "variable", "name": "MenuContext" } ], "exports": [ { "kind": "js", "name": "MenuService", "declaration": { "name": "MenuService", "module": "components/menu/src/auro-menu.context.js" } }, { "kind": "js", "name": "MenuContext", "declaration": { "name": "MenuContext", "module": "components/menu/src/auro-menu.context.js" } } ] }, { "kind": "javascript-module", "path": "components/menu/src/auro-menu.js", "declarations": [ { "kind": "class", "description": "The `auro-menu` element provides users a way to select from a list of options.", "name": "AuroMenu", "slots": [ { "description": "Text to show while loading attribute is set", "name": "loadingText" }, { "description": "Icon to show while loading attribute is set", "name": "loadingIcon" }, { "description": "Slot for insertion of menu options.", "name": "" } ], "members": [ { "kind": "field", "name": "currentLabel", "readonly": true, "return": { "type": { "text": "string" } } }, { "kind": "field", "name": "items", "readonly": true, "return": { "type": { "text": "Array" } }, "deprecated": "use `options` property instead." }, { "kind": "field", "name": "index", "return": { "type": { "text": "number" } }, "parameters": [ { "description": "Sets the index of the currently active option.", "name": "value", "type": { "text": "number" } } ] }, { "kind": "method", "name": "register", "static": true, "parameters": [ { "name": "name", "default": "\"auro-menu\"", "description": "The name of the element that you want to register.", "optional": true, "type": { "text": "string" } } ], "description": "This will register this element with the browser." }, { "kind": "field", "name": "formattedValue", "description": "Formatted value based on `multiSelect` state.\nDefault type is `String`, changing to `Array` when `multiSelect` is true.", "privacy": "private", "return": { "type": { "text": "String|Array" } }, "readonly": true }, { "kind": "field", "name": "propertyValues", "description": "Gets the current property values for the menu service.", "privacy": "private", "return": { "type": { "text": "Object" } }, "readonly": true }, { "kind": "method", "name": "provideContext", "description": "Provides the menu context to child components.\nInitializes the MenuService and subscribes to menu changes.", "privacy": "protected" }, { "kind": "method", "name": "updateActiveOption", "parameters": [ { "name": "option", "description": "The option to set as active.", "type": { "text": "HTMLElement" } } ], "description": "Updates the currently active option in the menu." }, { "kind": "method", "name": "setInternalValue", "parameters": [ { "name": "value", "description": "The value to set.", "type": { "text": "String|Array" } } ], "description": "Sets the internal value and manages update state.", "privacy": "protected" }, { "kind": "method", "name": "handleMenuChange", "parameters": [ { "name": "event", "description": "The event object from the menu service.", "type": { "text": "Object" } } ], "description": "Handles changes from the menu service and updates component state.", "privacy": "protected" }, { "kind": "field", "name": "selectedOptions", "description": "Gets the currently selected options.", "return": { "type": { "text": "Array" } }, "readonly": true }, { "kind": "field", "name": "selectedOption", "description": "Gets the first selected option, or null if none.", "return": { "type": { "text": "HTMLElement|null" } }, "readonly": true }, { "kind": "method", "name": "setTagAttribute", "parameters": [ { "name": "tagName", "description": "The tag name to set as an attribute.", "type": { "text": "string" } } ], "description": "Sets an attribute that matches the default tag name if the tag name is not the default.", "privacy": "private" }, { "kind": "method", "name": "setLoadingState", "parameters": [ { "name": "isLoading", "description": "Whether the menu is loading.", "type": { "text": "boolean" } } ], "description": "Sets the loading state and dispatches a loading change event.", "privacy": "protected" }, { "kind": "method", "name": "initializeMenu", "description": "Initializes the menu's state and structure.", "privacy": "private" }, { "kind": "method", "name": "makeSelection", "description": "Selects the currently highlighted option.", "privacy": "protected" }, { "kind": "method", "name": "clearSelection", "description": "Resets all options to their default state.", "privacy": "private" }, { "kind": "method", "name": "reset", "description": "Resets the menu to its initial state.\nThis is the only way to return value to undefined.", "privacy": "public" }, { "kind": "method", "name": "handleNestedMenus", "parameters": [ { "name": "menu", "description": "Root menu element.", "type": { "text": "HTMLElement" } } ], "description": "Handles nested menu structure.", "privacy": "private" }, { "kind": "method", "name": "handleKeyDown", "parameters": [ { "name": "event", "description": "Event object from the browser.", "type": { "text": "KeyboardEvent" } } ], "description": "Handles keyboard navigation.", "privacy": "private" }, { "kind": "method", "name": "navigateOptions", "parameters": [ { "name": "direction", "description": "The direction to navigate.", "type": { "text": "'up'|'down'" } } ], "description": "Navigates the menu options in the specified direction.", "privacy": "protected" }, { "kind": "method", "name": "handleSlotChange", "description": "Handles slot change events.", "privacy": "private" }, { "kind": "method", "name": "handleCustomEvent", "parameters": [ { "name": "option", "description": "Option with custom event.", "type": { "text": "HTMLElement" } } ], "description": "Handles custom events defined on options.", "privacy": "private" }, { "kind": "method", "name": "notifySelectionChange", "parameters": [ { "name": "{value, stringValue, keys, options}", "default": "{}" }, { "description": "The source that triggers this event.", "name": "source", "type": { "text": "any" } } ], "description": "Notifies selection change to parent components.", "privacy": "private" }, { "kind": "method", "name": "isOptionSelected", "parameters": [ { "name": "option", "description": "The option to check.", "type": { "text": "HTMLElement" } } ], "description": "Checks if an option is currently selected.", "privacy": "private", "return": { "type": { "text": "boolean" } } }, { "kind": "field", "name": "hasLoadingPlaceholder", "privacy": "public", "type": { "text": "boolean" }, "description": "Getter for loading placeholder state.", "return": { "type": { "text": "boolean" } }, "readonly": true, "attribute": "hasLoadingPlaceholder" }, { "kind": "field", "name": "wrapperClasses", "description": "Getter for wrapper classes based on size.", "return": { "type": { "text": "Object" } }, "privacy": "private", "readonly": true }, { "kind": "method", "name": "renderLayout", "description": "Logic to determine the layout of the component.", "privacy": "protected", "return": { "type": { "text": "void" } } }, { "kind": "field", "name": "shape", "privacy": "public", "type": { "text": "string" }, "attribute": "shape", "reflects": true, "description": "Sets the shape of the menu.", "default": "\"box\"", "inheritedFrom": { "name": "AuroElement", "module": "components/layoutElement/src/auroElement.js" } }, { "kind": "field", "name": "size", "privacy": "public", "type": { "text": "string" }, "attribute": "size", "reflects": true, "description": "Sets the size of the menu.", "default": "\"sm\"", "inheritedFrom": { "name": "AuroElement", "module": "components/layoutElement/src/auroElement.js" } }, { "kind": "field", "name": "value", "privacy": "public", "type": { "text": "string" }, "description": "The value of the selected option. In multi-select mode, this is a JSON stringified array of selected option values.", "default": "undefined", "attribute": "value", "reflects": true }, { "kind": "field", "name": "optionSelected", "privacy": "public", "type": { "text": "object" }, "description": "An array of currently selected menu options, type `HTMLElement` by default. In multi-select mode, `optionSelected` is an array of HTML elements.", "default": "undefined", "attribute": "optionSelected" }, { "kind": "field", "name": "matchWord", "privacy": "public", "type": { "text": "string" }, "description": "Specifies a string used to highlight matched string parts in options.", "default": "undefined", "attribute": "matchword" }, { "kind": "field", "name": "noCheckmark", "privacy": "public", "type": { "text": "boolean" }, "description": "When true, selected option will not show the checkmark.", "default": "false", "attribute": "nocheckmark", "reflects": true }, { "kind": "field", "name": "optionActive", "privacy": "public", "type": { "text": "object" }, "description": "Specifies the current active menuOption.", "default": "undefined", "attribute": "optionactive" }, { "kind": "field", "name": "loading", "privacy": "public", "type": { "text": "boolean" }, "description": "When true, displays a loading state using the loadingIcon and loadingText slots if provided.", "default": "false", "attribute": "loading", "reflects": true }, { "kind": "field", "name": "multiSelect", "privacy": "public", "type": { "text": "boolean" }, "description": "When true, the selected option can be multiple options.", "default": "false", "attribute": "multiselect", "reflects": true }, { "kind": "field", "name": "allowDeselect", "privacy": "public", "type": { "text": "boolean" }, "description": "Allows deselecting an already selected option when clicked again in single-select mode.", "default": "false", "attribute": "allowDeselect", "reflects": true }, { "kind": "field", "name": "selectAllMatchingOptions", "privacy": "public", "type": { "text": "boolean" }, "description": "When true, selects all options that match the provided value/key when setting value and multiselect is enabled.", "default": "false", "attribute": "selectAllMatchingOptions", "reflects": true }, { "kind": "field", "name": "disabled", "privacy": "public", "type": { "text": "boolean" }, "description": "When true, the entire menu and all options are disabled.", "attribute": "disabled", "reflects": true }, { "kind": "field", "name": "layout", "privacy": "public", "type": { "text": "string" }, "description": "Defines the language of an element.", "default": "{'default'}", "attribute": "layout", "reflects": true, "inheritedFrom": { "name": "AuroElement", "module": "components/layoutElement/src/auroElement.js" } }, { "kind": "field", "name": "level", "privacy": "private", "type": { "text": "number" }, "description": "Indent level for submenus." }, { "kind": "field", "name": "options", "privacy": "public", "type": { "text": "array" }, "description": "Available menu options", "readonly": true }, { "kind": "field", "name": "componentHasFocus", "description": "Returns true if the element has focus.", "privacy": "private", "return": { "type": { "text": "boolean" } }, "readonly": true, "inheritedFrom": { "name": "AuroElement", "module": "components/layoutElement/src/auroElement.js" } }, { "kind": "method", "name": "resetShapeClasses", "inheritedFrom": { "name": "AuroElement", "module": "components/layoutElement/src/auroElement.js" } }, { "kind": "method", "name": "resetLayoutClasses", "inheritedFrom": { "name": "AuroElement", "module": "components/layoutElement/src/auroElement.js" } }, { "kind": "method", "name": "updateComponentArchitecture", "inheritedFrom": { "name": "AuroElement", "module": "components/layoutElement/src/auroElement.js" } }, { "kind": "field", "name": "onDark", "privacy": "public", "type": { "text": "boolean" }, "attribute": "ondark", "reflects": true, "inheritedFrom": { "name": "AuroElement", "module": "components/layoutElement/src/auroElement.js" } } ], "events": [ { "name": "auroMenu-optionsChange", "type": { "text": "CustomEvent" } }, { "type": { "text": "CustomEvent" }, "description": "Notifies that a menuoption has been made `active`.", "name": "auroMenu-activatedOption" }, { "type": { "text": "CustomEvent" }, "description": "Notifies that a custom event has been fired.", "name": "auroMenu-customEventFired" }, { "type": { "text": "CustomEvent<{ loading: boolean; hasLoadingPlaceholder: boolean; }>" }, "description": "Notifies when the loading attribute is changed.", "name": "auroMenu-loadingChange" }, { "type": { "text": "CustomEvent" }, "description": "Notifies that an attempt to select a menuoption by matching a value has failed.", "name": "auroMenu-selectValueFailure" }, { "type": { "text": "CustomEvent" }, "description": "Notifies that the component value has been reset.", "name": "auroMenu-selectValueReset" }, { "type": { "text": "CustomEvent" }, "description": "Notifies that a new menuoption selection has been made.", "name": "auroMenu-selectedOption" } ], "attributes": [ { "name": "allowDeselect", "type": { "text": "boolean" }, "description": "Allows deselecting an already selected option when clicked again in single-select mode.", "default": "false", "fieldName": "allowDeselect" }, { "name": "disabled", "type": { "text": "boolean" }, "description": "When true, the entire menu and all options are disabled.", "fieldName": "disabled" }, { "name": "hasLoadingPlaceholder", "type": { "text": "boolean" }, "description": "Getter for loading placeholder state.", "return": { "type": { "text": "boolean" } }, "readonly": true, "fieldName": "hasLoadingPlaceholder" }, { "name": "layout", "type": { "text": "string" }, "description": "Defines the language of an element.", "default": "{'default'}", "fieldName": "layout", "inheritedFrom": { "name": "AuroElement", "module": "components/layoutElement/src/auroElement.js" } }, { "name": "loading", "type": { "text": "boolean" }, "description": "When true, displays a loading state using the loadingIcon and loadingText slots if provided.", "default": "false", "fieldName": "loading" }, { "name": "matchword", "type": { "text": "string" }, "description": "Specifies a string used to highlight matched string parts in options.", "default": "undefined", "fieldName": "matchWord" }, { "name": "multiselect", "type": { "text": "boolean" }, "description": "When true, the selected option can be multiple options.", "default": "false", "fieldName": "multiSelect" }, { "name": "nocheckmark", "type": { "text": "boolean" }, "description": "When true, selected option will not show the checkmark.", "default": "false", "fieldName": "noCheckmark" }, { "name": "optionactive", "type": { "text": "object" }, "description": "Specifies the current active menuOption.", "default": "undefined", "fieldName": "optionActive" }, { "name": "optionSelected", "type": { "text": "object" }, "description": "An array of currently selected menu options, type `HTMLElement` by default. In multi-select mode, `optionSelected` is an array of HTML elements.", "default": "undefined", "fieldName": "optionSelected" }, { "name": "size", "type": { "text": "string" }, "fieldName": "size", "description": "Sets the size of the menu.", "default": "\"sm\"", "inheritedFrom": { "name": "AuroElement", "module": "components/layoutElement/src/auroElement.js" } }, { "name": "selectAllMatchingOptions", "type": { "text": "boolean" }, "description": "When true, selects all options that match the provided value/key when setting value and multiselect is enabled.", "default": "false", "fieldName": "selectAllMatchingOptions" }, { "name": "shape", "type": { "text": "string" }, "fieldName": "shape", "description": "Sets the shape of the menu.", "default": "\"box\"", "inheritedFrom": { "name": "AuroElement", "module": "components/layoutElement/src/auroElement.js" } }, { "name": "value", "type": { "text": "string" }, "description": "The value of the selected option. In multi-select mode, this is a JSON stringified array of selected option values.", "default": "undefined", "fieldName": "value" }, { "name": "ondark", "type": { "text": "boolean" }, "fieldName": "onDark", "inheritedFrom": { "name": "AuroElement", "module": "components/layoutElement/src/auroElement.js" } } ], "superclass": { "name": "AuroElement", "module": "/components/layoutElement/src/auroElement.js" }, "tagName": "auro-menu", "customElement": true } ], "exports": [ { "kind": "js", "name": "AuroMenu", "declaration": { "name": "AuroMenu", "module": "components/menu/src/auro-menu.js" } } ] }, { "kind": "javascript-module", "path": "components/menu/src/auro-menuoption.js", "declarations": [ { "kind": "class", "description": "", "name": "AuroMenuOption", "members": [ { "kind": "method", "name": "register", "static": true, "parameters": [ { "name": "name", "default": "\"auro-menuoption\"", "description": "The name of the element that you want to register.", "optional": true, "type": { "text": "string" } } ], "description": "This will register this element with the browser." }, { "kind": "field", "name": "isActive", "description": "Returns whether the menu option is currently active and selectable.\nAn option is considered active if it is not hidden, not disabled, and not static.", "return": { "type": { "text": "boolean" } }, "readonly": true }, { "kind": "method", "name": "bindEvents", "description": "Sets up event listeners for user interaction with the menu option.\nThis function enables click and mouse enter events to trigger selection and highlighting logic." }, { "kind": "method", "name": "attachTo", "parameters": [ { "name": "service", "description": "The menu service instance to attach to.", "type": { "text": "Object" } } ], "description": "Attaches this menu option to a menu service and subscribes to its events.\nThis method enables the option to participate in menu selection and highlighting logic." }, { "kind": "method", "name": "handleMenuChange", "parameters": [ { "name": "event", "description": "The event object from the menu service.", "type": { "text": "Object" } } ], "description": "Handles changes from the menu service and updates the option's state.\nThis function synchronizes the option's properties and selection/highlight state with menu events." }, { "kind": "method", "name": "setInternalSelected", "parameters": [ { "name": "isSelected", "description": "Whether the option should be marked as selected.", "type": { "text": "boolean" } } ], "description": "Updates the internal selected state of the menu option bypassing 'updated' and triggers custom events if selected.\nThis function ensures the option's selection state is synchronized with menu logic and notifies listeners." }, { "kind": "method", "name": "setSelected", "parameters": [ { "name": "isSelected", "description": "Whether the option should be marked as selected.", "type": { "text": "boolean" } } ], "description": "Sets the selected state of the menu option.\nThis function updates whether the option is currently selected.", "deprecated": "Simply modify the `selected` property directly instead." }, { "kind": "method", "name": "updateActive", "parameters": [ { "name": "isActive", "description": "Whether the option should be marked as active.", "type": { "text": "boolean" } } ], "description": "Updates the active state and visual highlighting of the menu option.\nThis function toggles the option's active status and applies or removes the active CSS class.", "deprecated": "Simply modify the `active` property directly instead." }, { "kind": "method", "name": "updateActiveClasses", "description": "Updates the CSS class for the menu option based on its active state.\nThis function adds or removes the 'active' class to visually indicate the option's active status.", "privacy": "private" }, { "kind": "method", "name": "updateTextHighlight", "description": "Updates the visual highlighting of text within the menu option based on the current match word.\nThis function highlights matching text segments and manages nested spacers for display formatting.", "privacy": "private" }, { "kind": "method", "name": "handleClick", "description": "Handles click events on the menu option, toggling its selected state.\nThis function dispatches a click event and updates selection if the option is not disabled.", "privacy": "private" }, { "kind": "method", "name": "handleMouseEnter", "description": "Handles mouse enter events to highlight the menu option.\nThis function updates the menu service to set this option as the currently highlighted item if not disabled.", "privacy": "private" }, { "kind": "method", "name": "handleCustomEvent", "description": "Dispatches custom events defined for this menu option.\nThis function notifies listeners when a custom event is triggered by the option.", "privacy": "private" }, { "kind": "method", "name": "dispatchClickEvent", "description": "Dispatches a click event for this menu option.\nThis function notifies listeners that the option has been clicked.", "privacy": "private" }, { "kind": "method", "name": "generateIconHtml", "parameters": [ { "name": "svgContent", "description": "The SVG content to be embedded.", "type": { "text": "string" } } ], "description": "Generates an HTML element containing an SVG icon based on the provided `svgContent`.", "privacy": "private", "return": { "type": { "text": "Element" } } }, { "kind": "method", "name": "renderLayout", "description": "Logic to determine the layout of the component.", "privacy": "protected", "return": { "type": { "text": "void" } } }, { "kind": "field", "name": "shape", "privacy": "public", "type": { "text": "string" }, "attribute": "shape", "reflects": true, "default": "undefined", "inheritedFrom": { "name": "AuroElement", "module": "components/layoutElement/src/auroElement.js" } }, { "kind": "field", "name": "size", "privacy": "public", "type": { "text": "string" }, "attribute": "size", "reflects": true, "default": "undefined", "inheritedFrom": { "name": "AuroElement", "module": "components/layoutElement/src/auroElement.js" } }, { "kind": "field", "name": "iconTag" }, { "kind": "field", "name": "selected", "privacy": "public", "type": { "text": "boolean" }, "description": "Specifies that an option is selected.", "default": "false", "attribute": "selected", "reflects": true }, { "kind": "field", "name": "noCheckmark", "privacy": "private", "type": { "text": "boolean" }, "default": "false", "attribute": "noCheckmark", "reflects": true }, { "kind": "field", "name": "disabled", "privacy": "public", "type": { "text": "boolean" }, "description": "When true, disables the menu option.", "default": "false", "attribute": "disabled", "reflects": true }, { "kind": "field", "name": "runtimeUtils", "privacy": "private", "default": "new AuroLibraryRuntimeUtils()" }, { "kind": "field", "name": "menuService", "privacy": "private", "type": { "text": "null" }, "default": "null", "attribute": "menuService" }, { "kind": "field", "name": "unsubscribe", "type": { "text": "null" }, "default": "null" }, { "kind": "field", "name": "event", "privacy": "private", "type": { "text": "string" }, "attribute": "event", "reflects": true }, { "kind": "field", "name": "layout", "privacy": "public", "type": { "text": "string" }, "description": "Defines the language of an element.", "default": "{'default'}", "attribute": "layout", "reflects": true, "inheritedFrom": { "name": "AuroElement", "module": "components/layoutElement/src/auroElement.js" } }, { "kind": "field", "name": "key", "privacy": "public", "type": { "text": "string" }, "description": "Allows users to set a unique key for the menu option for specified option selection. If no key is provided, the value property will be used.", "attribute": "key", "reflects": true }, { "kind": "field", "name": "matchWord", "privacy": "private", "type": { "text": "string" }, "attribute": "matchWord" }, { "kind": "field", "name": "tabIndex", "privacy": "public", "type": { "text": "number" }, "description": "Specifies the tab index of the menu option.", "attribute": "tabIndex", "reflects": true }, { "kind": "field", "name": "value", "privacy": "public", "type": { "text": "string" }, "description": "Specifies the value to be sent to a server.", "attribute": "value", "reflects": true }, { "kind": "field", "name": "componentHasFocus", "description": "Returns true if the element has focus.", "privacy": "private", "return": { "type": { "text": "boolean" } }, "readonly": true, "inheritedFrom": { "name": "AuroElement", "module": "components/layoutElement/src/auroElement.js" } }, { "kind": "method", "name": "resetShapeClasses", "inheritedFrom": { "name": "AuroElement", "module": "components/layoutElement/src/auroElement.js" } }, { "kind": "method", "name": "resetLayoutClasses", "inheritedFrom": { "name": "AuroElement", "module": "components/layoutElement/src/auroElement.js" } }, { "kind": "method", "name": "updateComponentArchitecture", "inheritedFrom": { "name": "AuroElement", "module": "components/layoutElement/src/auroElement.js" } }, { "kind": "field", "name": "onDark", "privacy": "public", "type": { "text": "boolean" }, "attribute": "ondark", "reflects": true, "inheritedFrom": { "name": "AuroElement", "module": "components/layoutElement/src/auroElement.js" } } ], "events": [ { "name": "auroMenuOption-mouseover", "type": { "text": "CustomEvent" } }, { "name": "auroMenuOption-click", "type": { "text": "CustomEvent" } } ], "attributes": [ { "name": "disabled", "type": { "text": "boolean" }, "description": "When true, disables the menu option.", "default": "false", "fieldName": "disabled" }, { "name": "event", "type": { "text": "string" }, "fieldName": "event" }, { "name": "layout", "type": { "text": "string" }, "description": "Defines the language of an element.", "default": "{'default'}", "fieldName": "layout", "inheritedFrom": { "name": "AuroElement", "module": "components/layoutElement/src/auroElement.js" } }, { "name": "key", "type": { "text": "string" }, "description": "Allows users to set a unique key for the menu option for specified option selection. If no key is provided, the value property will be used.", "fieldName": "key" }, { "name": "menuService", "type": { "text": "null" }, "default": "null", "fieldName": "menuService" }, { "name": "matchWord", "type": { "text": "string" }, "fieldName": "matchWord" }, { "name": "noCheckmark", "type": { "text": "boolean" }, "default": "false", "fieldName": "noCheckmark" }, { "name": "selected", "type": { "text": "boolean" }, "description": "Specifies that an option is selected.", "default": "false", "fieldName": "selected" }, { "name": "tabIndex", "type": { "text": "number" }, "description": "Specifies the tab index of the menu option.", "fieldName": "tabIndex" }, { "name": "value", "type": { "text": "string" }, "description": "Specifies the value to be sent to a server.", "fieldName": "value" }, { "name": "shape", "type": { "text": "string" }, "fieldName": "shape", "inheritedFrom": { "name": "AuroElement", "module": "components/layoutElement/src/auroElement.js" } }, { "name": "size", "type": { "text": "string" }, "fieldName": "size", "inheritedFrom": { "name": "AuroElement", "module": "components/layoutElement/src/auroElement.js" } }, { "name": "ondark", "type": { "text": "boolean" }, "fieldName": "onDark", "inheritedFrom": { "name": "AuroElement", "module": "components/layoutElement/src/auroElement.js" } } ], "superclass": { "name": "AuroElement", "module": "/components/layoutElement/src/auroElement.js" } } ], "exports": [ { "kind": "js", "name": "AuroMenuOption", "declaration": { "name": "AuroMenuOption", "module": "components/menu/src/auro-menuoption.js" } } ] }, { "kind": "javascript-module", "path": "components/menu/src/iconVersion.js", "declarations": [], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "9.1.2", "module": "components/menu/src/iconVersion.js" } } ] }, { "kind": "javascript-module", "path": "components/menu/src/index.js", "declarations": [], "exports": [ { "kind": "js", "name": "AuroMenu", "declaration": { "name": "AuroMenu", "module": "components/menu/src/index.js" } }, { "kind": "js", "name": "AuroMenuOption", "declaration": { "name": "AuroMenuOption", "module": "components/menu/src/index.js" } }, { "kind": "js", "name": "arrayConverter", "declaration": { "name": "arrayConverter", "module": "./auro-menu-utils.js" } }, { "kind": "js", "name": "isOptionInteractive", "declaration": { "name": "isOptionInteractive", "module": "./auro-menu-utils.js" } }, { "kind": "js", "name": "dispatchMenuEvent", "declaration": { "name": "dispatchMenuEvent", "module": "./auro-menu-utils.js" } } ] }, { "kind": "javascript-module", "path": "components/menu/src/registered.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "components/radio/src/auro-radio-group.js", "declarations": [ { "kind": "class", "description": "The `auro-radio-group` element is used to group a set `auro-radio` elements.", "name": "AuroRadioGroup", "cssParts": [ { "description": "Apply css to the fieldset element in the shadow DOM", "name": "radio-group" } ], "slots": [ { "type": { "text": "HTMLSlotElement" }, "description": "Allows for the legend to be overridden.", "name": "legend" }, { "type": { "text": "HTMLSlotElement" }, "description": "Allows overriding the optional display text \"(optional)\", which appears next to the label.", "name": "optionalLabel" }, { "type": { "text": "HTMLSlotElement" }, "description": "Allows for the helper text to be overridden.", "name": "helpText" } ], "members": [ { "kind": "method", "name": "_initializeDefaults" }, { "kind": "method", "name": "register", "static": true, "parameters": [ { "name": "name", "default": "\"auro-radio-group\"", "description": "The name of the element that you want to register.", "optional": true, "type": { "text": "string" } } ], "description": "This will register this element with the browser." }, { "kind": "method", "name": "handleSelection", "parameters": [ { "name": "event", "description": "The trigger event tied to this function.", "type": { "text": "Event" } } ], "description": "Method for handling of selection of a radio element.", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "handleRadioBlur", "description": "Method handles radio element blur.", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "reset", "description": "Resets component to initial state.", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "validate", "parameters": [ { "name": "force", "default": "false", "description": "Whether to force validation.", "optional": true, "type": { "text": "boolean" } } ], "description": "Validates value." }, { "kind": "method", "name": "resetRadio", "description": "Method handles the reset event from a radio element.", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "handleItems", "description": "Method for handling the attributes of each radio input.", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "handleSlotChange", "description": "Method for handling slot content changes.", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "handleLegendSlotChange", "description": "Method for handling legend slot changes.", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "initializeIndex", "description": "Method for initializing the tab index of the checked radio input.", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "handleToggleSelected", "parameters": [ { "name": "event", "description": "The trigger event tied to this function.", "type": { "text": "Event" } } ], "description": "Method for handling a newly selected radio input.", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "selectItem", "parameters": [ { "name": "index", "description": "The value of the element's index attribute.", "type": { "text": "Number" } } ], "description": "Method for selecting a radio input.", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "selectNextItem", "parameters": [ { "name": "index", "description": "The value of the element's index attribute.", "type": { "text": "Number" } }, { "name": "moveDirection", "description": "Arrow key pressed by user.", "type": { "text": "String" } } ], "description": "Method for selecting the next radio input.", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "handleKeyDown", "parameters": [ { "name": "event", "description": "The trigger event tied to this function.", "type": { "text": "Event" } } ], "description": "Method for handling a keydown event.", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "field", "name": "appearance", "privacy": "public", "type": { "text": "'default' | 'inverse'" }, "description": "Defines whether the component will be on lighter or darker backgrounds.", "default": "'default'", "attribute": "appearance", "reflects": true }, { "kind": "field", "name": "disabled", "privacy": "public", "type": { "text": "boolean" }, "description": "If true, all radio buttons will be disabled.", "attribute": "disabled", "reflects": true }, { "kind": "field", "name": "error", "privacy": "public", "type": { "text": "string" }, "description": "If true, sets persistent validity to `customError` and sets `setCustomValidity` = attribute value.", "attribute": "error", "reflects": true }, { "kind": "field", "name": "hasLegend", "privacy": "private", "type": { "text": "boolean" }, "description": "Indicates whether the legend slot is set or not." }, { "kind": "field", "name": "horizontal", "privacy": "public", "type": { "text": "boolean" }, "description": "If true, displays radio buttons horizontally.", "attribute": "horizontal" }, { "kind": "field", "name": "noValidate", "privacy": "public", "type": { "text": "boolean" }, "description": "If true, disables auto-validation on blur.", "attribute": "noValidate", "reflects": true }, { "kind": "field", "name": "onDark", "privacy": "public", "type": { "text": "boolean" }, "description": "DEPRECATED - use `appearance=\"inverse\"` instead.", "attribute": "onDark", "reflects": true }, { "kind": "field", "name": "optionSelected", "privacy": "public", "type": { "text": "object" }, "description": "Specifies the current selected radio button.", "attribute": "optionSelected" }, { "kind": "field", "name": "required", "privacy": "public", "type": { "text": "boolean" }, "description": "Populates the `required` attribute on the element. Used for client-side validation.", "attribute": "required", "reflects": true }, { "kind": "field", "name": "setCustomValidity", "privacy": "public", "type": { "text": "string" }, "description": "Sets a custom help text message to display for all validityStates.", "attribute": "setCustomValidity" }, { "kind": "field", "name": "setCustomValidityCustomError", "privacy": "public", "type": { "text": "string" }, "description": "Custom help text message to display when validity = `customError`.", "attribute": "setCustomValidityCustomError" }, { "kind": "field", "name": "setCustomValidityValueMissing", "privacy": "public", "type": { "text": "string" }, "description": "Custom help text message to display when validity = `valueMissing`.", "attribute": "setCustomValidityValueMissing" }, { "kind": "field", "name": "touched", "privacy": "private", "type": { "text": "boolean" }, "description": "Indicates whether the radio group is in a dirty state (has been interacted with)." }, { "kind": "field", "name": "validity", "privacy": "public", "type": { "text": "string" }, "description": "Specifies the `validityState` this element is in.", "attribute": "validity", "reflects": true }, { "kind": "field", "name": "value", "privacy": "public", "type": { "text": "string" }, "description": "Specifies the current value of the selected radio button.", "attribute": "value" } ], "events": [ { "name": "input", "type": { "text": "CustomEvent" }, "description": "Notifies every time the value prop of the element is changed." }, { "description": "Notifies that the element has been validated.", "name": "auroFormElement-validated" } ], "attributes": [ { "name": "appearance", "type": { "text": "'default' | 'inverse'" }, "description": "Defines whether the component will be on lighter or darker backgrounds.", "default": "'default'", "fieldName": "appearance" }, { "name": "disabled", "type": { "text": "boolean" }, "description": "If true, all radio buttons will be disabled.", "fieldName": "disabled" }, { "name": "error", "type": { "text": "string" }, "description": "If true, sets persistent validity to `customError` and sets `setCustomValidity` = attribute value.", "fieldName": "error" }, { "name": "horizontal", "type": { "text": "boolean" }, "description": "If true, displays radio buttons horizontally.", "fieldName": "horizontal" }, { "name": "noValidate", "type": { "text": "boolean" }, "description": "If true, disables auto-validation on blur.", "fieldName": "noValidate" }, { "name": "onDark", "type": { "text": "boolean" }, "description": "DEPRECATED - use `appearance=\"inverse\"` instead.", "fieldName": "onDark" }, { "name": "optionSelected", "type": { "text": "object" }, "description": "Specifies the current selected radio button.", "fieldName": "optionSelected" }, { "name": "required", "type": { "text": "boolean" }, "description": "Populates the `required` attribute on the element. Used for client-side validation.", "fieldName": "required" }, { "name": "setCustomValidity", "type": { "text": "string" }, "description": "Sets a custom help text message to display for all validityStates.", "fieldName": "setCustomValidity" }, { "name": "setCustomValidityCustomError", "type": { "text": "string" }, "description": "Custom help text message to display when validity = `customError`.", "fieldName": "setCustomValidityCustomError" }, { "name": "setCustomValidityValueMissing", "type": { "text": "string" }, "description": "Custom help text message to display when validity = `valueMissing`.", "fieldName": "setCustomValidityValueMissing" }, { "name": "validity", "type": { "text": "string" }, "description": "Specifies the `validityState` this element is in.", "fieldName": "validity" }, { "name": "value", "type": { "text": "string" }, "description": "Specifies the current value of the selected radio button.", "fieldName": "value" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "auro-radio-group", "customElement": true } ], "exports": [ { "kind": "js", "name": "AuroRadioGroup", "declaration": { "name": "AuroRadioGroup", "module": "components/radio/src/auro-radio-group.js" } } ] }, { "kind": "javascript-module", "path": "components/radio/src/auro-radio.js", "declarations": [ { "kind": "class", "description": "The `auro-radio` element is used to a button that allows the user to select one option from a set.", "name": "AuroRadio", "cssParts": [ { "description": "apply css to a specific checkbox.", "name": "radio" }, { "description": "apply css to a specific checkbox's input.", "name": "radio-input" }, { "description": "apply css to a specific checkbox's label.", "name": "radio-label" } ], "members": [ { "kind": "method", "name": "_initializeDefaults" }, { "kind": "method", "name": "register", "static": true, "parameters": [ { "name": "name", "default": "\"auro-radio\"", "description": "The name of the element that you want to register.", "optional": true, "type": { "text": "string" } } ], "description": "This will register this element with the browser." }, { "kind": "method", "name": "handleChange", "parameters": [ { "name": "event", "description": "The trigger event tied to this function.", "type": { "text": "Event" } } ], "description": "Method for handling content when change event is fired.", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "handleInput", "parameters": [ { "name": "event", "description": "The trigger event tied to this function.", "type": { "text": "Event" } } ], "description": "Method for handling content when input event is fired.", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "handleFocus", "parameters": [ { "name": "event", "description": "The trigger event tied to this function.", "type": { "text": "Event" } } ], "description": "Method for handling focus event.", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "handleBlur", "parameters": [ { "name": "event", "description": "The trigger event tied to this function.", "type": { "text": "Event" } } ], "description": "Method for handling blur event.", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "reset", "description": "Resets component to initial state.", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "isRequired", "parameters": [ { "name": "required", "description": "The element's required attribute.", "type": { "text": "Boolean" } } ], "description": "Method for handling passing the required status to aria.", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "field", "name": "appearance", "privacy": "public", "type": { "text": "'default' | 'inverse'" }, "description": "Defines whether the component will be on lighter or darker backgrounds.", "default": "'default'", "attribute": "appearance", "reflects": true }, { "kind": "field", "name": "checked", "privacy": "public", "type": { "text": "boolean" }, "description": "If set to true, the radio button will be filled.", "attribute": "checked", "reflects": true }, { "kind": "field", "name": "disabled", "privacy": "public", "type": { "text": "boolean" }, "description": "If set to true, the radio button will be non-clickable.", "attribute": "disabled", "reflects": true }, { "kind": "field", "name": "error", "privacy": "public", "type": { "text": "boolean" }, "description": "If set to true, sets an error state on the radio button.", "attribute": "error", "reflects": true }, { "kind": "field", "name": "id", "privacy": "public", "type": { "text": "string" }, "description": "The id global attribute defines an identifier (ID) which must be unique in the whole document.", "attribute": "id", "reflects": true }, { "kind": "field", "name": "inputId", "privacy": "private", "type": { "text": "string" }, "description": "ID for input node." }, { "kind": "field", "name": "label", "privacy": "public", "type": { "text": "string" }, "description": "Label for the radio button.", "attribute": "label" }, { "kind": "field", "name": "name", "privacy": "public", "type": { "text": "string" }, "description": "Name for the radio button group.", "attribute": "name" }, { "kind": "field", "name": "onDark", "privacy": "public", "type": { "text": "boolean" }, "description": "DEPRECATED - use `appearance=\"inverse\"` instead.", "attribute": "onDark", "reflects": true }, { "kind": "field", "name": "required", "privacy": "public", "type": { "text": "boolean" }, "description": "Defines element as required.", "attribute": "required", "reflects": true }, { "kind": "field", "name": "role", "privacy": "private", "type": { "text": "string" }, "description": "Don't add to api.md since changing of this can easily break a11y.", "attribute": "role", "reflects": true }, { "kind": "field", "name": "touched", "privacy": "private", "type": { "text": "boolean" }, "description": "Whether or not the radio button has been touched by the user." }, { "kind": "field", "name": "value", "privacy": "public", "type": { "text": "string" }, "description": "The value of the radio button.", "attribute": "value" } ], "events": [ { "name": "toggleSelected", "type": { "text": "CustomEvent" }, "description": "Notifies that the component has toggled the checked/selected state." }, { "name": "focusSelected", "type": { "text": "CustomEvent" }, "description": "Notifies that the component has gained focus." }, { "name": "auroRadio-blur", "type": { "text": "CustomEvent" }, "description": "Notifies that the component has lost focus." }, { "name": "resetRadio", "type": { "text": "CustomEvent" }, "description": "Notifies that the component has reset the checked/selected state." }, { "name": "auroRadio-selected", "type": { "text": "CustomEvent" }, "description": "Notifies that the component has been marked as checked/selected." }, { "type": { "text": "CustomEvent" }, "description": "(Deprecated) Notifies when checked value is changed.", "name": "change" }, { "type": { "text": "InputEvent" }, "description": "Notifies when when checked value is changed by user's interface.", "name": "input" } ], "attributes": [ { "name": "appearance", "type": { "text": "'default' | 'inverse'" }, "description": "Defines whether the component will be on lighter or darker backgrounds.", "default": "'default'", "fieldName": "appearance" }, { "name": "checked", "type": { "text": "boolean" }, "description": "If set to true, the radio button will be filled.", "fieldName": "checked" }, { "name": "disabled", "type": { "text": "boolean" }, "description": "If set to true, the radio button will be non-clickable.", "fieldName": "disabled" }, { "name": "error", "type": { "text": "boolean" }, "description": "If set to true, sets an error state on the radio button.", "fieldName": "error" }, { "name": "id", "type": { "text": "string" }, "description": "The id global attribute defines an identifier (ID) which must be unique in the whole document.", "fieldName": "id" }, { "name": "label", "type": { "text": "string" }, "description": "Label for the radio button.", "fieldName": "label" }, { "name": "name", "type": { "text": "string" }, "description": "Name for the radio button group.", "fieldName": "name" }, { "name": "onDark", "type": { "text": "boolean" }, "description": "DEPRECATED - use `appearance=\"inverse\"` instead.", "fieldName": "onDark" }, { "name": "required", "type": { "text": "boolean" }, "description": "Defines element as required.", "fieldName": "required" }, { "name": "role", "type": { "text": "string" }, "description": "Don't add to api.md since changing of this can easily break a11y.", "fieldName": "role" }, { "name": "value", "type": { "text": "string" }, "description": "The value of the radio button.", "fieldName": "value" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "auro-radio", "customElement": true } ], "exports": [ { "kind": "js", "name": "AuroRadio", "declaration": { "name": "AuroRadio", "module": "components/radio/src/auro-radio.js" } } ] }, { "kind": "javascript-module", "path": "components/radio/src/index.js", "declarations": [], "exports": [ { "kind": "js", "name": "AuroRadio", "declaration": { "name": "AuroRadio", "module": "components/radio/src/index.js" } }, { "kind": "js", "name": "AuroRadioGroup", "declaration": { "name": "AuroRadioGroup", "module": "components/radio/src/index.js" } } ] }, { "kind": "javascript-module", "path": "components/radio/src/registered.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "components/select/src/auro-select.js", "declarations": [ { "kind": "class", "description": "The `auro-select` element is a wrapper for auro-dropdown and auro-menu to create a dropdown menu control.", "name": "AuroSelect", "cssParts": [ { "description": "Apply CSS to the trigger content container.", "name": "dropdownTrigger" }, { "description": "Apply CSS to the collapsed/expanded state icon container.", "name": "dropdownChevron" }, { "description": "Apply size styles to the dropdown bib (height, width, maxHeight, maxWidth only).", "name": "dropdownSize" }, { "description": "Apply CSS to the help text.", "name": "helpText" } ], "slots": [ { "description": "Default slot for the menu content.", "name": "" }, { "description": "Sets aria-label on close button in fullscreen bib", "name": "ariaLabel.bib.close" }, { "description": "Defines the headline to display above menu-options", "name": "bib.fullscreen.headline" }, { "description": "Defines the content of the label.", "name": "label" }, { "type": { "text": "HTMLSlotElement" }, "description": "Allows overriding the optional display text \"(optional)\", which appears next to the label.", "name": "optionalLabel" }, { "description": "Defines the content of the helpText.", "name": "helpText" }, { "description": "Dropdown value text display.", "name": "valueText" }, { "description": "Allows custom HTML content to display the selected value when select is not focused.", "name": "displayValue" } ], "members": [ { "kind": "method", "name": "_initializeDefaults", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "field", "name": "formattedValue", "description": "Formatted value based on `multiSelect` state.\nDefault type is `String`, changing to `Array` when `multiSelect` is true.", "privacy": "private", "return": { "type": { "text": "String|Array" } }, "readonly": true }, { "kind": "field", "name": "commonLabelClasses", "description": "Returns classmap configuration for html5 input labels in all layouts.", "privacy": "private", "return": { "type": { "text": "Record" } }, "readonly": true }, { "kind": "field", "name": "labelFontClass", "description": "Returns the label font class based on layout and selection state.", "privacy": "private", "return": { "type": { "text": "string" } }, "readonly": true }, { "kind": "field", "name": "hasValue", "description": "Whether or not the component has a value.", "return": { "type": { "text": "boolean" } }, "privacy": "private", "readonly": true }, { "kind": "method", "name": "configureDropdown", "description": "Binds all behavior needed to the dropdown after rendering.", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "register", "static": true, "parameters": [ { "name": "name", "default": "\"auro-select\"", "description": "The name of element that you want to register to.", "optional": true, "type": { "text": "string" } } ], "description": "This will register this element with the browser." }, { "kind": "method", "name": "updateDisplayedValue", "description": "Updates the displayed value in an Auro dropdown component based on optionSelected.", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "updateMenuShapeSize", "description": "Update menu to default for fullscreen bib, otherwise to this.size and this.shape.", "privacy": "private" }, { "kind": "method", "name": "updateOptionPositions", "description": "Sets aria-setsize and aria-posinset on each menu option so screen readers\ncan announce position even when the listbox context is broken by\nshadow DOM boundaries.", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "configureMenu", "description": "Binds all behavior needed to the menu after rendering.", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "configureSelect", "description": "Binds all behavior needed to the component after rendering.", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "updateActiveOption", "parameters": [ { "name": "index", "description": "Index of the option to make active.", "type": { "text": "number" } } ], "description": "Updates the active option in the menu." }, { "kind": "method", "name": "updateActiveOptionBasedOnKey", "parameters": [ { "name": "_key", "description": "The key pressed by the user.", "type": { "text": "string" } } ], "description": "Updates the active option in the menu based on keyboard input.", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "handleMenuLoadingChange", "parameters": [ { "name": "event", "description": "The event object containing details about the loading state change.", "type": { "text": "CustomEvent" } }, { "description": "Indicates whether the menu is currently loading.", "name": "event.detail.loading", "type": { "text": "boolean" } }, { "description": "Indicates if there are loading placeholders present.", "name": "event.detail.hasLoadingPlaceholder", "type": { "text": "boolean" } } ], "description": "Manages the visibility of the dropdown based on loading state changes.\n\nThis method listens for loading state changes and adjusts the visibility of the dropdown accordingly.\nIf the dropdown is visible and loading is true without any loading placeholders, it hides the dropdown\nand sets a flag to indicate it is hidden while loading. If loading is false and the dropdown was previously\nhidden, it checks if the active element is within the dropdown and shows it again if true.", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "hideBib", "description": "Hides the dropdown bib if its open.", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "showBib", "description": "Shows the dropdown bib if there are options to show.", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "handleFocusin", "description": "Function to support", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "handleSlotChange", "parameters": [ { "name": "event", "description": "`slotchange` event.", "type": { "text": "Event" } } ], "description": "Watch for slot changes and recalculate the menuoptions.", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "clearSelection", "description": "Resets all options to their default state.", "privacy": "private" }, { "kind": "method", "name": "setMenuValue", "parameters": [ { "name": "value" } ] }, { "kind": "method", "name": "scrollActiveOptionIntoView", "description": "Scrolls the currently active option into view.\nRespects user's motion preferences for accessibility.", "privacy": "private" }, { "kind": "method", "name": "scrollSelectedOptionIntoView", "description": "Scrolls the currently selected option into view.\nRespects user's motion preferences for accessibility.", "privacy": "private" }, { "kind": "method", "name": "reset", "description": "Resets component to initial state.", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "validate", "parameters": [ { "name": "force", "default": "false", "description": "Whether to force validation.", "optional": true, "type": { "text": "boolean" } } ], "description": "Validates value." }, { "kind": "method", "name": "_handleNativeSelectChange", "parameters": [ { "name": "event", "description": "// The change event from the native select element.", "type": { "text": "Event" } } ], "description": "Syncs the value from the native select element to the component's value.", "return": { "type": { "text": "void" } }, "privacy": "private" }, { "kind": "method", "name": "_updateNativeSelect", "description": "Updates the native select element's value based on the component's value.", "return": { "type": { "text": "void" } }, "privacy": "private" }, { "kind": "method", "name": "renderNativeSelect", "description": "Returns HTML for the hidden HTML5 select.", "privacy": "private", "return": { "type": { "text": "html" } } }, { "kind": "method", "name": "renderHtmlHelpText", "description": "Returns HTML for the help text and error message.", "privacy": "private", "return": { "type": { "text": "html" } } }, { "kind": "method", "name": "renderLayoutEmphasized", "description": "Returns HTML for the emphasized layout.", "privacy": "private", "return": { "type": { "text": "TemplateResult" } } }, { "kind": "method", "name": "renderLayoutSnowflake", "description": "Returns HTML for the snowflake layout.", "privacy": "private", "return": { "type": { "text": "TemplateResult" } } }, { "kind": "method", "name": "renderLayoutClassic", "description": "Returns HTML for the classic layout.", "privacy": "private", "return": { "type": { "text": "TemplateResult" } } }, { "kind": "method", "name": "renderLayout", "parameters": [ { "name": "ForcedLayout", "description": "Used to force a specific layout, pass in the layout name to use.", "optional": true, "type": { "text": "string" } } ], "description": "Logic to determine the layout of the component.", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "field", "name": "matchWidth", "privacy": "public", "type": { "text": "boolean" }, "description": "If declared, the popover and trigger will be set to the same width.", "default": "false", "attribute": "matchWidth", "reflects": true }, { "kind": "field", "name": "placement", "privacy": "public", "type": { "text": "string" }, "description": "Position where the bib should appear relative to the trigger.", "default": "'bottom-start'", "attribute": "placement", "reflects": true }, { "kind": "field", "name": "offset", "privacy": "public", "type": { "text": "number" }, "description": "Gap between the trigger element and bib.", "default": "0", "attribute": "offset", "reflects": true }, { "kind": "field", "name": "noFlip", "privacy": "public", "type": { "text": "boolean" }, "description": "If declared, the bib will NOT flip to an alternate position\nwhen there isn't enough space in the specified `placement`.", "default": "false", "attribute": "noFlip", "reflects": true }, { "kind": "field", "name": "shift", "privacy": "public", "type": { "text": "boolean" }, "description": "If set, the dropdown will shift its position to avoid being cut off by the viewport.", "default": "false", "attribute": "shift", "reflects": true }, { "kind": "field", "name": "autoPlacement", "privacy": "public", "type": { "text": "boolean" }, "description": "If declared, bib's position will be automatically calculated where to appear.", "default": "false", "attribute": "autoPlacement", "reflects": true }, { "kind": "field", "name": "forceDisplayValue", "privacy": "public", "type": { "text": "boolean" }, "description": "If declared, the label and value will be visually hidden and the displayValue will render 100% of the time.", "default": "false", "attribute": "forceDisplayValue", "reflects": true }, { "kind": "field", "name": "uniqueId", "privacy": "private" }, { "kind": "field", "name": "validation", "privacy": "private", "default": "new AuroFormValidation()" }, { "kind": "field", "name": "runtimeUtils", "privacy": "private", "default": "new AuroLibraryRuntimeUtils()" }, { "kind": "field", "name": "dropdownTag", "privacy": "private" }, { "kind": "field", "name": "bibtemplateTag", "privacy": "private" }, { "kind": "field", "name": "helpTextTag", "privacy": "private" }, { "kind": "field", "name": "isHiddenWhileLoading", "type": { "text": "boolean" }, "privacy": "private", "default": "false" }, { "kind": "field", "name": "hasFocus", "privacy": "private", "type": { "text": "boolean" }, "default": "false" }, { "kind": "field", "name": "hasDisplayValueContent", "privacy": "private", "type": { "text": "boolean" }, "default": "false" }, { "kind": "field", "name": "appearance", "privacy": "public", "type": { "text": "'default' | 'inverse'" }, "description": "Defines whether the component will be on lighter or darker backgrounds.", "default": "'default'", "attribute": "appearance", "reflects": true }, { "kind": "field", "name": "autocomplete", "privacy": "public", "type": { "text": "string" }, "description": "If declared, sets the autocomplete attribute for the select element.", "attribute": "autocomplete", "reflects": true }, { "kind": "field", "name": "disabled", "privacy": "public", "type": { "text": "boolean" }, "description": "When attribute is present, element shows disabled state.", "attribute": "disabled", "reflects": true }, { "kind": "field", "name": "error", "privacy": "public", "type": { "text": "string" }, "description": "When defined, sets persistent validity to `customError` and sets `setCustomValidity` = attribute value.", "attribute": "error", "reflects": true }, { "kind": "field", "name": "flexMenuWidth", "privacy": "public", "type": { "text": "boolean" }, "description": "If declared, make the width of the bib match the width of the content, rather than the trigger.", "attribute": "flexMenuWidth", "reflects": true }, { "kind": "field", "name": "fluid", "privacy": "public", "type": { "text": "boolean" }, "description": "When attribute is present, element will be 100% width of container element.", "attribute": "fluid", "reflects": true }, { "kind": "field", "name": "fullscreenBreakpoint", "privacy": "public", "type": { "text": "'xs' | 'sm' | 'md' | 'lg' | 'xl' | 'disabled'" }, "description": "Defines the screen size breakpoint at which the dropdown switches to fullscreen mode on mobile. `disabled` indicates a dropdown should _never_ enter fullscreen.\n\nWhen expanded, the dropdown will automatically display in fullscreen mode\nif the screen size is equal to or smaller than the selected breakpoint.", "default": "'sm'", "attribute": "fullscreenBreakpoint", "reflects": true }, { "kind": "field", "name": "isPopoverVisible", "privacy": "private", "type": { "text": "boolean" }, "attribute": "isPopoverVisible" }, { "kind": "field", "name": "largeFullscreenHeadline", "privacy": "public", "type": { "text": "boolean" }, "description": "If declared, make bib.fullscreen.headline in HeadingDisplay.\nOtherwise, Heading 600.", "attribute": "largeFullscreenHeadline", "reflects": true }, { "kind": "field", "name": "layout", "privacy": "public", "type": { "text": "string" }, "description": "Determines the overall layout of the select component.", "default": "'classic'", "attribute": "layout", "reflects": true, "inheritedFrom": { "name": "AuroElement", "module": "components/layoutElement/src/auroElement.js" } }, { "kind": "field", "name": "multiSelect", "privacy": "public", "type": { "text": "boolean" }, "description": "Sets multi-select mode, allowing multiple options to be selected at once.", "attribute": "multiselect", "reflects": true }, { "kind": "field", "name": "name", "privacy": "public", "type": { "text": "string" }, "description": "The name for the select element.", "attribute": "name", "reflects": true }, { "kind": "field", "name": "noCheckmark", "privacy": "public", "type": { "text": "boolean" }, "description": "When true, checkmark on selected option will no longer be present.", "attribute": "noCheckmark", "reflects": true }, { "kind": "field", "name": "noValidate", "privacy": "public", "type": { "text": "boolean" }, "description": "If set, disables auto-validation on blur.", "attribute": "noValidate", "reflects": true }, { "kind": "field", "name": "onDark", "privacy": "public", "type": { "text": "boolean" }, "attribute": "onDark", "reflects": true, "description": "DEPRECATED - use `appearance=\"inverse\"` instead.", "inheritedFrom": { "name": "AuroElement", "module": "components/layoutElement/src/auroElement.js" } }, { "kind": "field", "name": "options", "privacy": "private", "type": { "text": "array" }, "attribute": "options" }, { "kind": "field", "name": "optionSelected", "privacy": "public", "type": { "text": "HTMLElement|Array" }, "description": "Specifies the current selected menuOption. Default type is `HTMLElement`, changing to `Array` when `multiSelect` is true.", "attribute": "optionSelected" }, { "kind": "field", "name": "placeholder", "privacy": "public", "type": { "text": "string" }, "description": "Define custom placeholder text.", "attribute": "placeholder", "reflects": true }, { "kind": "field", "name": "required", "privacy": "public", "type": { "text": "boolean" }, "description": "Populates the `required` attribute on the element. Used for client-side validation.", "attribute": "required", "reflects": true }, { "kind": "field", "name": "setCustomValidity", "privacy": "public", "type": { "text": "string" }, "description": "Sets a custom help text message to display for all validityStates.", "attribute": "setCustomValidity" }, { "kind": "field", "name": "setCustomValidityCustomError", "privacy": "public", "type": { "text": "string" }, "description": "Custom help text message to display when validity = `customError`.", "attribute": "setCustomValidityCustomError" }, { "kind": "field", "name": "setCustomValidityValueMissing", "privacy": "public", "type": { "text": "string" }, "description": "Custom help text message to display when validity = `valueMissing`.", "attribute": "setCustomValidityValueMissing" }, { "kind": "field", "name": "shape", "privacy": "public", "type": { "text": "string" }, "attribute": "shape", "reflects": true, "description": "Determines the shape of the dropdown bib.", "inheritedFrom": { "name": "AuroElement", "module": "components/layoutElement/src/auroElement.js" } }, { "kind": "field", "name": "size", "privacy": "public", "type": { "text": "string" }, "attribute": "size", "reflects": true, "description": "Determines the size of the dropdown bib. Only the `emphasized` layout supports size=`xl`, while all other layouts support size=`lg`.", "inheritedFrom": { "name": "AuroElement", "module": "components/layoutElement/src/auroElement.js" } }, { "kind": "field", "name": "touched", "privacy": "private", "type": { "text": "boolean" }, "description": "Indicates whether the input is in a dirty state (has been interacted with)." }, { "kind": "field", "name": "validity", "privacy": "public", "type": { "text": "string" }, "description": "Specifies the `validityState` this element is in.", "attribute": "validity", "reflects": true }, { "kind": "field", "name": "value", "privacy": "public", "type": { "text": "string" }, "description": "Value selected for the component.", "attribute": "value", "reflects": true }, { "kind": "field", "name": "componentHasFocus", "description": "Returns true if the element has focus.", "privacy": "private", "return": { "type": { "text": "boolean" } }, "readonly": true, "inheritedFrom": { "name": "AuroElement", "module": "components/layoutElement/src/auroElement.js" } }, { "kind": "method", "name": "resetShapeClasses", "inheritedFrom": { "name": "AuroElement", "module": "components/layoutElement/src/auroElement.js" } }, { "kind": "method", "name": "resetLayoutClasses", "inheritedFrom": { "name": "AuroElement", "module": "components/layoutElement/src/auroElement.js" } }, { "kind": "method", "name": "updateComponentArchitecture", "inheritedFrom": { "name": "AuroElement", "module": "components/layoutElement/src/auroElement.js" } } ], "events": [ { "name": "auroSelect-valueSet", "type": { "text": "CustomEvent" }, "description": "Notifies that the component has a new value set." }, { "name": "input", "type": { "text": "CustomEvent" }, "description": "Notifies every time the value prop of the element is changed. The updated `value` and `optionSelected` will be delivered in `detail` object." }, { "description": "Notifies that the `validity` and `errorMessage` values have changed.", "name": "auroFormElement-validated" } ], "attributes": [ { "name": "appearance", "type": { "text": "'default' | 'inverse'" }, "description": "Defines whether the component will be on lighter or darker backgrounds.", "default": "'default'", "fieldName": "appearance" }, { "name": "autoPlacement", "type": { "text": "boolean" }, "description": "If declared, bib's position will be automatically calculated where to appear.", "default": "false", "fieldName": "autoPlacement" }, { "name": "autocomplete", "type": { "text": "string" }, "description": "If declared, sets the autocomplete attribute for the select element.", "fieldName": "autocomplete" }, { "name": "disabled", "type": { "text": "boolean" }, "description": "When attribute is present, element shows disabled state.", "fieldName": "disabled" }, { "name": "error", "type": { "text": "string" }, "description": "When defined, sets persistent validity to `customError` and sets `setCustomValidity` = attribute value.", "fieldName": "error" }, { "name": "flexMenuWidth", "type": { "text": "boolean" }, "description": "If declared, make the width of the bib match the width of the content, rather than the trigger.", "fieldName": "flexMenuWidth" }, { "name": "fluid", "type": { "text": "boolean" }, "description": "When attribute is present, element will be 100% width of container element.", "fieldName": "fluid" }, { "name": "forceDisplayValue", "type": { "text": "boolean" }, "description": "If declared, the label and value will be visually hidden and the displayValue will render 100% of the time.", "default": "false", "fieldName": "forceDisplayValue" }, { "name": "fullscreenBreakpoint", "type": { "text": "'xs' | 'sm' | 'md' | 'lg' | 'xl' | 'disabled'" }, "description": "Defines the screen size breakpoint at which the dropdown switches to fullscreen mode on mobile. `disabled` indicates a dropdown should _never_ enter fullscreen.\n\nWhen expanded, the dropdown will automatically display in fullscreen mode\nif the screen size is equal to or smaller than the selected breakpoint.", "default": "'sm'", "fieldName": "fullscreenBreakpoint" }, { "name": "isPopoverVisible", "type": { "text": "boolean" }, "fieldName": "isPopoverVisible" }, { "name": "largeFullscreenHeadline", "type": { "text": "boolean" }, "description": "If declared, make bib.fullscreen.headline in HeadingDisplay.\nOtherwise, Heading 600.", "fieldName": "largeFullscreenHeadline" }, { "name": "layout", "type": { "text": "string" }, "description": "Determines the overall layout of the select component.", "default": "'classic'", "fieldName": "layout", "inheritedFrom": { "name": "AuroElement", "module": "components/layoutElement/src/auroElement.js" } }, { "name": "matchWidth", "type": { "text": "boolean" }, "description": "If declared, the popover and trigger will be set to the same width.", "default": "false", "fieldName": "matchWidth" }, { "name": "multiselect", "type": { "text": "boolean" }, "description": "Sets multi-select mode, allowing multiple options to be selected at once.", "fieldName": "multiSelect" }, { "name": "name", "type": { "text": "string" }, "description": "The name for the select element.", "fieldName": "name" }, { "name": "noCheckmark", "type": { "text": "boolean" }, "description": "When true, checkmark on selected option will no longer be present.", "fieldName": "noCheckmark" }, { "name": "noFlip", "type": { "text": "boolean" }, "description": "If declared, the bib will NOT flip to an alternate position\nwhen there isn't enough space in the specified `placement`.", "default": "false", "fieldName": "noFlip" }, { "name": "noValidate", "type": { "text": "boolean" }, "description": "If set, disables auto-validation on blur.", "fieldName": "noValidate" }, { "name": "offset", "type": { "text": "number" }, "description": "Gap between the trigger element and bib.", "default": "0", "fieldName": "offset" }, { "name": "onDark", "type": { "text": "boolean" }, "description": "DEPRECATED - use `appearance=\"inverse\"` instead.", "fieldName": "onDark" }, { "name": "options", "type": { "text": "array" }, "fieldName": "options" }, { "name": "optionSelected", "type": { "text": "HTMLElement|Array" }, "description": "Specifies the current selected menuOption. Default type is `HTMLElement`, changing to `Array` when `multiSelect` is true.", "fieldName": "optionSelected" }, { "name": "placeholder", "type": { "text": "string" }, "description": "Define custom placeholder text.", "fieldName": "placeholder" }, { "name": "placement", "type": { "text": "string" }, "description": "Position where the bib should appear relative to the trigger.", "default": "'bottom-start'", "fieldName": "placement" }, { "name": "required", "type": { "text": "boolean" }, "description": "Populates the `required` attribute on the element. Used for client-side validation.", "fieldName": "required" }, { "name": "setCustomValidity", "type": { "text": "string" }, "description": "Sets a custom help text message to display for all validityStates.", "fieldName": "setCustomValidity" }, { "name": "setCustomValidityCustomError", "type": { "text": "string" }, "description": "Custom help text message to display when validity = `customError`.", "fieldName": "setCustomValidityCustomError" }, { "name": "setCustomValidityValueMissing", "type": { "text": "string" }, "description": "Custom help text message to display when validity = `valueMissing`.", "fieldName": "setCustomValidityValueMissing" }, { "name": "shape", "type": { "text": "string" }, "fieldName": "shape", "description": "Determines the shape of the dropdown bib.", "inheritedFrom": { "name": "AuroElement", "module": "components/layoutElement/src/auroElement.js" } }, { "name": "shift", "type": { "text": "boolean" }, "description": "If set, the dropdown will shift its position to avoid being cut off by the viewport.", "default": "false", "fieldName": "shift" }, { "name": "size", "type": { "text": "string" }, "fieldName": "size", "description": "Determines the size of the dropdown bib. Only the `emphasized` layout supports size=`xl`, while all other layouts support size=`lg`.", "inheritedFrom": { "name": "AuroElement", "module": "components/layoutElement/src/auroElement.js" } }, { "name": "validity", "type": { "text": "string" }, "description": "Specifies the `validityState` this element is in.", "fieldName": "validity" }, { "name": "value", "type": { "text": "string" }, "description": "Value selected for the component.", "fieldName": "value" }, { "name": "ondark", "type": { "text": "boolean" }, "fieldName": "onDark", "inheritedFrom": { "name": "AuroElement", "module": "components/layoutElement/src/auroElement.js" } } ], "superclass": { "name": "AuroElement", "module": "/components/layoutElement/src/auroElement.js" }, "tagName": "auro-select", "customElement": true } ], "exports": [ { "kind": "js", "name": "AuroSelect", "declaration": { "name": "AuroSelect", "module": "components/select/src/auro-select.js" } } ] }, { "kind": "javascript-module", "path": "components/select/src/index.js", "declarations": [], "exports": [ { "kind": "js", "name": "AuroSelect", "declaration": { "name": "AuroSelect", "module": "components/select/src/index.js" } } ] }, { "kind": "javascript-module", "path": "components/select/src/registered.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "components/select/src/selectKeyboardStrategy.js", "declarations": [ { "kind": "variable", "name": "selectKeyboardStrategy", "type": { "text": "object" }, "default": "{ ArrowUp(component, evt) { evt.preventDefault(); navigateArrow(component, 'up', { showFn: () => component.dropdown.show() }); }, ArrowDown(component, evt) { evt.preventDefault(); navigateArrow(component, 'down', { showFn: () => component.dropdown.show() }); }, Enter(component, evt) { evt.preventDefault(); component.menu.makeSelection(); }, Tab(component) { if (!component.dropdown.isPopoverVisible) { return; } // Tab selects the focused option and closes the popup per the // WAI-ARIA APG select-only combobox / listbox pattern. if (component.optionActive && !component.multiSelect) { component.menu.makeSelection(); } component.dropdown.hide(); }, default(component, evt) { component.updateActiveOptionBasedOnKey(evt.key); }, }" } ], "exports": [ { "kind": "js", "name": "selectKeyboardStrategy", "declaration": { "name": "selectKeyboardStrategy", "module": "components/select/src/selectKeyboardStrategy.js" } } ] } ] }