{ "schemaVersion": "1.0.0", "readme": "", "modules": [ { "kind": "javascript-module", "path": "src/main.ts", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/lib/i18n.js" } } ] }, { "kind": "javascript-module", "path": "src/internal/custom-element.ts", "declarations": [ { "kind": "variable", "name": "cls", "default": "this" } ], "exports": [ { "kind": "custom-element-definition", "declaration": { "name": "cls", "module": "src/internal/custom-element.ts" } } ] }, { "kind": "javascript-module", "path": "src/internal/dialog-element.ts", "declarations": [ { "kind": "variable", "name": "DialogDirective" }, { "kind": "variable", "name": "DialogLayer", "type": { "text": "{ PAGE: 'page', SCREEN: 'screen', CONTAINER: 'container' }" }, "default": "{ PAGE: 'page', SCREEN: 'screen', CONTAINER: 'container' }" }, { "kind": "variable", "name": "DialogShowCommand" }, { "kind": "variable", "name": "DialogDismissCommand" }, { "kind": "variable", "name": "DialogCloseCommand" }, { "kind": "class", "description": "", "name": "DialogShowEvent", "members": [ { "kind": "field", "name": "eventName", "type": { "text": "string" }, "static": true, "readonly": true, "default": "'dialog-show'" } ], "superclass": { "name": "Event", "module": "src/internal/dialog-element.ts" } }, { "kind": "class", "description": "", "name": "DialogCloseEvent", "members": [ { "kind": "field", "name": "eventName", "type": { "text": "string" }, "static": true, "readonly": true, "default": "'dialog-close'" } ], "superclass": { "name": "CustomEvent", "module": "src/internal/dialog-element.ts" } }, { "kind": "class", "description": "", "name": "DialogElement", "cssParts": [ { "name": "base" } ], "slots": [ { "description": "Default slot", "name": "" } ], "members": [ { "kind": "field", "name": "initialized", "type": { "text": "boolean" }, "privacy": "private", "static": true, "default": "true" }, { "kind": "field", "name": "#focusTrap", "privacy": "private" }, { "kind": "field", "name": "backdropDisabled", "type": { "text": "boolean" }, "default": "false", "attribute": "backdrop-disabled", "reflects": true }, { "kind": "field", "name": "blocking", "type": { "text": "boolean" }, "default": "false", "attribute": "blocking", "reflects": true }, { "kind": "field", "name": "layer", "type": { "text": "DialogLayer" }, "attribute": "layer", "reflects": true }, { "kind": "field", "name": "open", "type": { "text": "boolean" }, "default": "false", "attribute": "open", "reflects": true }, { "kind": "field", "name": "canShow", "readonly": true }, { "kind": "field", "name": "canClose", "readonly": true }, { "kind": "field", "name": "canDismiss", "readonly": true }, { "kind": "method", "name": "show", "return": { "type": { "text": "Promise" } } }, { "kind": "method", "name": "close", "return": { "type": { "text": "Promise" } }, "parameters": [ { "name": "returnValue", "optional": true, "type": { "text": "string" } } ] }, { "kind": "method", "name": "dismiss", "return": { "type": { "text": "Promise" } } }, { "kind": "method", "name": "toggle", "return": { "type": { "text": "Promise" } }, "parameters": [ { "name": "state", "optional": true, "type": { "text": "boolean" } }, { "name": "returnValue", "optional": true, "type": { "text": "string" } } ] }, { "kind": "method", "name": "showPopover", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "hidePopover", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "togglePopover", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "state", "optional": true, "type": { "text": "boolean" } } ] }, { "kind": "method", "name": "#addGlobalListeners", "privacy": "private" }, { "kind": "method", "name": "#removeGlobalListeners", "privacy": "private" }, { "kind": "field", "name": "#handleGlobalPointerDown", "privacy": "private" }, { "kind": "field", "name": "#handleGlobalPointerUp", "privacy": "private", "default": "((event: Event & { target: HTMLElement }) => { removeGlobalEventListener('mouseup', this.#handleGlobalPointerUp); if (!this.canDismiss) return; // check for host if in not screen layer if (this.layer !== DialogLayer.SCREEN && clickedOutside(event, this, true)) return; // check for container const container = this.renderRoot.querySelector('#base'); if (container && !clickedOutside(event, container, true)) return; // check for other dialogs const closestDialog = event.target.closest(DialogDirective.selector); if (!this.backdropDisabled && closestDialog && this !== closestDialog) return; event.preventDefault(); this.dismiss(); })" }, { "kind": "field", "name": "#handleGlobalKeydown", "privacy": "private", "default": "((event: KeyboardEvent): void => { if (event.key !== keyEscape || !this.canDismiss) return; event.preventDefault(); this.dismiss(); })" }, { "kind": "field", "name": "#handleToggle", "privacy": "private", "default": "((event: ToggleEvent & { target: HTMLElement }) => { this.open = event.newState === 'open'; }) as unknown" }, { "kind": "field", "name": "tagName", "type": { "text": "string" }, "static": true, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "role", "type": { "text": "ARIARole | null" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "dir", "type": { "text": "'ltr' | 'rtl'" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } } ], "events": [ { "type": { "text": "DialogShowEvent" } }, { "type": { "text": "DialogShowEvent" }, "description": "Emitted when the dialog is requested to be shown. Can be canceled to prevent showing", "name": "dialog-show" }, { "type": { "text": "DialogCloseEvent" }, "description": "Emitted when the dialog is requested to be closed. Can be canceled to prevent closing", "name": "dialog-close" } ], "attributes": [ { "name": "backdrop-disabled", "type": { "text": "boolean" }, "default": "false", "fieldName": "backdropDisabled" }, { "name": "blocking", "type": { "text": "boolean" }, "default": "false", "fieldName": "blocking" }, { "name": "layer", "type": { "text": "DialogLayer" }, "fieldName": "layer" }, { "name": "open", "type": { "text": "boolean" }, "default": "false", "fieldName": "open" } ], "superclass": { "name": "CustomElement", "module": "/src/internal/custom-element.js" }, "summary": "Base element for dialog components" } ], "exports": [ { "kind": "js", "name": "DialogDirective", "declaration": { "name": "DialogDirective", "module": "src/internal/dialog-element.ts" } }, { "kind": "js", "name": "DialogLayer", "declaration": { "name": "DialogLayer", "module": "src/internal/dialog-element.ts" } }, { "kind": "js", "name": "DialogShowCommand", "declaration": { "name": "DialogShowCommand", "module": "src/internal/dialog-element.ts" } }, { "kind": "js", "name": "DialogDismissCommand", "declaration": { "name": "DialogDismissCommand", "module": "src/internal/dialog-element.ts" } }, { "kind": "js", "name": "DialogCloseCommand", "declaration": { "name": "DialogCloseCommand", "module": "src/internal/dialog-element.ts" } }, { "kind": "js", "name": "DialogShowEvent", "declaration": { "name": "DialogShowEvent", "module": "src/internal/dialog-element.ts" } }, { "kind": "js", "name": "DialogCloseEvent", "declaration": { "name": "DialogCloseEvent", "module": "src/internal/dialog-element.ts" } }, { "kind": "js", "name": "DialogElement", "declaration": { "name": "DialogElement", "module": "src/internal/dialog-element.ts" } } ] }, { "kind": "javascript-module", "path": "src/internal/main.ts", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/internal/behaviors/form-associated.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/internal/controllers/active-descendants-controller.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/internal/controllers/breakpoint-controller.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/internal/controllers/drag-controller.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/internal/controllers/selectable-controller.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/internal/controllers/selection-controller.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/internal/controllers/slot-content-observer.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/internal/custom-element.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/internal/dialog-element.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/internal/utils/boolean-attribute-directive.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/internal/utils/command-directive.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/internal/utils/dedupe-mixin.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/internal/utils/dom.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/internal/utils/dom-renderer.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/internal/utils/events.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/internal/utils/lit.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/internal/utils/shared-event-listener.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/internal/utils/shared-resize-observer.js" } } ] }, { "kind": "javascript-module", "path": "src/internal/widget-element.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/translations/base.ts", "declarations": [], "exports": [ { "kind": "js", "name": "default", "declaration": { "module": "src/translations/base.ts" } } ] }, { "kind": "javascript-module", "path": "src/internal/behaviors/form-associated.ts", "declarations": [ { "kind": "variable", "name": "FormAssociated" } ], "exports": [ { "kind": "js", "name": "FormAssociated", "declaration": { "name": "FormAssociated", "module": "src/internal/behaviors/form-associated.ts" } } ] }, { "kind": "javascript-module", "path": "src/internal/controllers/active-descendants-controller.ts", "declarations": [ { "kind": "variable", "name": "ActiveDirective" }, { "kind": "class", "description": "", "name": "ActiveDescendantsController", "members": [ { "kind": "field", "name": "#abortController", "privacy": "private", "type": { "text": "AbortController | undefined" } }, { "kind": "field", "name": "#focusController", "privacy": "private", "default": "new FocusController(host)" }, { "kind": "field", "name": "#host", "privacy": "private", "default": "host" }, { "kind": "field", "name": "#options", "privacy": "private", "type": { "text": "object" }, "default": "{ getItems: () => [], ...options }" }, { "kind": "field", "name": "#items", "privacy": "private", "type": { "text": "T[]" }, "default": "[]" }, { "kind": "field", "name": "#activeIndex", "privacy": "private", "type": { "text": "number" }, "default": "-1" }, { "kind": "field", "name": "activeIndex", "type": { "text": "number" }, "readonly": true }, { "kind": "field", "name": "activeItem", "type": { "text": "T | undefined" }, "readonly": true }, { "kind": "method", "name": "hostDisconnected", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "hostUpdated", "return": { "type": { "text": "Promise" } } }, { "kind": "method", "name": "enable" }, { "kind": "method", "name": "disable" }, { "kind": "method", "name": "previous" }, { "kind": "method", "name": "next" }, { "kind": "method", "name": "first" }, { "kind": "method", "name": "last" }, { "kind": "method", "name": "updateItems", "return": { "type": { "text": "void" } } }, { "kind": "field", "name": "#handleKeyDown", "privacy": "private" } ] } ], "exports": [ { "kind": "js", "name": "ActiveDirective", "declaration": { "name": "ActiveDirective", "module": "src/internal/controllers/active-descendants-controller.ts" } }, { "kind": "js", "name": "ActiveDescendantsController", "declaration": { "name": "ActiveDescendantsController", "module": "src/internal/controllers/active-descendants-controller.ts" } } ] }, { "kind": "javascript-module", "path": "src/internal/controllers/breakpoint-controller.ts", "declarations": [ { "kind": "class", "description": "", "name": "BreakpointController", "members": [ { "kind": "field", "name": "#host", "privacy": "private", "default": "host" }, { "kind": "field", "name": "#options", "privacy": "private", "default": "options" }, { "kind": "field", "name": "#effect", "privacy": "private", "type": { "text": "() => void | undefined" } }, { "kind": "method", "name": "hostConnected", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "hostDisconnected", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "#observeBreakpoint", "privacy": "private", "return": { "type": { "text": "() => void" } }, "parameters": [ { "name": "name", "type": { "text": "Breakpoint['id']" } }, { "name": "callback", "type": { "text": "(matches: boolean) => void" } } ] } ] } ], "exports": [ { "kind": "js", "name": "BreakpointController", "declaration": { "name": "BreakpointController", "module": "src/internal/controllers/breakpoint-controller.ts" } } ] }, { "kind": "javascript-module", "path": "src/internal/controllers/drag-controller.ts", "declarations": [ { "kind": "variable", "name": "DragActiveDirective" }, { "kind": "function", "name": "DragControllerOptions", "return": { "type": { "text": "DragControllerOptions" } }, "parameters": [ { "name": "config", "optional": true, "type": { "text": "Partial>" } } ] }, { "kind": "class", "description": "", "name": "DragController", "members": [ { "kind": "field", "name": "#host", "privacy": "private", "default": "host" }, { "kind": "field", "name": "#options", "privacy": "private", "default": "DragControllerOptions(options)" }, { "kind": "field", "name": "#dragTargets", "privacy": "private", "default": "new WeakSet()" }, { "kind": "field", "name": "#listeners", "privacy": "private", "default": "new Map void>()" }, { "kind": "field", "name": "draggableElements", "type": { "text": "T[]" }, "readonly": true }, { "kind": "field", "name": "container", "type": { "text": "HTMLElement" }, "readonly": true }, { "kind": "method", "name": "hostConnected", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "hostDisconnected", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "hostUpdated", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "isDraggable", "return": { "type": { "text": "element is IsDraggable" } }, "parameters": [ { "name": "element", "optional": true, "type": { "text": "unknown" } } ] }, { "kind": "field", "name": "#handleDragStart", "privacy": "private" }, { "kind": "field", "name": "#handleDragMove", "privacy": "private" }, { "kind": "field", "name": "#handleDragEnd", "privacy": "private" }, { "kind": "method", "name": "#calculatePosition", "privacy": "private", "return": { "type": { "text": "DragPosition" } }, "parameters": [ { "name": "event", "type": { "text": "PointerEvent" } } ] }, { "kind": "method", "name": "#getDragTarget", "privacy": "private", "parameters": [ { "name": "event", "type": { "text": "PointerEvent" } } ] } ] } ], "exports": [ { "kind": "js", "name": "DragActiveDirective", "declaration": { "name": "DragActiveDirective", "module": "src/internal/controllers/drag-controller.ts" } }, { "kind": "js", "name": "DragControllerOptions", "declaration": { "name": "DragControllerOptions", "module": "src/internal/controllers/drag-controller.ts" } }, { "kind": "js", "name": "DragController", "declaration": { "name": "DragController", "module": "src/internal/controllers/drag-controller.ts" } } ] }, { "kind": "javascript-module", "path": "src/internal/controllers/focus-controller.ts", "declarations": [ { "kind": "class", "description": "", "name": "FocusController", "members": [ { "kind": "field", "name": "#host", "privacy": "private", "default": "host" }, { "kind": "field", "name": "#abortController", "privacy": "private", "type": { "text": "AbortController | undefined" } }, { "kind": "field", "name": "#keyboardInputDetected", "privacy": "private", "type": { "text": "boolean" }, "default": "false" }, { "kind": "field", "name": "focused", "type": { "text": "boolean" }, "readonly": true }, { "kind": "field", "name": "focusVisible", "type": { "text": "boolean" }, "readonly": true }, { "kind": "method", "name": "hostConnected", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "hostDisconnected", "return": { "type": { "text": "void" } } }, { "kind": "field", "name": "#handleFocus", "privacy": "private" }, { "kind": "field", "name": "#handleGlobalKeyboardInput", "privacy": "private" }, { "kind": "field", "name": "#handleGlobalPointerInput", "privacy": "private" } ] } ], "exports": [ { "kind": "js", "name": "FocusController", "declaration": { "name": "FocusController", "module": "src/internal/controllers/focus-controller.ts" } } ] }, { "kind": "javascript-module", "path": "src/internal/controllers/focusable-controller.ts", "declarations": [ { "kind": "class", "description": "", "name": "FocusableController", "members": [ { "kind": "field", "name": "#host", "privacy": "private", "default": "host" }, { "kind": "field", "name": "#options", "privacy": "private", "default": "options" }, { "kind": "field", "name": "#focusDisabled", "privacy": "private", "type": { "text": "boolean" }, "default": "false" }, { "kind": "field", "name": "#initialTabIndex", "privacy": "private", "type": { "text": "number" }, "default": "0" }, { "kind": "method", "name": "hostConnected" }, { "kind": "method", "name": "hostUpdated", "return": { "type": { "text": "void" } } } ] } ], "exports": [ { "kind": "js", "name": "FocusableController", "declaration": { "name": "FocusableController", "module": "src/internal/controllers/focusable-controller.ts" } } ] }, { "kind": "javascript-module", "path": "src/internal/controllers/intersection-controller.ts", "declarations": [ { "kind": "class", "description": "", "name": "IntersectionController", "members": [ { "kind": "field", "name": "#options", "privacy": "private", "type": { "text": "object" }, "default": "{ threshold: 1, ...options, root: options.root ?? host }" }, { "kind": "field", "name": "#intersectionObserver", "privacy": "private", "type": { "text": "IntersectionObserver | undefined" } }, { "kind": "field", "name": "#firstUpdated", "privacy": "private", "type": { "text": "boolean" }, "default": "false" }, { "kind": "field", "name": "#intersectingElements", "privacy": "private", "default": "new Set()" }, { "kind": "method", "name": "hostDisconnected", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "hostUpdated", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "isIntersecting", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "element", "type": { "text": "T" } } ] }, { "kind": "method", "name": "#updateWatchedElements", "privacy": "private" }, { "kind": "field", "name": "#handleIntersection", "privacy": "private" } ] } ], "exports": [ { "kind": "js", "name": "IntersectionController", "declaration": { "name": "IntersectionController", "module": "src/internal/controllers/intersection-controller.ts" } } ] }, { "kind": "javascript-module", "path": "src/internal/controllers/range-controller.ts", "declarations": [ { "kind": "variable", "name": "RangeAxis", "type": { "text": "{ BLOCK: 'block', INLINE: 'inline', BOTH: 'both' }" }, "default": "{ BLOCK: 'block', INLINE: 'inline', BOTH: 'both' }" }, { "kind": "variable", "name": "RangeStepBehavior", "type": { "text": "{ IGNORE: 'ignore', ROUND: 'round', CEIL: 'ceil', FLOOR: 'floor' }" }, "default": "{ IGNORE: 'ignore', ROUND: 'round', CEIL: 'ceil', FLOOR: 'floor' }" }, { "kind": "class", "description": "", "name": "RangeController", "members": [ { "kind": "field", "name": "#host", "privacy": "private", "default": "host" }, { "kind": "field", "name": "#options", "privacy": "private", "type": { "text": "object" }, "default": "{ axis: RangeAxis.BOTH, stepBehavior: RangeStepBehavior.ROUND, ...options }" }, { "kind": "field", "name": "step", "type": { "text": "number" }, "readonly": true }, { "kind": "method", "name": "hostConnected", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "stepUp", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "n", "optional": true, "type": { "text": "number" } } ] }, { "kind": "method", "name": "stepDown", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "n", "optional": true, "type": { "text": "number" } } ] }, { "kind": "method", "name": "clampValue", "return": { "type": { "text": "number" } }, "parameters": [ { "name": "value", "type": { "text": "number" } } ] }, { "kind": "field", "name": "#handleKeyboardEvent", "privacy": "private" } ] } ], "exports": [ { "kind": "js", "name": "RangeAxis", "declaration": { "name": "RangeAxis", "module": "src/internal/controllers/range-controller.ts" } }, { "kind": "js", "name": "RangeStepBehavior", "declaration": { "name": "RangeStepBehavior", "module": "src/internal/controllers/range-controller.ts" } }, { "kind": "js", "name": "RangeController", "declaration": { "name": "RangeController", "module": "src/internal/controllers/range-controller.ts" } } ] }, { "kind": "javascript-module", "path": "src/internal/controllers/selectable-controller.ts", "declarations": [ { "kind": "class", "description": "", "name": "SelectableController", "members": [ { "kind": "field", "name": "#host", "privacy": "private", "default": "host" }, { "kind": "field", "name": "#enabled", "privacy": "private", "type": { "text": "boolean" }, "default": "false" }, { "kind": "field", "name": "#selected", "privacy": "private", "type": { "text": "boolean" }, "default": "false" }, { "kind": "field", "name": "#selection", "privacy": "private", "type": { "text": "SelectionController | undefined" } }, { "kind": "field", "name": "selected", "type": { "text": "boolean" }, "readonly": true }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "readonly": true }, { "kind": "method", "name": "hostDisconnected", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "hostUpdated", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "toggle", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "state", "optional": true, "type": { "text": "boolean" } } ] }, { "kind": "field", "name": "#handleSelectionUpdate", "privacy": "private" } ] } ], "exports": [ { "kind": "js", "name": "SelectableController", "declaration": { "name": "SelectableController", "module": "src/internal/controllers/selectable-controller.ts" } } ] }, { "kind": "javascript-module", "path": "src/internal/controllers/selection-controller.ts", "declarations": [ { "kind": "variable", "name": "SelectionContext" }, { "kind": "class", "description": "", "name": "SelectionController", "members": [ { "kind": "field", "name": "#host", "privacy": "private", "type": { "text": "SelectionControllerHost" }, "default": "host" }, { "kind": "field", "name": "#hostConnected", "privacy": "private", "type": { "text": "boolean" }, "default": "false" }, { "kind": "field", "name": "#options", "privacy": "private", "default": "options" }, { "kind": "field", "name": "#controls", "privacy": "private", "default": "new Set()" }, { "kind": "field", "name": "#items", "privacy": "private", "default": "new Set()" }, { "kind": "field", "name": "#multiple", "privacy": "private", "type": { "text": "boolean" }, "default": "true" }, { "kind": "field", "name": "#selectionDisabled", "privacy": "private", "type": { "text": "boolean" }, "default": "false" }, { "kind": "field", "name": "#selectedValues", "privacy": "private", "default": "new Set()" }, { "kind": "field", "name": "controls", "type": { "text": "T[]" }, "readonly": true }, { "kind": "field", "name": "items", "type": { "text": "T[]" }, "readonly": true }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "readonly": true }, { "kind": "field", "name": "enabledItems", "type": { "text": "T[]" }, "readonly": true }, { "kind": "field", "name": "multiple", "type": { "text": "boolean" }, "readonly": true }, { "kind": "field", "name": "selectedItems", "type": { "text": "T[]" }, "readonly": true }, { "kind": "field", "name": "required", "type": { "text": "boolean" }, "readonly": true }, { "kind": "field", "name": "value", "type": { "text": "string[]" } }, { "kind": "field", "name": "selectedIndices", "type": { "text": "number[]" }, "readonly": true }, { "kind": "method", "name": "hostConnected" }, { "kind": "method", "name": "hostUpdate", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "hostUpdated", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "register", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "item", "type": { "text": "T" } } ] }, { "kind": "method", "name": "unregister", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "item", "type": { "text": "T" } } ] }, { "kind": "method", "name": "isSelected", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "item", "type": { "text": "T" } } ] }, { "kind": "method", "name": "isSelectable", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "item", "type": { "text": "T" } } ] }, { "kind": "method", "name": "isPartOfSelection", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "item", "type": { "text": "unknown" } } ] }, { "kind": "method", "name": "hasAllSelected", "return": { "type": { "text": "boolean" } } }, { "kind": "method", "name": "hasPartialSelection", "return": { "type": { "text": "boolean" } } }, { "kind": "method", "name": "toggle", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "item", "type": { "text": "T" } }, { "name": "state", "optional": true, "type": { "text": "boolean" } } ] }, { "kind": "method", "name": "toggleAll", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "state", "optional": true, "type": { "text": "boolean" } } ] }, { "kind": "method", "name": "#toggleItem", "privacy": "private", "parameters": [ { "name": "item", "type": { "text": "T" } }, { "name": "state", "type": { "text": "boolean" } } ] } ] } ], "exports": [ { "kind": "js", "name": "SelectionContext", "declaration": { "name": "SelectionContext", "module": "src/internal/controllers/selection-controller.ts" } }, { "kind": "js", "name": "SelectionController", "declaration": { "name": "SelectionController", "module": "src/internal/controllers/selection-controller.ts" } } ] }, { "kind": "javascript-module", "path": "src/internal/controllers/slot-content-observer.ts", "declarations": [ { "kind": "class", "description": "", "name": "SlotContentObserver", "members": [ { "kind": "field", "name": "#host", "privacy": "private", "default": "host" }, { "kind": "field", "name": "#slotsWithContent", "privacy": "private", "type": { "text": "Set" }, "default": "new Set()" }, { "kind": "method", "name": "hostConnected", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "hostDisconnected", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "whenSlotted", "return": { "type": { "text": "TemplateResult" } }, "parameters": [ { "name": "slotName", "type": { "text": "string" } }, { "name": "content", "default": "(slot: TemplateResult) => slot" } ] }, { "kind": "method", "name": "hasContent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "slotName", "optional": true, "type": { "text": "string" } } ] }, { "kind": "method", "name": "hasUpdated", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "props", "type": { "text": "PropertyValues" } } ] }, { "kind": "field", "name": "#handleSlotChange", "privacy": "private" }, { "kind": "method", "name": "#hasChanged", "privacy": "private", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "oldValue", "type": { "text": "Set" } }, { "name": "newValue", "type": { "text": "Set" } } ] } ] } ], "exports": [ { "kind": "js", "name": "SlotContentObserver", "declaration": { "name": "SlotContentObserver", "module": "src/internal/controllers/slot-content-observer.ts" } } ] }, { "kind": "javascript-module", "path": "src/internal/utils/boolean-attribute-directive.ts", "declarations": [ { "kind": "function", "name": "booleanAttributeDirective", "return": { "type": { "text": "BooleanAttributeDirective" } }, "parameters": [ { "name": "options", "type": { "text": "BooleanAttributeDirectiveOptions" } } ] } ], "exports": [ { "kind": "js", "name": "booleanAttributeDirective", "declaration": { "name": "booleanAttributeDirective", "module": "src/internal/utils/boolean-attribute-directive.ts" } } ] }, { "kind": "javascript-module", "path": "src/internal/utils/command-directive.ts", "declarations": [ { "kind": "class", "description": "", "name": "CommandEvent", "members": [ { "kind": "field", "name": "type", "type": { "text": "string" }, "static": true, "readonly": true, "default": "'odx-command'" } ], "superclass": { "name": "CustomEvent", "module": "src/internal/utils/command-directive.ts" } }, { "kind": "function", "name": "commandDirective", "return": { "type": { "text": "CommandDirective" } }, "parameters": [ { "name": "options", "type": { "text": "CommandDirectiveOptions" } } ] } ], "exports": [ { "kind": "js", "name": "CommandEvent", "declaration": { "name": "CommandEvent", "module": "src/internal/utils/command-directive.ts" } }, { "kind": "js", "name": "commandDirective", "declaration": { "name": "commandDirective", "module": "src/internal/utils/command-directive.ts" } } ] }, { "kind": "javascript-module", "path": "src/internal/utils/debounce.ts", "declarations": [ { "kind": "function", "name": "debounce", "return": { "type": { "text": "" } }, "parameters": [ { "name": "func", "type": { "text": "F" }, "description": "The function to debounce." }, { "name": "debounceMs", "type": { "text": "number" }, "description": "The number of milliseconds to delay." }, { "name": "{ signal, edges }", "default": "{}", "type": { "text": "DebounceOptions" } }, { "description": "The options object", "name": "options", "type": { "text": "DebounceOptions" } }, { "description": "An optional AbortSignal to cancel the debounced function.", "name": "options.signal", "type": { "text": "AbortSignal" } } ], "description": "Creates a debounced function that delays invoking the provided function until after `debounceMs` milliseconds\nhave elapsed since the last time the debounced function was invoked. The debounced function also has a `cancel`\nmethod to cancel any pending execution." } ], "exports": [ { "kind": "js", "name": "debounce", "declaration": { "name": "debounce", "module": "src/internal/utils/debounce.ts" } } ] }, { "kind": "javascript-module", "path": "src/internal/utils/dedupe-mixin.ts", "declarations": [ { "kind": "function", "name": "dedupeMixin", "return": { "type": { "text": "T" } }, "parameters": [ { "name": "mixin", "type": { "text": "T" } } ] } ], "exports": [ { "kind": "js", "name": "dedupeMixin", "declaration": { "name": "dedupeMixin", "module": "src/internal/utils/dedupe-mixin.ts" } } ] }, { "kind": "javascript-module", "path": "src/internal/utils/dom-renderer.ts", "declarations": [ { "kind": "function", "name": "createDOMRenderer", "return": { "type": { "text": "DOMRenderer" } }, "parameters": [ { "name": "options", "type": { "text": "CreateDOMRendererOptions" } } ] } ], "exports": [ { "kind": "js", "name": "createDOMRenderer", "declaration": { "name": "createDOMRenderer", "module": "src/internal/utils/dom-renderer.ts" } } ] }, { "kind": "javascript-module", "path": "src/internal/utils/dom.ts", "declarations": [ { "kind": "variable", "name": "keyEnter", "type": { "text": "string" }, "default": "'Enter'" }, { "kind": "variable", "name": "keyEscape", "type": { "text": "string" }, "default": "'Escape'" }, { "kind": "variable", "name": "keySpace", "type": { "text": "string" }, "default": "' '" }, { "kind": "variable", "name": "keyTab", "type": { "text": "string" }, "default": "'Tab'" }, { "kind": "variable", "name": "keyArrowUp", "type": { "text": "string" }, "default": "'ArrowUp'" }, { "kind": "variable", "name": "keyArrowRight", "type": { "text": "string" }, "default": "'ArrowRight'" }, { "kind": "variable", "name": "keyArrowDown", "type": { "text": "string" }, "default": "'ArrowDown'" }, { "kind": "variable", "name": "keyArrowLeft", "type": { "text": "string" }, "default": "'ArrowLeft'" }, { "kind": "variable", "name": "keyHome", "type": { "text": "string" }, "default": "'Home'" }, { "kind": "variable", "name": "keyEnd", "type": { "text": "string" }, "default": "'End'" }, { "kind": "variable", "name": "autoFocusSelector", "type": { "text": "string" }, "default": "'[odx-autofocus],[autofocus]'" }, { "kind": "function", "name": "clickedOutside", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "event", "type": { "text": "Event" } }, { "name": "target", "optional": true, "type": { "text": "HTMLElement | null" } }, { "name": "allowSelf", "default": "false" } ] }, { "kind": "function", "name": "isRTL", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "target", "optional": true, "type": { "text": "HTMLElement | null" } } ] }, { "kind": "function", "name": "getRootElement", "return": { "type": { "text": "HTMLElement" } }, "parameters": [ { "name": "element", "type": { "text": "HTMLElement" } } ] }, { "kind": "function", "name": "getElementFromEvent", "return": { "type": { "text": "T | undefined" } }, "parameters": [ { "name": "event", "type": { "text": "Event" } }, { "name": "filterFn", "type": { "text": "(element: HTMLElement, event: Event) => boolean" } }, { "name": "root", "optional": true, "type": { "text": "HTMLElement | null" } } ] }, { "kind": "function", "name": "getAssignedElements", "return": { "type": { "text": "T[]" } }, "parameters": [ { "name": "root", "type": { "text": "DocumentFragment | HTMLElement" } }, { "name": "options", "default": "{}", "type": { "text": "GetAssignedElementOptions" } } ] }, { "kind": "function", "name": "toPx", "return": { "type": { "text": "string | null" } }, "parameters": [ { "name": "value", "optional": true, "type": { "text": "number | null" } } ] }, { "kind": "function", "name": "waitForAnimations", "return": { "type": { "text": "Promise" } }, "parameters": [ { "name": "element", "optional": true, "type": { "text": "HTMLElement | null" } }, { "name": "options", "default": "{}", "type": { "text": "GetAnimationsOptions" } } ] }, { "kind": "function", "name": "renderProxyAnchor", "return": { "type": { "text": "HTMLAnchorElement | undefined" } }, "parameters": [ { "name": "host", "type": { "text": "Partial" } }, { "name": "instance", "optional": true, "type": { "text": "HTMLAnchorElement" } } ] } ], "exports": [ { "kind": "js", "name": "keyEnter", "declaration": { "name": "keyEnter", "module": "src/internal/utils/dom.ts" } }, { "kind": "js", "name": "keyEscape", "declaration": { "name": "keyEscape", "module": "src/internal/utils/dom.ts" } }, { "kind": "js", "name": "keySpace", "declaration": { "name": "keySpace", "module": "src/internal/utils/dom.ts" } }, { "kind": "js", "name": "keyTab", "declaration": { "name": "keyTab", "module": "src/internal/utils/dom.ts" } }, { "kind": "js", "name": "keyArrowUp", "declaration": { "name": "keyArrowUp", "module": "src/internal/utils/dom.ts" } }, { "kind": "js", "name": "keyArrowRight", "declaration": { "name": "keyArrowRight", "module": "src/internal/utils/dom.ts" } }, { "kind": "js", "name": "keyArrowDown", "declaration": { "name": "keyArrowDown", "module": "src/internal/utils/dom.ts" } }, { "kind": "js", "name": "keyArrowLeft", "declaration": { "name": "keyArrowLeft", "module": "src/internal/utils/dom.ts" } }, { "kind": "js", "name": "keyHome", "declaration": { "name": "keyHome", "module": "src/internal/utils/dom.ts" } }, { "kind": "js", "name": "keyEnd", "declaration": { "name": "keyEnd", "module": "src/internal/utils/dom.ts" } }, { "kind": "js", "name": "autoFocusSelector", "declaration": { "name": "autoFocusSelector", "module": "src/internal/utils/dom.ts" } }, { "kind": "js", "name": "clickedOutside", "declaration": { "name": "clickedOutside", "module": "src/internal/utils/dom.ts" } }, { "kind": "js", "name": "isRTL", "declaration": { "name": "isRTL", "module": "src/internal/utils/dom.ts" } }, { "kind": "js", "name": "getRootElement", "declaration": { "name": "getRootElement", "module": "src/internal/utils/dom.ts" } }, { "kind": "js", "name": "getElementFromEvent", "declaration": { "name": "getElementFromEvent", "module": "src/internal/utils/dom.ts" } }, { "kind": "js", "name": "getAssignedElements", "declaration": { "name": "getAssignedElements", "module": "src/internal/utils/dom.ts" } }, { "kind": "js", "name": "toPx", "declaration": { "name": "toPx", "module": "src/internal/utils/dom.ts" } }, { "kind": "js", "name": "waitForAnimations", "declaration": { "name": "waitForAnimations", "module": "src/internal/utils/dom.ts" } }, { "kind": "js", "name": "renderProxyAnchor", "declaration": { "name": "renderProxyAnchor", "module": "src/internal/utils/dom.ts" } } ] }, { "kind": "javascript-module", "path": "src/internal/utils/events.ts", "declarations": [ { "kind": "variable", "name": "ToggleEventState", "type": { "text": "{\n OPEN: 'open',\n CLOSED: 'closed',\n}" }, "default": "{ OPEN: 'open', CLOSED: 'closed', }" }, { "kind": "function", "name": "toggleEvent", "return": { "type": { "text": "ToggleEvent" } }, "parameters": [ { "name": "newState", "type": { "text": "boolean" } }, { "name": "init", "optional": true, "type": { "text": "ToggleEventInit" } } ] } ], "exports": [ { "kind": "js", "name": "ToggleEventState", "declaration": { "name": "ToggleEventState", "module": "src/internal/utils/events.ts" } }, { "kind": "js", "name": "toggleEvent", "declaration": { "name": "toggleEvent", "module": "src/internal/utils/events.ts" } } ] }, { "kind": "javascript-module", "path": "src/internal/utils/lit.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/internal/utils/shared-event-listener.ts", "declarations": [ { "kind": "function", "name": "addGlobalEventListener", "return": { "type": { "text": "() => void" } }, "parameters": [ { "name": "type", "type": { "text": "string" } }, { "name": "listener", "type": { "text": "EventListener" } }, { "name": "options", "optional": true, "type": { "text": "boolean | AddEventListenerOptions" } } ] }, { "kind": "function", "name": "removeGlobalEventListener", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "type", "type": { "text": "string" } }, { "name": "listener", "type": { "text": "EventListener" } } ] } ], "exports": [ { "kind": "js", "name": "addGlobalEventListener", "declaration": { "name": "addGlobalEventListener", "module": "src/internal/utils/shared-event-listener.ts" } }, { "kind": "js", "name": "removeGlobalEventListener", "declaration": { "name": "removeGlobalEventListener", "module": "src/internal/utils/shared-event-listener.ts" } } ] }, { "kind": "javascript-module", "path": "src/internal/utils/shared-resize-observer.ts", "declarations": [ { "kind": "function", "name": "observeElementResize", "return": { "type": { "text": "() => void" } }, "parameters": [ { "name": "target", "type": { "text": "HTMLElement" } }, { "name": "callback", "type": { "text": "ResizeObserverCallback" } } ] }, { "kind": "function", "name": "unobserveElementResize", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "target", "type": { "text": "HTMLElement" } } ] } ], "exports": [ { "kind": "js", "name": "observeElementResize", "declaration": { "name": "observeElementResize", "module": "src/internal/utils/shared-resize-observer.ts" } }, { "kind": "js", "name": "unobserveElementResize", "declaration": { "name": "unobserveElementResize", "module": "src/internal/utils/shared-resize-observer.ts" } } ] }, { "kind": "javascript-module", "path": "src/lib/accordion/accordion-item.ts", "declarations": [ { "kind": "variable", "name": "AccordionItemSize", "type": { "text": "{ MD: 'md', LG: 'lg' }" }, "default": "{ MD: 'md', LG: 'lg' }" }, { "kind": "class", "description": "", "name": "OdxAccordionItem", "slots": [ { "description": "Slot for a custom label of the accordion item", "name": "label" } ], "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "static": true, "default": "'odx-accordion-item' satisfies keyof HTMLElementTagNameMap", "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "shadowRootOptions", "type": { "text": "ShadowRootInit" }, "static": true, "default": "{ ...super.shadowRootOptions, delegatesFocus: true, }" }, { "kind": "field", "name": "focusTarget", "type": { "text": "HTMLButtonElement" }, "privacy": "private" }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Indicates whether the element is disabled.\nIf `true` it cannot be interacted with nor be focused.", "attribute": "disabled", "reflects": true }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "The label of the accordion item, displayed in the header.\nCan be set via attribute or slot. If both are provided, the slot content will take precedence.", "attribute": "label" }, { "kind": "field", "name": "open", "type": { "text": "boolean" }, "default": "false", "description": "Indicates whether the accordion item is open or closed.", "attribute": "open", "reflects": true }, { "kind": "field", "name": "size", "type": { "text": "AccordionItemSize" }, "description": "The size of the accordion item.", "attribute": "size", "reflects": true }, { "kind": "method", "name": "click", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "toggle", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "state", "optional": true, "type": { "text": "boolean" }, "description": "The desired state of the accordion item. If not provided, the state will be toggled." }, { "name": "emitEvent", "default": "false", "description": "Whether to emit the `toggle` event." } ], "description": "Toggles the open state of the accordion item.\nCloses all nested accordion items when closing." }, { "kind": "field", "name": "#handleClick", "privacy": "private" }, { "kind": "field", "name": "#handleKeyboardEvent", "privacy": "private" }, { "kind": "field", "name": "role", "type": { "text": "ARIARole | null" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "dir", "type": { "text": "'ltr' | 'rtl'" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } } ], "events": [ { "type": { "text": "ToggleEvent" }, "description": "Emitted when the accordion item is opened or closed. Can be canceled to prevent the action.", "name": "toggle" } ], "attributes": [ { "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Indicates whether the element is disabled.\nIf `true` it cannot be interacted with nor be focused.", "fieldName": "disabled" }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "The label of the accordion item, displayed in the header.\nCan be set via attribute or slot. If both are provided, the slot content will take precedence.", "fieldName": "label" }, { "name": "open", "type": { "text": "boolean" }, "default": "false", "description": "Indicates whether the accordion item is open or closed.", "fieldName": "open" }, { "name": "size", "type": { "text": "AccordionItemSize" }, "description": "The size of the accordion item.", "fieldName": "size" } ], "superclass": { "name": "CustomElement", "module": "/src/internal/custom-element.js" }, "summary": "An accordion item component that can be interacted with to show or hide its content.", "tagName": "odx-accordion-item", "customElement": true, "status": "rc", "since": "1.0", "dependencies": [ "odx-toggle-content" ], "cssParts": [], "cssProperties": [] } ], "exports": [ { "kind": "js", "name": "AccordionItemSize", "declaration": { "name": "AccordionItemSize", "module": "src/lib/accordion/accordion-item.ts" } }, { "kind": "js", "name": "OdxAccordionItem", "declaration": { "name": "OdxAccordionItem", "module": "src/lib/accordion/accordion-item.ts" } } ] }, { "kind": "javascript-module", "path": "src/lib/accordion/accordion.ts", "declarations": [ { "kind": "class", "description": "", "name": "OdxAccordion", "slots": [ { "description": "Default slot for accordion items", "name": "" } ], "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "static": true, "default": "'odx-accordion' satisfies keyof HTMLElementTagNameMap", "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "multiple", "type": { "text": "boolean" }, "default": "false", "description": "Indicates whether multiple accordion items can be open at the same time.", "attribute": "multiple", "reflects": true }, { "kind": "field", "name": "size", "type": { "text": "AccordionItemSize" }, "description": "The size of the accordion items.", "attribute": "size" }, { "kind": "method", "name": "getItems", "return": { "type": { "text": "OdxAccordionItem[]" } }, "description": "Gets the list of accordion items that are direct children of the accordion." }, { "kind": "method", "name": "toggleAll", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "state", "optional": true, "type": { "text": "boolean" }, "description": "The state to toggle the items to. If not provided, items will be toggled to the opposite of their current state." }, { "name": "emitEvent", "default": "false", "description": "Whether to emit the `toggle` event for each item that is toggled. Defaults to false." } ], "description": "Toggles the state of all accordion items." }, { "kind": "method", "name": "#syncItemProperties", "privacy": "private" }, { "kind": "field", "name": "#handleToggle", "privacy": "private" }, { "kind": "field", "name": "role", "type": { "text": "ARIARole | null" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "dir", "type": { "text": "'ltr' | 'rtl'" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } } ], "events": [ { "type": { "text": "ToggleEvent" }, "description": "@see {OdxAccordionItem}", "name": "toggle" } ], "attributes": [ { "name": "multiple", "type": { "text": "boolean" }, "default": "false", "description": "Indicates whether multiple accordion items can be open at the same time.", "fieldName": "multiple" }, { "name": "size", "type": { "text": "AccordionItemSize" }, "description": "The size of the accordion items.", "fieldName": "size" } ], "superclass": { "name": "CustomElement", "module": "/src/internal/custom-element.js" }, "summary": "An accordion is an interactive element that allows content to be shown or hidden.", "tagName": "odx-accordion", "customElement": true, "status": "rc", "since": "1.0", "dependencies": [ "odx-accordion-item" ], "cssParts": [], "cssProperties": [] } ], "exports": [ { "kind": "js", "name": "OdxAccordion", "declaration": { "name": "OdxAccordion", "module": "src/lib/accordion/accordion.ts" } } ] }, { "kind": "javascript-module", "path": "src/lib/anchor-navigation/anchor-navigation.ts", "declarations": [ { "kind": "class", "description": "", "name": "OdxAnchorNavigation", "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "static": true, "default": "'odx-anchor-navigation' satisfies keyof HTMLElementTagNameMap", "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "#items", "privacy": "private" }, { "kind": "field", "name": "#intersectionObserver", "privacy": "private", "type": { "text": "IntersectionObserver | undefined" } }, { "kind": "field", "name": "#intersectionState", "privacy": "private" }, { "kind": "field", "name": "activeItem", "readonly": true }, { "kind": "field", "name": "activeIndex", "readonly": true }, { "kind": "field", "name": "root", "type": { "text": "Document | HTMLElement" }, "default": "document" }, { "kind": "field", "name": "rootMargin", "type": { "text": "string | null | undefined" }, "attribute": "root-margin" }, { "kind": "field", "name": "threshold", "type": { "text": "number" }, "default": "0.5", "attribute": "threshold" }, { "kind": "field", "name": "layout", "type": { "text": "TabBarLayout" }, "attribute": "layout", "reflects": true }, { "kind": "method", "name": "#findAnchor", "privacy": "private", "parameters": [ { "name": "item", "type": { "text": "OdxNavigationItem" } } ] }, { "kind": "method", "name": "#observeAnchors", "privacy": "private" }, { "kind": "field", "name": "#handleClick", "privacy": "private" }, { "kind": "field", "name": "#handleIntersection", "privacy": "private" }, { "kind": "field", "name": "#handleSlotChange", "privacy": "private" }, { "kind": "field", "name": "role", "type": { "text": "ARIARole | null" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "dir", "type": { "text": "'ltr' | 'rtl'" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } } ], "attributes": [ { "name": "root-margin", "type": { "text": "string | null | undefined" }, "fieldName": "rootMargin" }, { "name": "threshold", "type": { "text": "number" }, "default": "0.5", "fieldName": "threshold" }, { "name": "layout", "type": { "text": "TabBarLayout" }, "fieldName": "layout" } ], "mixins": [ { "name": "SignalWatcher", "package": "@lit-labs/signals" } ], "superclass": { "name": "CustomElement", "module": "/src/internal/custom-element.js" }, "tagName": "odx-anchor-navigation", "customElement": true, "events": [], "slots": [], "cssParts": [], "cssProperties": [] } ], "exports": [ { "kind": "js", "name": "OdxAnchorNavigation", "declaration": { "name": "OdxAnchorNavigation", "module": "src/lib/anchor-navigation/anchor-navigation.ts" } } ] }, { "kind": "javascript-module", "path": "src/lib/area-footer/area-footer.ts", "declarations": [ { "kind": "variable", "name": "AreaFooterSize", "type": { "text": "{ SM: 'sm', MD: 'md', LG: 'lg' }" }, "default": "{ SM: 'sm', MD: 'md', LG: 'lg' }" }, { "kind": "class", "description": "", "name": "OdxAreaFooter", "slots": [ { "description": "Main content slot", "name": "" }, { "description": "Prefix slot for content before main content", "name": "prefix" } ], "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "static": true, "default": "'odx-area-footer' satisfies keyof HTMLElementTagNameMap", "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "size", "type": { "text": "AreaFooterSize" }, "description": "The size of the area footer, which determines the spacing and layout of the footer content.", "attribute": "size", "reflects": true }, { "kind": "field", "name": "role", "type": { "text": "ARIARole | null" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "dir", "type": { "text": "'ltr' | 'rtl'" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } } ], "attributes": [ { "name": "size", "type": { "text": "AreaFooterSize" }, "description": "The size of the area footer, which determines the spacing and layout of the footer content.", "fieldName": "size" } ], "superclass": { "name": "CustomElement", "module": "/src/internal/custom-element.js" }, "summary": "Area footer component for displaying content at the bottom of a page or section.", "tagName": "odx-area-footer", "customElement": true, "events": [], "cssParts": [], "cssProperties": [] } ], "exports": [ { "kind": "js", "name": "AreaFooterSize", "declaration": { "name": "AreaFooterSize", "module": "src/lib/area-footer/area-footer.ts" } }, { "kind": "js", "name": "OdxAreaFooter", "declaration": { "name": "OdxAreaFooter", "module": "src/lib/area-footer/area-footer.ts" } } ] }, { "kind": "javascript-module", "path": "src/lib/area-header/area-header.ts", "declarations": [ { "kind": "variable", "name": "AreaHeaderSize", "type": { "text": "{ XS: 'xs', SM: 'sm', MD: 'md', LG: 'lg', XL: 'xl' }" }, "default": "{ XS: 'xs', SM: 'sm', MD: 'md', LG: 'lg', XL: 'xl' }" }, { "kind": "class", "description": "", "name": "OdxAreaHeader", "slots": [ { "description": "The default slot for the main header content, usually containing a title element.", "name": "" }, { "description": "A slot for content to be placed before the main header content, such as an avatar or icon.", "name": "prefix" }, { "description": "A slot for additional content below the main header, such as a subtitle or description.", "name": "content" }, { "description": "A slot for content to be placed after the main header content for additional metadata.", "name": "suffix" }, { "description": "A slot for actions related to the area, typically containing a button group", "name": "actions" } ], "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "static": true, "default": "'odx-area-header' satisfies keyof HTMLElementTagNameMap", "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "#slots", "privacy": "private", "default": "new SlotContentObserver(this)" }, { "kind": "field", "name": "size", "type": { "text": "AreaHeaderSize" }, "description": "The size of the area header, which determines the size of the title and other elements within the header.", "attribute": "size", "reflects": true }, { "kind": "method", "name": "#syncProperties", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "field", "name": "role", "type": { "text": "ARIARole | null" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "dir", "type": { "text": "'ltr' | 'rtl'" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } } ], "attributes": [ { "name": "size", "type": { "text": "AreaHeaderSize" }, "description": "The size of the area header, which determines the size of the title and other elements within the header.", "fieldName": "size" } ], "superclass": { "name": "CustomElement", "module": "/src/internal/custom-element.js" }, "summary": "Area headers are used to introduce and provide context for different sections\nof a page or application. They typically contain a title, subtitle, and can\nalso include additional elements such as icons, images, or action buttons.", "tagName": "odx-area-header", "customElement": true, "events": [], "cssParts": [], "cssProperties": [] } ], "exports": [ { "kind": "js", "name": "AreaHeaderSize", "declaration": { "name": "AreaHeaderSize", "module": "src/lib/area-header/area-header.ts" } }, { "kind": "js", "name": "OdxAreaHeader", "declaration": { "name": "OdxAreaHeader", "module": "src/lib/area-header/area-header.ts" } } ] }, { "kind": "javascript-module", "path": "src/lib/autocomplete/autocomplete.ts", "declarations": [ { "kind": "class", "description": "", "name": "OdxAutocomplete", "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "static": true, "default": "'odx-autocomplete' satisfies keyof HTMLElementTagNameMap", "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "activeDescendants", "privacy": "protected", "readonly": true, "default": "new ActiveDescendantsController(this, { getItems: () => this.options, onChange: (_, option, firstChange) => { option?.scrollIntoView({ block: 'nearest', behavior: 'instant' }); if (!option || firstChange || option.selected) return; option?.activate(); }, })" }, { "kind": "field", "name": "options", "type": { "text": "OdxOption[]" }, "privacy": "protected", "readonly": true }, { "kind": "field", "name": "highlight", "type": { "text": "OdxHighlight" }, "privacy": "protected", "readonly": true }, { "kind": "field", "name": "dropdown", "type": { "text": "OdxDropdown | undefined" }, "privacy": "protected", "readonly": true }, { "kind": "field", "name": "minQueryLength", "type": { "text": "number" }, "default": "1", "attribute": "min-query-length" }, { "kind": "field", "name": "searchFn" }, { "kind": "field", "name": "control", "type": { "text": "HTMLInputElement | undefined" }, "readonly": true }, { "kind": "field", "name": "controlValue", "type": { "text": "string" }, "readonly": true }, { "kind": "method", "name": "#handleControlValueChange", "privacy": "private", "parameters": [ { "name": "value", "optional": true, "type": { "text": "string" } }, { "name": "showDropdown", "default": "true" } ] }, { "kind": "field", "name": "#handlePointerDown", "privacy": "private" }, { "kind": "field", "name": "#handleControlSlotChange", "privacy": "private" }, { "kind": "field", "name": "#handleControlFocusIn", "privacy": "private" }, { "kind": "field", "name": "#handleControlFocusOut", "privacy": "private" }, { "kind": "field", "name": "#handleControlClear", "privacy": "private" }, { "kind": "field", "name": "#handleControlInput", "privacy": "private" }, { "kind": "field", "name": "#handleControlKeyboardEvent", "privacy": "private" }, { "kind": "field", "name": "role", "type": { "text": "ARIARole | null" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "dir", "type": { "text": "'ltr' | 'rtl'" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } } ], "events": [ { "name": "change", "type": { "text": "Event" } } ], "attributes": [ { "name": "min-query-length", "type": { "text": "number" }, "default": "1", "fieldName": "minQueryLength" } ], "mixins": [ { "name": "FormAssociated", "module": "/src/internal/behaviors/form-associated.js" } ], "superclass": { "name": "CustomElement", "module": "/src/internal/custom-element.js" }, "tagName": "odx-autocomplete", "customElement": true, "slots": [], "cssParts": [], "cssProperties": [] } ], "exports": [ { "kind": "js", "name": "OdxAutocomplete", "declaration": { "name": "OdxAutocomplete", "module": "src/lib/autocomplete/autocomplete.ts" } } ] }, { "kind": "javascript-module", "path": "src/lib/avatar/avatar.ts", "declarations": [ { "kind": "variable", "name": "AvatarShape", "type": { "text": "{ CIRCLE: 'circle', RECTANGLE: 'rectangle' }" }, "default": "{ CIRCLE: 'circle', RECTANGLE: 'rectangle' }" }, { "kind": "variable", "name": "AvatarSize", "type": { "text": "{ XS: 'xs', SM: 'sm', MD: 'md', LG: 'lg', XL: 'xl', XXL: 'xxl' }" }, "default": "{ XS: 'xs', SM: 'sm', MD: 'md', LG: 'lg', XL: 'xl', XXL: 'xxl' }" }, { "kind": "variable", "name": "AvatarVariant", "type": { "text": "{ NEUTRAL: 'neutral', PRIMARY: 'primary', ACCENT: 'accent', GHOST: 'ghost' }" }, "default": "{ NEUTRAL: 'neutral', PRIMARY: 'primary', ACCENT: 'accent', GHOST: 'ghost' }" }, { "kind": "class", "description": "", "name": "OdxAvatar", "cssProperties": [ { "description": "The size of the avatar.", "name": "--size" } ], "slots": [ { "description": "The avatar icon or image to use. By default displays the user's initials or the user icon.", "name": "" } ], "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "static": true, "default": "'odx-avatar' satisfies keyof HTMLElementTagNameMap", "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "#slots", "privacy": "private", "default": "new SlotContentObserver(this)" }, { "kind": "field", "name": "interactive", "type": { "text": "boolean" }, "default": "false", "description": "Indicates whether the avatar is interactive (focusable and clickable).\nWhen `true`, the avatar will have the ARIA role `button` and respond to keyboard events.", "attribute": "interactive", "reflects": true }, { "kind": "field", "name": "name", "type": { "text": "string | null | undefined" }, "description": "The name of the individual or entity represented by this avatar, used to generate initials.\n\nThis should always be set when possible to ensure correct behavior for users relying on assistive technologies.", "attribute": "name" }, { "kind": "field", "name": "shape", "type": { "text": "AvatarShape" }, "description": "The shape of the avatar.", "attribute": "shape", "reflects": true }, { "kind": "field", "name": "size", "type": { "text": "AvatarSize" }, "description": "The size of the avatar.", "attribute": "size", "reflects": true }, { "kind": "field", "name": "variant", "type": { "text": "AvatarVariant" }, "description": "The variant of the avatar.", "attribute": "variant", "reflects": true }, { "kind": "method", "name": "getInitials", "return": { "type": { "text": "string" } }, "description": "Generates two letter initials from the `name` property by taking the first letter of the first and last words." }, { "kind": "field", "name": "#handleKeyboardEvent", "privacy": "private" }, { "kind": "field", "name": "role", "type": { "text": "ARIARole | null" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "dir", "type": { "text": "'ltr' | 'rtl'" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } } ], "attributes": [ { "name": "interactive", "type": { "text": "boolean" }, "default": "false", "description": "Indicates whether the avatar is interactive (focusable and clickable).\nWhen `true`, the avatar will have the ARIA role `button` and respond to keyboard events.", "fieldName": "interactive" }, { "name": "name", "type": { "text": "string | null | undefined" }, "description": "The name of the individual or entity represented by this avatar, used to generate initials.\n\nThis should always be set when possible to ensure correct behavior for users relying on assistive technologies.", "fieldName": "name" }, { "name": "shape", "type": { "text": "AvatarShape" }, "description": "The shape of the avatar.", "fieldName": "shape" }, { "name": "size", "type": { "text": "AvatarSize" }, "description": "The size of the avatar.", "fieldName": "size" }, { "name": "variant", "type": { "text": "AvatarVariant" }, "description": "The variant of the avatar.", "fieldName": "variant" } ], "superclass": { "name": "CustomElement", "module": "/src/internal/custom-element.js" }, "summary": "The avatar allows personalization or concretization of headlines or users through an image, an icon or through initials.", "tagName": "odx-avatar", "customElement": true, "status": "rc", "since": "1.0", "events": [], "cssParts": [] } ], "exports": [ { "kind": "js", "name": "AvatarShape", "declaration": { "name": "AvatarShape", "module": "src/lib/avatar/avatar.ts" } }, { "kind": "js", "name": "AvatarSize", "declaration": { "name": "AvatarSize", "module": "src/lib/avatar/avatar.ts" } }, { "kind": "js", "name": "AvatarVariant", "declaration": { "name": "AvatarVariant", "module": "src/lib/avatar/avatar.ts" } }, { "kind": "js", "name": "OdxAvatar", "declaration": { "name": "OdxAvatar", "module": "src/lib/avatar/avatar.ts" } } ] }, { "kind": "javascript-module", "path": "src/lib/badge/badge.ts", "declarations": [ { "kind": "variable", "name": "BadgeSize", "type": { "text": "{ MD: 'md', LG: 'lg' }" }, "default": "{ MD: 'md', LG: 'lg' }" }, { "kind": "variable", "name": "BadgeVariant", "type": { "text": "{\n NEUTRAL: 'neutral',\n PRIMARY: 'primary',\n ACCENT: 'accent',\n ACCENT_SUBTLE: 'accent-subtle',\n SUCCESS: 'success',\n SUCCESS_SUBTLE: 'success-subtle',\n WARNING: 'warning',\n DANGER: 'danger',\n DANGER_SUBTLE: 'danger-subtle',\n CONFIRMATION: 'confirmation',\n}" }, "default": "{ NEUTRAL: 'neutral', PRIMARY: 'primary', ACCENT: 'accent', ACCENT_SUBTLE: 'accent-subtle', SUCCESS: 'success', SUCCESS_SUBTLE: 'success-subtle', WARNING: 'warning', DANGER: 'danger', DANGER_SUBTLE: 'danger-subtle', CONFIRMATION: 'confirmation', }" }, { "kind": "class", "description": "", "name": "OdxBadge", "cssParts": [ { "description": "The badge's icon element, present when the `icon` property is set.", "name": "icon" }, { "description": "The badge's spinner element, present when the `loading` property is `true`.", "name": "spinner" } ], "slots": [ { "description": "The badge content. This is typically a number, short text string or an icon.", "name": "" } ], "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "static": true, "default": "'odx-badge' satisfies keyof HTMLElementTagNameMap", "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "animated", "type": { "text": "boolean" }, "default": "false", "description": "Indicates whether to show a pulse animation on the badge to draw attention to it.", "attribute": "animated", "reflects": true }, { "kind": "field", "name": "compact", "type": { "text": "boolean" }, "default": "false", "description": "Indicates whether to display the badge in a compact style.", "attribute": "compact", "reflects": true }, { "kind": "field", "name": "contrast", "type": { "text": "boolean" }, "default": "false", "description": "Indicates wether to use a outline to increased contrast of the badge against the background.", "attribute": "contrast", "reflects": true }, { "kind": "field", "name": "icon", "type": { "text": "OdxIconName | undefined" }, "description": "The name of the icon to display in the badge.", "attribute": "icon" }, { "kind": "field", "name": "max", "type": { "text": "number" }, "default": "99", "description": "The maximum numeric value to display before showing a \"+\" sign.", "attribute": "max" }, { "kind": "field", "name": "loading", "type": { "text": "boolean" }, "default": "false", "description": "Indicates whether the badge is used to display a loading state.", "attribute": "loading", "reflects": true }, { "kind": "field", "name": "size", "type": { "text": "BadgeSize" }, "description": "The size of the badge, which determines its dimensions and font size.", "attribute": "size", "reflects": true }, { "kind": "field", "name": "variant", "type": { "text": "BadgeVariant" }, "description": "The variant of the badge, which determines its color and other visual properties.", "attribute": "variant", "reflects": true }, { "kind": "field", "name": "value", "type": { "text": "number | null | undefined" }, "description": "The numeric value to display in the badge.\nIf not set, the badge will display its slotted content instead.", "attribute": "value" }, { "kind": "field", "name": "role", "type": { "text": "ARIARole | null" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "dir", "type": { "text": "'ltr' | 'rtl'" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } } ], "attributes": [ { "name": "animated", "type": { "text": "boolean" }, "default": "false", "description": "Indicates whether to show a pulse animation on the badge to draw attention to it.", "fieldName": "animated" }, { "name": "compact", "type": { "text": "boolean" }, "default": "false", "description": "Indicates whether to display the badge in a compact style.", "fieldName": "compact" }, { "name": "contrast", "type": { "text": "boolean" }, "default": "false", "description": "Indicates wether to use a outline to increased contrast of the badge against the background.", "fieldName": "contrast" }, { "name": "icon", "type": { "text": "OdxIconName | undefined" }, "description": "The name of the icon to display in the badge.", "fieldName": "icon" }, { "name": "max", "type": { "text": "number" }, "default": "99", "description": "The maximum numeric value to display before showing a \"+\" sign.", "fieldName": "max" }, { "name": "loading", "type": { "text": "boolean" }, "default": "false", "description": "Indicates whether the badge is used to display a loading state.", "fieldName": "loading" }, { "name": "size", "type": { "text": "BadgeSize" }, "description": "The size of the badge, which determines its dimensions and font size.", "fieldName": "size" }, { "name": "variant", "type": { "text": "BadgeVariant" }, "description": "The variant of the badge, which determines its color and other visual properties.", "fieldName": "variant" }, { "name": "value", "type": { "text": "number | null | undefined" }, "description": "The numeric value to display in the badge.\nIf not set, the badge will display its slotted content instead.", "fieldName": "value" } ], "superclass": { "name": "CustomElement", "module": "/src/internal/custom-element.js" }, "summary": "A badge is an indicator to show that new events, state changes or similar can be viewed via an element.", "tagName": "odx-badge", "customElement": true, "status": "rc", "since": "1.0", "dependencies": [ "odx-loading-spinner" ], "events": [], "cssProperties": [] } ], "exports": [ { "kind": "js", "name": "BadgeSize", "declaration": { "name": "BadgeSize", "module": "src/lib/badge/badge.ts" } }, { "kind": "js", "name": "BadgeVariant", "declaration": { "name": "BadgeVariant", "module": "src/lib/badge/badge.ts" } }, { "kind": "js", "name": "OdxBadge", "declaration": { "name": "OdxBadge", "module": "src/lib/badge/badge.ts" } } ] }, { "kind": "javascript-module", "path": "src/lib/bottom-sheet/bottom-sheet.ts", "declarations": [ { "kind": "variable", "name": "BottomSheetSize", "type": { "text": "{ SM: 'sm', MD: 'md' }" }, "default": "{ SM: 'sm', MD: 'md' }" }, { "kind": "class", "description": "", "name": "OdxBottomSheet", "cssParts": [ { "name": "base", "inheritedFrom": { "name": "DialogElement", "module": "src/internal/dialog-element.ts" } } ], "slots": [ { "description": "Default slot for the main content of the bottom sheet.", "name": "", "inheritedFrom": { "name": "DialogElement", "module": "src/internal/dialog-element.ts" } }, { "description": "The header slot, typically a odx-area-header component.", "name": "header" }, { "description": "Footer slot, typically a odx-area-footer component.", "name": "footer" } ], "members": [ { "kind": "field", "name": "initialized", "type": { "text": "boolean" }, "privacy": "private", "static": true, "default": "true", "inheritedFrom": { "name": "DialogElement", "module": "src/internal/dialog-element.ts" } }, { "kind": "field", "name": "backdropDisabled", "type": { "text": "boolean" }, "default": "false", "attribute": "backdrop-disabled", "reflects": true, "inheritedFrom": { "name": "DialogElement", "module": "src/internal/dialog-element.ts" } }, { "kind": "field", "name": "blocking", "type": { "text": "boolean" }, "default": "false", "attribute": "blocking", "reflects": true, "inheritedFrom": { "name": "DialogElement", "module": "src/internal/dialog-element.ts" } }, { "kind": "field", "name": "layer", "type": { "text": "DialogLayer" }, "attribute": "layer", "reflects": true, "inheritedFrom": { "name": "DialogElement", "module": "src/internal/dialog-element.ts" } }, { "kind": "field", "name": "open", "type": { "text": "boolean" }, "default": "false", "attribute": "open", "reflects": true, "inheritedFrom": { "name": "DialogElement", "module": "src/internal/dialog-element.ts" } }, { "kind": "field", "name": "canShow", "readonly": true, "inheritedFrom": { "name": "DialogElement", "module": "src/internal/dialog-element.ts" } }, { "kind": "field", "name": "canClose", "readonly": true, "inheritedFrom": { "name": "DialogElement", "module": "src/internal/dialog-element.ts" } }, { "kind": "field", "name": "canDismiss", "readonly": true, "inheritedFrom": { "name": "DialogElement", "module": "src/internal/dialog-element.ts" } }, { "kind": "method", "name": "show", "return": { "type": { "text": "Promise" } }, "inheritedFrom": { "name": "DialogElement", "module": "src/internal/dialog-element.ts" } }, { "kind": "method", "name": "close", "return": { "type": { "text": "Promise" } }, "parameters": [ { "name": "returnValue", "optional": true, "type": { "text": "string" } } ], "inheritedFrom": { "name": "DialogElement", "module": "src/internal/dialog-element.ts" } }, { "kind": "method", "name": "dismiss", "return": { "type": { "text": "Promise" } }, "inheritedFrom": { "name": "DialogElement", "module": "src/internal/dialog-element.ts" } }, { "kind": "method", "name": "toggle", "return": { "type": { "text": "Promise" } }, "parameters": [ { "name": "state", "optional": true, "type": { "text": "boolean" } }, { "name": "returnValue", "optional": true, "type": { "text": "string" } } ], "inheritedFrom": { "name": "DialogElement", "module": "src/internal/dialog-element.ts" } }, { "kind": "method", "name": "showPopover", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "DialogElement", "module": "src/internal/dialog-element.ts" } }, { "kind": "method", "name": "hidePopover", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "DialogElement", "module": "src/internal/dialog-element.ts" } }, { "kind": "method", "name": "togglePopover", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "state", "optional": true, "type": { "text": "boolean" } } ], "inheritedFrom": { "name": "DialogElement", "module": "src/internal/dialog-element.ts" } }, { "kind": "field", "name": "tagName", "type": { "text": "string" }, "static": true, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" }, "default": "'odx-bottom-sheet' satisfies keyof HTMLElementTagNameMap" }, { "kind": "field", "name": "role", "type": { "text": "ARIARole | null" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "dir", "type": { "text": "'ltr' | 'rtl'" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "#swipeVelocityFactor", "privacy": "private", "type": { "text": "number" }, "default": "0.8" }, { "kind": "field", "name": "#dragStartY", "privacy": "private", "type": { "text": "number" }, "default": "0" }, { "kind": "field", "name": "#dragStartTime", "privacy": "private", "type": { "text": "number" }, "default": "0" }, { "kind": "field", "name": "#isDragging", "privacy": "private", "type": { "text": "boolean" }, "default": "false" }, { "kind": "field", "name": "#capturedPointerId", "privacy": "private", "type": { "text": "number | undefined" } }, { "kind": "field", "name": "baseElement", "type": { "text": "HTMLElement" }, "privacy": "private" }, { "kind": "field", "name": "size", "type": { "text": "BottomSheetSize" }, "description": "The size of the bottom sheet, affecting its max width.", "attribute": "size", "reflects": true }, { "kind": "method", "name": "#resetDragState", "privacy": "private" }, { "kind": "field", "name": "#handlePointerDown", "privacy": "private" }, { "kind": "field", "name": "#handlePointerMove", "privacy": "private" }, { "kind": "field", "name": "#handlePointerUp", "privacy": "private" }, { "kind": "field", "name": "#focusTrap", "privacy": "private", "inheritedFrom": { "name": "DialogElement", "module": "src/internal/dialog-element.ts" } }, { "kind": "method", "name": "#addGlobalListeners", "privacy": "private", "inheritedFrom": { "name": "DialogElement", "module": "src/internal/dialog-element.ts" } }, { "kind": "method", "name": "#removeGlobalListeners", "privacy": "private", "inheritedFrom": { "name": "DialogElement", "module": "src/internal/dialog-element.ts" } }, { "kind": "field", "name": "#handleGlobalPointerDown", "privacy": "private", "inheritedFrom": { "name": "DialogElement", "module": "src/internal/dialog-element.ts" } }, { "kind": "field", "name": "#handleGlobalPointerUp", "privacy": "private", "default": "((event: Event & { target: HTMLElement }) => { removeGlobalEventListener('mouseup', this.#handleGlobalPointerUp); if (!this.canDismiss) return; // check for host if in not screen layer if (this.layer !== DialogLayer.SCREEN && clickedOutside(event, this, true)) return; // check for container const container = this.renderRoot.querySelector('#base'); if (container && !clickedOutside(event, container, true)) return; // check for other dialogs const closestDialog = event.target.closest(DialogDirective.selector); if (!this.backdropDisabled && closestDialog && this !== closestDialog) return; event.preventDefault(); this.dismiss(); })", "inheritedFrom": { "name": "DialogElement", "module": "src/internal/dialog-element.ts" } }, { "kind": "field", "name": "#handleGlobalKeydown", "privacy": "private", "default": "((event: KeyboardEvent): void => { if (event.key !== keyEscape || !this.canDismiss) return; event.preventDefault(); this.dismiss(); })", "inheritedFrom": { "name": "DialogElement", "module": "src/internal/dialog-element.ts" } }, { "kind": "field", "name": "#handleToggle", "privacy": "private", "default": "((event: ToggleEvent & { target: HTMLElement }) => { this.open = event.newState === 'open'; }) as unknown", "inheritedFrom": { "name": "DialogElement", "module": "src/internal/dialog-element.ts" } } ], "attributes": [ { "name": "size", "type": { "text": "BottomSheetSize" }, "description": "The size of the bottom sheet, affecting its max width.", "fieldName": "size" }, { "name": "backdrop-disabled", "type": { "text": "boolean" }, "default": "false", "fieldName": "backdropDisabled", "inheritedFrom": { "name": "DialogElement", "module": "src/internal/dialog-element.ts" } }, { "name": "blocking", "type": { "text": "boolean" }, "default": "false", "fieldName": "blocking", "inheritedFrom": { "name": "DialogElement", "module": "src/internal/dialog-element.ts" } }, { "name": "layer", "type": { "text": "DialogLayer" }, "fieldName": "layer", "inheritedFrom": { "name": "DialogElement", "module": "src/internal/dialog-element.ts" } }, { "name": "open", "type": { "text": "boolean" }, "default": "false", "fieldName": "open", "inheritedFrom": { "name": "DialogElement", "module": "src/internal/dialog-element.ts" } } ], "superclass": { "name": "DialogElement", "module": "/src/internal/dialog-element.js" }, "summary": "A bottom sheet component that slides up from the bottom of the screen.", "tagName": "odx-bottom-sheet", "customElement": true, "events": [ { "type": { "text": "DialogShowEvent" }, "inheritedFrom": { "name": "DialogElement", "module": "src/internal/dialog-element.ts" } }, { "type": { "text": "DialogShowEvent" }, "description": "Emitted when the dialog is requested to be shown. Can be canceled to prevent showing", "name": "dialog-show", "inheritedFrom": { "name": "DialogElement", "module": "src/internal/dialog-element.ts" } }, { "type": { "text": "DialogCloseEvent" }, "description": "Emitted when the dialog is requested to be closed. Can be canceled to prevent closing", "name": "dialog-close", "inheritedFrom": { "name": "DialogElement", "module": "src/internal/dialog-element.ts" } } ], "cssProperties": [] } ], "exports": [ { "kind": "js", "name": "BottomSheetSize", "declaration": { "name": "BottomSheetSize", "module": "src/lib/bottom-sheet/bottom-sheet.ts" } }, { "kind": "js", "name": "OdxBottomSheet", "declaration": { "name": "OdxBottomSheet", "module": "src/lib/bottom-sheet/bottom-sheet.ts" } } ] }, { "kind": "javascript-module", "path": "src/lib/blue-bar/blue-bar.ts", "declarations": [ { "kind": "variable", "name": "BlueBarSize", "type": { "text": "object" }, "default": "{ MD: ButtonSize.MD, LG: ButtonSize.LG, }" }, { "kind": "class", "description": "", "name": "OdxBlueBar", "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "static": true, "default": "'odx-blue-bar' satisfies keyof HTMLElementTagNameMap", "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "size", "type": { "text": "BlueBarSize" }, "attribute": "size", "reflects": true }, { "kind": "field", "name": "role", "type": { "text": "ARIARole | null" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "dir", "type": { "text": "'ltr' | 'rtl'" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } } ], "attributes": [ { "name": "size", "type": { "text": "BlueBarSize" }, "fieldName": "size" } ], "superclass": { "name": "CustomElement", "module": "/src/internal/custom-element.js" }, "tagName": "odx-blue-bar", "customElement": true, "events": [], "slots": [], "cssParts": [], "cssProperties": [] } ], "exports": [ { "kind": "js", "name": "BlueBarSize", "declaration": { "name": "BlueBarSize", "module": "src/lib/blue-bar/blue-bar.ts" } }, { "kind": "js", "name": "OdxBlueBar", "declaration": { "name": "OdxBlueBar", "module": "src/lib/blue-bar/blue-bar.ts" } } ] }, { "kind": "javascript-module", "path": "src/lib/breadcrumbs/breadcrumbs.ts", "declarations": [ { "kind": "variable", "name": "BreadcrumbsVariant", "type": { "text": "{ NEUTRAL: 'neutral', BRAND: 'brand' }" }, "default": "{ NEUTRAL: 'neutral', BRAND: 'brand' }" }, { "kind": "class", "description": "A navigation trail that shows the user's location in a hierarchy. Consumers slot\n`odx-link` or `` elements in document order — root first, current page last —\nand the component takes care of:\n\n- Inserting chevron separators between items.\n- Marking the final item with `aria-current=\"page\"` so screen readers announce it.\n- Collapsing middle items when the count exceeds `max`, keeping the first and last\n items visible. Set `max` to a high value to disable collapsing.\n- Applying `role=\"navigation\"` if the host element does not already carry a role.", "name": "OdxBreadcrumbs", "slots": [ { "description": "One link per breadcrumb level, in order from root to current page. Accepts `odx-link` or native `` elements; other elements are ignored.", "name": "" } ], "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "static": true, "default": "'odx-breadcrumbs' satisfies keyof HTMLElementTagNameMap", "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "#slotUpdateLock", "privacy": "private", "type": { "text": "boolean" }, "default": "false" }, { "kind": "field", "name": "#separators", "privacy": "private", "default": "new Set()" }, { "kind": "field", "name": "max", "type": { "text": "number" }, "default": "4", "description": "The maximum number of breadcrumb items to show before collapsing the middle items.\nThe first and last items are always shown and values less than 2 will be ignored.", "attribute": "max" }, { "kind": "field", "name": "variant", "type": { "text": "BreadcrumbsVariant" }, "description": "Visual style of the breadcrumbs:\n- `neutral` (default): subdued treatment suited for in-page navigation.\n- `brand`: brand-colored treatment for prominent placement (for example, on top of a hero).", "attribute": "variant", "reflects": true }, { "kind": "method", "name": "getItems", "return": { "type": { "text": "Array" } }, "description": "Returns the slotted link elements (`odx-link` or native ``) in document order.\nNon-link elements in the default slot are skipped." }, { "kind": "method", "name": "#syncItemProperties", "privacy": "private", "parameters": [ { "name": "update", "optional": true, "type": { "text": "(item: OdxLink | HTMLAnchorElement, index: number, items: Array) => void" } } ] }, { "kind": "field", "name": "#handleSlotChange", "privacy": "private" }, { "kind": "field", "name": "role", "type": { "text": "ARIARole | null" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "dir", "type": { "text": "'ltr' | 'rtl'" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } } ], "attributes": [ { "name": "max", "type": { "text": "number" }, "default": "4", "description": "The maximum number of breadcrumb items to show before collapsing the middle items.\nThe first and last items are always shown and values less than 2 will be ignored.", "fieldName": "max" }, { "name": "variant", "type": { "text": "BreadcrumbsVariant" }, "description": "Visual style of the breadcrumbs:\n- `neutral` (default): subdued treatment suited for in-page navigation.\n- `brand`: brand-colored treatment for prominent placement (for example, on top of a hero).", "fieldName": "variant" } ], "superclass": { "name": "CustomElement", "module": "/src/internal/custom-element.js" }, "summary": "Hierarchical navigation trail with automatic separators and overflow collapsing.", "tagName": "odx-breadcrumbs", "customElement": true, "events": [], "cssParts": [], "cssProperties": [] } ], "exports": [ { "kind": "js", "name": "BreadcrumbsVariant", "declaration": { "name": "BreadcrumbsVariant", "module": "src/lib/breadcrumbs/breadcrumbs.ts" } }, { "kind": "js", "name": "OdxBreadcrumbs", "declaration": { "name": "OdxBreadcrumbs", "module": "src/lib/breadcrumbs/breadcrumbs.ts" } } ] }, { "kind": "javascript-module", "path": "src/lib/button/button.base.ts", "declarations": [ { "kind": "variable", "name": "ButtonDirective" }, { "kind": "variable", "name": "ButtonSize", "type": { "text": "{ SM: 'sm', MD: 'md', LG: 'lg' }" }, "default": "{ SM: 'sm', MD: 'md', LG: 'lg' }" }, { "kind": "class", "description": "", "name": "ButtonBase", "cssParts": [ { "description": "The icon element rendered when the `icon` property is set.", "name": "icon" } ], "slots": [ { "description": "The button's label.", "name": "" }, { "description": "Prefix slot typically used for icons. Replaced by a loading spinner while `loading` is `true` if no `suffix` content is present.", "name": "prefix" }, { "description": "Suffix slot typically used for icons. Replaced by a loading spinner while `loading` is `true` when populated.", "name": "suffix" }, { "description": "Optional badge rendered as an overlay next to the label. Position is controlled by the `badgePlacement` property.", "name": "badge" } ], "members": [ { "kind": "field", "name": "slots", "privacy": "protected", "readonly": true, "default": "new SlotContentObserver(this)" }, { "kind": "field", "name": "tooltip", "privacy": "protected", "readonly": true, "default": "new TooltipController(this, { tooltipContent: () => this.currentHint, update: (tooltip) => { tooltip.placement = this.hintPlacement ?? TooltipPlacement.TOP; tooltip.variant = this.hintVariant ?? TooltipVariant.NEUTRAL; tooltip.size = TooltipSize.SM; }, })" }, { "kind": "field", "name": "loadingSlot", "type": { "text": "'prefix' | 'suffix' | undefined" }, "privacy": "protected" }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Indicates whether the element is disabled.\nIf `true` it cannot be interacted with nor be focused.", "attribute": "disabled", "reflects": true }, { "kind": "field", "name": "hint", "type": { "text": "string | null | undefined" }, "attribute": "hint" }, { "kind": "field", "name": "hintLoading", "type": { "text": "string | null | undefined" }, "attribute": "hint-loading" }, { "kind": "field", "name": "hintPlacement", "type": { "text": "TooltipPlacement | null | undefined" }, "attribute": "hint-placement" }, { "kind": "field", "name": "hintVariant", "type": { "text": "TooltipVariant | null | undefined" }, "description": "Visual variant of the hint tooltip. Defaults to `neutral`.", "attribute": "hint-variant" }, { "kind": "field", "name": "icon", "type": { "text": "OdxIconName | null | undefined" }, "description": "Name of the icon to render next to the label. When no slotted content is present,\nthe icon takes the place of the label entirely.", "attribute": "icon" }, { "kind": "field", "name": "loading", "type": { "text": "boolean" }, "default": "false", "description": "When `true`, replaces the prefix or suffix slot content with a loading spinner\nand prevents click activation. The button reports `aria-busy=\"true\"` while loading.", "attribute": "loading", "reflects": true }, { "kind": "field", "name": "size", "type": { "text": "ButtonSize" }, "description": "Size of the button. Affects height, padding, and typography.", "attribute": "size", "reflects": true }, { "kind": "field", "name": "currentIcon", "type": { "text": "OdxIconName | null | undefined" }, "readonly": true }, { "kind": "field", "name": "currentHint", "type": { "text": "string | null | undefined" }, "readonly": true }, { "kind": "method", "name": "click", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "renderContent", "privacy": "protected", "return": { "type": { "text": "TemplateResult" } } }, { "kind": "method", "name": "renderLabel", "privacy": "protected", "return": { "type": { "text": "TemplateResult | string" } }, "parameters": [ { "name": "label", "optional": true, "type": { "text": "TemplateResult | string" } } ] }, { "kind": "method", "name": "renderSlot", "privacy": "protected", "return": { "type": { "text": "TemplateResult" } }, "parameters": [ { "name": "name", "optional": true, "type": { "text": "'prefix' | 'suffix'" } } ] }, { "kind": "field", "name": "#handleClick", "privacy": "private" }, { "kind": "field", "name": "#handleKeyboardEvent", "privacy": "private" }, { "kind": "field", "name": "tagName", "type": { "text": "string" }, "static": true, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "role", "type": { "text": "ARIARole | null" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "dir", "type": { "text": "'ltr' | 'rtl'" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } } ], "attributes": [ { "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Indicates whether the element is disabled.\nIf `true` it cannot be interacted with nor be focused.", "fieldName": "disabled" }, { "name": "hint", "type": { "text": "string | null | undefined" }, "fieldName": "hint" }, { "name": "hint-loading", "type": { "text": "string | null | undefined" }, "fieldName": "hintLoading" }, { "name": "hint-placement", "type": { "text": "TooltipPlacement | null | undefined" }, "fieldName": "hintPlacement" }, { "name": "hint-variant", "type": { "text": "TooltipVariant | null | undefined" }, "description": "Visual variant of the hint tooltip. Defaults to `neutral`.", "fieldName": "hintVariant" }, { "name": "icon", "type": { "text": "OdxIconName | null | undefined" }, "description": "Name of the icon to render next to the label. When no slotted content is present,\nthe icon takes the place of the label entirely.", "fieldName": "icon" }, { "name": "loading", "type": { "text": "boolean" }, "default": "false", "description": "When `true`, replaces the prefix or suffix slot content with a loading spinner\nand prevents click activation. The button reports `aria-busy=\"true\"` while loading.", "fieldName": "loading" }, { "name": "size", "type": { "text": "ButtonSize" }, "description": "Size of the button. Affects height, padding, and typography.", "fieldName": "size" } ], "superclass": { "name": "CustomElement", "module": "/src/internal/custom-element.js" }, "summary": "Used for components with button functionality." } ], "exports": [ { "kind": "js", "name": "ButtonDirective", "declaration": { "name": "ButtonDirective", "module": "src/lib/button/button.base.ts" } }, { "kind": "js", "name": "ButtonSize", "declaration": { "name": "ButtonSize", "module": "src/lib/button/button.base.ts" } }, { "kind": "js", "name": "ButtonBase", "declaration": { "name": "ButtonBase", "module": "src/lib/button/button.base.ts" } } ] }, { "kind": "javascript-module", "path": "src/lib/button/button.ts", "declarations": [ { "kind": "variable", "name": "ButtonBadgePlacement", "type": { "text": "{ START: 'start', END: 'end' }" }, "default": "{ START: 'start', END: 'end' }" }, { "kind": "variable", "name": "ButtonVariant", "type": { "text": "{\n SECONDARY: 'secondary',\n TERTIARY: 'tertiary',\n PRIMARY: 'primary',\n ACCENT: 'accent',\n DANGER: 'danger',\n DANGER_GHOST: 'danger-ghost',\n GHOST: 'ghost',\n CONFIRMATION: 'confirmation',\n}" }, "default": "{ SECONDARY: 'secondary', TERTIARY: 'tertiary', PRIMARY: 'primary', ACCENT: 'accent', DANGER: 'danger', DANGER_GHOST: 'danger-ghost', GHOST: 'ghost', CONFIRMATION: 'confirmation', }" }, { "kind": "class", "description": "", "name": "OdxButton", "cssParts": [ { "description": "The icon element rendered when the `icon` property is set.", "name": "icon", "inheritedFrom": { "name": "ButtonBase", "module": "src/lib/button/button.base.ts" } } ], "slots": [ { "description": "The button's label.", "name": "", "inheritedFrom": { "name": "ButtonBase", "module": "src/lib/button/button.base.ts" } }, { "description": "Prefix slot typically used for icons. Replaced by a loading spinner while `loading` is `true` if no `suffix` content is present.", "name": "prefix", "inheritedFrom": { "name": "ButtonBase", "module": "src/lib/button/button.base.ts" } }, { "description": "Suffix slot typically used for icons. Replaced by a loading spinner while `loading` is `true` when populated.", "name": "suffix", "inheritedFrom": { "name": "ButtonBase", "module": "src/lib/button/button.base.ts" } }, { "description": "Optional badge rendered as an overlay next to the label. Position is controlled by the `badgePlacement` property.", "name": "badge", "inheritedFrom": { "name": "ButtonBase", "module": "src/lib/button/button.base.ts" } } ], "members": [ { "kind": "field", "name": "slots", "privacy": "protected", "readonly": true, "default": "new SlotContentObserver(this)", "inheritedFrom": { "name": "ButtonBase", "module": "src/lib/button/button.base.ts" } }, { "kind": "field", "name": "tooltip", "privacy": "protected", "readonly": true, "default": "new TooltipController(this, { tooltipContent: () => this.currentHint, update: (tooltip) => { tooltip.placement = this.hintPlacement ?? TooltipPlacement.TOP; tooltip.variant = this.hintVariant ?? TooltipVariant.NEUTRAL; tooltip.size = TooltipSize.SM; }, })", "inheritedFrom": { "name": "ButtonBase", "module": "src/lib/button/button.base.ts" } }, { "kind": "field", "name": "loadingSlot", "type": { "text": "'prefix' | 'suffix' | undefined" }, "privacy": "protected", "inheritedFrom": { "name": "ButtonBase", "module": "src/lib/button/button.base.ts" } }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Indicates whether the element is disabled.\nIf `true` it cannot be interacted with nor be focused.", "attribute": "disabled", "reflects": true, "inheritedFrom": { "name": "ButtonBase", "module": "src/lib/button/button.base.ts" } }, { "kind": "field", "name": "hint", "type": { "text": "string | null | undefined" }, "attribute": "hint", "inheritedFrom": { "name": "ButtonBase", "module": "src/lib/button/button.base.ts" } }, { "kind": "field", "name": "hintLoading", "type": { "text": "string | null | undefined" }, "attribute": "hint-loading", "inheritedFrom": { "name": "ButtonBase", "module": "src/lib/button/button.base.ts" } }, { "kind": "field", "name": "hintPlacement", "type": { "text": "TooltipPlacement | null | undefined" }, "attribute": "hint-placement", "inheritedFrom": { "name": "ButtonBase", "module": "src/lib/button/button.base.ts" } }, { "kind": "field", "name": "hintVariant", "type": { "text": "TooltipVariant | null | undefined" }, "description": "Visual variant of the hint tooltip. Defaults to `neutral`.", "attribute": "hint-variant", "inheritedFrom": { "name": "ButtonBase", "module": "src/lib/button/button.base.ts" } }, { "kind": "field", "name": "icon", "type": { "text": "OdxIconName | null | undefined" }, "description": "Name of the icon to render next to the label. When no slotted content is present,\nthe icon takes the place of the label entirely.", "attribute": "icon", "inheritedFrom": { "name": "ButtonBase", "module": "src/lib/button/button.base.ts" } }, { "kind": "field", "name": "loading", "type": { "text": "boolean" }, "default": "false", "description": "When `true`, replaces the prefix or suffix slot content with a loading spinner\nand prevents click activation. The button reports `aria-busy=\"true\"` while loading.", "attribute": "loading", "reflects": true, "inheritedFrom": { "name": "ButtonBase", "module": "src/lib/button/button.base.ts" } }, { "kind": "field", "name": "size", "type": { "text": "ButtonSize" }, "description": "Size of the button. Affects height, padding, and typography.", "attribute": "size", "reflects": true, "inheritedFrom": { "name": "ButtonBase", "module": "src/lib/button/button.base.ts" } }, { "kind": "field", "name": "currentIcon", "type": { "text": "OdxIconName | null | undefined" }, "readonly": true, "inheritedFrom": { "name": "ButtonBase", "module": "src/lib/button/button.base.ts" } }, { "kind": "field", "name": "currentHint", "type": { "text": "string | null | undefined" }, "readonly": true, "inheritedFrom": { "name": "ButtonBase", "module": "src/lib/button/button.base.ts" } }, { "kind": "method", "name": "click", "return": { "type": { "text": "void" } }, "description": "Simulates a user click. The call is ignored while the button is `disabled` or\n`loading`. When `href` is set, the click is forwarded to the proxy anchor so the\nbrowser performs link navigation with the correct `target`, `rel`, and `download`\nsemantics.", "inheritedFrom": { "name": "ButtonBase", "module": "src/lib/button/button.base.ts" } }, { "kind": "method", "name": "renderContent", "privacy": "protected", "return": { "type": { "text": "TemplateResult" } }, "inheritedFrom": { "name": "ButtonBase", "module": "src/lib/button/button.base.ts" } }, { "kind": "method", "name": "renderLabel", "privacy": "protected", "return": { "type": { "text": "TemplateResult | string" } }, "parameters": [ { "name": "label", "optional": true, "type": { "text": "TemplateResult | string" } } ], "inheritedFrom": { "name": "ButtonBase", "module": "src/lib/button/button.base.ts" } }, { "kind": "method", "name": "renderSlot", "privacy": "protected", "return": { "type": { "text": "TemplateResult" } }, "parameters": [ { "name": "name", "optional": true, "type": { "text": "'prefix' | 'suffix'" } } ], "inheritedFrom": { "name": "ButtonBase", "module": "src/lib/button/button.base.ts" } }, { "kind": "field", "name": "tagName", "type": { "text": "string" }, "static": true, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" }, "default": "'odx-button' satisfies keyof HTMLElementTagNameMap" }, { "kind": "field", "name": "role", "type": { "text": "ARIARole | null" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "dir", "type": { "text": "'ltr' | 'rtl'" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "formAssociated", "type": { "text": "boolean" }, "static": true, "readonly": true, "default": "true" }, { "kind": "field", "name": "anchor", "type": { "text": "HTMLAnchorElement | undefined" }, "privacy": "protected" }, { "kind": "field", "name": "badgePlacement", "type": { "text": "ButtonBadgePlacement" }, "attribute": "badge-placement", "reflects": true }, { "kind": "field", "name": "href", "type": { "text": "string" }, "default": "''", "description": "The URL that the element links to.", "attribute": "href" }, { "kind": "field", "name": "target", "type": { "text": "'_blank' | '_parent' | '_self' | '_top' | ''" }, "default": "''", "description": "Specifies where to open the linked document.", "attribute": "target" }, { "kind": "field", "name": "rel", "type": { "text": "string" }, "default": "''", "description": "Specifies the relationship between the current document and the linked document.", "attribute": "rel" }, { "kind": "field", "name": "download", "type": { "text": "string | undefined" }, "description": "Specifies that the target will be downloaded when a user clicks on the hyperlink.", "attribute": "download" }, { "kind": "field", "name": "type", "type": { "text": "'button' | 'submit' | 'reset'" }, "default": "'button'", "description": "The type of the button.", "attribute": "type" }, { "kind": "field", "name": "variant", "type": { "text": "ButtonVariant" }, "description": "The variant of the button.", "attribute": "variant", "reflects": true }, { "kind": "field", "name": "value", "type": { "text": "string" }, "default": "''", "description": "The value associated with the button. When the button is used to submit a form, this value is sent as part of the form data paired with the button's `name`.", "attribute": "value" }, { "kind": "field", "name": "#handleClick", "privacy": "private", "inheritedFrom": { "name": "ButtonBase", "module": "src/lib/button/button.base.ts" } }, { "kind": "field", "name": "elementInternals" }, { "kind": "field", "name": "#handleKeyboardEvent", "privacy": "private", "inheritedFrom": { "name": "ButtonBase", "module": "src/lib/button/button.base.ts" } } ], "attributes": [ { "name": "badge-placement", "type": { "text": "ButtonBadgePlacement" }, "fieldName": "badgePlacement" }, { "name": "href", "type": { "text": "string" }, "default": "''", "description": "The URL that the element links to.", "fieldName": "href" }, { "name": "target", "type": { "text": "'_blank' | '_parent' | '_self' | '_top' | ''" }, "default": "''", "description": "Specifies where to open the linked document.", "fieldName": "target" }, { "name": "rel", "type": { "text": "string" }, "default": "''", "description": "Specifies the relationship between the current document and the linked document.", "fieldName": "rel" }, { "name": "download", "type": { "text": "string | undefined" }, "description": "Specifies that the target will be downloaded when a user clicks on the hyperlink.", "fieldName": "download" }, { "name": "type", "type": { "text": "'button' | 'submit' | 'reset'" }, "default": "'button'", "description": "The type of the button.", "fieldName": "type" }, { "name": "variant", "type": { "text": "ButtonVariant" }, "description": "The variant of the button.", "fieldName": "variant" }, { "name": "value", "type": { "text": "string" }, "default": "''", "description": "The value associated with the button. When the button is used to submit a form, this value is sent as part of the form data paired with the button's `name`.", "fieldName": "value" }, { "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Indicates whether the element is disabled.\nIf `true` it cannot be interacted with nor be focused.", "fieldName": "disabled", "inheritedFrom": { "name": "ButtonBase", "module": "src/lib/button/button.base.ts" } }, { "name": "hint", "type": { "text": "string | null | undefined" }, "fieldName": "hint", "inheritedFrom": { "name": "ButtonBase", "module": "src/lib/button/button.base.ts" } }, { "name": "hint-loading", "type": { "text": "string | null | undefined" }, "fieldName": "hintLoading", "inheritedFrom": { "name": "ButtonBase", "module": "src/lib/button/button.base.ts" } }, { "name": "hint-placement", "type": { "text": "TooltipPlacement | null | undefined" }, "fieldName": "hintPlacement", "inheritedFrom": { "name": "ButtonBase", "module": "src/lib/button/button.base.ts" } }, { "name": "hint-variant", "type": { "text": "TooltipVariant | null | undefined" }, "description": "Visual variant of the hint tooltip. Defaults to `neutral`.", "fieldName": "hintVariant", "inheritedFrom": { "name": "ButtonBase", "module": "src/lib/button/button.base.ts" } }, { "name": "icon", "type": { "text": "OdxIconName | null | undefined" }, "description": "Name of the icon to render next to the label. When no slotted content is present,\nthe icon takes the place of the label entirely.", "fieldName": "icon", "inheritedFrom": { "name": "ButtonBase", "module": "src/lib/button/button.base.ts" } }, { "name": "loading", "type": { "text": "boolean" }, "default": "false", "description": "When `true`, replaces the prefix or suffix slot content with a loading spinner\nand prevents click activation. The button reports `aria-busy=\"true\"` while loading.", "fieldName": "loading", "inheritedFrom": { "name": "ButtonBase", "module": "src/lib/button/button.base.ts" } }, { "name": "size", "type": { "text": "ButtonSize" }, "description": "Size of the button. Affects height, padding, and typography.", "fieldName": "size", "inheritedFrom": { "name": "ButtonBase", "module": "src/lib/button/button.base.ts" } } ], "superclass": { "name": "ButtonBase", "module": "/src/lib/button/button.base.js" }, "summary": "Buttons allow the user to initialize or execute actions. Different styles are available for different operating situations", "tagName": "odx-button", "customElement": true, "status": "rc", "since": "1.0", "dependencies": [ "odx-icon", "odx-loading-spinner", "odx-tooltip" ], "events": [], "cssProperties": [] } ], "exports": [ { "kind": "js", "name": "ButtonBadgePlacement", "declaration": { "name": "ButtonBadgePlacement", "module": "src/lib/button/button.ts" } }, { "kind": "js", "name": "ButtonVariant", "declaration": { "name": "ButtonVariant", "module": "src/lib/button/button.ts" } }, { "kind": "js", "name": "OdxButton", "declaration": { "name": "OdxButton", "module": "src/lib/button/button.ts" } } ] }, { "kind": "javascript-module", "path": "src/lib/button/icon-button.ts", "declarations": [ { "kind": "variable", "name": "IconButtonPreset", "default": "{ clear: (element) => { element.icon = 'core::cancel'; element.variant = ButtonVariant.GHOST; }, close: (element) => { element.icon = 'core::close'; element.variant = ButtonVariant.GHOST; }, expand: (element) => { element.icon = 'core::chevron-down'; element.variant = ButtonVariant.GHOST; }, menu: (element) => { element.icon = 'core::chevron-down'; }, 'main-menu': (element) => { element.icon = 'core::menu'; element.variant = ButtonVariant.GHOST; }, } as const satisfies Record void>" }, { "kind": "class", "description": "", "name": "OdxIconButton", "members": [ { "kind": "field", "name": "slots", "privacy": "protected", "readonly": true, "default": "new SlotContentObserver(this)", "inheritedFrom": { "name": "ButtonBase", "module": "src/lib/button/button.base.ts" } }, { "kind": "field", "name": "tooltip", "privacy": "protected", "readonly": true, "default": "new TooltipController(this, { tooltipContent: () => this.currentHint, update: (tooltip) => { tooltip.placement = this.hintPlacement ?? TooltipPlacement.TOP; tooltip.variant = this.hintVariant ?? TooltipVariant.NEUTRAL; tooltip.size = TooltipSize.SM; }, })", "inheritedFrom": { "name": "ButtonBase", "module": "src/lib/button/button.base.ts" } }, { "kind": "field", "name": "loadingSlot", "type": { "text": "'prefix' | 'suffix' | undefined" }, "privacy": "protected", "inheritedFrom": { "name": "ButtonBase", "module": "src/lib/button/button.base.ts" } }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Indicates whether the element is disabled.\nIf `true` it cannot be interacted with nor be focused.", "attribute": "disabled", "reflects": true, "inheritedFrom": { "name": "ButtonBase", "module": "src/lib/button/button.base.ts" } }, { "kind": "field", "name": "hint", "type": { "text": "string | null | undefined" }, "attribute": "hint", "inheritedFrom": { "name": "ButtonBase", "module": "src/lib/button/button.base.ts" } }, { "kind": "field", "name": "hintLoading", "type": { "text": "string | null | undefined" }, "attribute": "hint-loading", "inheritedFrom": { "name": "ButtonBase", "module": "src/lib/button/button.base.ts" } }, { "kind": "field", "name": "hintPlacement", "type": { "text": "TooltipPlacement | null | undefined" }, "attribute": "hint-placement", "inheritedFrom": { "name": "ButtonBase", "module": "src/lib/button/button.base.ts" } }, { "kind": "field", "name": "hintVariant", "type": { "text": "TooltipVariant | null | undefined" }, "description": "Visual variant of the hint tooltip. Defaults to `neutral`.", "attribute": "hint-variant", "inheritedFrom": { "name": "ButtonBase", "module": "src/lib/button/button.base.ts" } }, { "kind": "field", "name": "icon", "type": { "text": "OdxIconName | null | undefined" }, "description": "Name of the icon to render next to the label. When no slotted content is present,\nthe icon takes the place of the label entirely.", "attribute": "icon", "inheritedFrom": { "name": "ButtonBase", "module": "src/lib/button/button.base.ts" } }, { "kind": "field", "name": "loading", "type": { "text": "boolean" }, "default": "false", "description": "When `true`, replaces the prefix or suffix slot content with a loading spinner\nand prevents click activation. The button reports `aria-busy=\"true\"` while loading.", "attribute": "loading", "reflects": true, "inheritedFrom": { "name": "ButtonBase", "module": "src/lib/button/button.base.ts" } }, { "kind": "field", "name": "size", "type": { "text": "ButtonSize" }, "description": "Size of the button. Affects height, padding, and typography.", "attribute": "size", "reflects": true, "inheritedFrom": { "name": "ButtonBase", "module": "src/lib/button/button.base.ts" } }, { "kind": "field", "name": "currentIcon", "type": { "text": "OdxIconName | null | undefined" }, "readonly": true, "inheritedFrom": { "name": "ButtonBase", "module": "src/lib/button/button.base.ts" } }, { "kind": "field", "name": "currentHint", "type": { "text": "string | null | undefined" }, "readonly": true, "inheritedFrom": { "name": "ButtonBase", "module": "src/lib/button/button.base.ts" } }, { "kind": "method", "name": "click", "return": { "type": { "text": "void" } }, "description": "Simulates a user click. The call is ignored while the button is `disabled` or\n`loading`. When `href` is set, the click is forwarded to the proxy anchor so the\nbrowser performs link navigation with the correct `target`, `rel`, and `download`\nsemantics.", "inheritedFrom": { "name": "ButtonBase", "module": "src/lib/button/button.base.ts" } }, { "kind": "method", "name": "renderContent", "privacy": "protected", "return": { "type": { "text": "TemplateResult" } }, "inheritedFrom": { "name": "ButtonBase", "module": "src/lib/button/button.base.ts" } }, { "kind": "method", "name": "renderLabel", "privacy": "protected", "return": { "type": { "text": "TemplateResult | string" } }, "parameters": [ { "name": "label", "optional": true, "type": { "text": "TemplateResult | string" } } ], "inheritedFrom": { "name": "ButtonBase", "module": "src/lib/button/button.base.ts" } }, { "kind": "method", "name": "renderSlot", "privacy": "protected", "return": { "type": { "text": "TemplateResult" } }, "parameters": [ { "name": "name", "optional": true, "type": { "text": "'prefix' | 'suffix'" } } ], "inheritedFrom": { "name": "ButtonBase", "module": "src/lib/button/button.base.ts" } }, { "kind": "field", "name": "tagName", "type": { "text": "string" }, "static": true, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" }, "default": "'odx-icon-button' satisfies keyof HTMLElementTagNameMap" }, { "kind": "field", "name": "role", "type": { "text": "ARIARole | null" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "dir", "type": { "text": "'ltr' | 'rtl'" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "formAssociated", "type": { "text": "boolean" }, "static": true, "readonly": true, "default": "true", "inheritedFrom": { "name": "OdxButton", "module": "src/lib/button/button.ts" } }, { "kind": "field", "name": "anchor", "type": { "text": "HTMLAnchorElement | undefined" }, "privacy": "protected", "inheritedFrom": { "name": "OdxButton", "module": "src/lib/button/button.ts" } }, { "kind": "field", "name": "badgePlacement", "type": { "text": "ButtonBadgePlacement" }, "attribute": "badge-placement", "reflects": true, "inheritedFrom": { "name": "OdxButton", "module": "src/lib/button/button.ts" } }, { "kind": "field", "name": "href", "type": { "text": "string" }, "default": "''", "description": "The URL that the element links to.", "attribute": "href", "inheritedFrom": { "name": "OdxButton", "module": "src/lib/button/button.ts" } }, { "kind": "field", "name": "target", "type": { "text": "'_blank' | '_parent' | '_self' | '_top' | ''" }, "default": "''", "description": "Specifies where to open the linked document.", "attribute": "target", "inheritedFrom": { "name": "OdxButton", "module": "src/lib/button/button.ts" } }, { "kind": "field", "name": "rel", "type": { "text": "string" }, "default": "''", "description": "Specifies the relationship between the current document and the linked document.", "attribute": "rel", "inheritedFrom": { "name": "OdxButton", "module": "src/lib/button/button.ts" } }, { "kind": "field", "name": "download", "type": { "text": "string | undefined" }, "description": "Specifies that the target will be downloaded when a user clicks on the hyperlink.", "attribute": "download", "inheritedFrom": { "name": "OdxButton", "module": "src/lib/button/button.ts" } }, { "kind": "field", "name": "type", "type": { "text": "'button' | 'submit' | 'reset'" }, "default": "'button'", "description": "The type of the button.", "attribute": "type", "inheritedFrom": { "name": "OdxButton", "module": "src/lib/button/button.ts" } }, { "kind": "field", "name": "variant", "type": { "text": "ButtonVariant" }, "description": "The variant of the button.", "attribute": "variant", "reflects": true, "inheritedFrom": { "name": "OdxButton", "module": "src/lib/button/button.ts" } }, { "kind": "field", "name": "value", "type": { "text": "string" }, "default": "''", "description": "The value associated with the button. When the button is used to submit a form, this value is sent as part of the form data paired with the button's `name`.", "attribute": "value", "inheritedFrom": { "name": "OdxButton", "module": "src/lib/button/button.ts" } }, { "kind": "field", "name": "elementInternals", "inheritedFrom": { "name": "OdxButton", "module": "src/lib/button/button.ts" } }, { "kind": "field", "name": "#initialAriaLabel", "privacy": "private", "type": { "text": "string | null" }, "default": "null" }, { "kind": "field", "name": "float", "type": { "text": "boolean" }, "default": "false", "attribute": "float", "reflects": true }, { "kind": "field", "name": "preset", "type": { "text": "IconButtonPreset | undefined" }, "attribute": "preset" }, { "kind": "field", "name": "#handleClick", "privacy": "private", "inheritedFrom": { "name": "ButtonBase", "module": "src/lib/button/button.base.ts" } }, { "kind": "field", "name": "#handleKeyboardEvent", "privacy": "private", "inheritedFrom": { "name": "ButtonBase", "module": "src/lib/button/button.base.ts" } } ], "attributes": [ { "name": "float", "type": { "text": "boolean" }, "default": "false", "fieldName": "float" }, { "name": "preset", "type": { "text": "IconButtonPreset | undefined" }, "fieldName": "preset" }, { "name": "badge-placement", "type": { "text": "ButtonBadgePlacement" }, "fieldName": "badgePlacement", "inheritedFrom": { "name": "OdxButton", "module": "src/lib/button/button.ts" } }, { "name": "href", "type": { "text": "string" }, "default": "''", "description": "The URL that the element links to.", "fieldName": "href", "inheritedFrom": { "name": "OdxButton", "module": "src/lib/button/button.ts" } }, { "name": "target", "type": { "text": "'_blank' | '_parent' | '_self' | '_top' | ''" }, "default": "''", "description": "Specifies where to open the linked document.", "fieldName": "target", "inheritedFrom": { "name": "OdxButton", "module": "src/lib/button/button.ts" } }, { "name": "rel", "type": { "text": "string" }, "default": "''", "description": "Specifies the relationship between the current document and the linked document.", "fieldName": "rel", "inheritedFrom": { "name": "OdxButton", "module": "src/lib/button/button.ts" } }, { "name": "download", "type": { "text": "string | undefined" }, "description": "Specifies that the target will be downloaded when a user clicks on the hyperlink.", "fieldName": "download", "inheritedFrom": { "name": "OdxButton", "module": "src/lib/button/button.ts" } }, { "name": "type", "type": { "text": "'button' | 'submit' | 'reset'" }, "default": "'button'", "description": "The type of the button.", "fieldName": "type", "inheritedFrom": { "name": "OdxButton", "module": "src/lib/button/button.ts" } }, { "name": "variant", "type": { "text": "ButtonVariant" }, "description": "The variant of the button.", "fieldName": "variant", "inheritedFrom": { "name": "OdxButton", "module": "src/lib/button/button.ts" } }, { "name": "value", "type": { "text": "string" }, "default": "''", "description": "The value associated with the button. When the button is used to submit a form, this value is sent as part of the form data paired with the button's `name`.", "fieldName": "value", "inheritedFrom": { "name": "OdxButton", "module": "src/lib/button/button.ts" } }, { "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Indicates whether the element is disabled.\nIf `true` it cannot be interacted with nor be focused.", "fieldName": "disabled", "inheritedFrom": { "name": "ButtonBase", "module": "src/lib/button/button.base.ts" } }, { "name": "hint", "type": { "text": "string | null | undefined" }, "fieldName": "hint", "inheritedFrom": { "name": "ButtonBase", "module": "src/lib/button/button.base.ts" } }, { "name": "hint-loading", "type": { "text": "string | null | undefined" }, "fieldName": "hintLoading", "inheritedFrom": { "name": "ButtonBase", "module": "src/lib/button/button.base.ts" } }, { "name": "hint-placement", "type": { "text": "TooltipPlacement | null | undefined" }, "fieldName": "hintPlacement", "inheritedFrom": { "name": "ButtonBase", "module": "src/lib/button/button.base.ts" } }, { "name": "hint-variant", "type": { "text": "TooltipVariant | null | undefined" }, "description": "Visual variant of the hint tooltip. Defaults to `neutral`.", "fieldName": "hintVariant", "inheritedFrom": { "name": "ButtonBase", "module": "src/lib/button/button.base.ts" } }, { "name": "icon", "type": { "text": "OdxIconName | null | undefined" }, "description": "Name of the icon to render next to the label. When no slotted content is present,\nthe icon takes the place of the label entirely.", "fieldName": "icon", "inheritedFrom": { "name": "ButtonBase", "module": "src/lib/button/button.base.ts" } }, { "name": "loading", "type": { "text": "boolean" }, "default": "false", "description": "When `true`, replaces the prefix or suffix slot content with a loading spinner\nand prevents click activation. The button reports `aria-busy=\"true\"` while loading.", "fieldName": "loading", "inheritedFrom": { "name": "ButtonBase", "module": "src/lib/button/button.base.ts" } }, { "name": "size", "type": { "text": "ButtonSize" }, "description": "Size of the button. Affects height, padding, and typography.", "fieldName": "size", "inheritedFrom": { "name": "ButtonBase", "module": "src/lib/button/button.base.ts" } } ], "superclass": { "name": "OdxButton", "module": "/src/lib/button/button.js" }, "tagName": "odx-icon-button", "customElement": true, "slots": [ { "description": "The button's label.", "name": "", "inheritedFrom": { "name": "ButtonBase", "module": "src/lib/button/button.base.ts" } }, { "description": "Prefix slot typically used for icons. Replaced by a loading spinner while `loading` is `true` if no `suffix` content is present.", "name": "prefix", "inheritedFrom": { "name": "ButtonBase", "module": "src/lib/button/button.base.ts" } }, { "description": "Suffix slot typically used for icons. Replaced by a loading spinner while `loading` is `true` when populated.", "name": "suffix", "inheritedFrom": { "name": "ButtonBase", "module": "src/lib/button/button.base.ts" } }, { "description": "Optional badge rendered as an overlay next to the label. Position is controlled by the `badgePlacement` property.", "name": "badge", "inheritedFrom": { "name": "ButtonBase", "module": "src/lib/button/button.base.ts" } } ], "cssParts": [ { "description": "The icon element rendered when the `icon` property is set.", "name": "icon", "inheritedFrom": { "name": "ButtonBase", "module": "src/lib/button/button.base.ts" } } ], "events": [], "cssProperties": [] } ], "exports": [ { "kind": "js", "name": "IconButtonPreset", "declaration": { "name": "IconButtonPreset", "module": "src/lib/button/icon-button.ts" } }, { "kind": "js", "name": "OdxIconButton", "declaration": { "name": "OdxIconButton", "module": "src/lib/button/icon-button.ts" } } ] }, { "kind": "javascript-module", "path": "src/lib/button/split-button.ts", "declarations": [ { "kind": "variable", "name": "SplitButtonLayout", "type": { "text": "{ HORIZONTAL: 'horizontal', VERTICAL: 'vertical' }" }, "default": "{ HORIZONTAL: 'horizontal', VERTICAL: 'vertical' }" }, { "kind": "class", "description": "", "name": "OdxSplitButton", "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "static": true, "default": "'odx-split-button' satisfies keyof HTMLElementTagNameMap", "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "default": "false", "attribute": "disabled", "reflects": true }, { "kind": "field", "name": "size", "type": { "text": "ButtonSize" }, "attribute": "size", "reflects": true }, { "kind": "field", "name": "layout", "type": { "text": "SplitButtonLayout" }, "attribute": "layout", "reflects": true }, { "kind": "field", "name": "variant", "type": { "text": "ButtonVariant" }, "attribute": "variant", "reflects": true }, { "kind": "field", "name": "role", "type": { "text": "ARIARole | null" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "dir", "type": { "text": "'ltr' | 'rtl'" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } } ], "attributes": [ { "name": "disabled", "type": { "text": "boolean" }, "default": "false", "fieldName": "disabled" }, { "name": "size", "type": { "text": "ButtonSize" }, "fieldName": "size" }, { "name": "layout", "type": { "text": "SplitButtonLayout" }, "fieldName": "layout" }, { "name": "variant", "type": { "text": "ButtonVariant" }, "fieldName": "variant" } ], "superclass": { "name": "CustomElement", "module": "/src/internal/custom-element.js" }, "summary": "A component that groups buttons closely together and indicates that they are related.", "tagName": "odx-split-button", "customElement": true, "events": [], "slots": [], "cssParts": [], "cssProperties": [] } ], "exports": [ { "kind": "js", "name": "SplitButtonLayout", "declaration": { "name": "SplitButtonLayout", "module": "src/lib/button/split-button.ts" } }, { "kind": "js", "name": "OdxSplitButton", "declaration": { "name": "OdxSplitButton", "module": "src/lib/button/split-button.ts" } } ] }, { "kind": "javascript-module", "path": "src/lib/button-group/button-group.ts", "declarations": [ { "kind": "variable", "name": "ButtonGroupBehavior", "type": { "text": "{ OVERFLOW: 'overflow', FIXED: 'fixed' }" }, "default": "{ OVERFLOW: 'overflow', FIXED: 'fixed' }" }, { "kind": "variable", "name": "ButtonGroupLayout", "type": { "text": "{ HORIZONTAL: 'horizontal', VERTICAL: 'vertical' }" }, "default": "{ HORIZONTAL: 'horizontal', VERTICAL: 'vertical' }" }, { "kind": "class", "description": "", "name": "OdxButtonGroup", "slots": [ { "description": "Default slot for buttons", "name": "" } ], "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "static": true, "default": "'odx-button-group' satisfies keyof HTMLElementTagNameMap", "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "#intersectionObserver", "privacy": "private", "type": { "text": "IntersectionObserver | undefined" } }, { "kind": "field", "name": "#visibleElements", "privacy": "private", "default": "new WeakSet()" }, { "kind": "field", "name": "behavior", "type": { "text": "ButtonGroupBehavior" }, "attribute": "behavior", "reflects": true }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "default": "false", "attribute": "disabled", "reflects": true }, { "kind": "field", "name": "layout", "type": { "text": "ButtonGroupLayout" }, "attribute": "layout", "reflects": true }, { "kind": "field", "name": "size", "type": { "text": "ButtonSize" }, "attribute": "size", "reflects": true }, { "kind": "field", "name": "variant", "type": { "text": "ButtonVariant | null | undefined" }, "attribute": "variant" }, { "kind": "method", "name": "getItems", "return": { "type": { "text": "ButtonBase[]" } } }, { "kind": "method", "name": "#renderOverflowMenu", "privacy": "private", "return": { "type": { "text": "TemplateResult | null" } }, "parameters": [ { "name": "buttons", "type": { "text": "ButtonBase[]" } } ] }, { "kind": "method", "name": "#observeItems", "privacy": "private" }, { "kind": "method", "name": "#createMenuItemHandler", "privacy": "private", "parameters": [ { "name": "button", "type": { "text": "ButtonBase" } } ] }, { "kind": "field", "name": "#handleSlotChange", "privacy": "private" }, { "kind": "field", "name": "role", "type": { "text": "ARIARole | null" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "dir", "type": { "text": "'ltr' | 'rtl'" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } } ], "attributes": [ { "name": "behavior", "type": { "text": "ButtonGroupBehavior" }, "fieldName": "behavior" }, { "name": "disabled", "type": { "text": "boolean" }, "default": "false", "fieldName": "disabled" }, { "name": "layout", "type": { "text": "ButtonGroupLayout" }, "fieldName": "layout" }, { "name": "size", "type": { "text": "ButtonSize" }, "fieldName": "size" }, { "name": "variant", "type": { "text": "ButtonVariant | null | undefined" }, "fieldName": "variant" } ], "superclass": { "name": "CustomElement", "module": "/src/internal/custom-element.js" }, "summary": "A component that groups buttons and handles overflow", "tagName": "odx-button-group", "customElement": true, "events": [], "cssParts": [], "cssProperties": [] } ], "exports": [ { "kind": "js", "name": "ButtonGroupBehavior", "declaration": { "name": "ButtonGroupBehavior", "module": "src/lib/button-group/button-group.ts" } }, { "kind": "js", "name": "ButtonGroupLayout", "declaration": { "name": "ButtonGroupLayout", "module": "src/lib/button-group/button-group.ts" } }, { "kind": "js", "name": "OdxButtonGroup", "declaration": { "name": "OdxButtonGroup", "module": "src/lib/button-group/button-group.ts" } } ] }, { "kind": "javascript-module", "path": "src/lib/card/card.ts", "declarations": [ { "kind": "variable", "name": "CardVariant", "type": { "text": "{ NEUTRAL: 'neutral', GHOST: 'ghost' }" }, "default": "{ NEUTRAL: 'neutral', GHOST: 'ghost' }" }, { "kind": "class", "description": "", "name": "OdxCard", "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "static": true, "default": "'odx-card' satisfies keyof HTMLElementTagNameMap", "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "#slots", "privacy": "private", "default": "new SlotContentObserver(this)" }, { "kind": "field", "name": "variant", "type": { "text": "CardVariant" }, "attribute": "variant", "reflects": true }, { "kind": "method", "name": "#handleSlotChange", "privacy": "private" }, { "kind": "field", "name": "role", "type": { "text": "ARIARole | null" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "dir", "type": { "text": "'ltr' | 'rtl'" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } } ], "attributes": [ { "name": "variant", "type": { "text": "CardVariant" }, "fieldName": "variant" } ], "superclass": { "name": "CustomElement", "module": "/src/internal/custom-element.js" }, "tagName": "odx-card", "customElement": true, "events": [], "slots": [], "cssParts": [], "cssProperties": [] } ], "exports": [ { "kind": "js", "name": "CardVariant", "declaration": { "name": "CardVariant", "module": "src/lib/card/card.ts" } }, { "kind": "js", "name": "OdxCard", "declaration": { "name": "OdxCard", "module": "src/lib/card/card.ts" } } ] }, { "kind": "javascript-module", "path": "src/lib/checkbox/checkbox.base.ts", "declarations": [ { "kind": "variable", "name": "CheckboxControlPlacement", "type": { "text": "{ START: 'start', END: 'end' }" }, "default": "{ START: 'start', END: 'end' }" }, { "kind": "variable", "name": "CheckboxSize", "type": { "text": "{ SM: 'sm', MD: 'md' }" }, "default": "{ SM: 'sm', MD: 'md' }" }, { "kind": "class", "description": "", "name": "CheckboxBase", "members": [ { "kind": "field", "name": "#keyDownDetected", "privacy": "private", "type": { "text": "boolean" }, "default": "false" }, { "kind": "field", "name": "selection", "privacy": "private", "default": "new SelectableController(this)" }, { "kind": "field", "name": "baseElement", "type": { "text": "HTMLElement" }, "privacy": "private" }, { "kind": "field", "name": "checked", "type": { "text": "boolean" }, "default": "false", "attribute": "checked", "reflects": true }, { "kind": "field", "name": "controlPlacement", "type": { "text": "CheckboxControlPlacement" }, "attribute": "control-placement", "reflects": true }, { "kind": "field", "name": "invalid", "type": { "text": "boolean" }, "default": "false", "attribute": "invalid", "reflects": true }, { "kind": "field", "name": "size", "type": { "text": "CheckboxSize" }, "attribute": "size", "reflects": true }, { "kind": "field", "name": "value", "type": { "text": "string" }, "default": "''", "attribute": "value" }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "attribute": "disabled", "reflects": true }, { "kind": "method", "name": "click", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "toFormValue", "return": { "type": { "text": "string | null" } } }, { "kind": "method", "name": "toggle", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "state", "optional": true, "type": { "text": "boolean" } } ] }, { "kind": "method", "name": "renderControl", "privacy": "protected", "return": { "type": { "text": "TemplateResult" } }, "parameters": [ { "name": "icon", "optional": true, "type": { "text": "OdxIconName" } } ] }, { "kind": "method", "name": "#isInteractive", "privacy": "private", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "event", "optional": true, "type": { "text": "Event" } } ] }, { "kind": "field", "name": "#handleClick", "privacy": "private" }, { "kind": "field", "name": "#handleKeyboardEvent", "privacy": "private" }, { "kind": "field", "name": "tagName", "type": { "text": "string" }, "static": true, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "role", "type": { "text": "ARIARole | null" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "dir", "type": { "text": "'ltr' | 'rtl'" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } } ], "events": [ { "name": "change", "type": { "text": "Event" } } ], "attributes": [ { "name": "checked", "type": { "text": "boolean" }, "default": "false", "fieldName": "checked" }, { "name": "control-placement", "type": { "text": "CheckboxControlPlacement" }, "fieldName": "controlPlacement" }, { "name": "invalid", "type": { "text": "boolean" }, "default": "false", "fieldName": "invalid" }, { "name": "size", "type": { "text": "CheckboxSize" }, "fieldName": "size" }, { "name": "value", "type": { "text": "string" }, "default": "''", "fieldName": "value" }, { "name": "disabled", "type": { "text": "boolean" }, "fieldName": "disabled" } ], "mixins": [ { "name": "FormAssociated", "module": "/src/internal/behaviors/form-associated.js" } ], "superclass": { "name": "CustomElement", "module": "/src/internal/custom-element.js" }, "summary": "Base class for checkbox components." } ], "exports": [ { "kind": "js", "name": "CheckboxControlPlacement", "declaration": { "name": "CheckboxControlPlacement", "module": "src/lib/checkbox/checkbox.base.ts" } }, { "kind": "js", "name": "CheckboxSize", "declaration": { "name": "CheckboxSize", "module": "src/lib/checkbox/checkbox.base.ts" } }, { "kind": "js", "name": "CheckboxBase", "declaration": { "name": "CheckboxBase", "module": "src/lib/checkbox/checkbox.base.ts" } } ] }, { "kind": "javascript-module", "path": "src/lib/checkbox/checkbox.ts", "declarations": [ { "kind": "class", "description": "", "name": "OdxCheckbox", "slots": [ { "description": "The default slot for the checkbox label", "name": "" }, { "description": "Hint slot", "name": "hint" } ], "members": [ { "kind": "field", "name": "selection", "privacy": "private", "default": "new SelectableController(this)", "inheritedFrom": { "name": "CheckboxBase", "module": "src/lib/checkbox/checkbox.base.ts" } }, { "kind": "field", "name": "baseElement", "type": { "text": "HTMLElement" }, "privacy": "private", "inheritedFrom": { "name": "CheckboxBase", "module": "src/lib/checkbox/checkbox.base.ts" } }, { "kind": "field", "name": "checked", "type": { "text": "boolean" }, "default": "false", "attribute": "checked", "reflects": true, "inheritedFrom": { "name": "CheckboxBase", "module": "src/lib/checkbox/checkbox.base.ts" } }, { "kind": "field", "name": "controlPlacement", "type": { "text": "CheckboxControlPlacement" }, "attribute": "control-placement", "reflects": true, "inheritedFrom": { "name": "CheckboxBase", "module": "src/lib/checkbox/checkbox.base.ts" } }, { "kind": "field", "name": "invalid", "type": { "text": "boolean" }, "default": "false", "attribute": "invalid", "reflects": true, "inheritedFrom": { "name": "CheckboxBase", "module": "src/lib/checkbox/checkbox.base.ts" } }, { "kind": "field", "name": "size", "type": { "text": "CheckboxSize" }, "attribute": "size", "reflects": true, "inheritedFrom": { "name": "CheckboxBase", "module": "src/lib/checkbox/checkbox.base.ts" } }, { "kind": "field", "name": "value", "type": { "text": "string" }, "default": "''", "attribute": "value", "inheritedFrom": { "name": "CheckboxBase", "module": "src/lib/checkbox/checkbox.base.ts" } }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "attribute": "disabled", "reflects": true, "inheritedFrom": { "name": "CheckboxBase", "module": "src/lib/checkbox/checkbox.base.ts" } }, { "kind": "method", "name": "click", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "CheckboxBase", "module": "src/lib/checkbox/checkbox.base.ts" } }, { "kind": "method", "name": "toFormValue", "return": { "type": { "text": "string | null" } }, "inheritedFrom": { "name": "CheckboxBase", "module": "src/lib/checkbox/checkbox.base.ts" } }, { "kind": "method", "name": "toggle", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "state", "optional": true, "type": { "text": "boolean" } } ], "inheritedFrom": { "name": "CheckboxBase", "module": "src/lib/checkbox/checkbox.base.ts" } }, { "kind": "method", "name": "renderControl", "privacy": "protected", "return": { "type": { "text": "TemplateResult" } }, "parameters": [ { "name": "icon", "optional": true, "type": { "text": "OdxIconName" } } ], "inheritedFrom": { "name": "CheckboxBase", "module": "src/lib/checkbox/checkbox.base.ts" } }, { "kind": "field", "name": "tagName", "type": { "text": "string" }, "static": true, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" }, "default": "'odx-checkbox' satisfies keyof HTMLElementTagNameMap" }, { "kind": "field", "name": "role", "type": { "text": "ARIARole | null" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "dir", "type": { "text": "'ltr' | 'rtl'" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "indeterminate", "type": { "text": "boolean" }, "default": "false", "attribute": "indeterminate", "reflects": true }, { "kind": "field", "name": "#keyDownDetected", "privacy": "private", "type": { "text": "boolean" }, "default": "false", "inheritedFrom": { "name": "CheckboxBase", "module": "src/lib/checkbox/checkbox.base.ts" } }, { "kind": "method", "name": "#isInteractive", "privacy": "private", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "event", "optional": true, "type": { "text": "Event" } } ], "inheritedFrom": { "name": "CheckboxBase", "module": "src/lib/checkbox/checkbox.base.ts" } }, { "kind": "field", "name": "#handleClick", "privacy": "private", "inheritedFrom": { "name": "CheckboxBase", "module": "src/lib/checkbox/checkbox.base.ts" } }, { "kind": "field", "name": "#handleKeyboardEvent", "privacy": "private", "inheritedFrom": { "name": "CheckboxBase", "module": "src/lib/checkbox/checkbox.base.ts" } } ], "attributes": [ { "name": "indeterminate", "type": { "text": "boolean" }, "default": "false", "fieldName": "indeterminate" }, { "name": "checked", "type": { "text": "boolean" }, "default": "false", "fieldName": "checked", "inheritedFrom": { "name": "CheckboxBase", "module": "src/lib/checkbox/checkbox.base.ts" } }, { "name": "control-placement", "type": { "text": "CheckboxControlPlacement" }, "fieldName": "controlPlacement", "inheritedFrom": { "name": "CheckboxBase", "module": "src/lib/checkbox/checkbox.base.ts" } }, { "name": "invalid", "type": { "text": "boolean" }, "default": "false", "fieldName": "invalid", "inheritedFrom": { "name": "CheckboxBase", "module": "src/lib/checkbox/checkbox.base.ts" } }, { "name": "size", "type": { "text": "CheckboxSize" }, "fieldName": "size", "inheritedFrom": { "name": "CheckboxBase", "module": "src/lib/checkbox/checkbox.base.ts" } }, { "name": "value", "type": { "text": "string" }, "default": "''", "fieldName": "value", "inheritedFrom": { "name": "CheckboxBase", "module": "src/lib/checkbox/checkbox.base.ts" } }, { "name": "disabled", "type": { "text": "boolean" }, "fieldName": "disabled", "inheritedFrom": { "name": "CheckboxBase", "module": "src/lib/checkbox/checkbox.base.ts" } } ], "superclass": { "name": "CheckboxBase", "module": "/src/lib/checkbox/checkbox.base.js" }, "summary": "A checkbox component that allows users to select one or more options from a set.", "tagName": "odx-checkbox", "customElement": true, "events": [ { "name": "change", "type": { "text": "Event" }, "inheritedFrom": { "name": "CheckboxBase", "module": "src/lib/checkbox/checkbox.base.ts" } } ], "cssParts": [], "cssProperties": [] } ], "exports": [ { "kind": "js", "name": "OdxCheckbox", "declaration": { "name": "OdxCheckbox", "module": "src/lib/checkbox/checkbox.ts" } } ] }, { "kind": "javascript-module", "path": "src/lib/checkbox-group/checkbox-group.ts", "declarations": [ { "kind": "variable", "name": "CheckboxGroupControlDirective" }, { "kind": "class", "description": "", "name": "OdxCheckboxGroup", "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "static": true, "default": "'odx-checkbox-group' satisfies keyof HTMLElementTagNameMap", "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "#rovingTabIndex", "privacy": "private", "default": "new RovingTabindexController(this, { direction: () => 'vertical', elements: () => [...this.selection.controls, ...this.selection.enabledItems], focusInIndex: (items) => { if (this.disabled) return -1; const selectedIndex = items.findIndex((item) => item.checked || item.indeterminate); return Math.max(0, selectedIndex) || Math.min(0, items.length - 1); }, isFocusableElement: (item) => !item.readonly || item.checked, })" }, { "kind": "field", "name": "selection", "default": "new SelectionController(this, { multiple: true, isSelectable: (item) => !item.readonly, isSelectionControl: (item) => item.slot === 'control' || CheckboxGroupControlDirective.applied(item), onChange: ({ value }) => { if (String(this.value) === String(value)) return; this.value = value; this.dispatchEvent(new Event('change')); }, onItemsChange: () => { this.#updateControls(); this.#rovingTabIndex.clearElementCache(); }, })" }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "default": "false", "attribute": "disabled", "reflects": true }, { "kind": "field", "name": "readonly", "type": { "text": "boolean" }, "default": "false", "attribute": "readonly" }, { "kind": "field", "name": "value", "type": { "text": "string[]" }, "default": "[]", "attribute": "value" }, { "kind": "method", "name": "clear", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "initialValue", "optional": true, "type": { "text": "string[]" } } ] }, { "kind": "method", "name": "toggleAll", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "state", "optional": true, "type": { "text": "boolean" } } ] }, { "kind": "method", "name": "#updateControls", "privacy": "private" }, { "kind": "field", "name": "role", "type": { "text": "ARIARole | null" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "dir", "type": { "text": "'ltr' | 'rtl'" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } } ], "attributes": [ { "name": "disabled", "type": { "text": "boolean" }, "default": "false", "fieldName": "disabled" }, { "name": "readonly", "type": { "text": "boolean" }, "default": "false", "fieldName": "readonly" }, { "name": "value", "type": { "text": "string[]" }, "default": "[]", "fieldName": "value" } ], "superclass": { "name": "CustomElement", "module": "/src/internal/custom-element.js" }, "tagName": "odx-checkbox-group", "customElement": true, "events": [], "slots": [], "cssParts": [], "cssProperties": [] } ], "exports": [ { "kind": "js", "name": "CheckboxGroupControlDirective", "declaration": { "name": "CheckboxGroupControlDirective", "module": "src/lib/checkbox-group/checkbox-group.ts" } }, { "kind": "js", "name": "OdxCheckboxGroup", "declaration": { "name": "OdxCheckboxGroup", "module": "src/lib/checkbox-group/checkbox-group.ts" } } ] }, { "kind": "javascript-module", "path": "src/lib/chip/chip.ts", "declarations": [ { "kind": "variable", "name": "ChipSize", "type": { "text": "{ SM: 'sm', MD: 'md' }" }, "default": "{ SM: 'sm', MD: 'md' }" }, { "kind": "variable", "name": "ChipVariant", "type": { "text": "{ NEUTRAL: 'neutral', PRIMARY: 'primary', ACCENT: 'accent' }" }, "default": "{ NEUTRAL: 'neutral', PRIMARY: 'primary', ACCENT: 'accent' }" }, { "kind": "class", "description": "", "name": "OdxChip", "slots": [ { "description": "The chip's label.", "name": "" } ], "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "static": true, "default": "'odx-chip' satisfies keyof HTMLElementTagNameMap", "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Indicates whether the chip is disabled.\nIf `true` it cannot be interacted with nor be focused.\nOnly has an effect if `interactive` is set to `true`.", "attribute": "disabled", "reflects": true }, { "kind": "field", "name": "interactive", "type": { "text": "boolean" }, "default": "false", "description": "Indicates whether the chip is interactive.\nIf `true` the chip can be focused.", "attribute": "interactive", "reflects": true }, { "kind": "field", "name": "removable", "type": { "text": "boolean" }, "default": "false", "description": "Indicates whether the chip can be removed.\nIf `true` a remove action will be added to the chip.\nThe `remove` event is fired when the remove action is clicked or the `esc` key is pressed while the chip is focused.", "attribute": "removable", "reflects": true }, { "kind": "field", "name": "size", "type": { "text": "ChipSize" }, "description": "The size of the chip.", "attribute": "size", "reflects": true }, { "kind": "field", "name": "variant", "type": { "text": "ChipVariant" }, "description": "The variant of the chip.", "attribute": "variant", "reflects": true }, { "kind": "method", "name": "getIcon", "return": { "type": { "text": "OdxIconName | null" } }, "description": "Get the icon assigned to the chip`s default slot." }, { "kind": "field", "name": "#handleClick", "privacy": "private" }, { "kind": "field", "name": "#handleKeyboardEvent", "privacy": "private" }, { "kind": "field", "name": "#handleRemove", "privacy": "private" }, { "kind": "field", "name": "role", "type": { "text": "ARIARole | null" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "dir", "type": { "text": "'ltr' | 'rtl'" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } } ], "events": [ { "description": "Fired when the remove action is triggered.", "name": "remove" } ], "attributes": [ { "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Indicates whether the chip is disabled.\nIf `true` it cannot be interacted with nor be focused.\nOnly has an effect if `interactive` is set to `true`.", "fieldName": "disabled" }, { "name": "interactive", "type": { "text": "boolean" }, "default": "false", "description": "Indicates whether the chip is interactive.\nIf `true` the chip can be focused.", "fieldName": "interactive" }, { "name": "removable", "type": { "text": "boolean" }, "default": "false", "description": "Indicates whether the chip can be removed.\nIf `true` a remove action will be added to the chip.\nThe `remove` event is fired when the remove action is clicked or the `esc` key is pressed while the chip is focused.", "fieldName": "removable" }, { "name": "size", "type": { "text": "ChipSize" }, "description": "The size of the chip.", "fieldName": "size" }, { "name": "variant", "type": { "text": "ChipVariant" }, "description": "The variant of the chip.", "fieldName": "variant" } ], "superclass": { "name": "CustomElement", "module": "/src/internal/custom-element.js" }, "summary": "Chips are dynamic UI elements that can be used as labels to highlight a particular state or property.", "tagName": "odx-chip", "customElement": true, "status": "rc", "since": "1.0", "dependencies": [ "odx-icon-button" ], "cssParts": [], "cssProperties": [] } ], "exports": [ { "kind": "js", "name": "ChipSize", "declaration": { "name": "ChipSize", "module": "src/lib/chip/chip.ts" } }, { "kind": "js", "name": "ChipVariant", "declaration": { "name": "ChipVariant", "module": "src/lib/chip/chip.ts" } }, { "kind": "js", "name": "OdxChip", "declaration": { "name": "OdxChip", "module": "src/lib/chip/chip.ts" } } ] }, { "kind": "javascript-module", "path": "src/lib/chip-group/chip-group.ts", "declarations": [ { "kind": "class", "description": "", "name": "OdxChipGroup", "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "static": true, "default": "'odx-chip-group' satisfies keyof HTMLElementTagNameMap", "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "#intersectionController", "privacy": "private", "default": "new IntersectionController(this, { root: () => this.baseElement, elements: () => this.getItems(), handler: (items) => { items.forEach((item) => { item.toggleAttribute('data-hidden', !this.#intersectionController.isIntersecting(item)); }); this.requestUpdate(); }, })" }, { "kind": "field", "name": "#rovingTabIndex", "privacy": "private", "default": "new RovingTabindexController(this, { direction: () => 'horizontal', elements: () => this.getItems(), focusInIndex: (items) => items.findIndex((item) => item.interactive || item.removable), isFocusableElement: (item) => (item.hasAttribute('data-hidden') ? false : item.interactive || item.removable), })" }, { "kind": "field", "name": "baseElement", "type": { "text": "HTMLElement" }, "privacy": "private" }, { "kind": "field", "name": "menuDisabled", "type": { "text": "boolean" }, "default": "false", "attribute": "menu-disabled", "reflects": true }, { "kind": "field", "name": "size", "type": { "text": "ChipSize" }, "attribute": "size", "reflects": true }, { "kind": "method", "name": "getItems", "return": { "type": { "text": "OdxChip[]" } } }, { "kind": "method", "name": "#renderOverflowIndicator", "privacy": "private", "parameters": [ { "name": "chips", "type": { "text": "OdxChip[]" } } ] }, { "kind": "method", "name": "#renderOverflowMenu", "privacy": "private", "parameters": [ { "name": "chips", "type": { "text": "OdxChip[]" } } ] }, { "kind": "method", "name": "#syncItemProperties", "privacy": "private" }, { "kind": "method", "name": "#forwardChipClick", "privacy": "private", "parameters": [ { "name": "chip", "type": { "text": "OdxChip" } } ] }, { "kind": "method", "name": "#forwardChipRemove", "privacy": "private", "parameters": [ { "name": "chip", "type": { "text": "OdxChip" } } ] }, { "kind": "field", "name": "#handleSlotChange", "privacy": "private" }, { "kind": "field", "name": "role", "type": { "text": "ARIARole | null" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "dir", "type": { "text": "'ltr' | 'rtl'" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } } ], "attributes": [ { "name": "menu-disabled", "type": { "text": "boolean" }, "default": "false", "fieldName": "menuDisabled" }, { "name": "size", "type": { "text": "ChipSize" }, "fieldName": "size" } ], "superclass": { "name": "CustomElement", "module": "/src/internal/custom-element.js" }, "tagName": "odx-chip-group", "customElement": true, "events": [], "slots": [], "cssParts": [], "cssProperties": [] } ], "exports": [ { "kind": "js", "name": "OdxChipGroup", "declaration": { "name": "OdxChipGroup", "module": "src/lib/chip-group/chip-group.ts" } } ] }, { "kind": "javascript-module", "path": "src/lib/content-box/content-box.ts", "declarations": [ { "kind": "variable", "name": "ContentBoxSize", "type": { "text": "{ SM: 'sm', MD: 'md' }" }, "default": "{ SM: 'sm', MD: 'md' }" }, { "kind": "class", "description": "", "name": "OdxContentBox", "slots": [ { "description": "Default slot for main content", "name": "" }, { "description": "Optional header slot. If not provided, the component will look for title, description, and actions slots to construct a header.", "name": "header" }, { "description": "Title slot for the header. Used if the header slot is not provided.", "name": "title" }, { "description": "Actions slot for the header. Used if the header slot is not provided.", "name": "actions" }, { "description": "Optional footer slot", "name": "footer" } ], "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "static": true, "default": "'odx-content-box' satisfies keyof HTMLElementTagNameMap", "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "#slots", "privacy": "private", "default": "new SlotContentObserver(this)" }, { "kind": "field", "name": "size", "type": { "text": "ContentBoxSize" }, "attribute": "size", "reflects": true }, { "kind": "field", "name": "role", "type": { "text": "ARIARole | null" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "dir", "type": { "text": "'ltr' | 'rtl'" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } } ], "attributes": [ { "name": "size", "type": { "text": "ContentBoxSize" }, "fieldName": "size" } ], "superclass": { "name": "CustomElement", "module": "/src/internal/custom-element.js" }, "summary": "A component that provides a consistent layout for content with optional header and footer sections.", "tagName": "odx-content-box", "customElement": true, "events": [], "cssParts": [], "cssProperties": [] } ], "exports": [ { "kind": "js", "name": "ContentBoxSize", "declaration": { "name": "ContentBoxSize", "module": "src/lib/content-box/content-box.ts" } }, { "kind": "js", "name": "OdxContentBox", "declaration": { "name": "OdxContentBox", "module": "src/lib/content-box/content-box.ts" } } ] }, { "kind": "javascript-module", "path": "src/lib/drawer/drawer.ts", "declarations": [ { "kind": "variable", "name": "DrawerPlacement", "type": { "text": "{ START: 'start', END: 'end', TOP: 'top', BOTTOM: 'bottom' }" }, "default": "{ START: 'start', END: 'end', TOP: 'top', BOTTOM: 'bottom' }" }, { "kind": "variable", "name": "DrawerSize", "type": { "text": "{ SM: 'sm', MD: 'md', LG: 'lg' }" }, "default": "{ SM: 'sm', MD: 'md', LG: 'lg' }" }, { "kind": "variable", "name": "DrawerVariant", "type": { "text": "{ DEFAULT: 'default', GHOST: 'ghost' }" }, "default": "{ DEFAULT: 'default', GHOST: 'ghost' }" }, { "kind": "class", "description": "", "name": "OdxDrawer", "members": [ { "kind": "field", "name": "initialized", "type": { "text": "boolean" }, "privacy": "private", "static": true, "default": "true", "inheritedFrom": { "name": "DialogElement", "module": "src/internal/dialog-element.ts" } }, { "kind": "field", "name": "backdropDisabled", "type": { "text": "boolean" }, "default": "false", "attribute": "backdrop-disabled", "reflects": true, "inheritedFrom": { "name": "DialogElement", "module": "src/internal/dialog-element.ts" } }, { "kind": "field", "name": "blocking", "type": { "text": "boolean" }, "default": "false", "attribute": "blocking", "reflects": true, "inheritedFrom": { "name": "DialogElement", "module": "src/internal/dialog-element.ts" } }, { "kind": "field", "name": "layer", "type": { "text": "DialogLayer" }, "attribute": "layer", "reflects": true, "inheritedFrom": { "name": "DialogElement", "module": "src/internal/dialog-element.ts" } }, { "kind": "field", "name": "open", "type": { "text": "boolean" }, "default": "false", "attribute": "open", "reflects": true, "inheritedFrom": { "name": "DialogElement", "module": "src/internal/dialog-element.ts" } }, { "kind": "field", "name": "canShow", "readonly": true, "inheritedFrom": { "name": "DialogElement", "module": "src/internal/dialog-element.ts" } }, { "kind": "field", "name": "canClose", "readonly": true, "inheritedFrom": { "name": "DialogElement", "module": "src/internal/dialog-element.ts" } }, { "kind": "field", "name": "canDismiss", "readonly": true, "inheritedFrom": { "name": "DialogElement", "module": "src/internal/dialog-element.ts" } }, { "kind": "method", "name": "show", "return": { "type": { "text": "Promise" } }, "inheritedFrom": { "name": "DialogElement", "module": "src/internal/dialog-element.ts" } }, { "kind": "method", "name": "close", "return": { "type": { "text": "Promise" } }, "parameters": [ { "name": "returnValue", "optional": true, "type": { "text": "string" } } ], "inheritedFrom": { "name": "DialogElement", "module": "src/internal/dialog-element.ts" } }, { "kind": "method", "name": "dismiss", "return": { "type": { "text": "Promise" } }, "inheritedFrom": { "name": "DialogElement", "module": "src/internal/dialog-element.ts" } }, { "kind": "method", "name": "toggle", "return": { "type": { "text": "Promise" } }, "parameters": [ { "name": "state", "optional": true, "type": { "text": "boolean" } }, { "name": "returnValue", "optional": true, "type": { "text": "string" } } ], "inheritedFrom": { "name": "DialogElement", "module": "src/internal/dialog-element.ts" } }, { "kind": "method", "name": "showPopover", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "DialogElement", "module": "src/internal/dialog-element.ts" } }, { "kind": "method", "name": "hidePopover", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "DialogElement", "module": "src/internal/dialog-element.ts" } }, { "kind": "method", "name": "togglePopover", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "state", "optional": true, "type": { "text": "boolean" } } ], "inheritedFrom": { "name": "DialogElement", "module": "src/internal/dialog-element.ts" } }, { "kind": "field", "name": "tagName", "type": { "text": "string" }, "static": true, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" }, "default": "'odx-drawer' satisfies keyof HTMLElementTagNameMap" }, { "kind": "field", "name": "role", "type": { "text": "ARIARole | null" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "dir", "type": { "text": "'ltr' | 'rtl'" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "placement", "type": { "text": "DrawerPlacement" }, "attribute": "placement", "reflects": true }, { "kind": "field", "name": "size", "type": { "text": "DrawerSize" }, "attribute": "size", "reflects": true }, { "kind": "field", "name": "variant", "type": { "text": "DrawerVariant" }, "attribute": "variant", "reflects": true }, { "kind": "field", "name": "#focusTrap", "privacy": "private", "inheritedFrom": { "name": "DialogElement", "module": "src/internal/dialog-element.ts" } }, { "kind": "method", "name": "#addGlobalListeners", "privacy": "private", "inheritedFrom": { "name": "DialogElement", "module": "src/internal/dialog-element.ts" } }, { "kind": "method", "name": "#removeGlobalListeners", "privacy": "private", "inheritedFrom": { "name": "DialogElement", "module": "src/internal/dialog-element.ts" } }, { "kind": "field", "name": "#handleGlobalPointerDown", "privacy": "private", "inheritedFrom": { "name": "DialogElement", "module": "src/internal/dialog-element.ts" } }, { "kind": "field", "name": "#handleGlobalPointerUp", "privacy": "private", "default": "((event: Event & { target: HTMLElement }) => { removeGlobalEventListener('mouseup', this.#handleGlobalPointerUp); if (!this.canDismiss) return; // check for host if in not screen layer if (this.layer !== DialogLayer.SCREEN && clickedOutside(event, this, true)) return; // check for container const container = this.renderRoot.querySelector('#base'); if (container && !clickedOutside(event, container, true)) return; // check for other dialogs const closestDialog = event.target.closest(DialogDirective.selector); if (!this.backdropDisabled && closestDialog && this !== closestDialog) return; event.preventDefault(); this.dismiss(); })", "inheritedFrom": { "name": "DialogElement", "module": "src/internal/dialog-element.ts" } }, { "kind": "field", "name": "#handleGlobalKeydown", "privacy": "private", "default": "((event: KeyboardEvent): void => { if (event.key !== keyEscape || !this.canDismiss) return; event.preventDefault(); this.dismiss(); })", "inheritedFrom": { "name": "DialogElement", "module": "src/internal/dialog-element.ts" } }, { "kind": "field", "name": "#handleToggle", "privacy": "private", "default": "((event: ToggleEvent & { target: HTMLElement }) => { this.open = event.newState === 'open'; }) as unknown", "inheritedFrom": { "name": "DialogElement", "module": "src/internal/dialog-element.ts" } } ], "attributes": [ { "name": "placement", "type": { "text": "DrawerPlacement" }, "fieldName": "placement" }, { "name": "size", "type": { "text": "DrawerSize" }, "fieldName": "size" }, { "name": "variant", "type": { "text": "DrawerVariant" }, "fieldName": "variant" }, { "name": "backdrop-disabled", "type": { "text": "boolean" }, "default": "false", "fieldName": "backdropDisabled", "inheritedFrom": { "name": "DialogElement", "module": "src/internal/dialog-element.ts" } }, { "name": "blocking", "type": { "text": "boolean" }, "default": "false", "fieldName": "blocking", "inheritedFrom": { "name": "DialogElement", "module": "src/internal/dialog-element.ts" } }, { "name": "layer", "type": { "text": "DialogLayer" }, "fieldName": "layer", "inheritedFrom": { "name": "DialogElement", "module": "src/internal/dialog-element.ts" } }, { "name": "open", "type": { "text": "boolean" }, "default": "false", "fieldName": "open", "inheritedFrom": { "name": "DialogElement", "module": "src/internal/dialog-element.ts" } } ], "superclass": { "name": "DialogElement", "module": "/src/internal/dialog-element.js" }, "tagName": "odx-drawer", "customElement": true, "slots": [ { "description": "Default slot", "name": "", "inheritedFrom": { "name": "DialogElement", "module": "src/internal/dialog-element.ts" } } ], "cssParts": [ { "name": "base", "inheritedFrom": { "name": "DialogElement", "module": "src/internal/dialog-element.ts" } } ], "events": [ { "type": { "text": "DialogShowEvent" }, "inheritedFrom": { "name": "DialogElement", "module": "src/internal/dialog-element.ts" } }, { "type": { "text": "DialogShowEvent" }, "description": "Emitted when the dialog is requested to be shown. Can be canceled to prevent showing", "name": "dialog-show", "inheritedFrom": { "name": "DialogElement", "module": "src/internal/dialog-element.ts" } }, { "type": { "text": "DialogCloseEvent" }, "description": "Emitted when the dialog is requested to be closed. Can be canceled to prevent closing", "name": "dialog-close", "inheritedFrom": { "name": "DialogElement", "module": "src/internal/dialog-element.ts" } } ], "cssProperties": [] } ], "exports": [ { "kind": "js", "name": "DrawerPlacement", "declaration": { "name": "DrawerPlacement", "module": "src/lib/drawer/drawer.ts" } }, { "kind": "js", "name": "DrawerSize", "declaration": { "name": "DrawerSize", "module": "src/lib/drawer/drawer.ts" } }, { "kind": "js", "name": "DrawerVariant", "declaration": { "name": "DrawerVariant", "module": "src/lib/drawer/drawer.ts" } }, { "kind": "js", "name": "OdxDrawer", "declaration": { "name": "OdxDrawer", "module": "src/lib/drawer/drawer.ts" } } ] }, { "kind": "javascript-module", "path": "src/lib/dropdown/dropdown.ts", "declarations": [ { "kind": "variable", "name": "DropdownPlacement", "type": { "text": "{\n TOP: PopoverHostPlacement.TOP,\n BOTTOM: PopoverHostPlacement.BOTTOM,\n TOP_START: PopoverHostPlacement.TOP_START,\n TOP_END: PopoverHostPlacement.TOP_END,\n BOTTOM_START: PopoverHostPlacement.BOTTOM_START,\n BOTTOM_END: PopoverHostPlacement.BOTTOM_END,\n}" }, "default": "{ TOP: PopoverHostPlacement.TOP, BOTTOM: PopoverHostPlacement.BOTTOM, TOP_START: PopoverHostPlacement.TOP_START, TOP_END: PopoverHostPlacement.TOP_END, BOTTOM_START: PopoverHostPlacement.BOTTOM_START, BOTTOM_END: PopoverHostPlacement.BOTTOM_END, }" }, { "kind": "class", "description": "", "name": "OdxDropdown", "members": [ { "kind": "field", "name": "initialized", "type": { "text": "boolean" }, "privacy": "private", "static": true, "default": "true", "inheritedFrom": { "name": "PopoverHost", "module": "src/lib/popover/popover-host.ts" } }, { "kind": "field", "name": "popoverElement", "type": { "text": "OdxPopover | undefined" }, "privacy": "protected", "inheritedFrom": { "name": "PopoverHost", "module": "src/lib/popover/popover-host.ts" } }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "default": "false", "attribute": "disabled", "reflects": true, "inheritedFrom": { "name": "PopoverHost", "module": "src/lib/popover/popover-host.ts" } }, { "kind": "field", "name": "open", "type": { "text": "boolean" }, "default": "false", "attribute": "open", "reflects": true, "inheritedFrom": { "name": "PopoverHost", "module": "src/lib/popover/popover-host.ts" } }, { "kind": "field", "name": "referenceElement", "type": { "text": "HTMLElement | null" }, "inheritedFrom": { "name": "PopoverHost", "module": "src/lib/popover/popover-host.ts" } }, { "kind": "field", "name": "placement", "type": { "text": "PopoverHostPlacement" }, "attribute": "placement", "reflects": true, "inheritedFrom": { "name": "PopoverHost", "module": "src/lib/popover/popover-host.ts" } }, { "kind": "field", "name": "popoverPlacementOptions", "type": { "text": "PopoverPlacementOptions" }, "readonly": true, "inheritedFrom": { "name": "PopoverHost", "module": "src/lib/popover/popover-host.ts" } }, { "kind": "method", "name": "hasMountedPopover", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "element", "type": { "text": "HTMLElement" } } ], "inheritedFrom": { "name": "PopoverHost", "module": "src/lib/popover/popover-host.ts" } }, { "kind": "method", "name": "mountPopover", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "referenceElement", "type": { "text": "HTMLElement | null" } } ], "inheritedFrom": { "name": "PopoverHost", "module": "src/lib/popover/popover-host.ts" } }, { "kind": "method", "name": "unmountPopover", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "referenceElement", "type": { "text": "HTMLElement" } } ], "inheritedFrom": { "name": "PopoverHost", "module": "src/lib/popover/popover-host.ts" } }, { "kind": "method", "name": "hasOpenPopover", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "referenceElement", "type": { "text": "HTMLElement | null" } } ], "inheritedFrom": { "name": "PopoverHost", "module": "src/lib/popover/popover-host.ts" } }, { "kind": "method", "name": "showPopover", "return": { "type": { "text": "Promise" } }, "inheritedFrom": { "name": "PopoverHost", "module": "src/lib/popover/popover-host.ts" } }, { "kind": "method", "name": "hidePopover", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "PopoverHost", "module": "src/lib/popover/popover-host.ts" } }, { "kind": "method", "name": "togglePopover", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "state", "optional": true, "type": { "text": "boolean" } } ], "inheritedFrom": { "name": "PopoverHost", "module": "src/lib/popover/popover-host.ts" } }, { "kind": "method", "name": "canPopoverShow", "return": { "type": { "text": "boolean" } }, "inheritedFrom": { "name": "PopoverHost", "module": "src/lib/popover/popover-host.ts" } }, { "kind": "method", "name": "onBeforePopoverShow", "return": { "type": { "text": "Promise | void" } }, "inheritedFrom": { "name": "PopoverHost", "module": "src/lib/popover/popover-host.ts" } }, { "kind": "method", "name": "onPopoverShow", "return": { "type": { "text": "Promise | void" } }, "inheritedFrom": { "name": "PopoverHost", "module": "src/lib/popover/popover-host.ts" } }, { "kind": "method", "name": "canPopoverHide", "return": { "type": { "text": "boolean" } }, "inheritedFrom": { "name": "PopoverHost", "module": "src/lib/popover/popover-host.ts" } }, { "kind": "method", "name": "onBeforePopoverHide", "return": { "type": { "text": "Promise | void" } }, "inheritedFrom": { "name": "PopoverHost", "module": "src/lib/popover/popover-host.ts" } }, { "kind": "method", "name": "onPopoverHide", "return": { "type": { "text": "Promise | void" } }, "inheritedFrom": { "name": "PopoverHost", "module": "src/lib/popover/popover-host.ts" } }, { "kind": "method", "name": "updateReferenceElementFromEvent", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "event", "type": { "text": "Event" } } ], "inheritedFrom": { "name": "PopoverHost", "module": "src/lib/popover/popover-host.ts" } }, { "kind": "field", "name": "tagName", "type": { "text": "string" }, "static": true, "default": "'odx-dropdown' satisfies keyof HTMLElementTagNameMap", "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "role", "type": { "text": "ARIARole | null" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "dir", "type": { "text": "'ltr' | 'rtl'" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "fill", "type": { "text": "boolean" }, "default": "false", "attribute": "fill", "reflects": true }, { "kind": "field", "name": "offset", "type": { "text": "number" }, "default": "0", "attribute": "offset" }, { "kind": "field", "name": "matchReferenceWidth", "type": { "text": "boolean" }, "default": "false", "attribute": "match-reference-width", "reflects": true }, { "kind": "field", "name": "#handleReferenceInteraction", "privacy": "private" }, { "kind": "field", "name": "#handleReferenceKeyboardEvent", "privacy": "private" }, { "kind": "field", "name": "#handleGlobalClick", "privacy": "private" }, { "kind": "field", "name": "#currentReferenceElement", "privacy": "private", "type": { "text": "HTMLElement | null" }, "default": "null", "inheritedFrom": { "name": "PopoverHost", "module": "src/lib/popover/popover-host.ts" } }, { "kind": "field", "name": "#referenceElements", "privacy": "private", "default": "new WeakSet()", "inheritedFrom": { "name": "PopoverHost", "module": "src/lib/popover/popover-host.ts" } }, { "kind": "field", "name": "#openPopovers", "privacy": "private", "default": "new WeakSet()", "inheritedFrom": { "name": "PopoverHost", "module": "src/lib/popover/popover-host.ts" } }, { "kind": "field", "name": "#positionUpdater", "privacy": "private", "type": { "text": "() => void | undefined" }, "inheritedFrom": { "name": "PopoverHost", "module": "src/lib/popover/popover-host.ts" } }, { "kind": "field", "name": "#mutationObserver", "privacy": "private", "default": "new MutationObserver((mutations) => { if (mutations.length === 0) return; this.#updateReferenceElements(); })", "inheritedFrom": { "name": "PopoverHost", "module": "src/lib/popover/popover-host.ts" } }, { "kind": "method", "name": "#updateReferenceElements", "privacy": "private", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "PopoverHost", "module": "src/lib/popover/popover-host.ts" } }, { "kind": "field", "name": "#handleToggle", "privacy": "private", "default": "(async (event: ToggleEvent) => { if (!this.referenceElement) return; this.open = event.newState === 'open'; ActiveDirective.toggle(this.referenceElement, this.open); if (this.open) { this.#openPopovers.add(this.referenceElement); addGlobalEventListener('keydown', this.#handleReferenceKeydown as EventListener, { capture: true, once: true }); await this.onBeforePopoverShow?.(); await waitForAnimations(this); await this.onPopoverShow?.(); } else { this.#openPopovers.delete(this.referenceElement); removeGlobalEventListener('keydown', this.#handleReferenceKeydown as EventListener); await this.onBeforePopoverHide?.(); await waitForAnimations(this); await this.onPopoverHide?.(); } }) as unknown", "inheritedFrom": { "name": "PopoverHost", "module": "src/lib/popover/popover-host.ts" } }, { "kind": "field", "name": "#handleReferenceKeydown", "privacy": "private", "inheritedFrom": { "name": "PopoverHost", "module": "src/lib/popover/popover-host.ts" } } ], "attributes": [ { "name": "fill", "type": { "text": "boolean" }, "default": "false", "fieldName": "fill" }, { "name": "offset", "type": { "text": "number" }, "default": "0", "fieldName": "offset" }, { "name": "match-reference-width", "type": { "text": "boolean" }, "default": "false", "fieldName": "matchReferenceWidth" }, { "name": "placement", "type": { "text": "PopoverHostPlacement" }, "fieldName": "placement", "inheritedFrom": { "name": "PopoverHost", "module": "src/lib/popover/popover-host.ts" } }, { "name": "disabled", "type": { "text": "boolean" }, "default": "false", "fieldName": "disabled", "inheritedFrom": { "name": "PopoverHost", "module": "src/lib/popover/popover-host.ts" } }, { "name": "open", "type": { "text": "boolean" }, "default": "false", "fieldName": "open", "inheritedFrom": { "name": "PopoverHost", "module": "src/lib/popover/popover-host.ts" } } ], "superclass": { "name": "PopoverHost", "module": "/src/lib/popover/popover-host.js" }, "tagName": "odx-dropdown", "customElement": true, "events": [], "slots": [], "cssParts": [], "cssProperties": [] } ], "exports": [ { "kind": "js", "name": "DropdownPlacement", "declaration": { "name": "DropdownPlacement", "module": "src/lib/dropdown/dropdown.ts" } }, { "kind": "js", "name": "OdxDropdown", "declaration": { "name": "OdxDropdown", "module": "src/lib/dropdown/dropdown.ts" } } ] }, { "kind": "javascript-module", "path": "src/lib/empty-state/empty-state.ts", "declarations": [ { "kind": "variable", "name": "EmptyStateSize", "type": { "text": "{ SM: 'sm', MD: 'md', LG: 'lg' }" }, "default": "{ SM: 'sm', MD: 'md', LG: 'lg' }" }, { "kind": "variable", "name": "EmptyStateVariant", "type": { "text": "{ NEUTRAL: 'neutral', SUBTLE: 'subtle', DANGER: 'danger' }" }, "default": "{ NEUTRAL: 'neutral', SUBTLE: 'subtle', DANGER: 'danger' }" }, { "kind": "class", "description": "", "name": "OdxEmptyState", "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "static": true, "default": "'odx-empty-state' satisfies keyof HTMLElementTagNameMap", "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "#slots", "privacy": "private", "default": "new SlotContentObserver(this)" }, { "kind": "field", "name": "icon", "type": { "text": "OdxIconName | null | undefined" }, "attribute": "icon" }, { "kind": "field", "name": "size", "type": { "text": "EmptyStateSize" }, "attribute": "size", "reflects": true }, { "kind": "field", "name": "variant", "type": { "text": "EmptyStateVariant" }, "attribute": "variant", "reflects": true }, { "kind": "field", "name": "role", "type": { "text": "ARIARole | null" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "dir", "type": { "text": "'ltr' | 'rtl'" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } } ], "attributes": [ { "name": "icon", "type": { "text": "OdxIconName | null | undefined" }, "fieldName": "icon" }, { "name": "size", "type": { "text": "EmptyStateSize" }, "fieldName": "size" }, { "name": "variant", "type": { "text": "EmptyStateVariant" }, "fieldName": "variant" } ], "superclass": { "name": "CustomElement", "module": "/src/internal/custom-element.js" }, "tagName": "odx-empty-state", "customElement": true, "events": [], "slots": [], "cssParts": [], "cssProperties": [] } ], "exports": [ { "kind": "js", "name": "EmptyStateSize", "declaration": { "name": "EmptyStateSize", "module": "src/lib/empty-state/empty-state.ts" } }, { "kind": "js", "name": "EmptyStateVariant", "declaration": { "name": "EmptyStateVariant", "module": "src/lib/empty-state/empty-state.ts" } }, { "kind": "js", "name": "OdxEmptyState", "declaration": { "name": "OdxEmptyState", "module": "src/lib/empty-state/empty-state.ts" } } ] }, { "kind": "javascript-module", "path": "src/lib/form-field/form-field.ts", "declarations": [ { "kind": "class", "description": "", "name": "OdxFormField", "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "static": true, "default": "'odx-form-field' satisfies keyof HTMLElementTagNameMap", "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "touched", "type": { "text": "boolean" }, "default": "false" }, { "kind": "method", "name": "getControl", "return": { "type": { "text": "FormAssociated | undefined" } } }, { "kind": "method", "name": "renderErrorMessage", "privacy": "protected", "return": { "type": { "text": "TemplateResult" } } }, { "kind": "field", "name": "#handleSlotChange", "privacy": "private" }, { "kind": "field", "name": "role", "type": { "text": "ARIARole | null" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "dir", "type": { "text": "'ltr' | 'rtl'" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } } ], "superclass": { "name": "CustomElement", "module": "/src/internal/custom-element.js" }, "tagName": "odx-form-field", "customElement": true, "events": [], "slots": [], "cssParts": [], "cssProperties": [] } ], "exports": [ { "kind": "js", "name": "OdxFormField", "declaration": { "name": "OdxFormField", "module": "src/lib/form-field/form-field.ts" } } ] }, { "kind": "javascript-module", "path": "src/lib/format/format-bytes.ts", "declarations": [ { "kind": "class", "description": "", "name": "OdxFormatBytes", "members": [ { "kind": "field", "name": "value", "type": { "text": "T | null | undefined" }, "description": "The numeric value to format, representing a quantity of bytes or bits depending on the `unit` property.", "attribute": "value", "inheritedFrom": { "name": "FormatBase", "module": "src/lib/format/format.base.ts" } }, { "kind": "field", "name": "fallbackValue", "type": { "text": "string | null | undefined" }, "description": "An optional fallback value to display if the `value` property is invalid or cannot be transformed.", "attribute": "fallbackValue", "inheritedFrom": { "name": "FormatBase", "module": "src/lib/format/format.base.ts" } }, { "kind": "field", "name": "lang", "type": { "text": "string" }, "attribute": "lang", "inheritedFrom": { "name": "FormatBase", "module": "src/lib/format/format.base.ts" } }, { "kind": "method", "name": "transform", "privacy": "protected", "return": { "type": { "text": "string" } }, "parameters": [ { "name": "value", "type": { "text": "number" } } ], "inheritedFrom": { "name": "FormatBase", "module": "src/lib/format/format.base.ts" } }, { "kind": "method", "name": "formatDate", "privacy": "protected", "return": { "type": { "text": "ReturnType" } }, "parameters": [ { "name": "[input, options]", "type": { "text": "Parameters" } } ], "inheritedFrom": { "name": "FormatBase", "module": "src/lib/format/format.base.ts" } }, { "kind": "method", "name": "formatNumber", "privacy": "protected", "return": { "type": { "text": "ReturnType" } }, "parameters": [ { "name": "[input, options]", "type": { "text": "Parameters" } } ], "inheritedFrom": { "name": "FormatBase", "module": "src/lib/format/format.base.ts" } }, { "kind": "method", "name": "formatList", "privacy": "protected", "return": { "type": { "text": "ReturnType" } }, "parameters": [ { "name": "[input, options]", "type": { "text": "Parameters" } } ], "inheritedFrom": { "name": "FormatBase", "module": "src/lib/format/format.base.ts" } }, { "kind": "method", "name": "formatRelativeTime", "privacy": "protected", "return": { "type": { "text": "ReturnType" } }, "parameters": [ { "name": "[input, options]", "type": { "text": "Parameters" } } ], "inheritedFrom": { "name": "FormatBase", "module": "src/lib/format/format.base.ts" } }, { "kind": "field", "name": "tagName", "type": { "text": "string" }, "static": true, "default": "'odx-format-bytes' satisfies keyof HTMLElementTagNameMap", "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "role", "type": { "text": "ARIARole | null" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "dir", "type": { "text": "'ltr' | 'rtl'" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "unit", "type": { "text": "'byte' | 'bit'" }, "default": "'byte'", "description": "The unit type to format. Determines the unit prefixes used (e.g. KB vs Kb).", "attribute": "unit" }, { "kind": "method", "name": "#resolveValue", "privacy": "private", "return": { "type": { "text": "TemplateResult | string" } }, "parameters": [ { "name": "value", "optional": true, "type": { "text": "T | null" } } ], "inheritedFrom": { "name": "FormatBase", "module": "src/lib/format/format.base.ts" } } ], "attributes": [ { "name": "value", "type": { "text": "number | null | undefined" }, "description": "The numeric value to format, representing a quantity of bytes or bits depending on the `unit` property.", "fieldName": "value" }, { "name": "unit", "type": { "text": "'byte' | 'bit'" }, "default": "'byte'", "description": "The unit type to format. Determines the unit prefixes used (e.g. KB vs Kb).", "fieldName": "unit" }, { "name": "fallbackValue", "type": { "text": "string | null | undefined" }, "description": "An optional fallback value to display if the `value` property is invalid or cannot be transformed.", "fieldName": "fallbackValue", "inheritedFrom": { "name": "FormatBase", "module": "src/lib/format/format.base.ts" } }, { "name": "lang", "type": { "text": "string" }, "fieldName": "lang", "inheritedFrom": { "name": "FormatBase", "module": "src/lib/format/format.base.ts" } } ], "superclass": { "name": "FormatBase", "module": "/src/lib/format/format.base.js" }, "summary": "A component for formatting byte and bit values into human-readable strings with appropriate unit prefixes (e.g. KB, MB, GB).", "tagName": "odx-format-bytes", "customElement": true, "events": [], "slots": [], "cssParts": [], "cssProperties": [] } ], "exports": [ { "kind": "js", "name": "OdxFormatBytes", "declaration": { "name": "OdxFormatBytes", "module": "src/lib/format/format-bytes.ts" } } ] }, { "kind": "javascript-module", "path": "src/lib/format/format-date.ts", "declarations": [ { "kind": "class", "description": "", "name": "OdxFormatDate", "members": [ { "kind": "field", "name": "value", "type": { "text": "T | null | undefined" }, "description": "The date value to format.\n\nCan be a `Date` object, a timestamp (number), or a date string.", "attribute": "value", "inheritedFrom": { "name": "FormatBase", "module": "src/lib/format/format.base.ts" } }, { "kind": "field", "name": "fallbackValue", "type": { "text": "string | null | undefined" }, "description": "An optional fallback value to display if the `value` property is invalid or cannot be transformed.", "attribute": "fallbackValue", "inheritedFrom": { "name": "FormatBase", "module": "src/lib/format/format.base.ts" } }, { "kind": "field", "name": "lang", "type": { "text": "string" }, "attribute": "lang", "inheritedFrom": { "name": "FormatBase", "module": "src/lib/format/format.base.ts" } }, { "kind": "method", "name": "transform", "privacy": "protected", "return": { "type": { "text": "string" } }, "parameters": [ { "name": "value", "type": { "text": "number | string | Date" } } ], "inheritedFrom": { "name": "FormatBase", "module": "src/lib/format/format.base.ts" } }, { "kind": "method", "name": "formatDate", "privacy": "protected", "return": { "type": { "text": "ReturnType" } }, "parameters": [ { "name": "[input, options]", "type": { "text": "Parameters" } } ], "inheritedFrom": { "name": "FormatBase", "module": "src/lib/format/format.base.ts" } }, { "kind": "method", "name": "formatNumber", "privacy": "protected", "return": { "type": { "text": "ReturnType" } }, "parameters": [ { "name": "[input, options]", "type": { "text": "Parameters" } } ], "inheritedFrom": { "name": "FormatBase", "module": "src/lib/format/format.base.ts" } }, { "kind": "method", "name": "formatList", "privacy": "protected", "return": { "type": { "text": "ReturnType" } }, "parameters": [ { "name": "[input, options]", "type": { "text": "Parameters" } } ], "inheritedFrom": { "name": "FormatBase", "module": "src/lib/format/format.base.ts" } }, { "kind": "method", "name": "formatRelativeTime", "privacy": "protected", "return": { "type": { "text": "ReturnType" } }, "parameters": [ { "name": "[input, options]", "type": { "text": "Parameters" } } ], "inheritedFrom": { "name": "FormatBase", "module": "src/lib/format/format.base.ts" } }, { "kind": "field", "name": "tagName", "type": { "text": "string" }, "static": true, "default": "'odx-format-date' satisfies keyof HTMLElementTagNameMap", "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "role", "type": { "text": "ARIARole | null" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "dir", "type": { "text": "'ltr' | 'rtl'" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "dateStyle", "type": { "text": "DateTimeFormatOptions['dateStyle'] | null | undefined" }, "description": "The https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat/DateTimeFormat#datestyle | dateStyle to use for formatting.\n\nSupports a custom `iso8601` value that formats the date as `YYYY-MM-DD` using the `sv-SE` locale, which produces an ISO 8601 compliant date string.", "attribute": "dateStyle" }, { "kind": "field", "name": "valueAsDate", "type": { "text": "Date | null" }, "description": "The `value` property parsed as a `Date` object.", "readonly": true }, { "kind": "method", "name": "#resolveValue", "privacy": "private", "return": { "type": { "text": "TemplateResult | string" } }, "parameters": [ { "name": "value", "optional": true, "type": { "text": "T | null" } } ], "inheritedFrom": { "name": "FormatBase", "module": "src/lib/format/format.base.ts" } } ], "attributes": [ { "name": "value", "type": { "text": "number | string | Date | null | undefined" }, "description": "The date value to format.\n\nCan be a `Date` object, a timestamp (number), or a date string.", "fieldName": "value" }, { "name": "dateStyle", "type": { "text": "DateTimeFormatOptions['dateStyle'] | null | undefined" }, "description": "The https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat/DateTimeFormat#datestyle | dateStyle to use for formatting.\n\nSupports a custom `iso8601` value that formats the date as `YYYY-MM-DD` using the `sv-SE` locale, which produces an ISO 8601 compliant date string.", "fieldName": "dateStyle" }, { "name": "fallbackValue", "type": { "text": "string | null | undefined" }, "description": "An optional fallback value to display if the `value` property is invalid or cannot be transformed.", "fieldName": "fallbackValue", "inheritedFrom": { "name": "FormatBase", "module": "src/lib/format/format.base.ts" } }, { "name": "lang", "type": { "text": "string" }, "fieldName": "lang", "inheritedFrom": { "name": "FormatBase", "module": "src/lib/format/format.base.ts" } } ], "superclass": { "name": "FormatBase", "module": "/src/lib/format/format.base.js" }, "summary": "A component for formatting date values into human-readable strings using the Intl.DateTimeFormat API.", "tagName": "odx-format-date", "customElement": true, "events": [], "slots": [], "cssParts": [], "cssProperties": [] } ], "exports": [ { "kind": "js", "name": "OdxFormatDate", "declaration": { "name": "OdxFormatDate", "module": "src/lib/format/format-date.ts" } } ] }, { "kind": "javascript-module", "path": "src/lib/format/format-number.ts", "declarations": [ { "kind": "class", "description": "", "name": "OdxFormatNumber", "members": [ { "kind": "field", "name": "value", "type": { "text": "T | null | undefined" }, "attribute": "value", "inheritedFrom": { "name": "FormatBase", "module": "src/lib/format/format.base.ts" } }, { "kind": "field", "name": "fallbackValue", "type": { "text": "string | null | undefined" }, "description": "An optional fallback value to display if the `value` property is invalid or cannot be transformed.", "attribute": "fallbackValue", "inheritedFrom": { "name": "FormatBase", "module": "src/lib/format/format.base.ts" } }, { "kind": "field", "name": "lang", "type": { "text": "string" }, "attribute": "lang", "inheritedFrom": { "name": "FormatBase", "module": "src/lib/format/format.base.ts" } }, { "kind": "method", "name": "transform", "privacy": "protected", "return": { "type": { "text": "string" } }, "parameters": [ { "name": "value", "type": { "text": "number" } } ], "inheritedFrom": { "name": "FormatBase", "module": "src/lib/format/format.base.ts" } }, { "kind": "method", "name": "formatDate", "privacy": "protected", "return": { "type": { "text": "ReturnType" } }, "parameters": [ { "name": "[input, options]", "type": { "text": "Parameters" } } ], "inheritedFrom": { "name": "FormatBase", "module": "src/lib/format/format.base.ts" } }, { "kind": "method", "name": "formatNumber", "privacy": "protected", "return": { "type": { "text": "ReturnType" } }, "parameters": [ { "name": "[input, options]", "type": { "text": "Parameters" } } ], "inheritedFrom": { "name": "FormatBase", "module": "src/lib/format/format.base.ts" } }, { "kind": "method", "name": "formatList", "privacy": "protected", "return": { "type": { "text": "ReturnType" } }, "parameters": [ { "name": "[input, options]", "type": { "text": "Parameters" } } ], "inheritedFrom": { "name": "FormatBase", "module": "src/lib/format/format.base.ts" } }, { "kind": "method", "name": "formatRelativeTime", "privacy": "protected", "return": { "type": { "text": "ReturnType" } }, "parameters": [ { "name": "[input, options]", "type": { "text": "Parameters" } } ], "inheritedFrom": { "name": "FormatBase", "module": "src/lib/format/format.base.ts" } }, { "kind": "field", "name": "tagName", "type": { "text": "string" }, "static": true, "default": "'odx-format-number' satisfies keyof HTMLElementTagNameMap", "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "role", "type": { "text": "ARIARole | null" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "dir", "type": { "text": "'ltr' | 'rtl'" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "currency", "type": { "text": "NumberFormatOptions['currency'] | null | undefined" }, "description": "The https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat/NumberFormat#currency_2 | currency to use in currency formatting.", "attribute": "currency" }, { "kind": "field", "name": "currencyDisplay", "type": { "text": "NumberFormatOptions['currencyDisplay'] | null | undefined" }, "description": "How to https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat/NumberFormat#currencydisplay | display the currency in currency formatting.", "attribute": "currencyDisplay" }, { "kind": "field", "name": "minimumFractionDigits", "type": { "text": "NumberFormatOptions['minimumFractionDigits'] | null | undefined" }, "description": "The https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat/NumberFormat#minimumfractiondigits | minimum number of fraction digits to use.", "attribute": "minimumFractionDigits" }, { "kind": "field", "name": "maximumFractionDigits", "type": { "text": "NumberFormatOptions['maximumFractionDigits'] | null | undefined" }, "description": "The https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat/NumberFormat#maximumfractiondigits | maximum number of fraction digits to use.", "attribute": "maximumFractionDigits" }, { "kind": "field", "name": "minimumIntegerDigits", "type": { "text": "NumberFormatOptions['minimumIntegerDigits'] | null | undefined" }, "description": "The https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat/NumberFormat#minimumintegerdigits | minimum number of integer digits to use.", "attribute": "minimumIntegerDigits" }, { "kind": "field", "name": "type", "type": { "text": "NumberFormatOptions['style'] | null | undefined" }, "description": "The https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat/NumberFormat#style | formatting style to use.", "attribute": "type" }, { "kind": "field", "name": "unit", "type": { "text": "UnitIdentifier | null | undefined" }, "description": "The https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat/NumberFormat#unit_2 | unit to use in unit formatting.", "attribute": "unit" }, { "kind": "field", "name": "unitDisplay", "type": { "text": "Intl.NumberFormatOptions['unitDisplay'] | null | undefined" }, "description": "The https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat/NumberFormat#unitdisplay | unit formatting style to use in unit formatting.", "attribute": "unitDisplay" }, { "kind": "method", "name": "#resolveValue", "privacy": "private", "return": { "type": { "text": "TemplateResult | string" } }, "parameters": [ { "name": "value", "optional": true, "type": { "text": "T | null" } } ], "inheritedFrom": { "name": "FormatBase", "module": "src/lib/format/format.base.ts" } } ], "attributes": [ { "name": "value", "type": { "text": "number | null | undefined" }, "fieldName": "value" }, { "name": "currency", "type": { "text": "NumberFormatOptions['currency'] | null | undefined" }, "description": "The https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat/NumberFormat#currency_2 | currency to use in currency formatting.", "fieldName": "currency" }, { "name": "currencyDisplay", "type": { "text": "NumberFormatOptions['currencyDisplay'] | null | undefined" }, "description": "How to https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat/NumberFormat#currencydisplay | display the currency in currency formatting.", "fieldName": "currencyDisplay" }, { "name": "minimumFractionDigits", "type": { "text": "NumberFormatOptions['minimumFractionDigits'] | null | undefined" }, "description": "The https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat/NumberFormat#minimumfractiondigits | minimum number of fraction digits to use.", "fieldName": "minimumFractionDigits" }, { "name": "maximumFractionDigits", "type": { "text": "NumberFormatOptions['maximumFractionDigits'] | null | undefined" }, "description": "The https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat/NumberFormat#maximumfractiondigits | maximum number of fraction digits to use.", "fieldName": "maximumFractionDigits" }, { "name": "minimumIntegerDigits", "type": { "text": "NumberFormatOptions['minimumIntegerDigits'] | null | undefined" }, "description": "The https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat/NumberFormat#minimumintegerdigits | minimum number of integer digits to use.", "fieldName": "minimumIntegerDigits" }, { "name": "type", "type": { "text": "NumberFormatOptions['style'] | null | undefined" }, "description": "The https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat/NumberFormat#style | formatting style to use.", "fieldName": "type" }, { "name": "unit", "type": { "text": "UnitIdentifier | null | undefined" }, "description": "The https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat/NumberFormat#unit_2 | unit to use in unit formatting.", "fieldName": "unit" }, { "name": "unitDisplay", "type": { "text": "Intl.NumberFormatOptions['unitDisplay'] | null | undefined" }, "description": "The https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat/NumberFormat#unitdisplay | unit formatting style to use in unit formatting.", "fieldName": "unitDisplay" }, { "name": "fallbackValue", "type": { "text": "string | null | undefined" }, "description": "An optional fallback value to display if the `value` property is invalid or cannot be transformed.", "fieldName": "fallbackValue", "inheritedFrom": { "name": "FormatBase", "module": "src/lib/format/format.base.ts" } }, { "name": "lang", "type": { "text": "string" }, "fieldName": "lang", "inheritedFrom": { "name": "FormatBase", "module": "src/lib/format/format.base.ts" } } ], "superclass": { "name": "FormatBase", "module": "/src/lib/format/format.base.js" }, "summary": "A component for formatting numeric values into human-readable strings using the Intl.NumberFormat API.", "tagName": "odx-format-number", "customElement": true, "events": [], "slots": [], "cssParts": [], "cssProperties": [] } ], "exports": [ { "kind": "js", "name": "OdxFormatNumber", "declaration": { "name": "OdxFormatNumber", "module": "src/lib/format/format-number.ts" } } ] }, { "kind": "javascript-module", "path": "src/lib/format/format.base.ts", "declarations": [ { "kind": "class", "description": "", "name": "FormatBase", "members": [ { "kind": "field", "name": "value", "type": { "text": "T | null | undefined" } }, { "kind": "field", "name": "fallbackValue", "type": { "text": "string | null | undefined" }, "description": "An optional fallback value to display if the `value` property is invalid or cannot be transformed.", "attribute": "fallbackValue" }, { "kind": "field", "name": "lang", "type": { "text": "string" }, "attribute": "lang" }, { "kind": "method", "name": "transform", "privacy": "protected", "return": { "type": { "text": "TemplateResult | string" } }, "parameters": [ { "name": "value", "type": { "text": "T" } } ] }, { "kind": "method", "name": "formatDate", "privacy": "protected", "return": { "type": { "text": "ReturnType" } }, "parameters": [ { "name": "[input, options]", "type": { "text": "Parameters" } } ] }, { "kind": "method", "name": "formatNumber", "privacy": "protected", "return": { "type": { "text": "ReturnType" } }, "parameters": [ { "name": "[input, options]", "type": { "text": "Parameters" } } ] }, { "kind": "method", "name": "formatList", "privacy": "protected", "return": { "type": { "text": "ReturnType" } }, "parameters": [ { "name": "[input, options]", "type": { "text": "Parameters" } } ] }, { "kind": "method", "name": "formatRelativeTime", "privacy": "protected", "return": { "type": { "text": "ReturnType" } }, "parameters": [ { "name": "[input, options]", "type": { "text": "Parameters" } } ] }, { "kind": "method", "name": "#resolveValue", "privacy": "private", "return": { "type": { "text": "TemplateResult | string" } }, "parameters": [ { "name": "value", "optional": true, "type": { "text": "T | null" } } ] }, { "kind": "field", "name": "tagName", "type": { "text": "string" }, "static": true, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "role", "type": { "text": "ARIARole | null" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "dir", "type": { "text": "'ltr' | 'rtl'" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } } ], "attributes": [ { "name": "fallbackValue", "type": { "text": "string | null | undefined" }, "description": "An optional fallback value to display if the `value` property is invalid or cannot be transformed.", "fieldName": "fallbackValue" }, { "name": "lang", "type": { "text": "string" }, "fieldName": "lang" } ], "superclass": { "name": "CustomElement", "module": "/src/internal/custom-element.js" } } ], "exports": [ { "kind": "js", "name": "FormatBase", "declaration": { "name": "FormatBase", "module": "src/lib/format/format.base.ts" } } ] }, { "kind": "javascript-module", "path": "src/lib/gradient-overlay/gradient-overlay.ts", "declarations": [ { "kind": "class", "description": "", "name": "OdxGradientOverlay", "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "static": true, "default": "'odx-gradient-overlay' satisfies keyof HTMLElementTagNameMap", "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "active", "type": { "text": "boolean" }, "default": "false", "attribute": "active", "reflects": true }, { "kind": "field", "name": "role", "type": { "text": "ARIARole | null" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "dir", "type": { "text": "'ltr' | 'rtl'" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } } ], "attributes": [ { "name": "active", "type": { "text": "boolean" }, "default": "false", "fieldName": "active" } ], "superclass": { "name": "CustomElement", "module": "/src/internal/custom-element.js" }, "tagName": "odx-gradient-overlay", "customElement": true, "events": [], "slots": [], "cssParts": [], "cssProperties": [] } ], "exports": [ { "kind": "js", "name": "OdxGradientOverlay", "declaration": { "name": "OdxGradientOverlay", "module": "src/lib/gradient-overlay/gradient-overlay.ts" } } ] }, { "kind": "javascript-module", "path": "src/lib/highlight/highlight.ts", "declarations": [ { "kind": "variable", "name": "HighlightVariant", "type": { "text": "{ NEUTRAL: 'neutral', ACCENT: 'accent', DANGER: 'danger' }" }, "default": "{ NEUTRAL: 'neutral', ACCENT: 'accent', DANGER: 'danger' }" }, { "kind": "class", "description": "", "name": "OdxHighlight", "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "static": true, "default": "'odx-highlight' satisfies keyof HTMLElementTagNameMap", "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "registry", "privacy": "private", "static": true, "default": "new Map()" }, { "kind": "field", "name": "#mutationObserver", "privacy": "private", "type": { "text": "MutationObserver | undefined" } }, { "kind": "field", "name": "root", "type": { "text": "HTMLElement" }, "default": "this" }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "default": "false", "attribute": "disabled" }, { "kind": "field", "name": "query", "type": { "text": "string | null | undefined" }, "attribute": "query" }, { "kind": "field", "name": "selector", "type": { "text": "string | null | undefined" }, "attribute": "selector" }, { "kind": "field", "name": "minlength", "type": { "text": "number" }, "default": "0", "attribute": "minlength" }, { "kind": "field", "name": "variant", "type": { "text": "HighlightVariant" }, "attribute": "variant", "reflects": true }, { "kind": "field", "name": "observeContent", "type": { "text": "boolean" }, "default": "false", "attribute": "observe-content" }, { "kind": "method", "name": "#updateHighlight", "privacy": "private", "parameters": [ { "name": "query", "type": { "text": "string" } }, { "name": "minlength", "type": { "text": "number" } } ] }, { "kind": "method", "name": "#searchTextContent", "privacy": "private", "return": { "type": { "text": "Range[]" } }, "parameters": [ { "name": "query", "type": { "text": "string" } }, { "name": "minlength", "type": { "text": "number" } } ] }, { "kind": "method", "name": "#createRange", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "value", "type": { "text": "string" } }, { "name": "query", "type": { "text": "string" } }, { "name": "callback", "optional": true, "type": { "text": "(index: number) => void" } } ] }, { "kind": "method", "name": "#watchContentChanges", "privacy": "private" }, { "kind": "method", "name": "updateGlobalHighlights", "privacy": "private", "static": true }, { "kind": "field", "name": "role", "type": { "text": "ARIARole | null" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "dir", "type": { "text": "'ltr' | 'rtl'" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } } ], "attributes": [ { "name": "disabled", "type": { "text": "boolean" }, "default": "false", "fieldName": "disabled" }, { "name": "query", "type": { "text": "string | null | undefined" }, "fieldName": "query" }, { "name": "selector", "type": { "text": "string | null | undefined" }, "fieldName": "selector" }, { "name": "minlength", "type": { "text": "number" }, "default": "0", "fieldName": "minlength" }, { "name": "variant", "type": { "text": "HighlightVariant" }, "fieldName": "variant" }, { "name": "observe-content", "type": { "text": "boolean" }, "default": "false", "fieldName": "observeContent" } ], "superclass": { "name": "CustomElement", "module": "/src/internal/custom-element.js" }, "tagName": "odx-highlight", "customElement": true, "events": [], "slots": [], "cssParts": [], "cssProperties": [] } ], "exports": [ { "kind": "js", "name": "HighlightVariant", "declaration": { "name": "HighlightVariant", "module": "src/lib/highlight/highlight.ts" } }, { "kind": "js", "name": "OdxHighlight", "declaration": { "name": "OdxHighlight", "module": "src/lib/highlight/highlight.ts" } } ] }, { "kind": "javascript-module", "path": "src/lib/image/image.ts", "declarations": [ { "kind": "class", "description": "", "name": "OdxImage", "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "static": true, "default": "'odx-image' satisfies keyof HTMLElementTagNameMap", "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "loader", "static": true, "default": "new ImageLoader()" }, { "kind": "field", "name": "loadingError", "type": { "text": "boolean" }, "default": "false" }, { "kind": "field", "name": "loading", "type": { "text": "boolean" }, "default": "false" }, { "kind": "field", "name": "image", "type": { "text": "HTMLImageElement | undefined" } }, { "kind": "field", "name": "src", "type": { "text": "string | null | undefined" }, "attribute": "src" }, { "kind": "field", "name": "alt", "type": { "text": "string | null | undefined" }, "attribute": "alt" }, { "kind": "field", "name": "height", "type": { "text": "number | null | undefined" }, "attribute": "height" }, { "kind": "field", "name": "width", "type": { "text": "number | null | undefined" }, "attribute": "width" }, { "kind": "method", "name": "load", "return": { "type": { "text": "Promise" } }, "parameters": [ { "name": "src", "type": { "text": "string" } } ] }, { "kind": "method", "name": "#handleDimensionChange", "privacy": "private" }, { "kind": "method", "name": "renderPlaceholder", "static": true, "return": { "type": { "text": "TemplateResult" } }, "parameters": [ { "name": "image", "type": { "text": "OdxImage" } } ] }, { "kind": "field", "name": "role", "type": { "text": "ARIARole | null" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "dir", "type": { "text": "'ltr' | 'rtl'" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } } ], "attributes": [ { "name": "src", "type": { "text": "string | null | undefined" }, "fieldName": "src" }, { "name": "alt", "type": { "text": "string | null | undefined" }, "fieldName": "alt" }, { "name": "height", "type": { "text": "number | null | undefined" }, "fieldName": "height" }, { "name": "width", "type": { "text": "number | null | undefined" }, "fieldName": "width" } ], "superclass": { "name": "CustomElement", "module": "/src/internal/custom-element.js" }, "tagName": "odx-image", "customElement": true, "events": [], "slots": [], "cssParts": [], "cssProperties": [] } ], "exports": [ { "kind": "js", "name": "OdxImage", "declaration": { "name": "OdxImage", "module": "src/lib/image/image.ts" } } ] }, { "kind": "javascript-module", "path": "src/lib/inline-message/inline-message.ts", "declarations": [ { "kind": "variable", "name": "InlineMessageSize", "type": { "text": "{ SM: 'sm', MD: 'md' }" }, "default": "{ SM: 'sm', MD: 'md' }" }, { "kind": "variable", "name": "InlineMessageVariant", "type": { "text": "{\n PRIMARY: 'primary',\n SUCCESS: 'success',\n WARNING: 'warning',\n DANGER: 'danger',\n CONFIRMATION: 'confirmation',\n}" }, "default": "{ PRIMARY: 'primary', SUCCESS: 'success', WARNING: 'warning', DANGER: 'danger', CONFIRMATION: 'confirmation', }" }, { "kind": "class", "description": "", "name": "OdxInlineMessage", "cssParts": [ { "description": "The wrapper around the entire component, including the icon, content, and dismiss button.", "name": "base" }, { "description": "The wrapper around the message content, excluding the icon and dismiss button.", "name": "content" }, { "description": "The icon element displayed to the left of the content.", "name": "icon" } ], "slots": [ { "description": "The content of the message, typically including a `` and some text.", "name": "" } ], "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "static": true, "default": "'odx-inline-message' satisfies keyof HTMLElementTagNameMap", "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "dismissible", "type": { "text": "boolean" }, "default": "false", "description": "Indicates whether the dismiss button is shown.", "attribute": "dismissible" }, { "kind": "field", "name": "icon", "type": { "text": "OdxIconName | null | undefined" }, "description": "The name of the icon to display. If not provided, a default icon will be used based on the `variant` property.", "attribute": "icon" }, { "kind": "field", "name": "iconDisabled", "type": { "text": "boolean" }, "default": "false", "attribute": "icon-disabled", "reflects": true }, { "kind": "field", "name": "size", "type": { "text": "InlineMessageSize" }, "attribute": "size", "reflects": true }, { "kind": "field", "name": "variant", "type": { "text": "InlineMessageVariant" }, "attribute": "variant", "reflects": true }, { "kind": "field", "name": "hidden", "type": { "text": "boolean" }, "default": "false", "attribute": "hidden", "reflects": true }, { "kind": "field", "name": "currentIcon", "type": { "text": "OdxIconName | null" }, "readonly": true }, { "kind": "field", "name": "#handleDismissClick", "privacy": "private" }, { "kind": "field", "name": "role", "type": { "text": "ARIARole | null" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "dir", "type": { "text": "'ltr' | 'rtl'" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } } ], "events": [ { "description": "Emitted when the message is about to be hidden. Can be canceled to prevent hiding.", "name": "hide" }, { "description": "Emitted after the message has been hidden. Not cancelable.", "name": "hidden" } ], "attributes": [ { "name": "dismissible", "type": { "text": "boolean" }, "default": "false", "description": "Indicates whether the dismiss button is shown.", "fieldName": "dismissible" }, { "name": "icon", "type": { "text": "OdxIconName | null | undefined" }, "description": "The name of the icon to display. If not provided, a default icon will be used based on the `variant` property.", "fieldName": "icon" }, { "name": "icon-disabled", "type": { "text": "boolean" }, "default": "false", "fieldName": "iconDisabled" }, { "name": "size", "type": { "text": "InlineMessageSize" }, "fieldName": "size" }, { "name": "variant", "type": { "text": "InlineMessageVariant" }, "fieldName": "variant" }, { "name": "hidden", "type": { "text": "boolean" }, "default": "false", "fieldName": "hidden" } ], "superclass": { "name": "CustomElement", "module": "/src/internal/custom-element.js" }, "summary": "An InlineMessage component is used to display important messages inline within a page or section.", "tagName": "odx-inline-message", "customElement": true, "status": "rc", "since": "1.0", "cssProperties": [] } ], "exports": [ { "kind": "js", "name": "InlineMessageSize", "declaration": { "name": "InlineMessageSize", "module": "src/lib/inline-message/inline-message.ts" } }, { "kind": "js", "name": "InlineMessageVariant", "declaration": { "name": "InlineMessageVariant", "module": "src/lib/inline-message/inline-message.ts" } }, { "kind": "js", "name": "OdxInlineMessage", "declaration": { "name": "OdxInlineMessage", "module": "src/lib/inline-message/inline-message.ts" } } ] }, { "kind": "javascript-module", "path": "src/lib/input/input-number.ts", "declarations": [ { "kind": "variable", "name": "InputNumberStepBehavior", "type": { "text": "{ IGNORE: 'ignore', ROUND: 'round', CEIL: 'ceil', FLOOR: 'floor' }" }, "default": "{ IGNORE: 'ignore', ROUND: 'round', CEIL: 'ceil', FLOOR: 'floor' }" }, { "kind": "class", "description": "", "name": "OdxInputNumber", "members": [ { "kind": "field", "name": "shadowRootOptions", "type": { "text": "ShadowRootInit" }, "static": true, "default": "{ ...super.shadowRootOptions, delegatesFocus: true, }", "inheritedFrom": { "name": "InputBase", "module": "src/lib/input/input.base.ts" } }, { "kind": "field", "name": "inputActionSelector", "type": { "text": "string | undefined" }, "privacy": "protected", "default": "'#decrement, #increment'", "inheritedFrom": { "name": "InputBase", "module": "src/lib/input/input.base.ts" } }, { "kind": "field", "name": "measureTarget", "type": { "text": "HTMLSpanElement" }, "privacy": "protected", "inheritedFrom": { "name": "InputBase", "module": "src/lib/input/input.base.ts" } }, { "kind": "field", "name": "autocomplete", "type": { "text": "HTMLInputElement['autocomplete']" }, "default": "'off'", "description": "Indicates the element's autocomplete state.", "attribute": "autocomplete", "inheritedFrom": { "name": "InputBase", "module": "src/lib/input/input.base.ts" } }, { "kind": "field", "name": "alignment", "type": { "text": "InputAlignment" }, "description": "Indicates the horizontal alignment of the input's content.", "attribute": "alignment", "reflects": true, "inheritedFrom": { "name": "InputBase", "module": "src/lib/input/input.base.ts" } }, { "kind": "field", "name": "dirname", "type": { "text": "string | null | undefined" }, "description": "Indicates the directionality of the element's text content.", "attribute": "dirname", "inheritedFrom": { "name": "InputBase", "module": "src/lib/input/input.base.ts" } }, { "kind": "field", "name": "hideControls", "type": { "text": "boolean" }, "default": "false", "description": "Indicates whether the element's built-in controls (e.g. increment/decrement buttons) should be hidden.", "attribute": "hide-controls", "reflects": true, "inheritedFrom": { "name": "InputBase", "module": "src/lib/input/input.base.ts" } }, { "kind": "field", "name": "inputmode", "type": { "text": "'none' | 'text' | 'decimal' | 'numeric' | 'tel' | 'search' | 'email' | 'url' | null | undefined" }, "description": "Indicates the type of virtual keyboard to display when the element receives focus on a touch-enabled device.", "attribute": "inputmode", "inheritedFrom": { "name": "InputBase", "module": "src/lib/input/input.base.ts" } }, { "kind": "field", "name": "invalid", "type": { "text": "boolean" }, "default": "false", "description": "Marks the input as invalid for styling purposes. Setting this does not affect\nthe form's built-in validity state; use `setCustomValidity()` on the inner\ninput or rely on `minLength`/`maxLength`/`pattern` for native validation.", "attribute": "invalid", "reflects": true, "inheritedFrom": { "name": "InputBase", "module": "src/lib/input/input.base.ts" } }, { "kind": "field", "name": "placeholder", "type": { "text": "string" }, "default": "''", "description": "The placeholder text to display when the input is empty.", "attribute": "placeholder", "inheritedFrom": { "name": "InputBase", "module": "src/lib/input/input.base.ts" } }, { "kind": "field", "name": "size", "type": { "text": "InputSize" }, "description": "Indicates the size of the input.", "attribute": "size", "reflects": true, "inheritedFrom": { "name": "InputBase", "module": "src/lib/input/input.base.ts" } }, { "kind": "field", "name": "unit", "type": { "text": "string | null | undefined" }, "description": "The unit label to display after the input value (e.g. \"kg\", \"cm\", etc.).", "attribute": "unit", "inheritedFrom": { "name": "InputBase", "module": "src/lib/input/input.base.ts" } }, { "kind": "method", "name": "select", "return": { "type": { "text": "void" } }, "description": "Selects all of the current value in the inner input and fires a `select` event.", "inheritedFrom": { "name": "InputBase", "module": "src/lib/input/input.base.ts" } }, { "kind": "method", "name": "setSelectionRange", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "start", "type": { "text": "number" } }, { "name": "end", "type": { "text": "number" } }, { "name": "direction", "default": "'none'", "type": { "text": "'forward' | 'backward' | 'none'" } } ], "description": "Selects a range of characters in the inner input. The optional `direction`\nindicates whether the selection is considered to extend forward, backward, or\nneither, which affects shift-arrow extension behavior.", "inheritedFrom": { "name": "InputBase", "module": "src/lib/input/input.base.ts" } }, { "kind": "method", "name": "click", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "InputBase", "module": "src/lib/input/input.base.ts" } }, { "kind": "method", "name": "toFormValue", "return": { "type": { "text": "string" } }, "inheritedFrom": { "name": "InputBase", "module": "src/lib/input/input.base.ts" } }, { "kind": "method", "name": "renderSlot", "privacy": "protected", "return": { "type": { "text": "TemplateResult" } }, "parameters": [ { "name": "name", "type": { "text": "'prefix' | 'suffix'" } }, { "name": "defaultContent", "optional": true, "type": { "text": "TemplateResult | string" } } ], "inheritedFrom": { "name": "InputBase", "module": "src/lib/input/input.base.ts" } }, { "kind": "method", "name": "handleInput", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "event", "type": { "text": "Event & { target: HTMLInputElement }" } } ], "inheritedFrom": { "name": "InputBase", "module": "src/lib/input/input.base.ts" } }, { "kind": "method", "name": "updateInputWidth", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "InputBase", "module": "src/lib/input/input.base.ts" } }, { "kind": "field", "name": "tagName", "type": { "text": "string" }, "static": true, "default": "'odx-input-number' satisfies keyof HTMLElementTagNameMap", "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "role", "type": { "text": "ARIARole | null" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "dir", "type": { "text": "'ltr' | 'rtl'" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "inputValue", "type": { "text": "number" }, "privacy": "private", "default": "0" }, { "kind": "field", "name": "iconDecrement", "type": { "text": "OdxIconName" }, "default": "'core::minus'", "attribute": "icon-decrement" }, { "kind": "field", "name": "iconIncrement", "type": { "text": "OdxIconName" }, "default": "'core::plus'", "attribute": "icon-increment" }, { "kind": "field", "name": "min", "type": { "text": "number" }, "default": "0", "attribute": "min" }, { "kind": "field", "name": "max", "type": { "text": "number" }, "default": "100", "attribute": "max" }, { "kind": "field", "name": "step", "type": { "text": "number" }, "default": "1", "attribute": "step" }, { "kind": "field", "name": "stepBehavior", "type": { "text": "InputNumberStepBehavior" }, "attribute": "stepBehavior" }, { "kind": "field", "name": "value", "type": { "text": "number" }, "attribute": "value" }, { "kind": "method", "name": "stepUp", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "n", "optional": true, "type": { "text": "number" } } ] }, { "kind": "method", "name": "stepDown", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "n", "optional": true, "type": { "text": "number" } } ] }, { "kind": "method", "name": "clampValue", "privacy": "protected", "return": { "type": { "text": "number" } }, "parameters": [ { "name": "value", "type": { "text": "number" } }, { "name": "min", "type": { "text": "number" } }, { "name": "max", "type": { "text": "number" } }, { "name": "step", "default": "1" }, { "name": "behavior", "default": "InputNumberStepBehavior.IGNORE", "type": { "text": "InputNumberStepBehavior" } } ] }, { "kind": "field", "name": "#handleChange", "privacy": "private" }, { "kind": "field", "name": "#handleKeyDown", "privacy": "private" }, { "kind": "method", "name": "#getTabbableTarget", "privacy": "private", "parameters": [ { "name": "event", "type": { "text": "Event" } } ], "inheritedFrom": { "name": "InputBase", "module": "src/lib/input/input.base.ts" } }, { "kind": "field", "name": "#handleClick", "privacy": "private", "inheritedFrom": { "name": "InputBase", "module": "src/lib/input/input.base.ts" } }, { "kind": "field", "name": "#handlePointerDown", "privacy": "private", "inheritedFrom": { "name": "InputBase", "module": "src/lib/input/input.base.ts" } } ], "events": [ { "description": "Fired when `select()` is called to programmatically select the value.", "name": "select", "inheritedFrom": { "name": "InputBase", "module": "src/lib/input/input.base.ts" } }, { "name": "change", "type": { "text": "Event" } } ], "attributes": [ { "name": "icon-decrement", "type": { "text": "OdxIconName" }, "default": "'core::minus'", "fieldName": "iconDecrement" }, { "name": "icon-increment", "type": { "text": "OdxIconName" }, "default": "'core::plus'", "fieldName": "iconIncrement" }, { "name": "min", "type": { "text": "number" }, "default": "0", "fieldName": "min" }, { "name": "max", "type": { "text": "number" }, "default": "100", "fieldName": "max" }, { "name": "step", "type": { "text": "number" }, "default": "1", "fieldName": "step" }, { "name": "stepBehavior", "type": { "text": "InputNumberStepBehavior" }, "fieldName": "stepBehavior" }, { "name": "value", "type": { "text": "number" }, "fieldName": "value" }, { "name": "autocomplete", "type": { "text": "HTMLInputElement['autocomplete']" }, "default": "'off'", "description": "Indicates the element's autocomplete state.", "fieldName": "autocomplete", "inheritedFrom": { "name": "InputBase", "module": "src/lib/input/input.base.ts" } }, { "name": "alignment", "type": { "text": "InputAlignment" }, "description": "Indicates the horizontal alignment of the input's content.", "fieldName": "alignment", "inheritedFrom": { "name": "InputBase", "module": "src/lib/input/input.base.ts" } }, { "name": "dirname", "type": { "text": "string | null | undefined" }, "description": "Indicates the directionality of the element's text content.", "fieldName": "dirname", "inheritedFrom": { "name": "InputBase", "module": "src/lib/input/input.base.ts" } }, { "name": "hide-controls", "type": { "text": "boolean" }, "default": "false", "description": "Indicates whether the element's built-in controls (e.g. increment/decrement buttons) should be hidden.", "fieldName": "hideControls", "inheritedFrom": { "name": "InputBase", "module": "src/lib/input/input.base.ts" } }, { "name": "inputmode", "type": { "text": "'none' | 'text' | 'decimal' | 'numeric' | 'tel' | 'search' | 'email' | 'url' | null | undefined" }, "description": "Indicates the type of virtual keyboard to display when the element receives focus on a touch-enabled device.", "fieldName": "inputmode", "inheritedFrom": { "name": "InputBase", "module": "src/lib/input/input.base.ts" } }, { "name": "invalid", "type": { "text": "boolean" }, "default": "false", "description": "Marks the input as invalid for styling purposes. Setting this does not affect\nthe form's built-in validity state; use `setCustomValidity()` on the inner\ninput or rely on `minLength`/`maxLength`/`pattern` for native validation.", "fieldName": "invalid", "inheritedFrom": { "name": "InputBase", "module": "src/lib/input/input.base.ts" } }, { "name": "placeholder", "type": { "text": "string" }, "default": "''", "description": "The placeholder text to display when the input is empty.", "fieldName": "placeholder", "inheritedFrom": { "name": "InputBase", "module": "src/lib/input/input.base.ts" } }, { "name": "size", "type": { "text": "InputSize" }, "description": "Indicates the size of the input.", "fieldName": "size", "inheritedFrom": { "name": "InputBase", "module": "src/lib/input/input.base.ts" } }, { "name": "unit", "type": { "text": "string | null | undefined" }, "description": "The unit label to display after the input value (e.g. \"kg\", \"cm\", etc.).", "fieldName": "unit", "inheritedFrom": { "name": "InputBase", "module": "src/lib/input/input.base.ts" } } ], "superclass": { "name": "InputBase", "module": "/src/lib/input/input.base.js" }, "tagName": "odx-input-number", "customElement": true, "slots": [ { "description": "Content rendered before the input value (typically an icon).", "name": "prefix", "inheritedFrom": { "name": "InputBase", "module": "src/lib/input/input.base.ts" } }, { "description": "Content rendered after the input value (typically an icon or action button). Built-in controls — clear button, password reveal, loading spinner — render into this slot alongside any consumer-provided content.", "name": "suffix", "inheritedFrom": { "name": "InputBase", "module": "src/lib/input/input.base.ts" } } ], "cssParts": [ { "description": "The inner `` element.", "name": "input", "inheritedFrom": { "name": "InputBase", "module": "src/lib/input/input.base.ts" } }, { "description": "The unit label rendered after the value.", "name": "unit", "inheritedFrom": { "name": "InputBase", "module": "src/lib/input/input.base.ts" } } ], "cssProperties": [] } ], "exports": [ { "kind": "js", "name": "InputNumberStepBehavior", "declaration": { "name": "InputNumberStepBehavior", "module": "src/lib/input/input-number.ts" } }, { "kind": "js", "name": "OdxInputNumber", "declaration": { "name": "OdxInputNumber", "module": "src/lib/input/input-number.ts" } } ] }, { "kind": "javascript-module", "path": "src/lib/input/input.base.ts", "declarations": [ { "kind": "variable", "name": "InputAlignment", "type": { "text": "{ START: 'start', CENTER: 'center', END: 'end' }" }, "default": "{ START: 'start', CENTER: 'center', END: 'end' }" }, { "kind": "variable", "name": "InputSize", "type": { "text": "{ SM: 'sm', MD: 'md', LG: 'lg' }" }, "default": "{ SM: 'sm', MD: 'md', LG: 'lg' }" }, { "kind": "class", "description": "", "name": "InputBase", "cssParts": [ { "description": "The inner `` element.", "name": "input" }, { "description": "The unit label rendered after the value.", "name": "unit" } ], "slots": [ { "description": "Content rendered before the input value (typically an icon).", "name": "prefix" }, { "description": "Content rendered after the input value (typically an icon or action button). Built-in controls — clear button, password reveal, loading spinner — render into this slot alongside any consumer-provided content.", "name": "suffix" } ], "members": [ { "kind": "field", "name": "shadowRootOptions", "type": { "text": "ShadowRootInit" }, "static": true, "default": "{ ...super.shadowRootOptions, delegatesFocus: true, }" }, { "kind": "field", "name": "inputActionSelector", "type": { "text": "string | undefined" }, "privacy": "protected" }, { "kind": "field", "name": "measureTarget", "type": { "text": "HTMLSpanElement" }, "privacy": "protected" }, { "kind": "field", "name": "autocomplete", "type": { "text": "HTMLInputElement['autocomplete']" }, "default": "'off'", "description": "Indicates the element's autocomplete state.", "attribute": "autocomplete" }, { "kind": "field", "name": "alignment", "type": { "text": "InputAlignment" }, "description": "Indicates the horizontal alignment of the input's content.", "attribute": "alignment", "reflects": true }, { "kind": "field", "name": "dirname", "type": { "text": "string | null | undefined" }, "description": "Indicates the directionality of the element's text content.", "attribute": "dirname" }, { "kind": "field", "name": "hideControls", "type": { "text": "boolean" }, "default": "false", "description": "Indicates whether the element's built-in controls (e.g. increment/decrement buttons) should be hidden.", "attribute": "hide-controls", "reflects": true }, { "kind": "field", "name": "inputmode", "type": { "text": "'none' | 'text' | 'decimal' | 'numeric' | 'tel' | 'search' | 'email' | 'url' | null | undefined" }, "description": "Indicates the type of virtual keyboard to display when the element receives focus on a touch-enabled device.", "attribute": "inputmode" }, { "kind": "field", "name": "invalid", "type": { "text": "boolean" }, "default": "false", "description": "Marks the input as invalid for styling purposes. Setting this does not affect\nthe form's built-in validity state; use `setCustomValidity()` on the inner\ninput or rely on `minLength`/`maxLength`/`pattern` for native validation.", "attribute": "invalid", "reflects": true }, { "kind": "field", "name": "placeholder", "type": { "text": "string" }, "default": "''", "description": "The placeholder text to display when the input is empty.", "attribute": "placeholder" }, { "kind": "field", "name": "size", "type": { "text": "InputSize" }, "description": "Indicates the size of the input.", "attribute": "size", "reflects": true }, { "kind": "field", "name": "unit", "type": { "text": "string | null | undefined" }, "description": "The unit label to display after the input value (e.g. \"kg\", \"cm\", etc.).", "attribute": "unit" }, { "kind": "method", "name": "select", "return": { "type": { "text": "void" } }, "description": "Selects all of the current value in the inner input and fires a `select` event." }, { "kind": "method", "name": "setSelectionRange", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "start", "type": { "text": "number" } }, { "name": "end", "type": { "text": "number" } }, { "name": "direction", "default": "'none'", "type": { "text": "'forward' | 'backward' | 'none'" } } ], "description": "Selects a range of characters in the inner input. The optional `direction`\nindicates whether the selection is considered to extend forward, backward, or\nneither, which affects shift-arrow extension behavior." }, { "kind": "method", "name": "click", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "toFormValue", "return": { "type": { "text": "string" } } }, { "kind": "method", "name": "renderSlot", "privacy": "protected", "return": { "type": { "text": "TemplateResult" } }, "parameters": [ { "name": "name", "type": { "text": "'prefix' | 'suffix'" } }, { "name": "defaultContent", "optional": true, "type": { "text": "TemplateResult | string" } } ] }, { "kind": "method", "name": "handleInput", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "event", "type": { "text": "InputEvent & { target: HTMLInputElement }" } } ] }, { "kind": "method", "name": "updateInputWidth", "privacy": "protected", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "#getTabbableTarget", "privacy": "private", "parameters": [ { "name": "event", "type": { "text": "Event" } } ] }, { "kind": "field", "name": "#handleClick", "privacy": "private" }, { "kind": "field", "name": "#handlePointerDown", "privacy": "private" }, { "kind": "field", "name": "tagName", "type": { "text": "string" }, "static": true, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "role", "type": { "text": "ARIARole | null" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "dir", "type": { "text": "'ltr' | 'rtl'" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } } ], "events": [ { "description": "Fired when `select()` is called to programmatically select the value.", "name": "select" } ], "attributes": [ { "name": "autocomplete", "type": { "text": "HTMLInputElement['autocomplete']" }, "default": "'off'", "description": "Indicates the element's autocomplete state.", "fieldName": "autocomplete" }, { "name": "alignment", "type": { "text": "InputAlignment" }, "description": "Indicates the horizontal alignment of the input's content.", "fieldName": "alignment" }, { "name": "dirname", "type": { "text": "string | null | undefined" }, "description": "Indicates the directionality of the element's text content.", "fieldName": "dirname" }, { "name": "hide-controls", "type": { "text": "boolean" }, "default": "false", "description": "Indicates whether the element's built-in controls (e.g. increment/decrement buttons) should be hidden.", "fieldName": "hideControls" }, { "name": "inputmode", "type": { "text": "'none' | 'text' | 'decimal' | 'numeric' | 'tel' | 'search' | 'email' | 'url' | null | undefined" }, "description": "Indicates the type of virtual keyboard to display when the element receives focus on a touch-enabled device.", "fieldName": "inputmode" }, { "name": "invalid", "type": { "text": "boolean" }, "default": "false", "description": "Marks the input as invalid for styling purposes. Setting this does not affect\nthe form's built-in validity state; use `setCustomValidity()` on the inner\ninput or rely on `minLength`/`maxLength`/`pattern` for native validation.", "fieldName": "invalid" }, { "name": "placeholder", "type": { "text": "string" }, "default": "''", "description": "The placeholder text to display when the input is empty.", "fieldName": "placeholder" }, { "name": "size", "type": { "text": "InputSize" }, "description": "Indicates the size of the input.", "fieldName": "size" }, { "name": "unit", "type": { "text": "string | null | undefined" }, "description": "The unit label to display after the input value (e.g. \"kg\", \"cm\", etc.).", "fieldName": "unit" } ], "mixins": [ { "name": "FormAssociated", "module": "/src/internal/behaviors/form-associated.js" } ], "superclass": { "name": "CustomElement", "module": "/src/internal/custom-element.js" }, "summary": "Base element for components with input functionality." } ], "exports": [ { "kind": "js", "name": "InputAlignment", "declaration": { "name": "InputAlignment", "module": "src/lib/input/input.base.ts" } }, { "kind": "js", "name": "InputSize", "declaration": { "name": "InputSize", "module": "src/lib/input/input.base.ts" } }, { "kind": "js", "name": "InputBase", "declaration": { "name": "InputBase", "module": "src/lib/input/input.base.ts" } } ] }, { "kind": "javascript-module", "path": "src/lib/input/input.ts", "declarations": [ { "kind": "variable", "name": "InputBehavior", "type": { "text": "{ INSTANT: 'instant', SUBMIT: 'submit' }" }, "default": "{ INSTANT: 'instant', SUBMIT: 'submit' }" }, { "kind": "variable", "name": "InputType", "type": { "text": "{\n TEXT: 'text',\n EMAIL: 'email',\n HIDDEN: 'hidden',\n NUMBER: 'number',\n PASSWORD: 'password',\n SEARCH: 'search',\n TEL: 'tel',\n URL: 'url',\n TIME: 'time',\n COMBOBOX: 'combobox',\n}" }, "default": "{ TEXT: 'text', EMAIL: 'email', HIDDEN: 'hidden', NUMBER: 'number', PASSWORD: 'password', SEARCH: 'search', TEL: 'tel', URL: 'url', TIME: 'time', COMBOBOX: 'combobox', }" }, { "kind": "class", "description": "", "name": "InputSearchEvent", "superclass": { "name": "CustomEvent", "module": "src/lib/input/input.ts" } }, { "kind": "class", "description": "Single-line text input that wraps the native `` element with consistent\nstyling, prefix/suffix slots, and richer behaviors for clearing, loading, and\npassword reveal.\n\nSupports the standard HTML input types (`text`, `email`, `password`, `search`,\n`tel`, `url`, `time`, `number`, `hidden`) plus a `combobox` mode used internally\nby select and autocomplete components.\n\nForm-associated via `ElementInternals` — the current `value` is submitted as\npart of the surrounding `
` under the element's `name`.", "name": "OdxInput", "members": [ { "kind": "field", "name": "shadowRootOptions", "type": { "text": "ShadowRootInit" }, "static": true, "default": "{ ...super.shadowRootOptions, delegatesFocus: true, }", "inheritedFrom": { "name": "InputBase", "module": "src/lib/input/input.base.ts" } }, { "kind": "field", "name": "inputActionSelector", "type": { "text": "string | undefined" }, "privacy": "protected", "inheritedFrom": { "name": "InputBase", "module": "src/lib/input/input.base.ts" } }, { "kind": "field", "name": "measureTarget", "type": { "text": "HTMLSpanElement" }, "privacy": "protected", "inheritedFrom": { "name": "InputBase", "module": "src/lib/input/input.base.ts" } }, { "kind": "field", "name": "autocomplete", "type": { "text": "HTMLInputElement['autocomplete']" }, "default": "'off'", "description": "Indicates the element's autocomplete state.", "attribute": "autocomplete", "inheritedFrom": { "name": "InputBase", "module": "src/lib/input/input.base.ts" } }, { "kind": "field", "name": "alignment", "type": { "text": "InputAlignment" }, "description": "Indicates the horizontal alignment of the input's content.", "attribute": "alignment", "reflects": true, "inheritedFrom": { "name": "InputBase", "module": "src/lib/input/input.base.ts" } }, { "kind": "field", "name": "dirname", "type": { "text": "string | null | undefined" }, "description": "Indicates the directionality of the element's text content.", "attribute": "dirname", "inheritedFrom": { "name": "InputBase", "module": "src/lib/input/input.base.ts" } }, { "kind": "field", "name": "hideControls", "type": { "text": "boolean" }, "default": "false", "description": "Indicates whether the element's built-in controls (e.g. increment/decrement buttons) should be hidden.", "attribute": "hide-controls", "reflects": true, "inheritedFrom": { "name": "InputBase", "module": "src/lib/input/input.base.ts" } }, { "kind": "field", "name": "inputmode", "type": { "text": "'none' | 'text' | 'decimal' | 'numeric' | 'tel' | 'search' | 'email' | 'url' | null | undefined" }, "description": "Indicates the type of virtual keyboard to display when the element receives focus on a touch-enabled device.", "attribute": "inputmode", "inheritedFrom": { "name": "InputBase", "module": "src/lib/input/input.base.ts" } }, { "kind": "field", "name": "invalid", "type": { "text": "boolean" }, "default": "false", "description": "Marks the input as invalid for styling purposes. Setting this does not affect\nthe form's built-in validity state; use `setCustomValidity()` on the inner\ninput or rely on `minLength`/`maxLength`/`pattern` for native validation.", "attribute": "invalid", "reflects": true, "inheritedFrom": { "name": "InputBase", "module": "src/lib/input/input.base.ts" } }, { "kind": "field", "name": "placeholder", "type": { "text": "string" }, "default": "''", "description": "The placeholder text to display when the input is empty.", "attribute": "placeholder", "inheritedFrom": { "name": "InputBase", "module": "src/lib/input/input.base.ts" } }, { "kind": "field", "name": "size", "type": { "text": "InputSize" }, "description": "Indicates the size of the input.", "attribute": "size", "reflects": true, "inheritedFrom": { "name": "InputBase", "module": "src/lib/input/input.base.ts" } }, { "kind": "field", "name": "unit", "type": { "text": "string | null | undefined" }, "description": "The unit label to display after the input value (e.g. \"kg\", \"cm\", etc.).", "attribute": "unit", "inheritedFrom": { "name": "InputBase", "module": "src/lib/input/input.base.ts" } }, { "kind": "method", "name": "select", "return": { "type": { "text": "void" } }, "description": "Selects all of the current value in the inner input and fires a `select` event.", "inheritedFrom": { "name": "InputBase", "module": "src/lib/input/input.base.ts" } }, { "kind": "method", "name": "setSelectionRange", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "start", "type": { "text": "number" } }, { "name": "end", "type": { "text": "number" } }, { "name": "direction", "default": "'none'", "type": { "text": "'forward' | 'backward' | 'none'" } } ], "description": "Selects a range of characters in the inner input. The optional `direction`\nindicates whether the selection is considered to extend forward, backward, or\nneither, which affects shift-arrow extension behavior.", "inheritedFrom": { "name": "InputBase", "module": "src/lib/input/input.base.ts" } }, { "kind": "method", "name": "click", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "InputBase", "module": "src/lib/input/input.base.ts" } }, { "kind": "method", "name": "toFormValue", "return": { "type": { "text": "string" } }, "inheritedFrom": { "name": "InputBase", "module": "src/lib/input/input.base.ts" } }, { "kind": "method", "name": "renderSlot", "privacy": "protected", "return": { "type": { "text": "TemplateResult" } }, "parameters": [ { "name": "name", "type": { "text": "'prefix' | 'suffix'" } }, { "name": "defaultContent", "optional": true, "type": { "text": "TemplateResult | string" } } ], "inheritedFrom": { "name": "InputBase", "module": "src/lib/input/input.base.ts" } }, { "kind": "method", "name": "handleInput", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "event", "type": { "text": "InputEvent & { target: HTMLInputElement }" } } ], "inheritedFrom": { "name": "InputBase", "module": "src/lib/input/input.base.ts" } }, { "kind": "method", "name": "updateInputWidth", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "InputBase", "module": "src/lib/input/input.base.ts" } }, { "kind": "field", "name": "tagName", "type": { "text": "string" }, "static": true, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" }, "default": "'odx-input' satisfies keyof HTMLElementTagNameMap" }, { "kind": "field", "name": "role", "type": { "text": "ARIARole | null" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "dir", "type": { "text": "'ltr' | 'rtl'" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "#handleInputDebounced", "privacy": "private", "type": { "text": "(event: Event) => void" } }, { "kind": "field", "name": "autocapitalize", "type": { "text": "string" }, "default": "'off'", "attribute": "autocapitalize" }, { "kind": "field", "name": "behavior", "type": { "text": "InputBehavior" }, "description": "For `type=\"search\"`, controls when the `search` event fires:\n- `'submit'` (default): only when the user presses Enter or clicks the search icon.\n- `'instant'`: on every value change (subject to `debounce`).", "attribute": "behavior" }, { "kind": "field", "name": "clearable", "type": { "text": "boolean" }, "default": "false", "description": "When `true`, renders a clear button in the suffix slot while the input has a\nnon-empty value and is neither disabled nor readonly.", "attribute": "clearable", "reflects": true }, { "kind": "field", "name": "debounce", "type": { "text": "number" }, "default": "0", "description": "Number of milliseconds to debounce the underlying `input` event. Useful for\n`behavior=\"instant\"` search to avoid firing on every keystroke.", "attribute": "debounce" }, { "kind": "field", "name": "loading", "type": { "text": "boolean" }, "default": "false", "description": "When `true`, replaces the suffix slot content with a loading spinner. Use this\nto indicate that an async operation (e.g. a search request) is in progress.", "attribute": "loading", "reflects": true }, { "kind": "field", "name": "minLength", "type": { "text": "number | null | undefined" }, "description": "Minimum number of characters the value must contain to satisfy form validation.", "attribute": "minLength" }, { "kind": "field", "name": "maxLength", "type": { "text": "number | null | undefined" }, "description": "Maximum number of characters the value may contain.", "attribute": "maxLength" }, { "kind": "field", "name": "pattern", "type": { "text": "string | null | undefined" }, "description": "Regular expression the value must match to satisfy form validation.", "attribute": "pattern" }, { "kind": "field", "name": "passwordRevealed", "type": { "text": "boolean" }, "default": "false", "description": "For `type=\"password\"`, controls whether the value is shown as plain text.\nToggled by the built-in reveal button rendered in the suffix slot.", "attribute": "password-revealed" }, { "kind": "field", "name": "type", "type": { "text": "InputType" }, "description": "The type of input to render. Mirrors the standard HTML `type` attribute with\nan additional `combobox` mode used by composite components like `odx-select`\nand `odx-autocomplete`.", "attribute": "type", "reflects": true }, { "kind": "field", "name": "value", "type": { "text": "string" }, "default": "''", "description": "The current value of the input. Submitted as form data under the element's `name`.", "attribute": "value" }, { "kind": "method", "name": "#updateInput", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "attribute", "type": { "text": "keyof typeof this.inputElement" } }, { "name": "value", "optional": true, "type": { "text": "string | number | null | undefined" } } ] }, { "kind": "method", "name": "#emitSearchEvent", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "field", "name": "#forwardEvent", "privacy": "private" }, { "kind": "field", "name": "#handleClear", "privacy": "private" }, { "kind": "field", "name": "#handleInput", "privacy": "private" }, { "kind": "field", "name": "#handlePasswordToggle", "privacy": "private" }, { "kind": "field", "name": "#handleSearch", "privacy": "private" }, { "kind": "method", "name": "#getTabbableTarget", "privacy": "private", "parameters": [ { "name": "event", "type": { "text": "Event" } } ], "inheritedFrom": { "name": "InputBase", "module": "src/lib/input/input.base.ts" } }, { "kind": "field", "name": "#handleClick", "privacy": "private", "inheritedFrom": { "name": "InputBase", "module": "src/lib/input/input.base.ts" } }, { "kind": "field", "name": "#handlePointerDown", "privacy": "private", "inheritedFrom": { "name": "InputBase", "module": "src/lib/input/input.base.ts" } } ], "events": [ { "description": "Fired when `select()` is called to programmatically select the value.", "name": "select", "inheritedFrom": { "name": "InputBase", "module": "src/lib/input/input.base.ts" } }, { "type": { "text": "InputSearchEvent" } }, { "description": "Fired when the value changes due to user input or after the value is cleared.", "name": "change" }, { "description": "Fired when the user requests clearing the value (via the clear button or Escape key). Cancelable: call `preventDefault()` to keep the current value.", "name": "clear" }, { "description": "Fired for `type=\"search\"` inputs when the user submits a query (Enter, search icon) or, in `behavior=\"instant\"`, on every value change. The `detail` contains `rawValue` (as typed) and `value` (trimmed).", "name": "search" } ], "attributes": [ { "name": "autocapitalize", "type": { "text": "string" }, "default": "'off'", "fieldName": "autocapitalize" }, { "name": "behavior", "type": { "text": "InputBehavior" }, "description": "For `type=\"search\"`, controls when the `search` event fires:\n- `'submit'` (default): only when the user presses Enter or clicks the search icon.\n- `'instant'`: on every value change (subject to `debounce`).", "fieldName": "behavior" }, { "name": "clearable", "type": { "text": "boolean" }, "default": "false", "description": "When `true`, renders a clear button in the suffix slot while the input has a\nnon-empty value and is neither disabled nor readonly.", "fieldName": "clearable" }, { "name": "debounce", "type": { "text": "number" }, "default": "0", "description": "Number of milliseconds to debounce the underlying `input` event. Useful for\n`behavior=\"instant\"` search to avoid firing on every keystroke.", "fieldName": "debounce" }, { "name": "loading", "type": { "text": "boolean" }, "default": "false", "description": "When `true`, replaces the suffix slot content with a loading spinner. Use this\nto indicate that an async operation (e.g. a search request) is in progress.", "fieldName": "loading" }, { "name": "minLength", "type": { "text": "number | null | undefined" }, "description": "Minimum number of characters the value must contain to satisfy form validation.", "fieldName": "minLength" }, { "name": "maxLength", "type": { "text": "number | null | undefined" }, "description": "Maximum number of characters the value may contain.", "fieldName": "maxLength" }, { "name": "pattern", "type": { "text": "string | null | undefined" }, "description": "Regular expression the value must match to satisfy form validation.", "fieldName": "pattern" }, { "name": "password-revealed", "type": { "text": "boolean" }, "default": "false", "description": "For `type=\"password\"`, controls whether the value is shown as plain text.\nToggled by the built-in reveal button rendered in the suffix slot.", "fieldName": "passwordRevealed" }, { "name": "type", "type": { "text": "InputType" }, "description": "The type of input to render. Mirrors the standard HTML `type` attribute with\nan additional `combobox` mode used by composite components like `odx-select`\nand `odx-autocomplete`.", "fieldName": "type" }, { "name": "value", "type": { "text": "string" }, "default": "''", "description": "The current value of the input. Submitted as form data under the element's `name`.", "fieldName": "value" }, { "name": "autocomplete", "type": { "text": "HTMLInputElement['autocomplete']" }, "default": "'off'", "description": "Indicates the element's autocomplete state.", "fieldName": "autocomplete", "inheritedFrom": { "name": "InputBase", "module": "src/lib/input/input.base.ts" } }, { "name": "alignment", "type": { "text": "InputAlignment" }, "description": "Indicates the horizontal alignment of the input's content.", "fieldName": "alignment", "inheritedFrom": { "name": "InputBase", "module": "src/lib/input/input.base.ts" } }, { "name": "dirname", "type": { "text": "string | null | undefined" }, "description": "Indicates the directionality of the element's text content.", "fieldName": "dirname", "inheritedFrom": { "name": "InputBase", "module": "src/lib/input/input.base.ts" } }, { "name": "hide-controls", "type": { "text": "boolean" }, "default": "false", "description": "Indicates whether the element's built-in controls (e.g. increment/decrement buttons) should be hidden.", "fieldName": "hideControls", "inheritedFrom": { "name": "InputBase", "module": "src/lib/input/input.base.ts" } }, { "name": "inputmode", "type": { "text": "'none' | 'text' | 'decimal' | 'numeric' | 'tel' | 'search' | 'email' | 'url' | null | undefined" }, "description": "Indicates the type of virtual keyboard to display when the element receives focus on a touch-enabled device.", "fieldName": "inputmode", "inheritedFrom": { "name": "InputBase", "module": "src/lib/input/input.base.ts" } }, { "name": "invalid", "type": { "text": "boolean" }, "default": "false", "description": "Marks the input as invalid for styling purposes. Setting this does not affect\nthe form's built-in validity state; use `setCustomValidity()` on the inner\ninput or rely on `minLength`/`maxLength`/`pattern` for native validation.", "fieldName": "invalid", "inheritedFrom": { "name": "InputBase", "module": "src/lib/input/input.base.ts" } }, { "name": "placeholder", "type": { "text": "string" }, "default": "''", "description": "The placeholder text to display when the input is empty.", "fieldName": "placeholder", "inheritedFrom": { "name": "InputBase", "module": "src/lib/input/input.base.ts" } }, { "name": "size", "type": { "text": "InputSize" }, "description": "Indicates the size of the input.", "fieldName": "size", "inheritedFrom": { "name": "InputBase", "module": "src/lib/input/input.base.ts" } }, { "name": "unit", "type": { "text": "string | null | undefined" }, "description": "The unit label to display after the input value (e.g. \"kg\", \"cm\", etc.).", "fieldName": "unit", "inheritedFrom": { "name": "InputBase", "module": "src/lib/input/input.base.ts" } } ], "superclass": { "name": "InputBase", "module": "/src/lib/input/input.base.js" }, "summary": "Single-line text input with clear, loading, password-reveal, and search behaviors.", "tagName": "odx-input", "customElement": true, "slots": [ { "description": "Content rendered before the input value (typically an icon).", "name": "prefix", "inheritedFrom": { "name": "InputBase", "module": "src/lib/input/input.base.ts" } }, { "description": "Content rendered after the input value (typically an icon or action button). Built-in controls — clear button, password reveal, loading spinner — render into this slot alongside any consumer-provided content.", "name": "suffix", "inheritedFrom": { "name": "InputBase", "module": "src/lib/input/input.base.ts" } } ], "cssParts": [ { "description": "The inner `` element.", "name": "input", "inheritedFrom": { "name": "InputBase", "module": "src/lib/input/input.base.ts" } }, { "description": "The unit label rendered after the value.", "name": "unit", "inheritedFrom": { "name": "InputBase", "module": "src/lib/input/input.base.ts" } } ], "cssProperties": [] } ], "exports": [ { "kind": "js", "name": "InputBehavior", "declaration": { "name": "InputBehavior", "module": "src/lib/input/input.ts" } }, { "kind": "js", "name": "InputType", "declaration": { "name": "InputType", "module": "src/lib/input/input.ts" } }, { "kind": "js", "name": "InputSearchEvent", "declaration": { "name": "InputSearchEvent", "module": "src/lib/input/input.ts" } }, { "kind": "js", "name": "OdxInput", "declaration": { "name": "OdxInput", "module": "src/lib/input/input.ts" } } ] }, { "kind": "javascript-module", "path": "src/lib/key-value-list/key-value-list.ts", "declarations": [ { "kind": "class", "description": "", "name": "OdxKeyValueList", "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "static": true, "default": "'odx-key-value-list' satisfies keyof HTMLElementTagNameMap", "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "layout", "type": { "text": "KeyValueLayout | null | undefined" }, "attribute": "layout", "reflects": true }, { "kind": "field", "name": "size", "type": { "text": "KeyValueSize" }, "attribute": "size", "reflects": true }, { "kind": "field", "name": "striped", "type": { "text": "boolean" }, "default": "false", "attribute": "striped", "reflects": true }, { "kind": "field", "name": "role", "type": { "text": "ARIARole | null" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "dir", "type": { "text": "'ltr' | 'rtl'" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } } ], "attributes": [ { "name": "layout", "type": { "text": "KeyValueLayout | null | undefined" }, "fieldName": "layout" }, { "name": "size", "type": { "text": "KeyValueSize" }, "fieldName": "size" }, { "name": "striped", "type": { "text": "boolean" }, "default": "false", "fieldName": "striped" } ], "superclass": { "name": "CustomElement", "module": "/src/internal/custom-element.js" }, "tagName": "odx-key-value-list", "customElement": true, "events": [], "slots": [], "cssParts": [], "cssProperties": [] } ], "exports": [ { "kind": "js", "name": "OdxKeyValueList", "declaration": { "name": "OdxKeyValueList", "module": "src/lib/key-value-list/key-value-list.ts" } } ] }, { "kind": "javascript-module", "path": "src/lib/key-value-list/key-value.ts", "declarations": [ { "kind": "variable", "name": "KeyValueAlignment", "type": { "text": "{ START: 'start', END: 'end' }" }, "default": "{ START: 'start', END: 'end' }" }, { "kind": "variable", "name": "KeyValueLayout", "type": { "text": "{ VERTICAL: 'vertical', HORIZONTAL: 'horizontal' }" }, "default": "{ VERTICAL: 'vertical', HORIZONTAL: 'horizontal' }" }, { "kind": "variable", "name": "KeyValueSize", "type": { "text": "{ SM: 'sm', MD: 'md', LG: 'lg' }" }, "default": "{ SM: 'sm', MD: 'md', LG: 'lg' }" }, { "kind": "variable", "name": "KeyValueVariant", "type": { "text": "{ NEUTRAL: 'neutral', ACCENT: 'accent', DANGER: 'danger', SUCCESS: 'success' }" }, "default": "{ NEUTRAL: 'neutral', ACCENT: 'accent', DANGER: 'danger', SUCCESS: 'success' }" }, { "kind": "class", "description": "", "name": "OdxKeyValue", "cssParts": [ { "description": "The value element", "name": "value" }, { "description": "The unit element", "name": "unit" } ], "slots": [ { "description": "Default slot for the value", "name": "" }, { "description": "Slot for the key/label", "name": "key" }, { "description": "Slot for content to appear before the key-value pair", "name": "prefix" }, { "description": "Slot for content to appear after the key-value pair", "name": "suffix" } ], "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "static": true, "default": "'odx-key-value' satisfies keyof HTMLElementTagNameMap", "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "#slots", "privacy": "private", "default": "new SlotContentObserver(this)" }, { "kind": "field", "name": "alignment", "type": { "text": "KeyValueAlignment" }, "attribute": "alignment", "reflects": true }, { "kind": "field", "name": "key", "type": { "text": "string" }, "default": "''", "attribute": "key" }, { "kind": "field", "name": "layout", "type": { "text": "KeyValueLayout" }, "attribute": "layout", "reflects": true }, { "kind": "field", "name": "size", "type": { "text": "KeyValueSize" }, "attribute": "size", "reflects": true }, { "kind": "field", "name": "unit", "type": { "text": "string | null | undefined" }, "attribute": "unit" }, { "kind": "field", "name": "value", "type": { "text": "string" }, "default": "''", "attribute": "value" }, { "kind": "field", "name": "variant", "type": { "text": "KeyValueVariant" }, "attribute": "variant", "reflects": true }, { "kind": "field", "name": "role", "type": { "text": "ARIARole | null" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "dir", "type": { "text": "'ltr' | 'rtl'" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } } ], "attributes": [ { "name": "alignment", "type": { "text": "KeyValueAlignment" }, "fieldName": "alignment" }, { "name": "key", "type": { "text": "string" }, "default": "''", "fieldName": "key" }, { "name": "layout", "type": { "text": "KeyValueLayout" }, "fieldName": "layout" }, { "name": "size", "type": { "text": "KeyValueSize" }, "fieldName": "size" }, { "name": "unit", "type": { "text": "string | null | undefined" }, "fieldName": "unit" }, { "name": "value", "type": { "text": "string" }, "default": "''", "fieldName": "value" }, { "name": "variant", "type": { "text": "KeyValueVariant" }, "fieldName": "variant" } ], "superclass": { "name": "CustomElement", "module": "/src/internal/custom-element.js" }, "summary": "A key-value component to display a label and its corresponding value.", "tagName": "odx-key-value", "customElement": true, "events": [], "cssProperties": [] } ], "exports": [ { "kind": "js", "name": "KeyValueAlignment", "declaration": { "name": "KeyValueAlignment", "module": "src/lib/key-value-list/key-value.ts" } }, { "kind": "js", "name": "KeyValueLayout", "declaration": { "name": "KeyValueLayout", "module": "src/lib/key-value-list/key-value.ts" } }, { "kind": "js", "name": "KeyValueSize", "declaration": { "name": "KeyValueSize", "module": "src/lib/key-value-list/key-value.ts" } }, { "kind": "js", "name": "KeyValueVariant", "declaration": { "name": "KeyValueVariant", "module": "src/lib/key-value-list/key-value.ts" } }, { "kind": "js", "name": "OdxKeyValue", "declaration": { "name": "OdxKeyValue", "module": "src/lib/key-value-list/key-value.ts" } } ] }, { "kind": "javascript-module", "path": "src/lib/label/label.ts", "declarations": [ { "kind": "class", "description": "", "name": "OdxLabel", "slots": [ { "description": "The label content.", "name": "" }, { "description": "The prefix content that appears before label content.", "name": "prefix" }, { "description": "The suffix content that appears after label content.", "name": "suffix" } ], "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "static": true, "default": "'odx-label' satisfies keyof HTMLElementTagNameMap", "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "role", "type": { "text": "ARIARole | null" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "dir", "type": { "text": "'ltr' | 'rtl'" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } } ], "superclass": { "name": "CustomElement", "module": "/src/internal/custom-element.js" }, "summary": "Label component for labeling other elements.", "tagName": "odx-label", "customElement": true, "events": [], "cssParts": [], "cssProperties": [] } ], "exports": [ { "kind": "js", "name": "OdxLabel", "declaration": { "name": "OdxLabel", "module": "src/lib/label/label.ts" } } ] }, { "kind": "javascript-module", "path": "src/lib/line-clamp/line-clamp.ts", "declarations": [ { "kind": "class", "description": "", "name": "OdxLineClamp", "slots": [ { "description": "The text content to be clamped. This component will apply the line clamp to its text content.", "name": "" } ], "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "static": true, "default": "'odx-line-clamp' satisfies keyof HTMLElementTagNameMap", "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "max", "type": { "text": "number | null | undefined" }, "description": "The maximum number of lines to display before truncating the text.", "attribute": "max" }, { "kind": "field", "name": "role", "type": { "text": "ARIARole | null" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "dir", "type": { "text": "'ltr' | 'rtl'" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } } ], "attributes": [ { "name": "max", "type": { "text": "number | null | undefined" }, "description": "The maximum number of lines to display before truncating the text.", "fieldName": "max" } ], "superclass": { "name": "CustomElement", "module": "/src/internal/custom-element.js" }, "summary": "A component that truncates text after a specified number of lines and adds an ellipsis.", "tagName": "odx-line-clamp", "customElement": true, "events": [], "cssParts": [], "cssProperties": [] } ], "exports": [ { "kind": "js", "name": "OdxLineClamp", "declaration": { "name": "OdxLineClamp", "module": "src/lib/line-clamp/line-clamp.ts" } } ] }, { "kind": "javascript-module", "path": "src/lib/link/link.ts", "declarations": [ { "kind": "class", "description": "", "name": "OdxLink", "slots": [ { "description": "The link content.", "name": "" } ], "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "static": true, "default": "'odx-link' satisfies keyof HTMLElementTagNameMap", "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "anchor", "type": { "text": "HTMLAnchorElement | undefined" }, "privacy": "protected" }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Indicates whether the element is disabled.\nIf `true` it cannot be interacted with nor be focused.", "attribute": "disabled", "reflects": true }, { "kind": "field", "name": "href", "type": { "text": "string" }, "default": "''", "description": "The URL that the element links to.", "attribute": "href" }, { "kind": "field", "name": "target", "type": { "text": "'_blank' | '_parent' | '_self' | '_top' | ''" }, "default": "''", "description": "Specifies where to open the linked document.", "attribute": "target" }, { "kind": "field", "name": "rel", "type": { "text": "string" }, "default": "''", "description": "Specifies the relationship between the current document and the linked document.", "attribute": "rel" }, { "kind": "field", "name": "download", "type": { "text": "string | undefined" }, "description": "Specifies that the target will be downloaded when a user clicks on the hyperlink.", "attribute": "download" }, { "kind": "field", "name": "external", "type": { "text": "boolean" }, "default": "false", "description": "Indicates that the link is external and should open in a new tab.\n\nIf `target` is not set, it will default to `_blank` when `external` is true.", "attribute": "external", "reflects": true }, { "kind": "field", "name": "inline", "type": { "text": "boolean" }, "default": "false", "description": "Indicates that the link should be displayed inline with surrounding content.", "attribute": "inline", "reflects": true }, { "kind": "method", "name": "click", "return": { "type": { "text": "void" } } }, { "kind": "field", "name": "#handleClick", "privacy": "private" }, { "kind": "field", "name": "#handleKeyboardEvent", "privacy": "private" }, { "kind": "field", "name": "role", "type": { "text": "ARIARole | null" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "dir", "type": { "text": "'ltr' | 'rtl'" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } } ], "attributes": [ { "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Indicates whether the element is disabled.\nIf `true` it cannot be interacted with nor be focused.", "fieldName": "disabled" }, { "name": "href", "type": { "text": "string" }, "default": "''", "description": "The URL that the element links to.", "fieldName": "href" }, { "name": "target", "type": { "text": "'_blank' | '_parent' | '_self' | '_top' | ''" }, "default": "''", "description": "Specifies where to open the linked document.", "fieldName": "target" }, { "name": "rel", "type": { "text": "string" }, "default": "''", "description": "Specifies the relationship between the current document and the linked document.", "fieldName": "rel" }, { "name": "download", "type": { "text": "string | undefined" }, "description": "Specifies that the target will be downloaded when a user clicks on the hyperlink.", "fieldName": "download" }, { "name": "external", "type": { "text": "boolean" }, "default": "false", "description": "Indicates that the link is external and should open in a new tab.\n\nIf `target` is not set, it will default to `_blank` when `external` is true.", "fieldName": "external" }, { "name": "inline", "type": { "text": "boolean" }, "default": "false", "description": "Indicates that the link should be displayed inline with surrounding content.", "fieldName": "inline" } ], "superclass": { "name": "CustomElement", "module": "/src/internal/custom-element.js" }, "summary": "Links are used as navigation elements.", "tagName": "odx-link", "customElement": true, "events": [], "cssParts": [], "cssProperties": [] } ], "exports": [ { "kind": "js", "name": "OdxLink", "declaration": { "name": "OdxLink", "module": "src/lib/link/link.ts" } } ] }, { "kind": "javascript-module", "path": "src/lib/list/list-item.ts", "declarations": [ { "kind": "variable", "name": "ListItemVariant", "type": { "text": "{ NEUTRAL: 'neutral', DANGER: 'danger', WARNING: 'warning' }" }, "default": "{ NEUTRAL: 'neutral', DANGER: 'danger', WARNING: 'warning' }" }, { "kind": "variable", "name": "ListItemSize", "type": { "text": "{ SM: 'sm', MD: 'md', LG: 'lg' }" }, "default": "{ SM: 'sm', MD: 'md', LG: 'lg' }" }, { "kind": "class", "description": "", "name": "OdxListItem", "slots": [ { "description": "The list item's label.", "name": "" }, { "description": "Prefix slot typically used for icons.", "name": "prefix" }, { "description": "Suffix slot typically used for icons or actions or badges.", "name": "suffix" }, { "description": "Slot for expandable content", "name": "expand" } ], "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "static": true, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" }, "default": "'odx-list-item' satisfies keyof HTMLElementTagNameMap" }, { "kind": "field", "name": "anchor", "type": { "text": "HTMLAnchorElement | undefined" }, "privacy": "protected" }, { "kind": "field", "name": "href", "type": { "text": "string" }, "default": "''", "description": "The URL that the element links to.", "attribute": "href" }, { "kind": "field", "name": "target", "type": { "text": "'_blank' | '_parent' | '_self' | '_top' | ''" }, "default": "''", "description": "Specifies where to open the linked document.", "attribute": "target" }, { "kind": "field", "name": "rel", "type": { "text": "string" }, "default": "''", "description": "Specifies the relationship between the current document and the linked document.", "attribute": "rel" }, { "kind": "field", "name": "download", "type": { "text": "string | undefined" }, "description": "Specifies that the target will be downloaded when a user clicks on the hyperlink.", "attribute": "download" }, { "kind": "field", "name": "loading", "type": { "text": "boolean" }, "default": "false", "description": "Indicates that the item is in a loading state.", "attribute": "loading", "reflects": true }, { "kind": "field", "name": "muted", "type": { "text": "boolean" }, "default": "false", "description": "Indicates that the item is muted, prevents hover and active styles from being applied.", "attribute": "muted", "reflects": true }, { "kind": "field", "name": "open", "type": { "text": "boolean" }, "default": "false", "description": "Indicates that the item is open, showing the content in the `expand` slot.\nIf no content is provided in the `expand` slot, this attribute has no effect.", "attribute": "open", "reflects": true }, { "kind": "field", "name": "selected", "type": { "text": "boolean" }, "default": "false", "description": "Indicates that the item is selected.", "attribute": "selected", "reflects": true }, { "kind": "field", "name": "size", "type": { "text": "ListItemSize" }, "description": "Indicates the size of the item.", "attribute": "size", "reflects": true }, { "kind": "field", "name": "variant", "type": { "text": "ListItemVariant" }, "description": "The variant of the list item.", "attribute": "variant", "reflects": true }, { "kind": "method", "name": "isExpandable", "return": { "type": { "text": "boolean" } } }, { "kind": "method", "name": "toggle", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "state", "optional": true, "type": { "text": "boolean" } }, { "name": "emitEvent", "default": "true" } ] }, { "kind": "method", "name": "click", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "WidgetElement", "module": "src/internal/widget-element.ts" } }, { "kind": "field", "name": "#settings", "privacy": "private", "default": "settings", "inheritedFrom": { "name": "WidgetElement", "module": "src/internal/widget-element.ts" } }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Indicates whether the element is disabled.\nIf `true` it cannot be interacted with nor be focused.", "attribute": "disabled", "reflects": true, "inheritedFrom": { "name": "WidgetElement", "module": "src/internal/widget-element.ts" } }, { "kind": "method", "name": "isInteractive", "privacy": "protected", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "event", "optional": true, "type": { "text": "Event" } } ], "inheritedFrom": { "name": "WidgetElement", "module": "src/internal/widget-element.ts" } }, { "kind": "field", "name": "#handleClick", "privacy": "private", "inheritedFrom": { "name": "WidgetElement", "module": "src/internal/widget-element.ts" } }, { "kind": "field", "name": "#handleKeyboardEvent", "privacy": "private", "inheritedFrom": { "name": "WidgetElement", "module": "src/internal/widget-element.ts" } }, { "kind": "field", "name": "role", "type": { "text": "ARIARole | null" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "dir", "type": { "text": "'ltr' | 'rtl'" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } } ], "events": [ { "type": { "text": "ToggleEvent" }, "description": "Emitted when the list item is opened or closed. Can be canceled to prevent the action.", "name": "toggle" } ], "attributes": [ { "name": "href", "type": { "text": "string" }, "default": "''", "description": "The URL that the element links to.", "fieldName": "href" }, { "name": "target", "type": { "text": "'_blank' | '_parent' | '_self' | '_top' | ''" }, "default": "''", "description": "Specifies where to open the linked document.", "fieldName": "target" }, { "name": "rel", "type": { "text": "string" }, "default": "''", "description": "Specifies the relationship between the current document and the linked document.", "fieldName": "rel" }, { "name": "download", "type": { "text": "string | undefined" }, "description": "Specifies that the target will be downloaded when a user clicks on the hyperlink.", "fieldName": "download" }, { "name": "loading", "type": { "text": "boolean" }, "default": "false", "description": "Indicates that the item is in a loading state.", "fieldName": "loading" }, { "name": "muted", "type": { "text": "boolean" }, "default": "false", "description": "Indicates that the item is muted, prevents hover and active styles from being applied.", "fieldName": "muted" }, { "name": "open", "type": { "text": "boolean" }, "default": "false", "description": "Indicates that the item is open, showing the content in the `expand` slot.\nIf no content is provided in the `expand` slot, this attribute has no effect.", "fieldName": "open" }, { "name": "selected", "type": { "text": "boolean" }, "default": "false", "description": "Indicates that the item is selected.", "fieldName": "selected" }, { "name": "size", "type": { "text": "ListItemSize" }, "description": "Indicates the size of the item.", "fieldName": "size" }, { "name": "variant", "type": { "text": "ListItemVariant" }, "description": "The variant of the list item.", "fieldName": "variant" }, { "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Indicates whether the element is disabled.\nIf `true` it cannot be interacted with nor be focused.", "fieldName": "disabled", "inheritedFrom": { "name": "WidgetElement", "module": "src/internal/widget-element.ts" } } ], "superclass": { "name": "WidgetElement", "module": "/src/internal/widget-element.js" }, "summary": "A list item component to be used within an `odx-list`.", "tagName": "odx-list-item", "customElement": true, "dependencies": [ "odx-toggle-content" ], "cssParts": [], "cssProperties": [] } ], "exports": [ { "kind": "js", "name": "ListItemVariant", "declaration": { "name": "ListItemVariant", "module": "src/lib/list/list-item.ts" } }, { "kind": "js", "name": "ListItemSize", "declaration": { "name": "ListItemSize", "module": "src/lib/list/list-item.ts" } }, { "kind": "js", "name": "OdxListItem", "declaration": { "name": "OdxListItem", "module": "src/lib/list/list-item.ts" } } ] }, { "kind": "javascript-module", "path": "src/lib/list/list.ts", "declarations": [ { "kind": "class", "description": "", "name": "OdxList", "slots": [ { "description": "Default slot for list items.", "name": "" } ], "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "static": true, "default": "'odx-list' satisfies keyof HTMLElementTagNameMap", "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "multiple", "type": { "text": "boolean" }, "default": "false", "description": "Indicates whether multiple list items can be open at the same time.", "attribute": "multiple", "reflects": true }, { "kind": "field", "name": "muted", "type": { "text": "boolean" }, "default": "false", "description": "Indicates whether the list is in a muted state, which renders the list items non-interactive.", "attribute": "muted", "reflects": true }, { "kind": "field", "name": "size", "type": { "text": "ListItemSize" }, "description": "The size of the list items.", "attribute": "size", "reflects": true }, { "kind": "method", "name": "getItems", "return": { "type": { "text": "OdxListItem[]" } }, "description": "Gets the list of list items that are direct children of the list." }, { "kind": "method", "name": "toggleAll", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "state", "optional": true, "type": { "text": "boolean" }, "description": "The state to toggle the items to. If not provided, items will be toggled to the opposite of their current state." }, { "name": "emitEvent", "default": "false", "description": "Whether to emit the `toggle` event for each item that is toggled. Defaults to false." } ], "description": "Toggles the state of all list items." }, { "kind": "field", "name": "#handleClick", "privacy": "private" }, { "kind": "field", "name": "#handleToggle", "privacy": "private" }, { "kind": "field", "name": "role", "type": { "text": "ARIARole | null" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "dir", "type": { "text": "'ltr' | 'rtl'" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } } ], "events": [ { "description": "@see {OdxListItem}", "name": "toggle" } ], "attributes": [ { "name": "multiple", "type": { "text": "boolean" }, "default": "false", "description": "Indicates whether multiple list items can be open at the same time.", "fieldName": "multiple" }, { "name": "muted", "type": { "text": "boolean" }, "default": "false", "description": "Indicates whether the list is in a muted state, which renders the list items non-interactive.", "fieldName": "muted" }, { "name": "size", "type": { "text": "ListItemSize" }, "description": "The size of the list items.", "fieldName": "size" } ], "superclass": { "name": "CustomElement", "module": "/src/internal/custom-element.js" }, "summary": "A container for grouping a set of list items.", "tagName": "odx-list", "customElement": true, "dependencies": [ "odx-list-item" ], "cssParts": [], "cssProperties": [] } ], "exports": [ { "kind": "js", "name": "OdxList", "declaration": { "name": "OdxList", "module": "src/lib/list/list.ts" } } ] }, { "kind": "javascript-module", "path": "src/lib/list-box/list-box.ts", "declarations": [ { "kind": "class", "description": "", "name": "OdxListbox", "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "static": true, "default": "'odx-list-box' satisfies keyof HTMLElementTagNameMap", "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "#activeDescendants", "privacy": "private", "default": "new ActiveDescendantsController(this, { getItems: () => [...this.selection.controls, ...this.selection.enabledItems], focusInIndex: (items) => { if (this.disabled) return -1; const selectedIndex = items.findIndex((item) => item.selected); return selectedIndex === -1 ? undefined : selectedIndex; }, onChange: (_, option) => { if (!this.autoSelect || this.multiple || !option) return; this.selection.toggle(option, true); }, })" }, { "kind": "field", "name": "selection", "privacy": "private", "default": "new SelectionController(this, { multiple: () => this.multiple, required: () => this.required, isSelectable: () => !this.disabled && !this.readonly, isSelectionControl: (item) => item.slot === 'control', onChange: ({ value }) => { this.value = value; this.dispatchEvent(new Event('change')); }, onItemsChange: () => { this.#updateControls(); }, })" }, { "kind": "field", "name": "value", "type": { "text": "string | string[]" }, "default": "''", "attribute": "value" }, { "kind": "field", "name": "autoSelect", "type": { "text": "boolean" }, "default": "false", "attribute": "auto-select", "reflects": true }, { "kind": "field", "name": "multiple", "type": { "text": "boolean" }, "default": "false", "attribute": "multiple" }, { "kind": "field", "name": "size", "type": { "text": "OptionSize" }, "attribute": "size", "reflects": true }, { "kind": "field", "name": "options", "type": { "text": "OdxOption[]" }, "readonly": true }, { "kind": "field", "name": "selectedOptions", "type": { "text": "OdxOption[] | OdxOption | null" }, "readonly": true }, { "kind": "method", "name": "clear", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "initialValue", "optional": true, "type": { "text": "string" } } ] }, { "kind": "method", "name": "toFormValue", "return": { "type": { "text": "string | FormData | null" } } }, { "kind": "method", "name": "#updateControls", "privacy": "private" }, { "kind": "field", "name": "#handleClick", "privacy": "private" }, { "kind": "field", "name": "#handleKeyboardEvent", "privacy": "private" }, { "kind": "field", "name": "role", "type": { "text": "ARIARole | null" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "dir", "type": { "text": "'ltr' | 'rtl'" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } } ], "attributes": [ { "name": "value", "type": { "text": "string | string[]" }, "default": "''", "fieldName": "value" }, { "name": "auto-select", "type": { "text": "boolean" }, "default": "false", "fieldName": "autoSelect" }, { "name": "multiple", "type": { "text": "boolean" }, "default": "false", "fieldName": "multiple" }, { "name": "size", "type": { "text": "OptionSize" }, "fieldName": "size" } ], "mixins": [ { "name": "FormAssociated", "module": "/src/internal/behaviors/form-associated.js" } ], "superclass": { "name": "CustomElement", "module": "/src/internal/custom-element.js" }, "tagName": "odx-list-box", "customElement": true, "events": [], "slots": [], "cssParts": [], "cssProperties": [] } ], "exports": [ { "kind": "js", "name": "OdxListbox", "declaration": { "name": "OdxListbox", "module": "src/lib/list-box/list-box.ts" } } ] }, { "kind": "javascript-module", "path": "src/lib/list-box/option.ts", "declarations": [ { "kind": "variable", "name": "OptionSize", "type": { "text": "{ SM: 'sm', MD: 'md' }" }, "default": "{ SM: 'sm', MD: 'md' }" }, { "kind": "class", "description": "", "name": "OdxOption", "slots": [ { "description": "The option's label.", "name": "" }, { "description": "Content to be displayed before the option's label. Typically used for icons.", "name": "prefix" }, { "description": "Content to be displayed after the option's label. Typically used for icons or badges.", "name": "suffix" } ], "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "static": true, "default": "'odx-option' satisfies keyof HTMLElementTagNameMap", "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "role", "type": { "text": "ARIARole | null" }, "default": "null", "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "#disabled", "privacy": "private", "type": { "text": "boolean" }, "default": "false" }, { "kind": "field", "name": "#label", "privacy": "private", "type": { "text": "string | undefined" } }, { "kind": "field", "name": "selection", "privacy": "private", "default": "new SelectableController(this)" }, { "kind": "field", "name": "label", "type": { "text": "string" }, "attribute": "label" }, { "kind": "field", "name": "selected", "type": { "text": "boolean" }, "default": "false", "attribute": "selected", "reflects": true }, { "kind": "field", "name": "size", "type": { "text": "OptionSize" }, "attribute": "size", "reflects": true }, { "kind": "field", "name": "type", "type": { "text": "'checkbox' | null | undefined" }, "attribute": "type" }, { "kind": "field", "name": "value", "type": { "text": "string" }, "default": "''", "attribute": "value" }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "attribute": "disabled", "reflects": true }, { "kind": "method", "name": "canActivate", "return": { "type": { "text": "boolean" } } }, { "kind": "method", "name": "activate", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "deactivate", "return": { "type": { "text": "void" } } }, { "kind": "field", "name": "dir", "type": { "text": "'ltr' | 'rtl'" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } } ], "attributes": [ { "name": "label", "type": { "text": "string" }, "fieldName": "label" }, { "name": "selected", "type": { "text": "boolean" }, "default": "false", "fieldName": "selected" }, { "name": "size", "type": { "text": "OptionSize" }, "fieldName": "size" }, { "name": "type", "type": { "text": "'checkbox' | null | undefined" }, "fieldName": "type" }, { "name": "value", "type": { "text": "string" }, "default": "''", "fieldName": "value" }, { "name": "disabled", "type": { "text": "boolean" }, "fieldName": "disabled" } ], "superclass": { "name": "CustomElement", "module": "/src/internal/custom-element.js" }, "summary": "Options are used to represent a single item within a list of options, such as a select dropdown or listbox.", "tagName": "odx-option", "customElement": true, "events": [], "cssParts": [], "cssProperties": [] } ], "exports": [ { "kind": "js", "name": "OptionSize", "declaration": { "name": "OptionSize", "module": "src/lib/list-box/option.ts" } }, { "kind": "js", "name": "OdxOption", "declaration": { "name": "OdxOption", "module": "src/lib/list-box/option.ts" } } ] }, { "kind": "javascript-module", "path": "src/lib/loading-dots/loading-dots.ts", "declarations": [ { "kind": "class", "description": "", "name": "OdxLoadingDots", "slots": [ { "description": "The loading text content to display.", "name": "" } ], "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "static": true, "default": "'odx-loading-dots' satisfies keyof HTMLElementTagNameMap", "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "role", "type": { "text": "ARIARole | null" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "dir", "type": { "text": "'ltr' | 'rtl'" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } } ], "superclass": { "name": "CustomElement", "module": "/src/internal/custom-element.js" }, "summary": "A loading indicator with three animated dots", "tagName": "odx-loading-dots", "customElement": true, "events": [], "cssParts": [], "cssProperties": [] } ], "exports": [ { "kind": "js", "name": "OdxLoadingDots", "declaration": { "name": "OdxLoadingDots", "module": "src/lib/loading-dots/loading-dots.ts" } } ] }, { "kind": "javascript-module", "path": "src/lib/loading-overlay/loading-overlay.ts", "declarations": [ { "kind": "class", "description": "", "name": "OdxLoadingOverlay", "slots": [ { "description": "The loading spinner to display. Defaults to ``", "name": "spinner" } ], "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "static": true, "default": "'odx-loading-overlay' satisfies keyof HTMLElementTagNameMap", "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "#loadingContainerPosition", "privacy": "private", "type": { "text": "string" }, "default": "''" }, { "kind": "field", "name": "#loadingContainer", "privacy": "private", "type": { "text": "HTMLElement | undefined" } }, { "kind": "field", "name": "backdropDisabled", "type": { "text": "boolean" }, "default": "false", "description": "Disables the backdrop, making only the spinner visible. The backdrop is enabled by default.", "attribute": "backdrop-disabled", "reflects": true }, { "kind": "field", "name": "backdropInverse", "type": { "text": "boolean" }, "default": "false", "description": "Inverts the backdrop color, making it light instead of dark. The backdrop is dark by default.", "attribute": "backdrop-inverse", "reflects": true }, { "kind": "field", "name": "loading", "type": { "text": "boolean" }, "default": "false", "description": "Indicates that the loading overlay is active and should be displayed.", "attribute": "loading", "reflects": true }, { "kind": "method", "name": "#showOverlay", "privacy": "private" }, { "kind": "method", "name": "#hideOverlay", "privacy": "private" }, { "kind": "field", "name": "role", "type": { "text": "ARIARole | null" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "dir", "type": { "text": "'ltr' | 'rtl'" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } } ], "attributes": [ { "name": "backdrop-disabled", "type": { "text": "boolean" }, "default": "false", "description": "Disables the backdrop, making only the spinner visible. The backdrop is enabled by default.", "fieldName": "backdropDisabled" }, { "name": "backdrop-inverse", "type": { "text": "boolean" }, "default": "false", "description": "Inverts the backdrop color, making it light instead of dark. The backdrop is dark by default.", "fieldName": "backdropInverse" }, { "name": "loading", "type": { "text": "boolean" }, "default": "false", "description": "Indicates that the loading overlay is active and should be displayed.", "fieldName": "loading" } ], "superclass": { "name": "CustomElement", "module": "/src/internal/custom-element.js" }, "summary": "A loading overlay component that displays a loading spinner over its parent element", "tagName": "odx-loading-overlay", "customElement": true, "events": [], "cssParts": [], "cssProperties": [] } ], "exports": [ { "kind": "js", "name": "OdxLoadingOverlay", "declaration": { "name": "OdxLoadingOverlay", "module": "src/lib/loading-overlay/loading-overlay.ts" } } ] }, { "kind": "javascript-module", "path": "src/lib/loading-spinner/loading-spinner.ts", "declarations": [ { "kind": "variable", "name": "LoadingSpinnerSize", "type": { "text": "{ SM: 'sm', MD: 'md', LG: 'lg' }" }, "default": "{ SM: 'sm', MD: 'md', LG: 'lg' }" }, { "kind": "class", "description": "", "name": "OdxLoadingSpinner", "slots": [ { "description": "The content of the loading spinner, typically used for a loading hint or message.", "name": "" } ], "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "static": true, "default": "'odx-loading-spinner' satisfies keyof HTMLElementTagNameMap", "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "icon", "type": { "text": "OdxIconName | null | undefined" }, "description": "The name of the icon to display in the center of the spinner.", "attribute": "icon" }, { "kind": "field", "name": "size", "type": { "text": "LoadingSpinnerSize" }, "description": "The size of the loading spinner.\nBy default the size is equal to the current font size of the element.", "attribute": "size", "reflects": true }, { "kind": "field", "name": "inline", "type": { "text": "boolean" }, "default": "false", "description": "Indicates whether the loading spinner should be displayed inline with it's content.", "attribute": "inline", "reflects": true }, { "kind": "field", "name": "role", "type": { "text": "ARIARole | null" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "dir", "type": { "text": "'ltr' | 'rtl'" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } } ], "attributes": [ { "name": "icon", "type": { "text": "OdxIconName | null | undefined" }, "description": "The name of the icon to display in the center of the spinner.", "fieldName": "icon" }, { "name": "size", "type": { "text": "LoadingSpinnerSize" }, "description": "The size of the loading spinner.\nBy default the size is equal to the current font size of the element.", "fieldName": "size" }, { "name": "inline", "type": { "text": "boolean" }, "default": "false", "description": "Indicates whether the loading spinner should be displayed inline with it's content.", "fieldName": "inline" } ], "superclass": { "name": "CustomElement", "module": "/src/internal/custom-element.js" }, "summary": "A loading indicator with spinner.", "tagName": "odx-loading-spinner", "customElement": true, "status": "rc", "since": "1.0", "events": [], "cssParts": [], "cssProperties": [] } ], "exports": [ { "kind": "js", "name": "LoadingSpinnerSize", "declaration": { "name": "LoadingSpinnerSize", "module": "src/lib/loading-spinner/loading-spinner.ts" } }, { "kind": "js", "name": "OdxLoadingSpinner", "declaration": { "name": "OdxLoadingSpinner", "module": "src/lib/loading-spinner/loading-spinner.ts" } } ] }, { "kind": "javascript-module", "path": "src/lib/logo/logo-caption.ts", "declarations": [ { "kind": "class", "description": "", "name": "OdxLogoCaption", "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "static": true, "default": "'odx-logo-caption' satisfies keyof HTMLElementTagNameMap", "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "stacked", "type": { "text": "boolean" }, "default": "false", "description": "Indicates whether the caption should be stacked vertically.", "attribute": "stacked", "reflects": true }, { "kind": "field", "name": "lang", "type": { "text": "string" }, "attribute": "lang" }, { "kind": "field", "name": "role", "type": { "text": "ARIARole | null" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "dir", "type": { "text": "'ltr' | 'rtl'" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } } ], "attributes": [ { "name": "stacked", "type": { "text": "boolean" }, "default": "false", "description": "Indicates whether the caption should be stacked vertically.", "fieldName": "stacked" }, { "name": "lang", "type": { "text": "string" }, "fieldName": "lang" } ], "mixins": [ { "name": "SignalWatcher", "package": "@lit-labs/signals" } ], "superclass": { "name": "CustomElement", "module": "/src/internal/custom-element.js" }, "summary": "A component for rendering the caption of the Dräger logo in multiple languages.", "tagName": "odx-logo-caption", "customElement": true, "status": "rc", "since": "1.0", "events": [], "slots": [], "cssParts": [], "cssProperties": [] } ], "exports": [ { "kind": "js", "name": "OdxLogoCaption", "declaration": { "name": "OdxLogoCaption", "module": "src/lib/logo/logo-caption.ts" } } ] }, { "kind": "javascript-module", "path": "src/lib/logo/logo.ts", "declarations": [ { "kind": "variable", "name": "logoDefault", "default": "html` `" }, { "kind": "variable", "name": "logoCompact", "default": "html` `" }, { "kind": "variable", "name": "LogoSize", "type": { "text": "{ XS: 'xs', SM: 'sm', MD: 'md', LG: 'lg', XL: 'xl' }" }, "default": "{ XS: 'xs', SM: 'sm', MD: 'md', LG: 'lg', XL: 'xl' }" }, { "kind": "variable", "name": "LogoType", "type": { "text": "{ DEFAULT: 'default', STACKED: 'stacked', CENTERED: 'centered' }" }, "default": "{ DEFAULT: 'default', STACKED: 'stacked', CENTERED: 'centered' }" }, { "kind": "variable", "name": "LogoVariant", "type": { "text": "{ REST: 'rest', REST_STATIC: 'rest-static', INVERSE: 'inverse', INVERSE_STATIC: 'inverse-static' }" }, "default": "{ REST: 'rest', REST_STATIC: 'rest-static', INVERSE: 'inverse', INVERSE_STATIC: 'inverse-static' }" }, { "kind": "class", "description": "", "name": "OdxLogo", "cssProperties": [ { "description": "The height of the logo, use `size` attribute for predefined sizes.", "name": "--height" } ], "slots": [ { "description": "Optional caption of the logo, which should be an instance of ``.", "name": "" } ], "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "static": true, "default": "'odx-logo' satisfies keyof HTMLElementTagNameMap", "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "compact", "type": { "text": "boolean" }, "default": "false", "description": "Indicates whether the compact logo version should be used.", "attribute": "compact", "reflects": true }, { "kind": "field", "name": "size", "type": { "text": "LogoSize" }, "description": "The size of the logo.", "attribute": "size", "reflects": true }, { "kind": "field", "name": "safeSpace", "type": { "text": "boolean" }, "default": "false", "description": "Indicates whether the logo should render itself with safe space around it.", "attribute": "safe-space", "reflects": true }, { "kind": "field", "name": "type", "type": { "text": "LogoType" }, "description": "The type of the logo, which determines the layout of the caption if present.\n`default` - The default logo with the caption to the right of it.\n`stacked` - The default logo with the caption stacked to the right of it.\n`centered` - The default logo with the caption centered below it.", "attribute": "type", "reflects": true }, { "kind": "field", "name": "variant", "type": { "text": "LogoVariant" }, "description": "The variant of the logo.", "attribute": "variant", "reflects": true }, { "kind": "field", "name": "lang", "type": { "text": "string" }, "attribute": "lang" }, { "kind": "method", "name": "#syncCaption", "privacy": "private" }, { "kind": "field", "name": "role", "type": { "text": "ARIARole | null" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "dir", "type": { "text": "'ltr' | 'rtl'" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } } ], "attributes": [ { "name": "compact", "type": { "text": "boolean" }, "default": "false", "description": "Indicates whether the compact logo version should be used.", "fieldName": "compact" }, { "name": "size", "type": { "text": "LogoSize" }, "description": "The size of the logo.", "fieldName": "size" }, { "name": "safe-space", "type": { "text": "boolean" }, "default": "false", "description": "Indicates whether the logo should render itself with safe space around it.", "fieldName": "safeSpace" }, { "name": "type", "type": { "text": "LogoType" }, "description": "The type of the logo, which determines the layout of the caption if present.\n`default` - The default logo with the caption to the right of it.\n`stacked` - The default logo with the caption stacked to the right of it.\n`centered` - The default logo with the caption centered below it.", "fieldName": "type" }, { "name": "variant", "type": { "text": "LogoVariant" }, "description": "The variant of the logo.", "fieldName": "variant" }, { "name": "lang", "type": { "text": "string" }, "fieldName": "lang" } ], "superclass": { "name": "CustomElement", "module": "/src/internal/custom-element.js" }, "summary": "A component that can display multiple variants of the Dräger logo.", "tagName": "odx-logo", "customElement": true, "status": "rc", "since": "1.0", "events": [], "cssParts": [] } ], "exports": [ { "kind": "js", "name": "logoDefault", "declaration": { "name": "logoDefault", "module": "src/lib/logo/logo.ts" } }, { "kind": "js", "name": "logoCompact", "declaration": { "name": "logoCompact", "module": "src/lib/logo/logo.ts" } }, { "kind": "js", "name": "LogoSize", "declaration": { "name": "LogoSize", "module": "src/lib/logo/logo.ts" } }, { "kind": "js", "name": "LogoType", "declaration": { "name": "LogoType", "module": "src/lib/logo/logo.ts" } }, { "kind": "js", "name": "LogoVariant", "declaration": { "name": "LogoVariant", "module": "src/lib/logo/logo.ts" } }, { "kind": "js", "name": "OdxLogo", "declaration": { "name": "OdxLogo", "module": "src/lib/logo/logo.ts" } } ] }, { "kind": "javascript-module", "path": "src/lib/main-menu/main-menu.ts", "declarations": [ { "kind": "class", "description": "", "name": "OdxMainMenu", "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "static": true, "default": "'odx-main-menu' satisfies keyof HTMLElementTagNameMap", "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "#slots", "privacy": "private", "default": "new SlotContentObserver(this)" }, { "kind": "field", "name": "#handleSlotChange", "privacy": "private" }, { "kind": "field", "name": "role", "type": { "text": "ARIARole | null" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "dir", "type": { "text": "'ltr' | 'rtl'" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } } ], "superclass": { "name": "CustomElement", "module": "/src/internal/custom-element.js" }, "tagName": "odx-main-menu", "customElement": true, "events": [], "slots": [], "cssParts": [], "cssProperties": [] } ], "exports": [ { "kind": "js", "name": "OdxMainMenu", "declaration": { "name": "OdxMainMenu", "module": "src/lib/main-menu/main-menu.ts" } } ] }, { "kind": "javascript-module", "path": "src/lib/media-player/media-player.ts", "declarations": [ { "kind": "class", "description": "", "name": "OdxMediaPlayer", "slots": [ { "description": "Default lot for video/audio element.", "name": "" } ], "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "static": true, "default": "'odx-media-player' satisfies keyof HTMLElementTagNameMap", "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "#mediaElement", "privacy": "private", "type": { "text": "HTMLMediaElement | undefined" } }, { "kind": "field", "name": "playing", "type": { "text": "boolean" }, "privacy": "private", "default": "false" }, { "kind": "method", "name": "#formatTime", "privacy": "private", "parameters": [ { "name": "time", "type": { "text": "number" } } ] }, { "kind": "field", "name": "#handleMediaChange", "privacy": "private" }, { "kind": "field", "name": "#handlePlayStateToggle", "privacy": "private" }, { "kind": "field", "name": "#handleMediaPlayStateChange", "privacy": "private" }, { "kind": "field", "name": "#handleMediaUpdate", "privacy": "private" }, { "kind": "field", "name": "role", "type": { "text": "ARIARole | null" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "dir", "type": { "text": "'ltr' | 'rtl'" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } } ], "superclass": { "name": "CustomElement", "module": "/src/internal/custom-element.js" }, "summary": "A media player component that controls audio/video playback.", "tagName": "odx-media-player", "customElement": true, "dependencies": [ "odx-media-track", "odx-media-volume-control" ], "events": [], "cssParts": [], "cssProperties": [] } ], "exports": [ { "kind": "js", "name": "OdxMediaPlayer", "declaration": { "name": "OdxMediaPlayer", "module": "src/lib/media-player/media-player.ts" } } ] }, { "kind": "javascript-module", "path": "src/lib/media-player/media-track.ts", "declarations": [ { "kind": "class", "description": "", "name": "OdxMediaTrack", "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "static": true, "default": "'odx-media-track' satisfies keyof HTMLElementTagNameMap", "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "media", "type": { "text": "HTMLMediaElement | null | undefined" } }, { "kind": "field", "name": "#handleMediaUpdate", "privacy": "private" }, { "kind": "field", "name": "#handleProgressClick", "privacy": "private" }, { "kind": "field", "name": "role", "type": { "text": "ARIARole | null" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "dir", "type": { "text": "'ltr' | 'rtl'" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } } ], "superclass": { "name": "CustomElement", "module": "/src/internal/custom-element.js" }, "summary": "A media track component that displays the playback progress and allows seeking.", "tagName": "odx-media-track", "customElement": true, "dependencies": [ "odx-progress-bar" ], "events": [], "slots": [], "cssParts": [], "cssProperties": [] } ], "exports": [ { "kind": "js", "name": "OdxMediaTrack", "declaration": { "name": "OdxMediaTrack", "module": "src/lib/media-player/media-track.ts" } } ] }, { "kind": "javascript-module", "path": "src/lib/media-player/media-volume-control.ts", "declarations": [ { "kind": "class", "description": "", "name": "OdxMediaVolumeControl", "slots": [ { "description": "Default slot for volume control content.", "name": "" } ], "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "static": true, "default": "'odx-media-volume-control' satisfies keyof HTMLElementTagNameMap", "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "media", "type": { "text": "HTMLMediaElement | null" }, "default": "null" }, { "kind": "field", "name": "expanded", "type": { "text": "boolean" }, "default": "false", "attribute": "expanded", "reflects": true }, { "kind": "field", "name": "#handleMediaVolumeChange", "privacy": "private" }, { "kind": "field", "name": "#handleMuteClick", "privacy": "private" }, { "kind": "field", "name": "#handleSliderInput", "privacy": "private" }, { "kind": "field", "name": "role", "type": { "text": "ARIARole | null" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "dir", "type": { "text": "'ltr' | 'rtl'" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } } ], "attributes": [ { "name": "expanded", "type": { "text": "boolean" }, "default": "false", "fieldName": "expanded" } ], "superclass": { "name": "CustomElement", "module": "/src/internal/custom-element.js" }, "summary": "A media volume control component that allows adjusting playback volume.", "tagName": "odx-media-volume-control", "customElement": true, "dependencies": [ "odx-slider", "odx-toggle-button" ], "events": [], "cssParts": [], "cssProperties": [] } ], "exports": [ { "kind": "js", "name": "OdxMediaVolumeControl", "declaration": { "name": "OdxMediaVolumeControl", "module": "src/lib/media-player/media-volume-control.ts" } } ] }, { "kind": "javascript-module", "path": "src/lib/menu/menu-item.ts", "declarations": [ { "kind": "variable", "name": "MenuItemSize", "type": { "text": "{ SM: 'sm', MD: 'md' }" }, "default": "{ SM: 'sm', MD: 'md' }" }, { "kind": "variable", "name": "MenuItemVariant", "type": { "text": "{ NEUTRAL: 'neutral', DANGER: 'danger', SUBTLE: 'subtle' }" }, "default": "{ NEUTRAL: 'neutral', DANGER: 'danger', SUBTLE: 'subtle' }" }, { "kind": "variable", "name": "MenuItemPreset", "default": "{ 'link-external': (element) => { element.icon ||= 'core::link-external'; element.target = element.target || '_blank'; element.variant = MenuItemVariant.SUBTLE; }, } as const satisfies Record void>" }, { "kind": "class", "description": "", "name": "OdxMenuItem", "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "static": true, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" }, "default": "'odx-menu-item' satisfies keyof HTMLElementTagNameMap" }, { "kind": "field", "name": "anchor", "type": { "text": "HTMLAnchorElement | undefined" }, "privacy": "protected" }, { "kind": "field", "name": "href", "type": { "text": "string" }, "default": "''", "description": "The URL that the element links to.", "attribute": "href" }, { "kind": "field", "name": "target", "type": { "text": "'_blank' | '_parent' | '_self' | '_top' | ''" }, "default": "''", "description": "Specifies where to open the linked document.", "attribute": "target" }, { "kind": "field", "name": "rel", "type": { "text": "string" }, "default": "''", "description": "Specifies the relationship between the current document and the linked document.", "attribute": "rel" }, { "kind": "field", "name": "download", "type": { "text": "string | undefined" }, "description": "Specifies that the target will be downloaded when a user clicks on the hyperlink.", "attribute": "download" }, { "kind": "field", "name": "icon", "type": { "text": "OdxIconName | null | undefined" }, "attribute": "icon" }, { "kind": "field", "name": "preset", "type": { "text": "MenuItemPreset | null | undefined" }, "attribute": "preset" }, { "kind": "field", "name": "size", "type": { "text": "MenuItemSize" }, "attribute": "size", "reflects": true }, { "kind": "field", "name": "variant", "type": { "text": "MenuItemVariant" }, "attribute": "variant", "reflects": true }, { "kind": "method", "name": "click", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "WidgetElement", "module": "src/internal/widget-element.ts" } }, { "kind": "field", "name": "#settings", "privacy": "private", "default": "settings", "inheritedFrom": { "name": "WidgetElement", "module": "src/internal/widget-element.ts" } }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Indicates whether the element is disabled.\nIf `true` it cannot be interacted with nor be focused.", "attribute": "disabled", "reflects": true, "inheritedFrom": { "name": "WidgetElement", "module": "src/internal/widget-element.ts" } }, { "kind": "method", "name": "isInteractive", "privacy": "protected", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "event", "optional": true, "type": { "text": "Event" } } ], "inheritedFrom": { "name": "WidgetElement", "module": "src/internal/widget-element.ts" } }, { "kind": "field", "name": "#handleClick", "privacy": "private", "inheritedFrom": { "name": "WidgetElement", "module": "src/internal/widget-element.ts" } }, { "kind": "field", "name": "#handleKeyboardEvent", "privacy": "private", "inheritedFrom": { "name": "WidgetElement", "module": "src/internal/widget-element.ts" } }, { "kind": "field", "name": "role", "type": { "text": "ARIARole | null" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "dir", "type": { "text": "'ltr' | 'rtl'" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } } ], "attributes": [ { "name": "href", "type": { "text": "string" }, "default": "''", "description": "The URL that the element links to.", "fieldName": "href" }, { "name": "target", "type": { "text": "'_blank' | '_parent' | '_self' | '_top' | ''" }, "default": "''", "description": "Specifies where to open the linked document.", "fieldName": "target" }, { "name": "rel", "type": { "text": "string" }, "default": "''", "description": "Specifies the relationship between the current document and the linked document.", "fieldName": "rel" }, { "name": "download", "type": { "text": "string | undefined" }, "description": "Specifies that the target will be downloaded when a user clicks on the hyperlink.", "fieldName": "download" }, { "name": "icon", "type": { "text": "OdxIconName | null | undefined" }, "fieldName": "icon" }, { "name": "preset", "type": { "text": "MenuItemPreset | null | undefined" }, "fieldName": "preset" }, { "name": "size", "type": { "text": "MenuItemSize" }, "fieldName": "size" }, { "name": "variant", "type": { "text": "MenuItemVariant" }, "fieldName": "variant" }, { "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Indicates whether the element is disabled.\nIf `true` it cannot be interacted with nor be focused.", "fieldName": "disabled", "inheritedFrom": { "name": "WidgetElement", "module": "src/internal/widget-element.ts" } } ], "superclass": { "name": "WidgetElement", "module": "/src/internal/widget-element.js" }, "tagName": "odx-menu-item", "customElement": true, "events": [], "slots": [], "cssParts": [], "cssProperties": [] } ], "exports": [ { "kind": "js", "name": "MenuItemSize", "declaration": { "name": "MenuItemSize", "module": "src/lib/menu/menu-item.ts" } }, { "kind": "js", "name": "MenuItemVariant", "declaration": { "name": "MenuItemVariant", "module": "src/lib/menu/menu-item.ts" } }, { "kind": "js", "name": "MenuItemPreset", "declaration": { "name": "MenuItemPreset", "module": "src/lib/menu/menu-item.ts" } }, { "kind": "js", "name": "OdxMenuItem", "declaration": { "name": "OdxMenuItem", "module": "src/lib/menu/menu-item.ts" } } ] }, { "kind": "javascript-module", "path": "src/lib/menu/menu.ts", "declarations": [ { "kind": "class", "description": "", "name": "OdxMenu", "members": [ { "kind": "field", "name": "initialized", "type": { "text": "boolean" }, "privacy": "private", "static": true, "default": "true", "inheritedFrom": { "name": "PopoverHost", "module": "src/lib/popover/popover-host.ts" } }, { "kind": "field", "name": "popoverElement", "type": { "text": "OdxPopover | undefined" }, "privacy": "protected", "inheritedFrom": { "name": "PopoverHost", "module": "src/lib/popover/popover-host.ts" } }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "default": "false", "attribute": "disabled", "reflects": true, "inheritedFrom": { "name": "PopoverHost", "module": "src/lib/popover/popover-host.ts" } }, { "kind": "field", "name": "open", "type": { "text": "boolean" }, "default": "false", "attribute": "open", "reflects": true, "inheritedFrom": { "name": "PopoverHost", "module": "src/lib/popover/popover-host.ts" } }, { "kind": "field", "name": "referenceElement", "type": { "text": "HTMLElement | null" }, "inheritedFrom": { "name": "PopoverHost", "module": "src/lib/popover/popover-host.ts" } }, { "kind": "field", "name": "placement", "type": { "text": "PopoverHostPlacement" }, "attribute": "placement", "reflects": true, "inheritedFrom": { "name": "PopoverHost", "module": "src/lib/popover/popover-host.ts" } }, { "kind": "field", "name": "popoverPlacementOptions", "type": { "text": "PopoverPlacementOptions" }, "readonly": true, "inheritedFrom": { "name": "PopoverHost", "module": "src/lib/popover/popover-host.ts" } }, { "kind": "method", "name": "hasMountedPopover", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "element", "type": { "text": "HTMLElement" } } ], "inheritedFrom": { "name": "PopoverHost", "module": "src/lib/popover/popover-host.ts" } }, { "kind": "method", "name": "mountPopover", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "referenceElement", "type": { "text": "HTMLElement | null" } } ], "inheritedFrom": { "name": "PopoverHost", "module": "src/lib/popover/popover-host.ts" } }, { "kind": "method", "name": "unmountPopover", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "referenceElement", "type": { "text": "HTMLElement" } } ], "inheritedFrom": { "name": "PopoverHost", "module": "src/lib/popover/popover-host.ts" } }, { "kind": "method", "name": "hasOpenPopover", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "referenceElement", "type": { "text": "HTMLElement | null" } } ], "inheritedFrom": { "name": "PopoverHost", "module": "src/lib/popover/popover-host.ts" } }, { "kind": "method", "name": "showPopover", "return": { "type": { "text": "Promise" } }, "inheritedFrom": { "name": "PopoverHost", "module": "src/lib/popover/popover-host.ts" } }, { "kind": "method", "name": "hidePopover", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "PopoverHost", "module": "src/lib/popover/popover-host.ts" } }, { "kind": "method", "name": "togglePopover", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "state", "optional": true, "type": { "text": "boolean" } } ], "inheritedFrom": { "name": "PopoverHost", "module": "src/lib/popover/popover-host.ts" } }, { "kind": "method", "name": "canPopoverShow", "return": { "type": { "text": "boolean" } }, "inheritedFrom": { "name": "PopoverHost", "module": "src/lib/popover/popover-host.ts" } }, { "kind": "method", "name": "onBeforePopoverShow", "return": { "type": { "text": "Promise" } }, "inheritedFrom": { "name": "PopoverHost", "module": "src/lib/popover/popover-host.ts" } }, { "kind": "method", "name": "onPopoverShow", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "PopoverHost", "module": "src/lib/popover/popover-host.ts" } }, { "kind": "method", "name": "canPopoverHide", "return": { "type": { "text": "boolean" } }, "inheritedFrom": { "name": "PopoverHost", "module": "src/lib/popover/popover-host.ts" } }, { "kind": "method", "name": "onBeforePopoverHide", "return": { "type": { "text": "Promise" } }, "inheritedFrom": { "name": "PopoverHost", "module": "src/lib/popover/popover-host.ts" } }, { "kind": "method", "name": "onPopoverHide", "return": { "type": { "text": "Promise | void" } }, "inheritedFrom": { "name": "PopoverHost", "module": "src/lib/popover/popover-host.ts" } }, { "kind": "method", "name": "updateReferenceElementFromEvent", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "event", "type": { "text": "Event" } } ], "inheritedFrom": { "name": "PopoverHost", "module": "src/lib/popover/popover-host.ts" } }, { "kind": "field", "name": "tagName", "type": { "text": "string" }, "static": true, "default": "'odx-menu' satisfies keyof HTMLElementTagNameMap", "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "role", "type": { "text": "ARIARole | null" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "dir", "type": { "text": "'ltr' | 'rtl'" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "#slots", "privacy": "private", "default": "new SlotContentObserver(this)" }, { "kind": "field", "name": "#rovingTabIndex", "privacy": "private", "default": "new RovingTabindexController(this, { elements: () => this.getItems(), direction: 'vertical', focusInIndex: (items) => items.findIndex((item) => !item.disabled), isFocusableElement: (item) => this.open && !item.disabled, })" }, { "kind": "field", "name": "touchFallbackEnabled", "type": { "text": "boolean" }, "privacy": "private", "default": "false" }, { "kind": "field", "name": "touchFallbackThreshold", "type": { "text": "number" }, "default": "4", "description": "The number of items required to trigger the touch fallback on small screens.", "attribute": "touch-fallback-threshold" }, { "kind": "field", "name": "size", "type": { "text": "MenuItemSize | null | undefined" }, "attribute": "size" }, { "kind": "method", "name": "getItems", "return": { "type": { "text": "OdxMenuItem[]" } } }, { "kind": "method", "name": "#syncItemProperties", "privacy": "private" }, { "kind": "field", "name": "#handleContentClick", "privacy": "private" }, { "kind": "field", "name": "#handleReferenceClick", "privacy": "private" }, { "kind": "field", "name": "#handleKeyDown", "privacy": "private" }, { "kind": "field", "name": "#handleReferenceKeyDown", "privacy": "private" }, { "kind": "field", "name": "#currentReferenceElement", "privacy": "private", "type": { "text": "HTMLElement | null" }, "default": "null", "inheritedFrom": { "name": "PopoverHost", "module": "src/lib/popover/popover-host.ts" } }, { "kind": "field", "name": "#referenceElements", "privacy": "private", "default": "new WeakSet()", "inheritedFrom": { "name": "PopoverHost", "module": "src/lib/popover/popover-host.ts" } }, { "kind": "field", "name": "#openPopovers", "privacy": "private", "default": "new WeakSet()", "inheritedFrom": { "name": "PopoverHost", "module": "src/lib/popover/popover-host.ts" } }, { "kind": "field", "name": "#positionUpdater", "privacy": "private", "type": { "text": "() => void | undefined" }, "inheritedFrom": { "name": "PopoverHost", "module": "src/lib/popover/popover-host.ts" } }, { "kind": "field", "name": "#mutationObserver", "privacy": "private", "default": "new MutationObserver((mutations) => { if (mutations.length === 0) return; this.#updateReferenceElements(); })", "inheritedFrom": { "name": "PopoverHost", "module": "src/lib/popover/popover-host.ts" } }, { "kind": "method", "name": "#updateReferenceElements", "privacy": "private", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "PopoverHost", "module": "src/lib/popover/popover-host.ts" } }, { "kind": "field", "name": "#handleToggle", "privacy": "private", "default": "(async (event: ToggleEvent) => { if (!this.referenceElement) return; this.open = event.newState === 'open'; ActiveDirective.toggle(this.referenceElement, this.open); if (this.open) { this.#openPopovers.add(this.referenceElement); addGlobalEventListener('keydown', this.#handleReferenceKeydown as EventListener, { capture: true, once: true }); await this.onBeforePopoverShow?.(); await waitForAnimations(this); await this.onPopoverShow?.(); } else { this.#openPopovers.delete(this.referenceElement); removeGlobalEventListener('keydown', this.#handleReferenceKeydown as EventListener); await this.onBeforePopoverHide?.(); await waitForAnimations(this); await this.onPopoverHide?.(); } }) as unknown", "inheritedFrom": { "name": "PopoverHost", "module": "src/lib/popover/popover-host.ts" } }, { "kind": "field", "name": "#handleReferenceKeydown", "privacy": "private", "inheritedFrom": { "name": "PopoverHost", "module": "src/lib/popover/popover-host.ts" } } ], "attributes": [ { "name": "touch-fallback-threshold", "type": { "text": "number" }, "default": "4", "description": "The number of items required to trigger the touch fallback on small screens.", "fieldName": "touchFallbackThreshold" }, { "name": "size", "type": { "text": "MenuItemSize | null | undefined" }, "fieldName": "size" }, { "name": "disabled", "type": { "text": "boolean" }, "default": "false", "fieldName": "disabled", "inheritedFrom": { "name": "PopoverHost", "module": "src/lib/popover/popover-host.ts" } }, { "name": "open", "type": { "text": "boolean" }, "default": "false", "fieldName": "open", "inheritedFrom": { "name": "PopoverHost", "module": "src/lib/popover/popover-host.ts" } }, { "name": "placement", "type": { "text": "PopoverHostPlacement" }, "fieldName": "placement", "inheritedFrom": { "name": "PopoverHost", "module": "src/lib/popover/popover-host.ts" } } ], "superclass": { "name": "PopoverHost", "module": "/src/lib/popover/popover-host.js" }, "tagName": "odx-menu", "customElement": true, "events": [], "slots": [], "cssParts": [], "cssProperties": [] } ], "exports": [ { "kind": "js", "name": "OdxMenu", "declaration": { "name": "OdxMenu", "module": "src/lib/menu/menu.ts" } } ] }, { "kind": "javascript-module", "path": "src/lib/modal/modal.ts", "declarations": [ { "kind": "variable", "name": "ModalSize", "type": { "text": "{ SM: 'sm', MD: 'md', LG: 'lg', FULL: 'full' }" }, "default": "{ SM: 'sm', MD: 'md', LG: 'lg', FULL: 'full' }" }, { "kind": "class", "description": "", "name": "OdxModal", "members": [ { "kind": "field", "name": "initialized", "type": { "text": "boolean" }, "privacy": "private", "static": true, "default": "true", "inheritedFrom": { "name": "DialogElement", "module": "src/internal/dialog-element.ts" } }, { "kind": "field", "name": "backdropDisabled", "type": { "text": "boolean" }, "default": "false", "attribute": "backdrop-disabled", "reflects": true, "inheritedFrom": { "name": "DialogElement", "module": "src/internal/dialog-element.ts" } }, { "kind": "field", "name": "blocking", "type": { "text": "boolean" }, "default": "false", "attribute": "blocking", "reflects": true, "inheritedFrom": { "name": "DialogElement", "module": "src/internal/dialog-element.ts" } }, { "kind": "field", "name": "layer", "type": { "text": "DialogLayer" }, "attribute": "layer", "reflects": true, "inheritedFrom": { "name": "DialogElement", "module": "src/internal/dialog-element.ts" } }, { "kind": "field", "name": "open", "type": { "text": "boolean" }, "default": "false", "attribute": "open", "reflects": true, "inheritedFrom": { "name": "DialogElement", "module": "src/internal/dialog-element.ts" } }, { "kind": "field", "name": "canShow", "readonly": true, "inheritedFrom": { "name": "DialogElement", "module": "src/internal/dialog-element.ts" } }, { "kind": "field", "name": "canClose", "readonly": true, "inheritedFrom": { "name": "DialogElement", "module": "src/internal/dialog-element.ts" } }, { "kind": "field", "name": "canDismiss", "readonly": true, "inheritedFrom": { "name": "DialogElement", "module": "src/internal/dialog-element.ts" } }, { "kind": "method", "name": "show", "return": { "type": { "text": "Promise" } }, "inheritedFrom": { "name": "DialogElement", "module": "src/internal/dialog-element.ts" } }, { "kind": "method", "name": "close", "return": { "type": { "text": "Promise" } }, "parameters": [ { "name": "returnValue", "optional": true, "type": { "text": "string" } } ], "inheritedFrom": { "name": "DialogElement", "module": "src/internal/dialog-element.ts" } }, { "kind": "method", "name": "dismiss", "return": { "type": { "text": "Promise" } }, "inheritedFrom": { "name": "DialogElement", "module": "src/internal/dialog-element.ts" } }, { "kind": "method", "name": "toggle", "return": { "type": { "text": "Promise" } }, "parameters": [ { "name": "state", "optional": true, "type": { "text": "boolean" } }, { "name": "returnValue", "optional": true, "type": { "text": "string" } } ], "inheritedFrom": { "name": "DialogElement", "module": "src/internal/dialog-element.ts" } }, { "kind": "method", "name": "showPopover", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "DialogElement", "module": "src/internal/dialog-element.ts" } }, { "kind": "method", "name": "hidePopover", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "DialogElement", "module": "src/internal/dialog-element.ts" } }, { "kind": "method", "name": "togglePopover", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "state", "optional": true, "type": { "text": "boolean" } } ], "inheritedFrom": { "name": "DialogElement", "module": "src/internal/dialog-element.ts" } }, { "kind": "field", "name": "tagName", "type": { "text": "string" }, "static": true, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" }, "default": "'odx-modal' satisfies keyof HTMLElementTagNameMap" }, { "kind": "field", "name": "role", "type": { "text": "ARIARole | null" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "dir", "type": { "text": "'ltr' | 'rtl'" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "size", "type": { "text": "ModalSize" }, "attribute": "size", "reflects": true }, { "kind": "field", "name": "#focusTrap", "privacy": "private", "inheritedFrom": { "name": "DialogElement", "module": "src/internal/dialog-element.ts" } }, { "kind": "method", "name": "#addGlobalListeners", "privacy": "private", "inheritedFrom": { "name": "DialogElement", "module": "src/internal/dialog-element.ts" } }, { "kind": "method", "name": "#removeGlobalListeners", "privacy": "private", "inheritedFrom": { "name": "DialogElement", "module": "src/internal/dialog-element.ts" } }, { "kind": "field", "name": "#handleGlobalPointerDown", "privacy": "private", "inheritedFrom": { "name": "DialogElement", "module": "src/internal/dialog-element.ts" } }, { "kind": "field", "name": "#handleGlobalPointerUp", "privacy": "private", "default": "((event: Event & { target: HTMLElement }) => { removeGlobalEventListener('mouseup', this.#handleGlobalPointerUp); if (!this.canDismiss) return; // check for host if in not screen layer if (this.layer !== DialogLayer.SCREEN && clickedOutside(event, this, true)) return; // check for container const container = this.renderRoot.querySelector('#base'); if (container && !clickedOutside(event, container, true)) return; // check for other dialogs const closestDialog = event.target.closest(DialogDirective.selector); if (!this.backdropDisabled && closestDialog && this !== closestDialog) return; event.preventDefault(); this.dismiss(); })", "inheritedFrom": { "name": "DialogElement", "module": "src/internal/dialog-element.ts" } }, { "kind": "field", "name": "#handleGlobalKeydown", "privacy": "private", "default": "((event: KeyboardEvent): void => { if (event.key !== keyEscape || !this.canDismiss) return; event.preventDefault(); this.dismiss(); })", "inheritedFrom": { "name": "DialogElement", "module": "src/internal/dialog-element.ts" } }, { "kind": "field", "name": "#handleToggle", "privacy": "private", "default": "((event: ToggleEvent & { target: HTMLElement }) => { this.open = event.newState === 'open'; }) as unknown", "inheritedFrom": { "name": "DialogElement", "module": "src/internal/dialog-element.ts" } } ], "attributes": [ { "name": "size", "type": { "text": "ModalSize" }, "fieldName": "size" }, { "name": "backdrop-disabled", "type": { "text": "boolean" }, "default": "false", "fieldName": "backdropDisabled", "inheritedFrom": { "name": "DialogElement", "module": "src/internal/dialog-element.ts" } }, { "name": "blocking", "type": { "text": "boolean" }, "default": "false", "fieldName": "blocking", "inheritedFrom": { "name": "DialogElement", "module": "src/internal/dialog-element.ts" } }, { "name": "layer", "type": { "text": "DialogLayer" }, "fieldName": "layer", "inheritedFrom": { "name": "DialogElement", "module": "src/internal/dialog-element.ts" } }, { "name": "open", "type": { "text": "boolean" }, "default": "false", "fieldName": "open", "inheritedFrom": { "name": "DialogElement", "module": "src/internal/dialog-element.ts" } } ], "superclass": { "name": "DialogElement", "module": "/src/internal/dialog-element.js" }, "tagName": "odx-modal", "customElement": true, "slots": [ { "description": "Default slot", "name": "", "inheritedFrom": { "name": "DialogElement", "module": "src/internal/dialog-element.ts" } } ], "cssParts": [ { "name": "base", "inheritedFrom": { "name": "DialogElement", "module": "src/internal/dialog-element.ts" } } ], "events": [ { "type": { "text": "DialogShowEvent" }, "inheritedFrom": { "name": "DialogElement", "module": "src/internal/dialog-element.ts" } }, { "type": { "text": "DialogShowEvent" }, "description": "Emitted when the dialog is requested to be shown. Can be canceled to prevent showing", "name": "dialog-show", "inheritedFrom": { "name": "DialogElement", "module": "src/internal/dialog-element.ts" } }, { "type": { "text": "DialogCloseEvent" }, "description": "Emitted when the dialog is requested to be closed. Can be canceled to prevent closing", "name": "dialog-close", "inheritedFrom": { "name": "DialogElement", "module": "src/internal/dialog-element.ts" } } ], "cssProperties": [] } ], "exports": [ { "kind": "js", "name": "ModalSize", "declaration": { "name": "ModalSize", "module": "src/lib/modal/modal.ts" } }, { "kind": "js", "name": "OdxModal", "declaration": { "name": "OdxModal", "module": "src/lib/modal/modal.ts" } } ] }, { "kind": "javascript-module", "path": "src/lib/navigation/navigation-item-group.ts", "declarations": [ { "kind": "class", "description": "", "name": "OdxNavigationItemGroup", "slots": [ { "description": "Default slot for navigation items.", "name": "" }, { "description": "Slot for content to be displayed before the label, typically an icon.", "name": "prefix" }, { "description": "Slot for content to be displayed after the label, typically an icon or badge.", "name": "suffix" } ], "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "static": true, "default": "'odx-navigation-item-group' satisfies keyof HTMLElementTagNameMap", "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "active", "type": { "text": "boolean" }, "default": "false", "attribute": "active", "reflects": true }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "default": "false", "attribute": "disabled", "reflects": true }, { "kind": "field", "name": "icon", "type": { "text": "OdxIconName | null | undefined" }, "attribute": "icon" }, { "kind": "field", "name": "iconActive", "type": { "text": "OdxIconName | null | undefined" }, "attribute": "icon-active" }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "attribute": "label" }, { "kind": "field", "name": "loading", "type": { "text": "boolean" }, "default": "false", "attribute": "loading", "reflects": true }, { "kind": "field", "name": "open", "type": { "text": "boolean" }, "default": "false", "attribute": "open", "reflects": true }, { "kind": "field", "name": "size", "type": { "text": "NavigationItemSize" }, "attribute": "size", "reflects": true }, { "kind": "field", "name": "currentIcon", "type": { "text": "OdxIconName | null | undefined" }, "readonly": true }, { "kind": "method", "name": "getItems", "return": { "type": { "text": "OdxNavigationItem[]" } } }, { "kind": "method", "name": "toggle", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "state", "optional": true, "type": { "text": "boolean" } }, { "name": "emitEvent", "default": "true" } ] }, { "kind": "method", "name": "#syncItemProperties", "privacy": "private" }, { "kind": "field", "name": "role", "type": { "text": "ARIARole | null" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "dir", "type": { "text": "'ltr' | 'rtl'" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } } ], "events": [ { "type": { "text": "ToggleEvent" }, "description": "Emitted when the item group is opened or closed. Can be canceled to prevent the action.", "name": "toggle" } ], "attributes": [ { "name": "active", "type": { "text": "boolean" }, "default": "false", "fieldName": "active" }, { "name": "disabled", "type": { "text": "boolean" }, "default": "false", "fieldName": "disabled" }, { "name": "icon", "type": { "text": "OdxIconName | null | undefined" }, "fieldName": "icon" }, { "name": "icon-active", "type": { "text": "OdxIconName | null | undefined" }, "fieldName": "iconActive" }, { "name": "label", "type": { "text": "string" }, "default": "''", "fieldName": "label" }, { "name": "loading", "type": { "text": "boolean" }, "default": "false", "fieldName": "loading" }, { "name": "open", "type": { "text": "boolean" }, "default": "false", "fieldName": "open" }, { "name": "size", "type": { "text": "NavigationItemSize" }, "fieldName": "size" } ], "superclass": { "name": "CustomElement", "module": "/src/internal/custom-element.js" }, "summary": "A component for grouping navigation items within a navigation menu.\nIt can be opened or closed to show or hide its child navigation items.", "tagName": "odx-navigation-item-group", "customElement": true, "dependencies": [ "odx-navigation-item", "odx-toggle-content" ], "cssParts": [], "cssProperties": [] } ], "exports": [ { "kind": "js", "name": "OdxNavigationItemGroup", "declaration": { "name": "OdxNavigationItemGroup", "module": "src/lib/navigation/navigation-item-group.ts" } } ] }, { "kind": "javascript-module", "path": "src/lib/navigation/navigation-item.ts", "declarations": [ { "kind": "variable", "name": "NavigationItemType", "type": { "text": "{ BUTTON: 'button', LINK: 'link' }" }, "default": "{ BUTTON: 'button', LINK: 'link' }" }, { "kind": "variable", "name": "NavigationItemSize", "type": { "text": "{ SM: 'sm', MD: 'md', LG: 'lg' }" }, "default": "{ SM: 'sm', MD: 'md', LG: 'lg' }" }, { "kind": "class", "description": "", "name": "OdxNavigationItem", "slots": [ { "description": "The navigation item's label.", "name": "" }, { "description": "Prefix slot typically used for icons.", "name": "prefix" }, { "description": "Suffix slot typically used for icons or actions or badges.", "name": "suffix" } ], "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "static": true, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" }, "default": "'odx-navigation-item' satisfies keyof HTMLElementTagNameMap" }, { "kind": "field", "name": "anchor", "type": { "text": "HTMLAnchorElement | undefined" }, "privacy": "protected" }, { "kind": "field", "name": "href", "type": { "text": "string" }, "default": "''", "description": "The URL that the element links to.", "attribute": "href" }, { "kind": "field", "name": "target", "type": { "text": "'_blank' | '_parent' | '_self' | '_top' | ''" }, "default": "''", "description": "Specifies where to open the linked document.", "attribute": "target" }, { "kind": "field", "name": "rel", "type": { "text": "string" }, "default": "''", "description": "Specifies the relationship between the current document and the linked document.", "attribute": "rel" }, { "kind": "field", "name": "active", "type": { "text": "boolean" }, "default": "false", "attribute": "active", "reflects": true }, { "kind": "field", "name": "icon", "type": { "text": "OdxIconName | null | undefined" }, "attribute": "icon" }, { "kind": "field", "name": "iconActive", "type": { "text": "OdxIconName | null | undefined" }, "attribute": "icon-active" }, { "kind": "field", "name": "loading", "type": { "text": "boolean" }, "default": "false", "description": "Indicates that the item is in a loading state.", "attribute": "loading", "reflects": true }, { "kind": "field", "name": "size", "type": { "text": "NavigationItemSize" }, "description": "Indicates the size of the item.", "attribute": "size", "reflects": true }, { "kind": "field", "name": "type", "type": { "text": "NavigationItemType" }, "description": "Indicates the type of the navigation item, which determines its visual appearance.", "attribute": "type", "reflects": true }, { "kind": "field", "name": "currentIcon", "type": { "text": "OdxIconName | null | undefined" }, "readonly": true }, { "kind": "method", "name": "click", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "WidgetElement", "module": "src/internal/widget-element.ts" } }, { "kind": "field", "name": "#settings", "privacy": "private", "default": "settings", "inheritedFrom": { "name": "WidgetElement", "module": "src/internal/widget-element.ts" } }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Indicates whether the element is disabled.\nIf `true` it cannot be interacted with nor be focused.", "attribute": "disabled", "reflects": true, "inheritedFrom": { "name": "WidgetElement", "module": "src/internal/widget-element.ts" } }, { "kind": "method", "name": "isInteractive", "privacy": "protected", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "event", "optional": true, "type": { "text": "Event" } } ], "inheritedFrom": { "name": "WidgetElement", "module": "src/internal/widget-element.ts" } }, { "kind": "field", "name": "#handleClick", "privacy": "private", "inheritedFrom": { "name": "WidgetElement", "module": "src/internal/widget-element.ts" } }, { "kind": "field", "name": "#handleKeyboardEvent", "privacy": "private", "inheritedFrom": { "name": "WidgetElement", "module": "src/internal/widget-element.ts" } }, { "kind": "field", "name": "role", "type": { "text": "ARIARole | null" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "dir", "type": { "text": "'ltr' | 'rtl'" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } } ], "attributes": [ { "name": "href", "type": { "text": "string" }, "default": "''", "description": "The URL that the element links to.", "fieldName": "href" }, { "name": "target", "type": { "text": "'_blank' | '_parent' | '_self' | '_top' | ''" }, "default": "''", "description": "Specifies where to open the linked document.", "fieldName": "target" }, { "name": "rel", "type": { "text": "string" }, "default": "''", "description": "Specifies the relationship between the current document and the linked document.", "fieldName": "rel" }, { "name": "active", "type": { "text": "boolean" }, "default": "false", "fieldName": "active" }, { "name": "icon", "type": { "text": "OdxIconName | null | undefined" }, "fieldName": "icon" }, { "name": "icon-active", "type": { "text": "OdxIconName | null | undefined" }, "fieldName": "iconActive" }, { "name": "loading", "type": { "text": "boolean" }, "default": "false", "description": "Indicates that the item is in a loading state.", "fieldName": "loading" }, { "name": "size", "type": { "text": "NavigationItemSize" }, "description": "Indicates the size of the item.", "fieldName": "size" }, { "name": "type", "type": { "text": "NavigationItemType" }, "description": "Indicates the type of the navigation item, which determines its visual appearance.", "fieldName": "type" }, { "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Indicates whether the element is disabled.\nIf `true` it cannot be interacted with nor be focused.", "fieldName": "disabled", "inheritedFrom": { "name": "WidgetElement", "module": "src/internal/widget-element.ts" } } ], "superclass": { "name": "WidgetElement", "module": "/src/internal/widget-element.js" }, "summary": "A navigation item component for use withing navigation related components.", "tagName": "odx-navigation-item", "customElement": true, "events": [], "cssParts": [], "cssProperties": [] } ], "exports": [ { "kind": "js", "name": "NavigationItemType", "declaration": { "name": "NavigationItemType", "module": "src/lib/navigation/navigation-item.ts" } }, { "kind": "js", "name": "NavigationItemSize", "declaration": { "name": "NavigationItemSize", "module": "src/lib/navigation/navigation-item.ts" } }, { "kind": "js", "name": "OdxNavigationItem", "declaration": { "name": "OdxNavigationItem", "module": "src/lib/navigation/navigation-item.ts" } } ] }, { "kind": "javascript-module", "path": "src/lib/navigation/navigation.ts", "declarations": [ { "kind": "class", "description": "", "name": "OdxNavigation", "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "static": true, "default": "'odx-navigation' satisfies keyof HTMLElementTagNameMap", "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "horizontal", "type": { "text": "boolean" }, "default": "false", "attribute": "horizontal", "reflects": true }, { "kind": "field", "name": "size", "type": { "text": "NavigationItemSize" }, "attribute": "size", "reflects": true }, { "kind": "method", "name": "getItems", "return": { "type": { "text": "Array" } }, "parameters": [ { "name": "deep", "default": "false" } ] }, { "kind": "method", "name": "#syncItemProperties", "privacy": "private" }, { "kind": "field", "name": "role", "type": { "text": "ARIARole | null" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "dir", "type": { "text": "'ltr' | 'rtl'" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } } ], "attributes": [ { "name": "horizontal", "type": { "text": "boolean" }, "default": "false", "fieldName": "horizontal" }, { "name": "size", "type": { "text": "NavigationItemSize" }, "fieldName": "size" } ], "superclass": { "name": "CustomElement", "module": "/src/internal/custom-element.js" }, "tagName": "odx-navigation", "customElement": true, "events": [], "slots": [], "cssParts": [], "cssProperties": [] } ], "exports": [ { "kind": "js", "name": "OdxNavigation", "declaration": { "name": "OdxNavigation", "module": "src/lib/navigation/navigation.ts" } } ] }, { "kind": "javascript-module", "path": "src/lib/page/page-banner.ts", "declarations": [ { "kind": "variable", "name": "PageBannerSize", "type": { "text": "{ SM: 'sm', MD: 'md' }" }, "default": "{ SM: 'sm', MD: 'md' }" }, { "kind": "variable", "name": "PageBannerVariant", "type": { "text": "{\n PRIMARY_SUBTLE: 'primary-subtle',\n PRIMARY: 'primary',\n SUCCESS: 'success',\n WARNING: 'warning',\n DANGER_SUBTLE: 'danger-subtle',\n DANGER: 'danger',\n CONFIRMATION: 'confirmation',\n}" }, "default": "{ PRIMARY_SUBTLE: 'primary-subtle', PRIMARY: 'primary', SUCCESS: 'success', WARNING: 'warning', DANGER_SUBTLE: 'danger-subtle', DANGER: 'danger', CONFIRMATION: 'confirmation', }" }, { "kind": "class", "description": "", "name": "OdxPageBanner", "cssParts": [ { "description": "The wrapper around the entire component, including the icon, content, and dismiss button.", "name": "base" }, { "description": "The wrapper around the message content, excluding the icon and dismiss button.", "name": "content" }, { "description": "The icon element displayed to the left of the content.", "name": "icon" } ], "slots": [ { "description": "The content of the banner, typically including a `` and some text.", "name": "" } ], "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "static": true, "default": "'odx-page-banner' satisfies keyof HTMLElementTagNameMap", "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "#slots", "privacy": "private", "default": "new SlotContentObserver(this)" }, { "kind": "field", "name": "dismissible", "type": { "text": "boolean" }, "default": "false", "description": "Indicates whether the banner can be dismissed by the user.\nIf `true`, a close button will be shown, and the user can hide the banner by clicking it.", "attribute": "dismissible" }, { "kind": "field", "name": "icon", "type": { "text": "OdxIconName | null | undefined" }, "description": "The icon to display in the banner.", "attribute": "icon" }, { "kind": "field", "name": "size", "type": { "text": "PageBannerSize" }, "description": "The size of the banner, which determines the outer spacing and the size of the icon.", "attribute": "size", "reflects": true }, { "kind": "field", "name": "variant", "type": { "text": "PageBannerVariant" }, "description": "The variant of the banner, which determines its color and emphasis level.", "attribute": "variant", "reflects": true }, { "kind": "field", "name": "hidden", "type": { "text": "boolean" }, "default": "false", "description": "Indicates whether the banner is hidden. When `true`, the banner will be visually hidden and not take up space in the layout.", "attribute": "hidden", "reflects": true }, { "kind": "method", "name": "hide", "return": { "type": { "text": "Promise" } } }, { "kind": "method", "name": "#updateActions", "privacy": "private" }, { "kind": "field", "name": "role", "type": { "text": "ARIARole | null" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "dir", "type": { "text": "'ltr' | 'rtl'" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } } ], "events": [ { "name": "hide", "type": { "text": "Event" }, "description": "Emitted when the banner is about to be hidden. Can be canceled to prevent hiding." }, { "name": "hidden", "type": { "text": "Event" }, "description": "Emitted after the banner has been hidden. Not cancelable." } ], "attributes": [ { "name": "dismissible", "type": { "text": "boolean" }, "default": "false", "description": "Indicates whether the banner can be dismissed by the user.\nIf `true`, a close button will be shown, and the user can hide the banner by clicking it.", "fieldName": "dismissible" }, { "name": "icon", "type": { "text": "OdxIconName | null | undefined" }, "description": "The icon to display in the banner.", "fieldName": "icon" }, { "name": "size", "type": { "text": "PageBannerSize" }, "description": "The size of the banner, which determines the outer spacing and the size of the icon.", "fieldName": "size" }, { "name": "variant", "type": { "text": "PageBannerVariant" }, "description": "The variant of the banner, which determines its color and emphasis level.", "fieldName": "variant" }, { "name": "hidden", "type": { "text": "boolean" }, "default": "false", "description": "Indicates whether the banner is hidden. When `true`, the banner will be visually hidden and not take up space in the layout.", "fieldName": "hidden" } ], "superclass": { "name": "CustomElement", "module": "/src/internal/custom-element.js" }, "summary": "The Page Banner is used to display important messages at the top of a page.", "tagName": "odx-page-banner", "customElement": true, "status": "rc", "since": "1.0", "dependencies": [ "odx-icon-button" ], "cssProperties": [] } ], "exports": [ { "kind": "js", "name": "PageBannerSize", "declaration": { "name": "PageBannerSize", "module": "src/lib/page/page-banner.ts" } }, { "kind": "js", "name": "PageBannerVariant", "declaration": { "name": "PageBannerVariant", "module": "src/lib/page/page-banner.ts" } }, { "kind": "js", "name": "OdxPageBanner", "declaration": { "name": "OdxPageBanner", "module": "src/lib/page/page-banner.ts" } } ] }, { "kind": "javascript-module", "path": "src/lib/page/page-footer.ts", "declarations": [ { "kind": "variable", "name": "PageFooterVariant", "type": { "text": "{ NEUTRAL: 'neutral', BRAND: 'brand' }" }, "default": "{ NEUTRAL: 'neutral', BRAND: 'brand' }" }, { "kind": "class", "description": "", "name": "OdxPageFooter", "slots": [ { "description": "The content of the page footer, which typically includes copyright information or links.", "name": "" } ], "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "static": true, "default": "'odx-page-footer' satisfies keyof HTMLElementTagNameMap", "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "compact", "type": { "text": "boolean" }, "default": "false", "description": "Indicates whether to display the page footer in a compact style, which reduces the padding and font size of the footer content.", "attribute": "compact", "reflects": true }, { "kind": "field", "name": "variant", "type": { "text": "PageFooterVariant" }, "description": "The variant of the page footer, which determines its background and foreground colors.", "attribute": "variant", "reflects": true }, { "kind": "field", "name": "role", "type": { "text": "ARIARole | null" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "dir", "type": { "text": "'ltr' | 'rtl'" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } } ], "attributes": [ { "name": "compact", "type": { "text": "boolean" }, "default": "false", "description": "Indicates whether to display the page footer in a compact style, which reduces the padding and font size of the footer content.", "fieldName": "compact" }, { "name": "variant", "type": { "text": "PageFooterVariant" }, "description": "The variant of the page footer, which determines its background and foreground colors.", "fieldName": "variant" } ], "superclass": { "name": "CustomElement", "module": "/src/internal/custom-element.js" }, "summary": "The page footer component is used to display information at the bottom of a page.", "tagName": "odx-page-footer", "customElement": true, "status": "rc", "since": "1.0", "dependencies": [ "odx-logo", "odx-logo-caption" ], "events": [], "cssParts": [], "cssProperties": [] } ], "exports": [ { "kind": "js", "name": "PageFooterVariant", "declaration": { "name": "PageFooterVariant", "module": "src/lib/page/page-footer.ts" } }, { "kind": "js", "name": "OdxPageFooter", "declaration": { "name": "OdxPageFooter", "module": "src/lib/page/page-footer.ts" } } ] }, { "kind": "javascript-module", "path": "src/lib/page/page-header-title.ts", "declarations": [ { "kind": "class", "description": "", "name": "OdxPageHeaderTitle", "slots": [ { "description": "The content of the page header title.", "name": "" } ], "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "static": true, "default": "'odx-page-header-title' satisfies keyof HTMLElementTagNameMap", "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "#anchor", "privacy": "private", "type": { "text": "HTMLAnchorElement | undefined" } }, { "kind": "field", "name": "#slots", "privacy": "private", "default": "new SlotContentObserver(this)" }, { "kind": "field", "name": "compact", "type": { "text": "boolean" }, "default": "false", "description": "Indicates whether the page header title uses the compact logo type.", "attribute": "compact", "reflects": true }, { "kind": "field", "name": "interactive", "type": { "text": "boolean" }, "default": "false", "description": "Indicates whether the page header title is interactive (focusable and clickable).\nWhen `true`, the page header title will have the ARIA role `button` and respond to keyboard events.", "attribute": "interactive", "reflects": true }, { "kind": "field", "name": "href", "type": { "text": "string" }, "default": "''", "description": "The URL that the element links to.", "attribute": "href" }, { "kind": "method", "name": "click", "return": { "type": { "text": "void" } } }, { "kind": "field", "name": "#handleKeyboardEvent", "privacy": "private" }, { "kind": "field", "name": "role", "type": { "text": "ARIARole | null" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "dir", "type": { "text": "'ltr' | 'rtl'" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } } ], "attributes": [ { "name": "compact", "type": { "text": "boolean" }, "default": "false", "description": "Indicates whether the page header title uses the compact logo type.", "fieldName": "compact" }, { "name": "interactive", "type": { "text": "boolean" }, "default": "false", "description": "Indicates whether the page header title is interactive (focusable and clickable).\nWhen `true`, the page header title will have the ARIA role `button` and respond to keyboard events.", "fieldName": "interactive" }, { "name": "href", "type": { "text": "string" }, "default": "''", "description": "The URL that the element links to.", "fieldName": "href" } ], "superclass": { "name": "CustomElement", "module": "/src/internal/custom-element.js" }, "summary": "The page header title component is used to display the logo and title of the page header.", "tagName": "odx-page-header-title", "customElement": true, "status": "rc", "since": "1.0", "dependencies": [ "odx-logo" ], "events": [], "cssParts": [], "cssProperties": [] } ], "exports": [ { "kind": "js", "name": "OdxPageHeaderTitle", "declaration": { "name": "OdxPageHeaderTitle", "module": "src/lib/page/page-header-title.ts" } } ] }, { "kind": "javascript-module", "path": "src/lib/page/page-header.ts", "declarations": [ { "kind": "variable", "name": "PageHeaderSize", "type": { "text": "{ MD: 'md', LG: 'lg' }" }, "default": "{ MD: 'md', LG: 'lg' }" }, { "kind": "class", "description": "", "name": "OdxPageHeader", "slots": [ { "description": "The content of the page header after the logo.", "name": "" }, { "description": "The content before the logo.", "name": "prefix" }, { "description": "The logo of the pag header. By default, an `odx-logo` element is used.", "name": "logo" }, { "description": "The actions of the page header, which are displayed at the end of the header.", "name": "actions" } ], "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "static": true, "default": "'odx-page-header' satisfies keyof HTMLElementTagNameMap", "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "#slots", "privacy": "private", "default": "new SlotContentObserver(this)" }, { "kind": "field", "name": "size", "type": { "text": "PageHeaderSize" }, "attribute": "size", "reflects": true }, { "kind": "field", "name": "#handleSlotChange", "privacy": "private" }, { "kind": "field", "name": "role", "type": { "text": "ARIARole | null" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "dir", "type": { "text": "'ltr' | 'rtl'" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } } ], "attributes": [ { "name": "size", "type": { "text": "PageHeaderSize" }, "fieldName": "size" } ], "superclass": { "name": "CustomElement", "module": "/src/internal/custom-element.js" }, "summary": "The page header component is used to display the header of a page, which typically includes the logo, title, and actions.", "tagName": "odx-page-header", "customElement": true, "status": "rc", "since": "1.0", "dependencies": [ "odx-logo" ], "events": [], "cssParts": [], "cssProperties": [] } ], "exports": [ { "kind": "js", "name": "PageHeaderSize", "declaration": { "name": "PageHeaderSize", "module": "src/lib/page/page-header.ts" } }, { "kind": "js", "name": "OdxPageHeader", "declaration": { "name": "OdxPageHeader", "module": "src/lib/page/page-header.ts" } } ] }, { "kind": "javascript-module", "path": "src/lib/page/page-layout.ts", "declarations": [ { "kind": "variable", "name": "PageLayoutAlignment", "type": { "text": "{ START: 'start', CENTER: 'center' }" }, "default": "{ START: 'start', CENTER: 'center' }" }, { "kind": "variable", "name": "PageLayoutSize", "type": { "text": "{ AUTO: 'auto', SM: 'sm', MD: 'md', LG: 'lg' }" }, "default": "{ AUTO: 'auto', SM: 'sm', MD: 'md', LG: 'lg' }" }, { "kind": "class", "description": "", "name": "OdxPageLayout", "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "static": true, "default": "'odx-page-layout' satisfies keyof HTMLElementTagNameMap", "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "#slots", "privacy": "private", "default": "new SlotContentObserver(this)" }, { "kind": "field", "name": "alignment", "type": { "text": "PageLayoutAlignment" }, "attribute": "alignment", "reflects": true }, { "kind": "field", "name": "size", "type": { "text": "PageLayoutSize" }, "attribute": "size", "reflects": true }, { "kind": "field", "name": "role", "type": { "text": "ARIARole | null" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "dir", "type": { "text": "'ltr' | 'rtl'" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } } ], "attributes": [ { "name": "alignment", "type": { "text": "PageLayoutAlignment" }, "fieldName": "alignment" }, { "name": "size", "type": { "text": "PageLayoutSize" }, "fieldName": "size" } ], "superclass": { "name": "CustomElement", "module": "/src/internal/custom-element.js" }, "tagName": "odx-page-layout", "customElement": true, "events": [], "slots": [], "cssParts": [], "cssProperties": [] } ], "exports": [ { "kind": "js", "name": "PageLayoutAlignment", "declaration": { "name": "PageLayoutAlignment", "module": "src/lib/page/page-layout.ts" } }, { "kind": "js", "name": "PageLayoutSize", "declaration": { "name": "PageLayoutSize", "module": "src/lib/page/page-layout.ts" } }, { "kind": "js", "name": "OdxPageLayout", "declaration": { "name": "OdxPageLayout", "module": "src/lib/page/page-layout.ts" } } ] }, { "kind": "javascript-module", "path": "src/lib/page/page.ts", "declarations": [ { "kind": "variable", "name": "PageLayout", "type": { "text": "{ DEFAULT: 'default', NARROW: 'narrow', WIDE: 'wide', FULL: 'full' }" }, "default": "{ DEFAULT: 'default', NARROW: 'narrow', WIDE: 'wide', FULL: 'full' }" }, { "kind": "class", "description": "", "name": "OdxPage", "cssParts": [ { "description": "The banner container element.", "name": "banner" }, { "description": "The header container element.", "name": "header" }, { "description": "The navigation container element.", "name": "navigation" }, { "description": "The main content container element.", "name": "main" }, { "description": "The footer container element.", "name": "footer" } ], "slots": [ { "description": "The main content of the page.", "name": "" }, { "description": "The banner of the page, which is used to display important information or actions.", "name": "banner" }, { "description": "The header of the page, which is used to display the page header .", "name": "header" }, { "description": "The start area of the page, which is used to display navigation or other secondary content.", "name": "start" }, { "description": "The footer of the page, which is used to display copyright information or other secondary content.", "name": "footer" } ], "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "static": true, "default": "'odx-page' satisfies keyof HTMLElementTagNameMap", "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "#currentFrameId", "privacy": "private", "type": { "text": "number" }, "default": "0" }, { "kind": "field", "name": "#breakpointController", "privacy": "private", "type": { "text": "BreakpointController | undefined" } }, { "kind": "field", "name": "headerElement", "type": { "text": "HTMLElement" }, "privacy": "private" }, { "kind": "field", "name": "layout", "type": { "text": "PageLayout" }, "attribute": "layout", "reflects": true }, { "kind": "field", "name": "breakpoint", "type": { "text": "keyof ODX.Breakpoints.Config" }, "default": "'sm'", "attribute": "breakpoint" }, { "kind": "method", "name": "#updatePageOffset", "privacy": "private" }, { "kind": "field", "name": "#handleBreakpointChange", "privacy": "private" }, { "kind": "field", "name": "#handleScroll", "privacy": "private" }, { "kind": "field", "name": "role", "type": { "text": "ARIARole | null" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "dir", "type": { "text": "'ltr' | 'rtl'" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } } ], "attributes": [ { "name": "layout", "type": { "text": "PageLayout" }, "fieldName": "layout" }, { "name": "breakpoint", "type": { "text": "keyof ODX.Breakpoints.Config" }, "default": "'sm'", "fieldName": "breakpoint" } ], "superclass": { "name": "CustomElement", "module": "/src/internal/custom-element.js" }, "summary": "The page component is the main layout component for a page.", "tagName": "odx-page", "customElement": true, "status": "rc", "since": "1.0", "events": [], "cssProperties": [] } ], "exports": [ { "kind": "js", "name": "PageLayout", "declaration": { "name": "PageLayout", "module": "src/lib/page/page.ts" } }, { "kind": "js", "name": "OdxPage", "declaration": { "name": "OdxPage", "module": "src/lib/page/page.ts" } } ] }, { "kind": "javascript-module", "path": "src/lib/pagination/pagination.ts", "declarations": [ { "kind": "class", "description": "", "name": "OdxPagination", "cssParts": [ { "description": "The button for navigating to the first page.", "name": "first-page-button" }, { "description": "The button for navigating to the previous page.", "name": "previous-page-button" }, { "description": "The button for navigating to the next page.", "name": "next-page-button" }, { "description": "The button for navigating to the last page.", "name": "last-page-button" } ], "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "static": true, "default": "'odx-pagination' satisfies keyof HTMLElementTagNameMap", "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "compact", "type": { "text": "boolean" }, "default": "false", "attribute": "compact", "reflects": true }, { "kind": "field", "name": "page", "type": { "text": "number" }, "default": "0", "attribute": "page" }, { "kind": "field", "name": "pageSize", "type": { "text": "number" }, "default": "10", "attribute": "page-size" }, { "kind": "field", "name": "totalItems", "type": { "text": "number" }, "default": "0", "attribute": "total-items" }, { "kind": "field", "name": "paginationContext", "readonly": true }, { "kind": "field", "name": "totalPages", "type": { "text": "number" }, "readonly": true }, { "kind": "method", "name": "previousPage", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "nextPage", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "firstPage", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "lastPage", "return": { "type": { "text": "void" } } }, { "kind": "field", "name": "role", "type": { "text": "ARIARole | null" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "dir", "type": { "text": "'ltr' | 'rtl'" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } } ], "events": [ { "name": "change", "type": { "text": "CustomEvent" } } ], "attributes": [ { "name": "compact", "type": { "text": "boolean" }, "default": "false", "fieldName": "compact" }, { "name": "page", "type": { "text": "number" }, "default": "0", "fieldName": "page" }, { "name": "page-size", "type": { "text": "number" }, "default": "10", "fieldName": "pageSize" }, { "name": "total-items", "type": { "text": "number" }, "default": "0", "fieldName": "totalItems" } ], "mixins": [ { "name": "SignalWatcher", "package": "@lit-labs/signals" } ], "superclass": { "name": "CustomElement", "module": "/src/internal/custom-element.js" }, "summary": "A pagination component for navigating through paged data.", "tagName": "odx-pagination", "customElement": true, "status": "beta", "since": "1.0", "dependencies": [ "odx-icon-button", "odx-split-button" ], "slots": [], "cssProperties": [] } ], "exports": [ { "kind": "js", "name": "OdxPagination", "declaration": { "name": "OdxPagination", "module": "src/lib/pagination/pagination.ts" } } ] }, { "kind": "javascript-module", "path": "src/lib/popover/compute-popover-placement.ts", "declarations": [ { "kind": "function", "name": "PopoverPlacementOptions", "return": { "type": { "text": "PopoverPlacementOptions" } }, "parameters": [ { "name": "options", "optional": true, "type": { "text": "Partial" } } ] }, { "kind": "function", "name": "computePopoverPlacement", "return": { "type": { "text": "Promise" } }, "parameters": [ { "name": "referenceElement", "type": { "text": "ReferenceElement" } }, { "name": "floatingElement", "type": { "text": "HTMLElement" } }, { "name": "options", "type": { "text": "PopoverPlacementOptions" } } ] } ], "exports": [ { "kind": "js", "name": "autoUpdate", "declaration": { "name": "autoUpdate", "package": "@floating-ui/dom" } }, { "kind": "js", "name": "PopoverPlacementOptions", "declaration": { "name": "PopoverPlacementOptions", "module": "src/lib/popover/compute-popover-placement.ts" } }, { "kind": "js", "name": "computePopoverPlacement", "declaration": { "name": "computePopoverPlacement", "module": "src/lib/popover/compute-popover-placement.ts" } } ] }, { "kind": "javascript-module", "path": "src/lib/popover/popover-host.ts", "declarations": [ { "kind": "variable", "name": "PopoverToggleCommand" }, { "kind": "variable", "name": "PopoverHostPlacement", "type": { "text": "{\n TOP: 'top',\n TOP_START: 'top-start',\n TOP_END: 'top-end',\n\n RIGHT: 'right',\n RIGHT_START: 'right-start',\n RIGHT_END: 'right-end',\n\n BOTTOM: 'bottom',\n BOTTOM_START: 'bottom-start',\n BOTTOM_END: 'bottom-end',\n\n LEFT: 'left',\n LEFT_START: 'left-start',\n LEFT_END: 'left-end',\n}" }, "default": "{ TOP: 'top', TOP_START: 'top-start', TOP_END: 'top-end', RIGHT: 'right', RIGHT_START: 'right-start', RIGHT_END: 'right-end', BOTTOM: 'bottom', BOTTOM_START: 'bottom-start', BOTTOM_END: 'bottom-end', LEFT: 'left', LEFT_START: 'left-start', LEFT_END: 'left-end', }" }, { "kind": "class", "description": "", "name": "PopoverHost", "members": [ { "kind": "field", "name": "initialized", "type": { "text": "boolean" }, "privacy": "private", "static": true, "default": "true" }, { "kind": "field", "name": "#currentReferenceElement", "privacy": "private", "type": { "text": "HTMLElement | null" }, "default": "null" }, { "kind": "field", "name": "#referenceElements", "privacy": "private", "default": "new WeakSet()" }, { "kind": "field", "name": "#openPopovers", "privacy": "private", "default": "new WeakSet()" }, { "kind": "field", "name": "#positionUpdater", "privacy": "private", "type": { "text": "() => void | undefined" } }, { "kind": "field", "name": "#mutationObserver", "privacy": "private", "default": "new MutationObserver((mutations) => { if (mutations.length === 0) return; this.#updateReferenceElements(); })" }, { "kind": "field", "name": "popoverElement", "type": { "text": "OdxPopover | undefined" }, "privacy": "protected" }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "default": "false", "attribute": "disabled", "reflects": true }, { "kind": "field", "name": "open", "type": { "text": "boolean" }, "default": "false", "attribute": "open", "reflects": true }, { "kind": "field", "name": "referenceElement", "type": { "text": "HTMLElement | null" } }, { "kind": "field", "name": "placement", "type": { "text": "PopoverHostPlacement" }, "attribute": "placement", "reflects": true }, { "kind": "field", "name": "popoverPlacementOptions", "type": { "text": "PopoverPlacementOptions" }, "readonly": true }, { "kind": "method", "name": "hasMountedPopover", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "element", "type": { "text": "HTMLElement" } } ] }, { "kind": "method", "name": "mountPopover", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "referenceElement", "type": { "text": "HTMLElement | null" } } ] }, { "kind": "method", "name": "unmountPopover", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "_referenceElement", "type": { "text": "HTMLElement" } } ] }, { "kind": "method", "name": "hasOpenPopover", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "referenceElement", "type": { "text": "HTMLElement | null" } } ] }, { "kind": "method", "name": "showPopover", "return": { "type": { "text": "Promise" } } }, { "kind": "method", "name": "hidePopover", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "togglePopover", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "state", "optional": true, "type": { "text": "boolean" } } ] }, { "kind": "method", "name": "canPopoverShow", "return": { "type": { "text": "boolean" } } }, { "kind": "method", "name": "onBeforePopoverShow", "return": { "type": { "text": "Promise | void" } } }, { "kind": "method", "name": "onPopoverShow", "return": { "type": { "text": "Promise | void" } } }, { "kind": "method", "name": "canPopoverHide", "return": { "type": { "text": "boolean" } } }, { "kind": "method", "name": "onBeforePopoverHide", "return": { "type": { "text": "Promise | void" } } }, { "kind": "method", "name": "onPopoverHide", "return": { "type": { "text": "Promise | void" } } }, { "kind": "method", "name": "updateReferenceElementFromEvent", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "event", "type": { "text": "Event" } } ] }, { "kind": "method", "name": "#updateReferenceElements", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "field", "name": "#handleToggle", "privacy": "private", "default": "(async (event: ToggleEvent) => { if (!this.referenceElement) return; this.open = event.newState === 'open'; ActiveDirective.toggle(this.referenceElement, this.open); if (this.open) { this.#openPopovers.add(this.referenceElement); addGlobalEventListener('keydown', this.#handleReferenceKeydown as EventListener, { capture: true, once: true }); await this.onBeforePopoverShow?.(); await waitForAnimations(this); await this.onPopoverShow?.(); } else { this.#openPopovers.delete(this.referenceElement); removeGlobalEventListener('keydown', this.#handleReferenceKeydown as EventListener); await this.onBeforePopoverHide?.(); await waitForAnimations(this); await this.onPopoverHide?.(); } }) as unknown" }, { "kind": "field", "name": "#handleReferenceKeydown", "privacy": "private" }, { "kind": "field", "name": "tagName", "type": { "text": "string" }, "static": true, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "role", "type": { "text": "ARIARole | null" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "dir", "type": { "text": "'ltr' | 'rtl'" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } } ], "attributes": [ { "name": "disabled", "type": { "text": "boolean" }, "default": "false", "fieldName": "disabled" }, { "name": "open", "type": { "text": "boolean" }, "default": "false", "fieldName": "open" }, { "name": "placement", "type": { "text": "PopoverHostPlacement" }, "fieldName": "placement" } ], "superclass": { "name": "CustomElement", "module": "/src/internal/custom-element.js" } } ], "exports": [ { "kind": "js", "name": "PopoverPlacementOptions", "declaration": { "name": "PopoverPlacementOptions", "module": "./compute-popover-placement.js" } }, { "kind": "js", "name": "PopoverToggleCommand", "declaration": { "name": "PopoverToggleCommand", "module": "src/lib/popover/popover-host.ts" } }, { "kind": "js", "name": "PopoverHostPlacement", "declaration": { "name": "PopoverHostPlacement", "module": "src/lib/popover/popover-host.ts" } }, { "kind": "js", "name": "PopoverHost", "declaration": { "name": "PopoverHost", "module": "src/lib/popover/popover-host.ts" } } ] }, { "kind": "javascript-module", "path": "src/lib/popover/popover.ts", "declarations": [ { "kind": "class", "description": "", "name": "OdxPopover", "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "static": true, "default": "'odx-popover' satisfies keyof HTMLElementTagNameMap", "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "arrowElement", "type": { "text": "HTMLElement" } }, { "kind": "field", "name": "withArrow", "type": { "text": "boolean" }, "default": "false", "attribute": "with-arrow", "reflects": true }, { "kind": "field", "name": "role", "type": { "text": "ARIARole | null" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "dir", "type": { "text": "'ltr' | 'rtl'" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } } ], "attributes": [ { "name": "with-arrow", "type": { "text": "boolean" }, "default": "false", "fieldName": "withArrow" } ], "superclass": { "name": "CustomElement", "module": "/src/internal/custom-element.js" }, "tagName": "odx-popover", "customElement": true, "events": [], "slots": [], "cssParts": [], "cssProperties": [] } ], "exports": [ { "kind": "js", "name": "OdxPopover", "declaration": { "name": "OdxPopover", "module": "src/lib/popover/popover.ts" } } ] }, { "kind": "javascript-module", "path": "src/lib/progress-bar/progress-bar.base.ts", "declarations": [ { "kind": "variable", "name": "ProgressVariant", "type": { "text": "{\n NEUTRAL: 'neutral',\n ACCENT: 'accent',\n DANGER: 'danger',\n SUCCESS: 'success',\n CONFIRMATION: 'confirmation',\n}" }, "default": "{ NEUTRAL: 'neutral', ACCENT: 'accent', DANGER: 'danger', SUCCESS: 'success', CONFIRMATION: 'confirmation', }" }, { "kind": "class", "description": "", "name": "ProgressBarBase", "members": [ { "kind": "field", "name": "label", "type": { "text": "string | null | undefined" }, "attribute": "label" }, { "kind": "field", "name": "min", "type": { "text": "number" }, "default": "0", "attribute": "min" }, { "kind": "field", "name": "max", "type": { "text": "number" }, "default": "100", "attribute": "max" }, { "kind": "field", "name": "value", "type": { "text": "number" }, "default": "0", "attribute": "value" }, { "kind": "field", "name": "valueText", "type": { "text": "string | null | undefined" }, "attribute": "valueText" }, { "kind": "field", "name": "hideValue", "type": { "text": "boolean" }, "default": "false", "attribute": "hide-value", "reflects": true }, { "kind": "field", "name": "indeterminate", "type": { "text": "boolean" }, "default": "false", "attribute": "indeterminate", "reflects": true }, { "kind": "field", "name": "variant", "type": { "text": "ProgressVariant" }, "attribute": "variant", "reflects": true }, { "kind": "field", "name": "valuePercentage", "type": { "text": "number" }, "readonly": true }, { "kind": "field", "name": "valueHidden", "type": { "text": "boolean" }, "privacy": "protected", "readonly": true }, { "kind": "field", "name": "tagName", "type": { "text": "string" }, "static": true, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "role", "type": { "text": "ARIARole | null" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "dir", "type": { "text": "'ltr' | 'rtl'" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } } ], "attributes": [ { "name": "label", "type": { "text": "string | null | undefined" }, "fieldName": "label" }, { "name": "min", "type": { "text": "number" }, "default": "0", "fieldName": "min" }, { "name": "max", "type": { "text": "number" }, "default": "100", "fieldName": "max" }, { "name": "value", "type": { "text": "number" }, "default": "0", "fieldName": "value" }, { "name": "valueText", "type": { "text": "string | null | undefined" }, "fieldName": "valueText" }, { "name": "hide-value", "type": { "text": "boolean" }, "default": "false", "fieldName": "hideValue" }, { "name": "indeterminate", "type": { "text": "boolean" }, "default": "false", "fieldName": "indeterminate" }, { "name": "variant", "type": { "text": "ProgressVariant" }, "fieldName": "variant" } ], "superclass": { "name": "CustomElement", "module": "/src/internal/custom-element.js" } } ], "exports": [ { "kind": "js", "name": "ProgressVariant", "declaration": { "name": "ProgressVariant", "module": "src/lib/progress-bar/progress-bar.base.ts" } }, { "kind": "js", "name": "ProgressBarBase", "declaration": { "name": "ProgressBarBase", "module": "src/lib/progress-bar/progress-bar.base.ts" } } ] }, { "kind": "javascript-module", "path": "src/lib/progress-bar/progress-bar.ts", "declarations": [ { "kind": "class", "description": "", "name": "OdxProgressBar", "slots": [ { "description": "Default slot used for the hint text displayed below the progress bar.", "name": "" } ], "members": [ { "kind": "field", "name": "label", "type": { "text": "string | null | undefined" }, "attribute": "label", "inheritedFrom": { "name": "ProgressBarBase", "module": "src/lib/progress-bar/progress-bar.base.ts" } }, { "kind": "field", "name": "min", "type": { "text": "number" }, "default": "0", "attribute": "min", "inheritedFrom": { "name": "ProgressBarBase", "module": "src/lib/progress-bar/progress-bar.base.ts" } }, { "kind": "field", "name": "max", "type": { "text": "number" }, "default": "100", "attribute": "max", "inheritedFrom": { "name": "ProgressBarBase", "module": "src/lib/progress-bar/progress-bar.base.ts" } }, { "kind": "field", "name": "value", "type": { "text": "number" }, "default": "0", "attribute": "value", "inheritedFrom": { "name": "ProgressBarBase", "module": "src/lib/progress-bar/progress-bar.base.ts" } }, { "kind": "field", "name": "valueText", "type": { "text": "string | null | undefined" }, "attribute": "valueText", "inheritedFrom": { "name": "ProgressBarBase", "module": "src/lib/progress-bar/progress-bar.base.ts" } }, { "kind": "field", "name": "hideValue", "type": { "text": "boolean" }, "default": "false", "attribute": "hide-value", "reflects": true, "inheritedFrom": { "name": "ProgressBarBase", "module": "src/lib/progress-bar/progress-bar.base.ts" } }, { "kind": "field", "name": "indeterminate", "type": { "text": "boolean" }, "default": "false", "attribute": "indeterminate", "reflects": true, "inheritedFrom": { "name": "ProgressBarBase", "module": "src/lib/progress-bar/progress-bar.base.ts" } }, { "kind": "field", "name": "variant", "type": { "text": "ProgressVariant" }, "attribute": "variant", "reflects": true, "inheritedFrom": { "name": "ProgressBarBase", "module": "src/lib/progress-bar/progress-bar.base.ts" } }, { "kind": "field", "name": "valuePercentage", "type": { "text": "number" }, "readonly": true, "inheritedFrom": { "name": "ProgressBarBase", "module": "src/lib/progress-bar/progress-bar.base.ts" } }, { "kind": "field", "name": "valueHidden", "type": { "text": "boolean" }, "privacy": "protected", "readonly": true, "inheritedFrom": { "name": "ProgressBarBase", "module": "src/lib/progress-bar/progress-bar.base.ts" } }, { "kind": "field", "name": "tagName", "type": { "text": "string" }, "static": true, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" }, "default": "'odx-progress-bar' satisfies keyof HTMLElementTagNameMap" }, { "kind": "field", "name": "role", "type": { "text": "ARIARole | null" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "dir", "type": { "text": "'ltr' | 'rtl'" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "#slots", "privacy": "private", "default": "new SlotContentObserver(this)" }, { "kind": "field", "name": "condensed", "type": { "text": "boolean" }, "default": "false", "attribute": "condensed", "reflects": true } ], "attributes": [ { "name": "condensed", "type": { "text": "boolean" }, "default": "false", "fieldName": "condensed" }, { "name": "label", "type": { "text": "string | null | undefined" }, "fieldName": "label", "inheritedFrom": { "name": "ProgressBarBase", "module": "src/lib/progress-bar/progress-bar.base.ts" } }, { "name": "min", "type": { "text": "number" }, "default": "0", "fieldName": "min", "inheritedFrom": { "name": "ProgressBarBase", "module": "src/lib/progress-bar/progress-bar.base.ts" } }, { "name": "max", "type": { "text": "number" }, "default": "100", "fieldName": "max", "inheritedFrom": { "name": "ProgressBarBase", "module": "src/lib/progress-bar/progress-bar.base.ts" } }, { "name": "value", "type": { "text": "number" }, "default": "0", "fieldName": "value", "inheritedFrom": { "name": "ProgressBarBase", "module": "src/lib/progress-bar/progress-bar.base.ts" } }, { "name": "valueText", "type": { "text": "string | null | undefined" }, "fieldName": "valueText", "inheritedFrom": { "name": "ProgressBarBase", "module": "src/lib/progress-bar/progress-bar.base.ts" } }, { "name": "hide-value", "type": { "text": "boolean" }, "default": "false", "fieldName": "hideValue", "inheritedFrom": { "name": "ProgressBarBase", "module": "src/lib/progress-bar/progress-bar.base.ts" } }, { "name": "indeterminate", "type": { "text": "boolean" }, "default": "false", "fieldName": "indeterminate", "inheritedFrom": { "name": "ProgressBarBase", "module": "src/lib/progress-bar/progress-bar.base.ts" } }, { "name": "variant", "type": { "text": "ProgressVariant" }, "fieldName": "variant", "inheritedFrom": { "name": "ProgressBarBase", "module": "src/lib/progress-bar/progress-bar.base.ts" } } ], "superclass": { "name": "ProgressBarBase", "module": "/src/lib/progress-bar/progress-bar.base.js" }, "summary": "Displays the progress of a task, such as a file upload or a form completion, in a linear bar format.", "tagName": "odx-progress-bar", "customElement": true, "since": "1.0", "status": "rc", "dependencies": [ "odx-text" ], "events": [], "cssParts": [], "cssProperties": [] } ], "exports": [ { "kind": "js", "name": "OdxProgressBar", "declaration": { "name": "OdxProgressBar", "module": "src/lib/progress-bar/progress-bar.ts" } } ] }, { "kind": "javascript-module", "path": "src/lib/progress-ring/progress-ring.ts", "declarations": [ { "kind": "variable", "name": "ProgressRingSize", "type": { "text": "{ SM: 'sm', MD: 'md', LG: 'lg' }" }, "default": "{ SM: 'sm', MD: 'md', LG: 'lg' }" }, { "kind": "class", "description": "", "name": "OdxProgressRing", "cssParts": [ { "description": "The inner SVG element", "name": "inner" }, { "description": "The track circle element", "name": "track" }, { "description": "The indicator circle element", "name": "indicator" } ], "slots": [ { "description": "Default slot for additional content inside the progress ring", "name": "" } ], "members": [ { "kind": "field", "name": "label", "type": { "text": "string | null | undefined" }, "attribute": "label", "inheritedFrom": { "name": "ProgressBarBase", "module": "src/lib/progress-bar/progress-bar.base.ts" } }, { "kind": "field", "name": "min", "type": { "text": "number" }, "default": "0", "attribute": "min", "inheritedFrom": { "name": "ProgressBarBase", "module": "src/lib/progress-bar/progress-bar.base.ts" } }, { "kind": "field", "name": "max", "type": { "text": "number" }, "default": "100", "attribute": "max", "inheritedFrom": { "name": "ProgressBarBase", "module": "src/lib/progress-bar/progress-bar.base.ts" } }, { "kind": "field", "name": "value", "type": { "text": "number" }, "default": "0", "attribute": "value", "inheritedFrom": { "name": "ProgressBarBase", "module": "src/lib/progress-bar/progress-bar.base.ts" } }, { "kind": "field", "name": "valueText", "type": { "text": "string | null | undefined" }, "attribute": "valueText", "inheritedFrom": { "name": "ProgressBarBase", "module": "src/lib/progress-bar/progress-bar.base.ts" } }, { "kind": "field", "name": "hideValue", "type": { "text": "boolean" }, "default": "false", "attribute": "hide-value", "reflects": true, "inheritedFrom": { "name": "ProgressBarBase", "module": "src/lib/progress-bar/progress-bar.base.ts" } }, { "kind": "field", "name": "indeterminate", "type": { "text": "boolean" }, "default": "false", "attribute": "indeterminate", "reflects": true, "inheritedFrom": { "name": "ProgressBarBase", "module": "src/lib/progress-bar/progress-bar.base.ts" } }, { "kind": "field", "name": "variant", "type": { "text": "ProgressVariant" }, "attribute": "variant", "reflects": true, "inheritedFrom": { "name": "ProgressBarBase", "module": "src/lib/progress-bar/progress-bar.base.ts" } }, { "kind": "field", "name": "valuePercentage", "type": { "text": "number" }, "readonly": true, "inheritedFrom": { "name": "ProgressBarBase", "module": "src/lib/progress-bar/progress-bar.base.ts" } }, { "kind": "field", "name": "valueHidden", "type": { "text": "boolean" }, "privacy": "protected", "readonly": true, "inheritedFrom": { "name": "ProgressBarBase", "module": "src/lib/progress-bar/progress-bar.base.ts" } }, { "kind": "field", "name": "tagName", "type": { "text": "string" }, "static": true, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" }, "default": "'odx-progress-ring' satisfies keyof HTMLElementTagNameMap" }, { "kind": "field", "name": "role", "type": { "text": "ARIARole | null" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "dir", "type": { "text": "'ltr' | 'rtl'" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "size", "type": { "text": "ProgressRingSize" }, "attribute": "size", "reflects": true } ], "attributes": [ { "name": "size", "type": { "text": "ProgressRingSize" }, "fieldName": "size" }, { "name": "label", "type": { "text": "string | null | undefined" }, "fieldName": "label", "inheritedFrom": { "name": "ProgressBarBase", "module": "src/lib/progress-bar/progress-bar.base.ts" } }, { "name": "min", "type": { "text": "number" }, "default": "0", "fieldName": "min", "inheritedFrom": { "name": "ProgressBarBase", "module": "src/lib/progress-bar/progress-bar.base.ts" } }, { "name": "max", "type": { "text": "number" }, "default": "100", "fieldName": "max", "inheritedFrom": { "name": "ProgressBarBase", "module": "src/lib/progress-bar/progress-bar.base.ts" } }, { "name": "value", "type": { "text": "number" }, "default": "0", "fieldName": "value", "inheritedFrom": { "name": "ProgressBarBase", "module": "src/lib/progress-bar/progress-bar.base.ts" } }, { "name": "valueText", "type": { "text": "string | null | undefined" }, "fieldName": "valueText", "inheritedFrom": { "name": "ProgressBarBase", "module": "src/lib/progress-bar/progress-bar.base.ts" } }, { "name": "hide-value", "type": { "text": "boolean" }, "default": "false", "fieldName": "hideValue", "inheritedFrom": { "name": "ProgressBarBase", "module": "src/lib/progress-bar/progress-bar.base.ts" } }, { "name": "indeterminate", "type": { "text": "boolean" }, "default": "false", "fieldName": "indeterminate", "inheritedFrom": { "name": "ProgressBarBase", "module": "src/lib/progress-bar/progress-bar.base.ts" } }, { "name": "variant", "type": { "text": "ProgressVariant" }, "fieldName": "variant", "inheritedFrom": { "name": "ProgressBarBase", "module": "src/lib/progress-bar/progress-bar.base.ts" } } ], "superclass": { "name": "ProgressBarBase", "module": "/src/lib/progress-bar/progress-bar.base.js" }, "summary": "A progress ring that indicates the progress of a task", "tagName": "odx-progress-ring", "customElement": true, "events": [], "cssProperties": [] } ], "exports": [ { "kind": "js", "name": "ProgressRingSize", "declaration": { "name": "ProgressRingSize", "module": "src/lib/progress-ring/progress-ring.ts" } }, { "kind": "js", "name": "OdxProgressRing", "declaration": { "name": "OdxProgressRing", "module": "src/lib/progress-ring/progress-ring.ts" } } ] }, { "kind": "javascript-module", "path": "src/lib/radio-group/radio-group.ts", "declarations": [ { "kind": "class", "description": "", "name": "OdxRadioGroup", "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "static": true, "default": "'odx-radio-group' satisfies keyof HTMLElementTagNameMap", "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "#rovingTabIndex", "privacy": "private", "default": "new RovingTabindexController(this, { direction: () => 'vertical', elements: () => this.selection.enabledItems, elementEnterAction: (item) => item.click(), focusInIndex: (items) => { if (this.disabled) return -1; const selectedIndex = items.findIndex((item) => item.checked); return Math.max(0, selectedIndex) || Math.min(0, items.length - 1); }, isFocusableElement: (item) => !item.readonly, })" }, { "kind": "field", "name": "selection", "privacy": "private", "default": "new SelectionController(this, { isSelectable: (item) => !item.readonly, onChange: ({ value }) => { if (this.value === value[0]) return; this.value = value[0] ?? ''; this.dispatchEvent(new Event('change')); }, onItemsChange: () => { this.#rovingTabIndex.clearElementCache(); }, })" }, { "kind": "field", "name": "value", "type": { "text": "string" }, "default": "''", "attribute": "value" }, { "kind": "method", "name": "clear", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "initialValue", "optional": true, "type": { "text": "string" } } ] }, { "kind": "field", "name": "role", "type": { "text": "ARIARole | null" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "dir", "type": { "text": "'ltr' | 'rtl'" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } } ], "attributes": [ { "name": "value", "type": { "text": "string" }, "default": "''", "fieldName": "value" } ], "mixins": [ { "name": "FormAssociated", "module": "/src/internal/behaviors/form-associated.js" } ], "superclass": { "name": "CustomElement", "module": "/src/internal/custom-element.js" }, "tagName": "odx-radio-group", "customElement": true, "events": [], "slots": [], "cssParts": [], "cssProperties": [] } ], "exports": [ { "kind": "js", "name": "OdxRadioGroup", "declaration": { "name": "OdxRadioGroup", "module": "src/lib/radio-group/radio-group.ts" } } ] }, { "kind": "javascript-module", "path": "src/lib/radio-group/radio.ts", "declarations": [ { "kind": "class", "description": "", "name": "OdxRadio", "members": [ { "kind": "field", "name": "selection", "privacy": "private", "default": "new SelectableController(this)", "inheritedFrom": { "name": "CheckboxBase", "module": "src/lib/checkbox/checkbox.base.ts" } }, { "kind": "field", "name": "baseElement", "type": { "text": "HTMLElement" }, "privacy": "private", "inheritedFrom": { "name": "CheckboxBase", "module": "src/lib/checkbox/checkbox.base.ts" } }, { "kind": "field", "name": "checked", "type": { "text": "boolean" }, "default": "false", "attribute": "checked", "reflects": true, "inheritedFrom": { "name": "CheckboxBase", "module": "src/lib/checkbox/checkbox.base.ts" } }, { "kind": "field", "name": "controlPlacement", "type": { "text": "CheckboxControlPlacement" }, "attribute": "control-placement", "reflects": true, "inheritedFrom": { "name": "CheckboxBase", "module": "src/lib/checkbox/checkbox.base.ts" } }, { "kind": "field", "name": "invalid", "type": { "text": "boolean" }, "default": "false", "attribute": "invalid", "reflects": true, "inheritedFrom": { "name": "CheckboxBase", "module": "src/lib/checkbox/checkbox.base.ts" } }, { "kind": "field", "name": "size", "type": { "text": "CheckboxSize" }, "attribute": "size", "reflects": true, "inheritedFrom": { "name": "CheckboxBase", "module": "src/lib/checkbox/checkbox.base.ts" } }, { "kind": "field", "name": "value", "type": { "text": "string" }, "default": "''", "attribute": "value", "inheritedFrom": { "name": "CheckboxBase", "module": "src/lib/checkbox/checkbox.base.ts" } }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "attribute": "disabled", "reflects": true, "inheritedFrom": { "name": "CheckboxBase", "module": "src/lib/checkbox/checkbox.base.ts" } }, { "kind": "method", "name": "click", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "CheckboxBase", "module": "src/lib/checkbox/checkbox.base.ts" } }, { "kind": "method", "name": "toFormValue", "return": { "type": { "text": "null" } }, "inheritedFrom": { "name": "CheckboxBase", "module": "src/lib/checkbox/checkbox.base.ts" } }, { "kind": "method", "name": "toggle", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "state", "optional": true, "type": { "text": "boolean" } } ], "inheritedFrom": { "name": "CheckboxBase", "module": "src/lib/checkbox/checkbox.base.ts" } }, { "kind": "method", "name": "renderControl", "privacy": "protected", "return": { "type": { "text": "TemplateResult" } }, "parameters": [ { "name": "icon", "optional": true, "type": { "text": "OdxIconName" } } ], "inheritedFrom": { "name": "CheckboxBase", "module": "src/lib/checkbox/checkbox.base.ts" } }, { "kind": "field", "name": "tagName", "type": { "text": "string" }, "static": true, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" }, "default": "'odx-radio' satisfies keyof HTMLElementTagNameMap" }, { "kind": "field", "name": "role", "type": { "text": "ARIARole | null" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "dir", "type": { "text": "'ltr' | 'rtl'" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "#keyDownDetected", "privacy": "private", "type": { "text": "boolean" }, "default": "false", "inheritedFrom": { "name": "CheckboxBase", "module": "src/lib/checkbox/checkbox.base.ts" } }, { "kind": "method", "name": "#isInteractive", "privacy": "private", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "event", "optional": true, "type": { "text": "Event" } } ], "inheritedFrom": { "name": "CheckboxBase", "module": "src/lib/checkbox/checkbox.base.ts" } }, { "kind": "field", "name": "#handleClick", "privacy": "private", "inheritedFrom": { "name": "CheckboxBase", "module": "src/lib/checkbox/checkbox.base.ts" } }, { "kind": "field", "name": "#handleKeyboardEvent", "privacy": "private", "inheritedFrom": { "name": "CheckboxBase", "module": "src/lib/checkbox/checkbox.base.ts" } } ], "superclass": { "name": "CheckboxBase", "module": "/src/lib/checkbox/checkbox.base.js" }, "tagName": "odx-radio", "customElement": true, "attributes": [ { "name": "checked", "type": { "text": "boolean" }, "default": "false", "fieldName": "checked", "inheritedFrom": { "name": "CheckboxBase", "module": "src/lib/checkbox/checkbox.base.ts" } }, { "name": "control-placement", "type": { "text": "CheckboxControlPlacement" }, "fieldName": "controlPlacement", "inheritedFrom": { "name": "CheckboxBase", "module": "src/lib/checkbox/checkbox.base.ts" } }, { "name": "invalid", "type": { "text": "boolean" }, "default": "false", "fieldName": "invalid", "inheritedFrom": { "name": "CheckboxBase", "module": "src/lib/checkbox/checkbox.base.ts" } }, { "name": "size", "type": { "text": "CheckboxSize" }, "fieldName": "size", "inheritedFrom": { "name": "CheckboxBase", "module": "src/lib/checkbox/checkbox.base.ts" } }, { "name": "value", "type": { "text": "string" }, "default": "''", "fieldName": "value", "inheritedFrom": { "name": "CheckboxBase", "module": "src/lib/checkbox/checkbox.base.ts" } }, { "name": "disabled", "type": { "text": "boolean" }, "fieldName": "disabled", "inheritedFrom": { "name": "CheckboxBase", "module": "src/lib/checkbox/checkbox.base.ts" } } ], "events": [ { "name": "change", "type": { "text": "Event" }, "inheritedFrom": { "name": "CheckboxBase", "module": "src/lib/checkbox/checkbox.base.ts" } } ], "slots": [], "cssParts": [], "cssProperties": [] } ], "exports": [ { "kind": "js", "name": "OdxRadio", "declaration": { "name": "OdxRadio", "module": "src/lib/radio-group/radio.ts" } } ] }, { "kind": "javascript-module", "path": "src/lib/rail-navigation/rail-navigation.ts", "declarations": [ { "kind": "class", "description": "", "name": "OdxRailNavigation", "slots": [ { "description": "Content for the navigation items.", "name": "" }, { "description": "Content for the header of the navigation.", "name": "header" } ], "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "static": true, "default": "'odx-rail-navigation' satisfies keyof HTMLElementTagNameMap", "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "navigation", "type": { "text": "OdxNavigation" } }, { "kind": "field", "name": "open", "type": { "text": "boolean" }, "default": "false", "attribute": "open", "reflects": true }, { "kind": "field", "name": "size", "type": { "text": "NavigationItemSize" }, "attribute": "size", "reflects": true }, { "kind": "method", "name": "toggle", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "state", "optional": true, "type": { "text": "boolean" } }, { "name": "emitEvent", "default": "true" } ] }, { "kind": "field", "name": "role", "type": { "text": "ARIARole | null" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "dir", "type": { "text": "'ltr' | 'rtl'" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } } ], "events": [ { "type": { "text": "ToggleEvent" }, "description": "Emitted when the rail navigation is open or closed. Can be canceled.", "name": "toggle" } ], "attributes": [ { "name": "open", "type": { "text": "boolean" }, "default": "false", "fieldName": "open" }, { "name": "size", "type": { "text": "NavigationItemSize" }, "fieldName": "size" } ], "mixins": [ { "name": "SignalWatcher", "package": "@lit-labs/signals" } ], "superclass": { "name": "CustomElement", "module": "/src/internal/custom-element.js" }, "summary": "A navigation component that can be collapsed to a rail.", "tagName": "odx-rail-navigation", "customElement": true, "cssParts": [], "cssProperties": [] } ], "exports": [ { "kind": "js", "name": "OdxRailNavigation", "declaration": { "name": "OdxRailNavigation", "module": "src/lib/rail-navigation/rail-navigation.ts" } } ] }, { "kind": "javascript-module", "path": "src/lib/rating/rating.ts", "declarations": [ { "kind": "variable", "name": "RatingSize", "type": { "text": "{ SM: 'sm', MD: 'md', LG: 'lg' }" }, "default": "{ SM: 'sm', MD: 'md', LG: 'lg' }" }, { "kind": "variable", "name": "RatingVariant", "type": { "text": "{ NEUTRAL: 'neutral', CALLOUT: 'callout' }" }, "default": "{ NEUTRAL: 'neutral', CALLOUT: 'callout' }" }, { "kind": "class", "description": "", "name": "OdxRating", "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "static": true, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" }, "default": "'odx-rating' satisfies keyof HTMLElementTagNameMap" }, { "kind": "field", "name": "#range", "privacy": "private", "default": "new RangeController(this, { stepBehavior: RangeStepBehavior.CEIL, onChange: this.#handleRangeChange })" }, { "kind": "field", "name": "trackElement", "type": { "text": "HTMLElement" }, "privacy": "private" }, { "kind": "field", "name": "indicatorElement", "type": { "text": "HTMLElement" }, "privacy": "private" }, { "kind": "field", "name": "icon", "type": { "text": "OdxIconName | undefined" }, "attribute": "icon" }, { "kind": "field", "name": "max", "type": { "text": "number" }, "default": "5", "attribute": "max" }, { "kind": "field", "name": "size", "type": { "text": "RatingSize" }, "attribute": "size", "reflects": true }, { "kind": "field", "name": "step", "type": { "text": "number" }, "default": "1", "attribute": "step" }, { "kind": "field", "name": "variant", "type": { "text": "RatingVariant" }, "attribute": "variant", "reflects": true }, { "kind": "field", "name": "value", "type": { "text": "number" }, "default": "0", "attribute": "value" }, { "kind": "method", "name": "getIcon", "return": { "type": { "text": "OdxIconName" } }, "parameters": [ { "name": "_index", "type": { "text": "number" } } ] }, { "kind": "method", "name": "#renderSegments", "privacy": "private", "parameters": [ { "name": "length", "type": { "text": "number" } } ] }, { "kind": "method", "name": "#getValueFromEvent", "privacy": "private", "return": { "type": { "text": "number" } }, "parameters": [ { "name": "event", "type": { "text": "MouseEvent" } } ] }, { "kind": "method", "name": "#updateAriaAttributes", "privacy": "private" }, { "kind": "field", "name": "#handleRangeChange", "privacy": "private" }, { "kind": "field", "name": "#handleTrackClick", "privacy": "private" }, { "kind": "field", "name": "#handleTrackMouseMove", "privacy": "private" }, { "kind": "field", "name": "#handleTrackMouseOut", "privacy": "private" }, { "kind": "field", "name": "#settings", "privacy": "private", "default": "settings", "inheritedFrom": { "name": "WidgetElement", "module": "src/internal/widget-element.ts" } }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Indicates whether the element is disabled.\nIf `true` it cannot be interacted with nor be focused.", "attribute": "disabled", "reflects": true, "inheritedFrom": { "name": "WidgetElement", "module": "src/internal/widget-element.ts" } }, { "kind": "method", "name": "click", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "WidgetElement", "module": "src/internal/widget-element.ts" } }, { "kind": "method", "name": "isInteractive", "privacy": "protected", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "event", "optional": true, "type": { "text": "Event" } } ], "inheritedFrom": { "name": "WidgetElement", "module": "src/internal/widget-element.ts" } }, { "kind": "field", "name": "#handleClick", "privacy": "private", "inheritedFrom": { "name": "WidgetElement", "module": "src/internal/widget-element.ts" } }, { "kind": "field", "name": "#handleKeyboardEvent", "privacy": "private", "inheritedFrom": { "name": "WidgetElement", "module": "src/internal/widget-element.ts" } }, { "kind": "field", "name": "role", "type": { "text": "ARIARole | null" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "dir", "type": { "text": "'ltr' | 'rtl'" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } } ], "attributes": [ { "name": "icon", "type": { "text": "OdxIconName | undefined" }, "fieldName": "icon" }, { "name": "max", "type": { "text": "number" }, "default": "5", "fieldName": "max" }, { "name": "size", "type": { "text": "RatingSize" }, "fieldName": "size" }, { "name": "step", "type": { "text": "number" }, "default": "1", "fieldName": "step" }, { "name": "variant", "type": { "text": "RatingVariant" }, "fieldName": "variant" }, { "name": "value", "type": { "text": "number" }, "default": "0", "fieldName": "value" }, { "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Indicates whether the element is disabled.\nIf `true` it cannot be interacted with nor be focused.", "fieldName": "disabled", "inheritedFrom": { "name": "WidgetElement", "module": "src/internal/widget-element.ts" } } ], "mixins": [ { "name": "FormAssociated", "module": "/src/internal/behaviors/form-associated.js" } ], "superclass": { "name": "WidgetElement", "module": "/src/internal/widget-element.js" }, "summary": "A rating component that displays a rating scale", "tagName": "odx-rating", "customElement": true, "events": [], "slots": [], "cssParts": [], "cssProperties": [] } ], "exports": [ { "kind": "js", "name": "RatingSize", "declaration": { "name": "RatingSize", "module": "src/lib/rating/rating.ts" } }, { "kind": "js", "name": "RatingVariant", "declaration": { "name": "RatingVariant", "module": "src/lib/rating/rating.ts" } }, { "kind": "js", "name": "OdxRating", "declaration": { "name": "OdxRating", "module": "src/lib/rating/rating.ts" } } ] }, { "kind": "javascript-module", "path": "src/lib/relative-time/relative-time.ts", "declarations": [ { "kind": "class", "description": "", "name": "OdxRelativeTime", "members": [ { "kind": "field", "name": "value", "type": { "text": "T | null | undefined" }, "description": "The date value to format as relative time.\n\nCan be a `Date` object, a timestamp (number), or a date string.", "attribute": "value", "inheritedFrom": { "name": "FormatBase", "module": "src/lib/format/format.base.ts" } }, { "kind": "field", "name": "fallbackValue", "type": { "text": "string | null | undefined" }, "description": "An optional fallback value to display if the `value` property is invalid or cannot be transformed.", "attribute": "fallbackValue", "inheritedFrom": { "name": "FormatBase", "module": "src/lib/format/format.base.ts" } }, { "kind": "field", "name": "lang", "type": { "text": "string" }, "attribute": "lang", "inheritedFrom": { "name": "FormatBase", "module": "src/lib/format/format.base.ts" } }, { "kind": "method", "name": "transform", "privacy": "protected", "return": { "type": { "text": "TemplateResult" } }, "parameters": [ { "name": "value", "type": { "text": "Date | string" } } ], "inheritedFrom": { "name": "FormatBase", "module": "src/lib/format/format.base.ts" } }, { "kind": "method", "name": "formatDate", "privacy": "protected", "return": { "type": { "text": "ReturnType" } }, "parameters": [ { "name": "[input, options]", "type": { "text": "Parameters" } } ], "inheritedFrom": { "name": "FormatBase", "module": "src/lib/format/format.base.ts" } }, { "kind": "method", "name": "formatNumber", "privacy": "protected", "return": { "type": { "text": "ReturnType" } }, "parameters": [ { "name": "[input, options]", "type": { "text": "Parameters" } } ], "inheritedFrom": { "name": "FormatBase", "module": "src/lib/format/format.base.ts" } }, { "kind": "method", "name": "formatList", "privacy": "protected", "return": { "type": { "text": "ReturnType" } }, "parameters": [ { "name": "[input, options]", "type": { "text": "Parameters" } } ], "inheritedFrom": { "name": "FormatBase", "module": "src/lib/format/format.base.ts" } }, { "kind": "method", "name": "formatRelativeTime", "privacy": "protected", "return": { "type": { "text": "ReturnType" } }, "parameters": [ { "name": "[input, options]", "type": { "text": "Parameters" } } ], "inheritedFrom": { "name": "FormatBase", "module": "src/lib/format/format.base.ts" } }, { "kind": "field", "name": "tagName", "type": { "text": "string" }, "static": true, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" }, "default": "'odx-relative-time' satisfies keyof HTMLElementTagNameMap" }, { "kind": "field", "name": "role", "type": { "text": "ARIARole | null" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "dir", "type": { "text": "'ltr' | 'rtl'" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "#syncInterval", "privacy": "private", "type": { "text": "number | undefined" } }, { "kind": "field", "name": "format", "type": { "text": "RelativeTimeFormatOptions['style'] | null | undefined" }, "description": "The https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/RelativeTimeFormat/RelativeTimeFormat#style | style of the formatted relative time.", "attribute": "format" }, { "kind": "field", "name": "minUnit", "type": { "text": "RelativeTimeFormatOptions['minUnit'] | null | undefined" }, "description": "The minimum unit to use when formatting the relative time.", "attribute": "minUnit" }, { "kind": "field", "name": "numeric", "type": { "text": "RelativeTimeFormatOptions['numeric'] | null | undefined" }, "description": "Whether to use https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/RelativeTimeFormat/RelativeTimeFormat#numeric | numeric values in the output.", "attribute": "numeric" }, { "kind": "field", "name": "start", "type": { "text": "number | string | Date | null | undefined" }, "description": "The start date to use as the reference point when calculating the relative time. Defaults to the current date and time.\n\nCan be a `Date` object, a timestamp (number), or a date string.", "attribute": "start" }, { "kind": "field", "name": "syncInterval", "type": { "text": "number | null | undefined" }, "default": "null", "description": "An optional interval in milliseconds to automatically update the displayed relative time string.\n\nThe minimal allowed value is `100` milliseconds to prevent excessive updates.\nIf set to `null`, the relative time string will not update automatically.", "attribute": "syncInterval" }, { "kind": "field", "name": "valueAsDate", "type": { "text": "Date | null" }, "description": "The date value as a `Date` object, or `null` if the value is invalid or not set.", "readonly": true }, { "kind": "method", "name": "#setupSyncInterval", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "#resolveValue", "privacy": "private", "return": { "type": { "text": "TemplateResult | string" } }, "parameters": [ { "name": "value", "optional": true, "type": { "text": "T | null" } } ], "inheritedFrom": { "name": "FormatBase", "module": "src/lib/format/format.base.ts" } } ], "attributes": [ { "name": "format", "type": { "text": "RelativeTimeFormatOptions['style'] | null | undefined" }, "description": "The https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/RelativeTimeFormat/RelativeTimeFormat#style | style of the formatted relative time.", "fieldName": "format" }, { "name": "minUnit", "type": { "text": "RelativeTimeFormatOptions['minUnit'] | null | undefined" }, "description": "The minimum unit to use when formatting the relative time.", "fieldName": "minUnit" }, { "name": "numeric", "type": { "text": "RelativeTimeFormatOptions['numeric'] | null | undefined" }, "description": "Whether to use https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/RelativeTimeFormat/RelativeTimeFormat#numeric | numeric values in the output.", "fieldName": "numeric" }, { "name": "start", "type": { "text": "number | string | Date | null | undefined" }, "description": "The start date to use as the reference point when calculating the relative time. Defaults to the current date and time.\n\nCan be a `Date` object, a timestamp (number), or a date string.", "fieldName": "start" }, { "name": "syncInterval", "type": { "text": "number | null | undefined" }, "default": "null", "description": "An optional interval in milliseconds to automatically update the displayed relative time string.\n\nThe minimal allowed value is `100` milliseconds to prevent excessive updates.\nIf set to `null`, the relative time string will not update automatically.", "fieldName": "syncInterval" }, { "name": "value", "type": { "text": "number | string | Date" }, "description": "The date value to format as relative time.\n\nCan be a `Date` object, a timestamp (number), or a date string.", "fieldName": "value" }, { "name": "fallbackValue", "type": { "text": "string | null | undefined" }, "description": "An optional fallback value to display if the `value` property is invalid or cannot be transformed.", "fieldName": "fallbackValue", "inheritedFrom": { "name": "FormatBase", "module": "src/lib/format/format.base.ts" } }, { "name": "lang", "type": { "text": "string" }, "fieldName": "lang", "inheritedFrom": { "name": "FormatBase", "module": "src/lib/format/format.base.ts" } } ], "superclass": { "name": "FormatBase", "module": "/src/lib/format/format.base.js" }, "summary": "A component for formatting date values as relative time strings using the Intl.RelativeTimeFormat API.", "tagName": "odx-relative-time", "customElement": true, "events": [], "slots": [], "cssParts": [], "cssProperties": [] } ], "exports": [ { "kind": "js", "name": "OdxRelativeTime", "declaration": { "name": "OdxRelativeTime", "module": "src/lib/relative-time/relative-time.ts" } } ] }, { "kind": "javascript-module", "path": "src/lib/scroll-container/scroll-container.ts", "declarations": [ { "kind": "variable", "name": "ScrollContainerNextDirective" }, { "kind": "variable", "name": "ScrollContainerPreviousDirective" }, { "kind": "class", "description": "", "name": "ScrollContainerChangeEvent", "members": [ { "kind": "field", "name": "eventName", "type": { "text": "string" }, "static": true, "readonly": true, "default": "'change'" } ], "superclass": { "name": "CustomEvent", "module": "src/lib/scroll-container/scroll-container.ts" } }, { "kind": "class", "description": "", "name": "OdxScrollContainer", "slots": [ { "description": "Header slot", "name": "header" }, { "description": "Prefix slot", "name": "prefix" }, { "description": "Suffix slot", "name": "suffix" }, { "description": "Default slot", "name": "" } ], "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "static": true, "default": "'odx-scroll-container' satisfies keyof HTMLElementTagNameMap", "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "#slots", "privacy": "private", "default": "new SlotContentObserver(this)" }, { "kind": "field", "name": "#scrollPadding", "privacy": "private", "type": { "text": "number" }, "default": "0" }, { "kind": "field", "name": "scroller", "type": { "text": "HTMLElement" }, "readonly": true }, { "kind": "field", "name": "stage", "type": { "text": "HTMLElement" }, "readonly": true }, { "kind": "field", "name": "leftOverflow", "type": { "text": "boolean" }, "default": "false" }, { "kind": "field", "name": "rightOverflow", "type": { "text": "boolean" }, "default": "false" }, { "kind": "method", "name": "scrollToPreviousElement", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "scrollToNextElement", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "scrollToElement", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "element", "type": { "text": "HTMLElement" } } ] }, { "kind": "method", "name": "#update", "privacy": "private" }, { "kind": "field", "name": "#handleClick", "privacy": "private" }, { "kind": "field", "name": "role", "type": { "text": "ARIARole | null" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } }, { "kind": "field", "name": "dir", "type": { "text": "'ltr' | 'rtl'" }, "inheritedFrom": { "name": "CustomElement", "module": "src/internal/custom-element.ts" } } ], "events": [ { "type": { "text": "ScrollContainerChangeEvent" } } ], "superclass": { "name": "CustomElement", "module": "/src/internal/custom-element.js" }, "tagName": "odx-scroll-container", "customElement": true, "cssParts": [], "cssProperties": [] } ], "exports": [ { "kind": "js", "name": "ScrollContainerNextDirective", "declaration": { "name": "ScrollContainerNextDirective", "module": "src/lib/scroll-container/scroll-container.ts" } }, { "kind": "js", "name": "ScrollContainerPreviousDirective", "declaration": { "name": "ScrollContainerPreviousDirective", "module": "src/lib/scroll-container/scroll-container.ts" } }, { "kind": "js", "name": "ScrollContainerChangeEvent", "declaration": { "name": "ScrollContainerChangeEvent", "module": "src/lib/scroll-container/scroll-container.ts" } }, { "kind": "js", "name": "OdxScrollContainer", "declaration": { "name": "OdxScrollContainer", "module": "src/lib/scroll-container/scroll-container.ts" } } ] }, { "kind": "javascript-module", "path": "src/lib/select/listbox-control-element.ts", "declarations": [ { "kind": "class", "description": "", "name": "ListboxControlElement", "members": [ { "kind": "field", "name": "activeDescendants", "privacy": "protected", "readonly": true, "default": "new ActiveDescendantsController