{ "$schema": "https://cdn.jsdelivr.net/npm/custom-elements-manifest@2.1.0/schema.json", "schemaVersion": "2.1.0", "modules": [ { "kind": "javascript-module", "path": "components/Badge.js", "declarations": [ { "kind": "class", "name": "Badge", "tagName": "mdw-badge", "customElement": true, "attributes": [ { "name": "color", "fieldName": "color", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "ink", "fieldName": "ink", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "type-style", "fieldName": "typeStyle", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "density", "fieldName": "density", "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "mixins/DensityMixin.js" } }, { "name": "shape-top", "fieldName": "shapeTop", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shape-bottom", "fieldName": "shapeBottom", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shape-start", "fieldName": "shapeStart", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shape-end", "fieldName": "shapeEnd", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shape-style", "fieldName": "shapeStyle", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "outlined", "fieldName": "outlined", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } } ], "members": [ { "name": "disabled", "kind": "field", "description": "Whether the element is disabled (affects interactive states)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L14" }, "type": { "text": "boolean" } }, { "name": "focused", "kind": "field", "description": "Force focus state (independent of document)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L16" }, "type": { "text": "boolean" } }, { "name": "hovered", "kind": "field", "description": "Force hover state (independent of interaction)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L18" }, "type": { "text": "boolean" } }, { "name": "pressed", "kind": "field", "description": "Force pressed state (independent of interaction)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L20" }, "type": { "text": "boolean" } }, { "name": "stateLayer", "kind": "field", "description": "Show the visual state layer element when true", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L34" }, "type": { "text": "boolean" } }, { "name": "disabledState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L37" }, "type": { "text": "boolean" } }, { "name": "hoveredState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L38" }, "type": { "text": "boolean" } }, { "name": "focusedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L39" }, "type": { "text": "boolean" } }, { "name": "pressedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L40" }, "type": { "text": "boolean" } }, { "name": "touchedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L41" }, "type": { "text": "boolean" } }, { "name": "pointedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L44" }, "type": { "text": "boolean" } }, { "name": "stateTargetElement", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L50" }, "type": { "text": "HTMLElement" } }, { "name": "color", "kind": "field", "description": "Palette or surface token used to select background/ink tokens.\nExamples: 'primary', 'background', 'surface-container-low'.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L52" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "ink", "kind": "field", "description": "Explicit ink override token (e.g. 'outline', 'on-primary', 'inverse-on-surface', 'inherit').\nMaps to `--mdw-ink`.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L57" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "typeStyle", "kind": "field", "description": "Typographic style shortcut that maps to type scale variables\n(e.g. 'headline-large', 'body-medium').", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L62" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "shapeTop", "kind": "field", "description": "Show top cut/shape on the element", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L9" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shapeBottom", "kind": "field", "description": "Show bottom cut/shape on the element", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L11" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shapeStart", "kind": "field", "description": "Show start-side cut/shape (logical start)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L13" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shapeEnd", "kind": "field", "description": "Show end-side cut/shape (logical end)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L15" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shapeStyle", "kind": "field", "description": "Predefined shape size/style name (none|extra-small|small|medium|large|extra-large|full|inherit)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L17" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "outlined", "kind": "field", "description": "When true, an outline is rendered around the element", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L19" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "density", "kind": "field", "description": "Density level affecting spacing and compactness. Integer from -4 (dense) to 4 (spacious).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/DensityMixin.js#L9" }, "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "mixins/DensityMixin.js" } }, { "name": "prototype", "kind": "field", "static": true, "type": { "text": "CustomElement" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "compose", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L145" }, "type": { "text": "(parts: CompositionPart[]) => Composition" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#refsProxy", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1145" }, "type": { "text": "Record" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#refsCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1148" }, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#refsCompositionCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1151" }, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#composition", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1154" }, "type": { "text": "Composition" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#patching", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1156" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#pendingPatchRenders", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1159" }, "type": { "text": "[string, any, CustomElement][]" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#propAttributeCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1162" }, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#callbackArguments", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1165" }, "type": { "text": "CallbackArguments" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "elementInternals", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1172" }, "type": { "text": "ElementInternals" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "render", "kind": "field", "description": "Updates nodes based on data\nExpects data in JSON Merge Patch format", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1185" }, "type": { "text": "RenderDraw" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "propChangedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1213" }, "type": { "text": "(this: T, name: K, oldValue: K extends keyof T ? T[K] : unknown, newValue: K extends keyof T ? T[K] : unknown, changes?: K extends keyof T ? T[K] extends object ? Partial : T[K] : unknown) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attributeChangedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1234" }, "type": { "text": "(name: string, oldValue: string, newValue: string) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#template", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1284" }, "type": { "text": "DocumentFragment" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#onObserverPropertyChanged", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1294" }, "type": { "text": "(name: string, oldValue: any, newValue: any, changes: any) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "static", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1330" }, "type": { "text": "typeof CustomElement" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "patch", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1333" }, "type": { "text": "(patch: any) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "refs", "kind": "field", "description": "Proxy object that returns shadow DOM elements by tag.\nIf called before interpolation (eg: on composed), returns from template", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1404" }, "type": { "text": "Record" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attributeCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1391" }, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "callbackArguments", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1400" }, "type": { "text": "CallbackArguments | { composition: Composition; refs: Record; html: any; inline: (fn: (data: Partial) => any) => string; template: DocumentFragment; element: T; }" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "composition", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1403" }, "type": { "text": "Composition" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "connectedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1435" }, "type": { "text": "() => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "disconnectedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1441" }, "type": { "text": "() => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "delegatesFocus", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1175" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "elementName", "kind": "field", "static": true, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "observedAttributes", "kind": "field", "static": true, "type": { "text": "Iterable" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "interpolatesTemplate", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "supportsElementInternals", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "supportsElementInternalsRole", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "defined", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "registrations", "kind": "field", "static": true, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "expressions", "kind": "method", "static": true, "description": "Expressions are idempotent functions that are selectively called whenever\na render is requested.\nExpressions are constructed exactly as methods though differ in expected\narguments. The first argument should be destructured to ensure each used\nproperty is accessed at least once in order to inspect used properties.\n\nThe Composition API will inspect this function with a proxy for `this` to\ncatalog what observables are used by the expression. This allows the\nComposition API to build a cache as well as selective invoke the expression\nonly when needed.\n\nWhen used with in element templates, the element itself will be passed as\nits first argument.\n````js\n Button\n .prop('filled', 'boolean')\n .prop('outlined', 'boolean')\n .expresssions({\n _isFilledOrOutlined({filled, outlined}) {\n return (filled || outlined)\n },\n })\n .html`
`;\n````\n\nWhen used with external data source, that data source\nwill be passed to the expression with all properties being `null` at first\ninspection.\n````js\n const externalData = {first: 'John', last: 'Doe'};\n ContactCard\n .expresssions({\n _fullName({first, last}) {\n return [first, last].filter(Boolean).join(' ');\n },\n })\n myButton.render(externalData);\n````\n\nExpressions may be support argumentless calls by using default\nparameters with `this`.\n````js\n Button\n .expresssions({\n isFilledOrOutlined({filled, outlined} = this) {\n return (filled || outlined)\n },\n });\n myButton.isFilledorOutlined();\n````", "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends { [K in keyof any]: K extends `_${any}` ? ((data: INSTANCE, state?: Record) => string | boolean | null) : ((data?: INSTANCE, state?: Record) => string | boolean | null); } & ThisType>(this: CLASS, expressions: PROPS & ThisType) => CLASS & Class<{ [K in keyof PROPS]: K extends `_${any}` ? never : () => ReturnType; }, ARGS>" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "methods", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "overrides", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends Partial>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "props", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "idl", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "append", "kind": "field", "static": true, "description": "Append parts to composition", "type": { "text": "(this: T, ...parts: CompositionPart[]) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "recompose", "kind": "field", "static": true, "description": "After composition, invokes callback.\nMay be called multiple times.", "type": { "text": ", T3 extends CompositionCallback[\"composed\"]>(this: T1, callback: T3) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "css", "kind": "field", "static": true, "description": "Appends styles to composition", "type": { "text": "(this: T1, array: T2, ...rest: T2 extends string ? any : T2 extends TemplateStringsArray ? any[] : (HTMLStyleElement | CSSStyleSheet)[]) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "autoRegister", "kind": "field", "static": true, "description": "Registers class with customElements. If class is registered before then,\ndoes nothing.", "type": { "text": "(this: T, elementName: string) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "html", "kind": "field", "static": true, "description": "Appends DocumentFragment to composition", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1405" }, "type": { "text": "(this: T, string: TemplateStringsArray, ...substitutions: (string | Element | ((this: InstanceType, data: InstanceType, injections?: any) => any))[]) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "extend", "kind": "field", "static": true, "description": "Extends base class into a new class.\nUse to avoid mutating base class.", "type": { "text": " T2>(this: T1, customExtender?: T3) => T3 extends null ? T1 : T2" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "setStatic", "kind": "field", "static": true, "description": "Assigns static values to class", "type": { "text": " any) | string | number | boolean | any[] | object); }>(this: T1, source: T2 & ThisType) => T1 & T2" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "readonly", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "set", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "mixin", "kind": "field", "static": true, "description": "Returns result of calling mixin with current class", "type": { "text": " any, RETURN extends ReturnType, SUBCLASS extends ClassOf>(this: BASE, mixin: FN) => SUBCLASS & BASE" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "register", "kind": "field", "static": true, "description": "Registers class with window.customElements synchronously", "type": { "text": "(this: T, elementName?: string, force?: boolean) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "propList", "kind": "field", "static": true, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attrList", "kind": "field", "static": true, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "propChangedCallbacks", "kind": "field", "static": true, "type": { "text": "Map any)[]>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attributeChangedCallbacks", "kind": "field", "static": true, "type": { "text": "Map any)[]>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "prop", "kind": "field", "static": true, "description": "Creates observable property on instances (via prototype)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1007" }, "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "setPrototype", "kind": "field", "static": true, "description": "Creates observable property on instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any)>(this: CLASS, name: KEY, options: OPTIONS) => OPTIONS extends (...args2: any[]) => infer R ? R : OPTIONS extends ObserverPropertyType ? ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? unknown extends R ? object : R : OPTIONS extends { type: ObserverPropertyType; } ? ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? unknown extends R ? string : R : never" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "define", "kind": "field", "static": true, "description": "Define properties on instances via Object.defineProperties().\nAutomatically sets property non-enumerable if name begins with `_`.\nFunctions will be remapped as getters", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends { [P in keyof any]: { enumerable?: boolean; configurable?: boolean; writable?: boolean; value?: any; get?: ((this: INSTANCE) => any); set?: (this: INSTANCE, value: any) => void; } | ((this: INSTANCE, ...args: any[]) => any); }, VALUE extends { [KEY in keyof PROPS]: PROPS[KEY] extends (...args2: any[]) => infer R ? R : PROPS[KEY] extends TypedPropertyDescriptor ? R : never; }>(this: CLASS, props: PROPS & ThisType) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "undefine", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROP extends string, PROPS extends INSTANCE & Record>(this: CLASS, name: PROP) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "observe", "kind": "field", "static": true, "description": "Creates observable properties on instances", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends IDLParameter, VALUE extends { [KEY in keyof PROPS]: PROPS[KEY] extends (...args2: any[]) => infer R ? R : PROPS[KEY] extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : PROPS[KEY] extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : PROPS[KEY] extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : PROPS[KEY] extends ObserverOptions ? (unknown extends R ? string : R) : never; }>(this: CLASS, props: PROPS) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "defineStatic", "kind": "field", "static": true, "type": { "text": ">(this: T1, props: T2) => T1 & ParsedProps" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "events", "kind": "field", "static": true, "type": { "text": "(this: T, listeners?: CompositionEventListenerObject>, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "childEvents", "kind": "field", "static": true, "type": { "text": "(this: T, listenerMap: { [x: string]: CompositionEventListenerObject>; }, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "rootEvents", "kind": "field", "static": true, "type": { "text": "(this: T, listeners?: CompositionEventListenerObject>, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "on", "kind": "field", "static": true, "type": { "text": ", T3 extends CompositionCallback, T4 extends keyof T3>(this: T1, name: T3 | T4, callbacks?: T3[T4] & ThisType) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "off", "kind": "field", "static": true, "type": { "text": ", T3 extends CompositionCallback, T4 extends keyof T3>(this: T1, name: T3 | T4, callbacks?: T3[T4] & ThisType) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "offPropChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: ObjectOrObjectEntries<{ [P in keyof T2]?: (this: T2, oldValue: T2[P], newValue: T2[P], changes: any, element: T2) => void; }>) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "offAttributeChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: { [x: string]: (this: T2, oldValue: string, newValue: string, element: T2) => void; }) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "onPropChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: ObjectOrObjectEntries<{ [P in keyof T2]?: (this: T2, oldValue: T2[P], newValue: T2[P], changes: any, element: T2) => void; }>) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "onAttributeChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: { [x: string]: (this: T2, oldValue: string, newValue: string, element: T2) => void; }) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } } ], "slots": [ { "name": "", "description": "" } ], "cssParts": [], "events": [], "demos": [ { "url": "demo/components/badge.html" } ], "superclass": { "module": "core/CustomElement.js", "name": "default" }, "mixins": [ { "module": "mixins/ThemableMixin.js", "name": "default" }, { "module": "mixins/DensityMixin.js", "name": "default" }, { "module": "mixins/ShapeMixin.js", "name": "default" } ], "description": "Badges show notifications, counts, or status information on\nnavigation items and icons.\n@see https://m3.material.io/components/badges/specs" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "default", "module": "components/Badge.js" } }, { "kind": "custom-element-definition", "name": "mdw-badge", "declaration": { "name": "default", "module": "components/Badge.js" } } ] }, { "kind": "javascript-module", "path": "components/Body.js", "declarations": [ { "kind": "class", "name": "Body", "tagName": "mdw-body", "customElement": true, "attributes": [ { "name": "color", "fieldName": "color", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "ink", "fieldName": "ink", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "type-style", "fieldName": "typeStyle", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "block", "fieldName": "block", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "inline", "fieldName": "inline", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "row", "fieldName": "row", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "x", "fieldName": "x", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "y", "fieldName": "y", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "gap", "fieldName": "gap", "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "padding", "fieldName": "padding", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "text-padding", "fieldName": "textPadding", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/TypographyMixin.js" } }, { "name": "text-padding-top", "fieldName": "textPaddingTop", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/TypographyMixin.js" } }, { "name": "text-leading", "fieldName": "textLeading", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/TypographyMixin.js" } }, { "name": "text-padding-bottom", "fieldName": "textPaddingBottom", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/TypographyMixin.js" } } ], "members": [ { "name": "delegatesFocus", "kind": "field", "description": "When true, the element delegates focus to an internal focus target.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/DelegatesFocusMixin.js#L15" }, "type": { "text": "boolean" } }, { "name": "textPadding", "kind": "field", "description": "General vertical padding for text content (css length)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/TypographyMixin.js#L24" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/TypographyMixin.js" } }, { "name": "textPaddingTop", "kind": "field", "description": "Padding-top override for text content (css length)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/TypographyMixin.js#L26" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/TypographyMixin.js" } }, { "name": "textLeading", "kind": "field", "description": "Line-leading (extra top spacing) for text (css length or 'sp' units)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/TypographyMixin.js#L28" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/TypographyMixin.js" } }, { "name": "textPaddingBottom", "kind": "field", "description": "Padding-bottom override for text content (css length)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/TypographyMixin.js#L30" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/TypographyMixin.js" } }, { "name": "block", "kind": "field", "description": "Set `display: block` on the host (boolean)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js#L9" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "inline", "kind": "field", "description": "Use inline flex layout: `display: inline-flex` (boolean)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js#L11" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "row", "kind": "field", "description": "Switch main axis to horizontal: `flex-direction: row` (boolean)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js#L13" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "x", "kind": "field", "description": "Main-axis alignment / justification.\nAllowed: 'start'|'center'|'end'|'between'|'around'|'stretch'|'baseline'.\nDefault: 'start'.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js#L19" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "y", "kind": "field", "description": "Cross-axis alignment / alignment of items.\nSame allowed values as `x`. Default: 'start'.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js#L29" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "gap", "kind": "field", "description": "Gap between children. Accepts preset numeric strings (e.g. '8') mapped to px, or floats.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js#L36" }, "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "padding", "kind": "field", "description": "Padding preset or numeric value (e.g. 'pane', '8', '16').", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js#L38" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "color", "kind": "field", "description": "Palette or surface token used to select background/ink tokens.\nExamples: 'primary', 'background', 'surface-container-low'.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L52" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "ink", "kind": "field", "description": "Explicit ink override token (e.g. 'outline', 'on-primary', 'inverse-on-surface', 'inherit').\nMaps to `--mdw-ink`.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L57" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "typeStyle", "kind": "field", "description": "Typographic style shortcut that maps to type scale variables\n(e.g. 'headline-large', 'body-medium').", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L62" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "prototype", "kind": "field", "static": true, "type": { "text": "CustomElement" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } } ], "slots": [ { "name": "", "description": "" } ], "cssParts": [], "events": [], "demos": [], "superclass": { "module": "components/Box.js", "name": "default" }, "mixins": [ { "module": "mixins/TypographyMixin.js", "name": "default" } ], "description": "Material Design Type scale: Body.\n@see https://m3.material.io/styles/typography/type-scale-tokens" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "default", "module": "components/Body.js" } }, { "kind": "custom-element-definition", "name": "mdw-body", "declaration": { "name": "default", "module": "components/Body.js" } } ] }, { "kind": "javascript-module", "path": "components/BottomAppBar.js", "declarations": [ { "kind": "class", "name": "BottomAppBar", "tagName": "mdw-bottom-app-bar", "customElement": true, "attributes": [ { "name": "color", "fieldName": "color", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Surface.js" } }, { "name": "ink", "fieldName": "ink", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Surface.js" } }, { "name": "type-style", "fieldName": "typeStyle", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Surface.js" } }, { "name": "block", "fieldName": "block", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Surface.js" } }, { "name": "inline", "fieldName": "inline", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Surface.js" } }, { "name": "row", "fieldName": "row", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Surface.js" } }, { "name": "x", "fieldName": "x", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Surface.js" } }, { "name": "y", "fieldName": "y", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Surface.js" } }, { "name": "gap", "fieldName": "gap", "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "components/Surface.js" } }, { "name": "padding", "fieldName": "padding", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Surface.js" } }, { "name": "shape-top", "fieldName": "shapeTop", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Surface.js" } }, { "name": "shape-bottom", "fieldName": "shapeBottom", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Surface.js" } }, { "name": "shape-start", "fieldName": "shapeStart", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Surface.js" } }, { "name": "shape-end", "fieldName": "shapeEnd", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Surface.js" } }, { "name": "shape-style", "fieldName": "shapeStyle", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Surface.js" } }, { "name": "outlined", "fieldName": "outlined", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Surface.js" } }, { "name": "kbd-nav", "fieldName": "kbdNav", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/AriaToolbarMixin.js" } } ], "members": [ { "name": "kbdNav", "kind": "field", "description": "Enable keyboard roving navigation when present (set to 'true').", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/KeyboardNavMixin.js#L23" }, "type": { "text": "string" } }, { "name": "kbdNavQuery", "kind": "field", "description": "Query used to find roving tab index children", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/KeyboardNavMixin.js#L32" }, "type": { "text": "string" } }, { "name": "kbdNavFocusableWhenDisabled", "kind": "field", "description": "Flag whether disabled elements participating in roving tab index\nshould be focusable.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/KeyboardNavMixin.js#L39" }, "type": { "text": "boolean" } }, { "name": "ariaOrientationDefault", "kind": "field", "description": "Default orientation for toolbar: 'horizontal' or 'vertical'.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/AriaToolbarMixin.js#L14" }, "type": { "text": "\"horizontal\" | \"vertical\"" } }, { "name": "kbdNavChildren", "kind": "field", "description": "List of roving tab index participating children", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/KeyboardNavMixin.js#L48" }, "type": { "text": "NodeListOf" } }, { "name": "disabled", "kind": "field", "description": "Whether the element is disabled (affects interactive states)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L14" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Surface.js" } }, { "name": "focused", "kind": "field", "description": "Force focus state (independent of document)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L16" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Surface.js" } }, { "name": "hovered", "kind": "field", "description": "Force hover state (independent of interaction)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L18" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Surface.js" } }, { "name": "pressed", "kind": "field", "description": "Force pressed state (independent of interaction)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L20" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Surface.js" } }, { "name": "stateLayer", "kind": "field", "description": "Show the visual state layer element when true", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L34" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Surface.js" } }, { "name": "disabledState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L37" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Surface.js" } }, { "name": "hoveredState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L38" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Surface.js" } }, { "name": "focusedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L39" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Surface.js" } }, { "name": "pressedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L40" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Surface.js" } }, { "name": "touchedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L41" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Surface.js" } }, { "name": "pointedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L44" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Surface.js" } }, { "name": "stateTargetElement", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L50" }, "type": { "text": "HTMLElement" }, "inheritedFrom": { "name": "default", "module": "components/Surface.js" } }, { "name": "color", "kind": "field", "description": "Palette or surface token used to select background/ink tokens.\nExamples: 'primary', 'background', 'surface-container-low'.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/BottomAppBar.js#L21" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Surface.js" } }, { "name": "ink", "kind": "field", "description": "Explicit ink override token (e.g. 'outline', 'on-primary', 'inverse-on-surface', 'inherit').\nMaps to `--mdw-ink`.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L57" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Surface.js" } }, { "name": "typeStyle", "kind": "field", "description": "Typographic style shortcut that maps to type scale variables\n(e.g. 'headline-large', 'body-medium').", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L62" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Surface.js" } }, { "name": "shapeTop", "kind": "field", "description": "Show top cut/shape on the element", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L9" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Surface.js" } }, { "name": "shapeBottom", "kind": "field", "description": "Show bottom cut/shape on the element", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L11" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Surface.js" } }, { "name": "shapeStart", "kind": "field", "description": "Show start-side cut/shape (logical start)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L13" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Surface.js" } }, { "name": "shapeEnd", "kind": "field", "description": "Show end-side cut/shape (logical end)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L15" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Surface.js" } }, { "name": "shapeStyle", "kind": "field", "description": "Predefined shape size/style name (none|extra-small|small|medium|large|extra-large|full|inherit)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L17" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Surface.js" } }, { "name": "outlined", "kind": "field", "description": "When true, an outline is rendered around the element", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L19" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Surface.js" } }, { "name": "block", "kind": "field", "description": "Set `display: block` on the host (boolean)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js#L9" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Surface.js" } }, { "name": "inline", "kind": "field", "description": "Use inline flex layout: `display: inline-flex` (boolean)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js#L11" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Surface.js" } }, { "name": "row", "kind": "field", "description": "Switch main axis to horizontal: `flex-direction: row` (boolean)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js#L13" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Surface.js" } }, { "name": "x", "kind": "field", "description": "Main-axis alignment / justification.\nAllowed: 'start'|'center'|'end'|'between'|'around'|'stretch'|'baseline'.\nDefault: 'start'.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js#L19" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Surface.js" } }, { "name": "y", "kind": "field", "description": "Cross-axis alignment / alignment of items.\nSame allowed values as `x`. Default: 'start'.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js#L29" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Surface.js" } }, { "name": "gap", "kind": "field", "description": "Gap between children. Accepts preset numeric strings (e.g. '8') mapped to px, or floats.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js#L36" }, "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "components/Surface.js" } }, { "name": "padding", "kind": "field", "description": "Padding preset or numeric value (e.g. 'pane', '8', '16').", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js#L38" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Surface.js" } }, { "name": "prototype", "kind": "field", "static": true, "type": { "text": "CustomElement" }, "inheritedFrom": { "name": "default", "module": "components/Surface.js" } } ], "slots": [ { "name": "", "description": "" } ], "cssParts": [], "events": [], "demos": [ { "url": "demo/components/bottomappbar.html" } ], "superclass": { "module": "components/Surface.js", "name": "default" }, "mixins": [ { "module": "mixins/AriaToolbarMixin.js", "name": "default" } ], "description": "Note: FAB does not exist inside because FABs can appear outside.\nSpace will be maintained for the FAB to slide into position. FAB should be\nnext on the DOM, so users can logically tab to it." } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "default", "module": "components/BottomAppBar.js" } }, { "kind": "custom-element-definition", "name": "mdw-bottom-app-bar", "declaration": { "name": "default", "module": "components/BottomAppBar.js" } } ] }, { "kind": "javascript-module", "path": "components/BottomSheet.js", "declarations": [ { "kind": "class", "name": "BottomSheet", "tagName": "mdw-bottom-sheet", "customElement": true, "attributes": [ { "name": "color", "fieldName": "color", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "ink", "fieldName": "ink", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "type-style", "fieldName": "typeStyle", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "block", "fieldName": "block", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/FlexboxMixin.js" } }, { "name": "inline", "fieldName": "inline", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/FlexboxMixin.js" } }, { "name": "row", "fieldName": "row", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/FlexboxMixin.js" } }, { "name": "x", "fieldName": "x", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/FlexboxMixin.js" } }, { "name": "y", "fieldName": "y", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/FlexboxMixin.js" } }, { "name": "gap", "fieldName": "gap", "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "mixins/FlexboxMixin.js" } }, { "name": "padding", "fieldName": "padding", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/FlexboxMixin.js" } }, { "name": "shape-top", "description": "Overrides default of shape top to be true", "fieldName": "shapeTop", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shape-bottom", "fieldName": "shapeBottom", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shape-start", "fieldName": "shapeStart", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shape-end", "fieldName": "shapeEnd", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shape-style", "fieldName": "shapeStyle", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "outlined", "fieldName": "outlined", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "modal", "description": "Whether the bottom sheet displays as a modal and shows a scrim.", "fieldName": "modal", "type": { "text": "boolean" } }, { "name": "fixed", "description": "If true, the sheet is fixed (not translated) and anchors to layout.", "fieldName": "fixed", "type": { "text": "boolean" } }, { "name": "open", "description": "Whether the bottom sheet is currently open.", "fieldName": "open", "type": { "text": "boolean" } }, { "name": "expanded", "description": "Whether the bottom sheet is expanded to show full content.", "fieldName": "expanded", "type": { "text": "boolean" } }, { "name": "drag-handle", "fieldName": "dragHandle", "type": { "text": "boolean" } }, { "name": "onopen", "description": "Event handler: called when the sheet opens.", "fieldName": "onopen", "type": { "text": "function" } }, { "name": "onclose", "description": "Event handler: called when the sheet closes.", "fieldName": "onclose", "type": { "text": "function" } } ], "members": [ { "name": "delegatesFocus", "kind": "field", "description": "When true, the element delegates focus to an internal focus target.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/DelegatesFocusMixin.js#L15" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "disabled", "kind": "field", "description": "Whether the element is disabled (affects interactive states)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L14" }, "type": { "text": "boolean" } }, { "name": "focused", "kind": "field", "description": "Force focus state (independent of document)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L16" }, "type": { "text": "boolean" } }, { "name": "hovered", "kind": "field", "description": "Force hover state (independent of interaction)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L18" }, "type": { "text": "boolean" } }, { "name": "pressed", "kind": "field", "description": "Force pressed state (independent of interaction)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L20" }, "type": { "text": "boolean" } }, { "name": "stateLayer", "kind": "field", "description": "Show the visual state layer element when true", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/BottomSheet.js#L22" }, "type": { "text": "boolean" } }, { "name": "disabledState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L37" }, "type": { "text": "boolean" } }, { "name": "hoveredState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L38" }, "type": { "text": "boolean" } }, { "name": "focusedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L39" }, "type": { "text": "boolean" } }, { "name": "pressedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L40" }, "type": { "text": "boolean" } }, { "name": "touchedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L41" }, "type": { "text": "boolean" } }, { "name": "pointedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L44" }, "type": { "text": "boolean" } }, { "name": "stateTargetElement", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L50" }, "type": { "text": "HTMLElement" } }, { "name": "color", "kind": "field", "description": "Palette or surface token used to select background/ink tokens.\nExamples: 'primary', 'background', 'surface-container-low'.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L52" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "ink", "kind": "field", "description": "Explicit ink override token (e.g. 'outline', 'on-primary', 'inverse-on-surface', 'inherit').\nMaps to `--mdw-ink`.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L57" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "typeStyle", "kind": "field", "description": "Typographic style shortcut that maps to type scale variables\n(e.g. 'headline-large', 'body-medium').", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L62" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "shapeTop", "kind": "field", "description": "Show top cut/shape on the element\nOverrides default of shape top to be true", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/BottomSheet.js#L108" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shapeBottom", "kind": "field", "description": "Show bottom cut/shape on the element", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L11" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shapeStart", "kind": "field", "description": "Show start-side cut/shape (logical start)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L13" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shapeEnd", "kind": "field", "description": "Show end-side cut/shape (logical end)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L15" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shapeStyle", "kind": "field", "description": "Predefined shape size/style name (none|extra-small|small|medium|large|extra-large|full|inherit)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L17" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "outlined", "kind": "field", "description": "When true, an outline is rendered around the element", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L19" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "block", "kind": "field", "description": "Set `display: block` on the host (boolean)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js#L9" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/FlexboxMixin.js" } }, { "name": "inline", "kind": "field", "description": "Use inline flex layout: `display: inline-flex` (boolean)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js#L11" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/FlexboxMixin.js" } }, { "name": "row", "kind": "field", "description": "Switch main axis to horizontal: `flex-direction: row` (boolean)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js#L13" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/FlexboxMixin.js" } }, { "name": "x", "kind": "field", "description": "Main-axis alignment / justification.\nAllowed: 'start'|'center'|'end'|'between'|'around'|'stretch'|'baseline'.\nDefault: 'start'.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js#L19" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/FlexboxMixin.js" } }, { "name": "y", "kind": "field", "description": "Cross-axis alignment / alignment of items.\nSame allowed values as `x`. Default: 'start'.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js#L29" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/FlexboxMixin.js" } }, { "name": "gap", "kind": "field", "description": "Gap between children. Accepts preset numeric strings (e.g. '8') mapped to px, or floats.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js#L36" }, "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "mixins/FlexboxMixin.js" } }, { "name": "padding", "kind": "field", "description": "Padding preset or numeric value (e.g. 'pane', '8', '16').", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js#L38" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/FlexboxMixin.js" } }, { "name": "modal", "kind": "field", "description": "Whether the bottom sheet displays as a modal and shows a scrim.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/BottomSheet.js#L113" }, "type": { "text": "boolean" } }, { "name": "fixed", "kind": "field", "description": "If true, the sheet is fixed (not translated) and anchors to layout.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/BottomSheet.js#L115" }, "type": { "text": "boolean" } }, { "name": "open", "kind": "field", "description": "Whether the bottom sheet is currently open.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/BottomSheet.js#L117" }, "type": { "text": "boolean" } }, { "name": "expanded", "kind": "field", "description": "Whether the bottom sheet is expanded to show full content.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/BottomSheet.js#L119" }, "type": { "text": "boolean" } }, { "name": "dragHandle", "kind": "field", "description": "When true, a drag handle is rendered to allow pointer dragging.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/BottomSheet.js#L372" }, "type": { "text": "boolean" } }, { "name": "onopen", "kind": "field", "description": "Event handler: called when the sheet opens.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/BottomSheet.js#L150" }, "type": { "text": "EventListener" } }, { "name": "hostStyles", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/BottomSheet.js#L165" }, "type": { "text": "ElementStylerOptions | { styles: { marginBottom: string | number; transform: string; }; timing: { duration: number; easing: string; }; }" } }, { "name": "checkForScrim", "kind": "method", "description": "Ensure a scrim is present when the sheet is modal and open.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/BottomSheet.js#L196" }, "return": { "type": { "text": "(animate?: boolean) => void" } } }, { "name": "checkDragFinished", "kind": "method", "description": "Evaluate drag state and settle the sheet (close or snap open).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/BottomSheet.js#L223" }, "return": { "type": { "text": "() => void" } } }, { "name": "onDragHandleActive", "kind": "method", "description": "Pointer active on the drag handle; registers the pointer for dragging.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/BottomSheet.js#L255" }, "return": { "type": { "text": "(event: PointerEvent) => void" } } }, { "name": "onDragHandleInactive", "kind": "method", "description": "Pointer inactive on the drag handle; finalizes potential drag.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/BottomSheet.js#L267" }, "return": { "type": { "text": "(event: PointerEvent) => void" } } }, { "name": "onPointerOrTouchMove", "kind": "method", "description": "Handle pointer or touch move events during dragging.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/BottomSheet.js#L279" }, "return": { "type": { "text": "(event: PointerEvent | TouchEvent) => void" } } }, { "name": "prototype", "kind": "field", "static": true, "type": { "text": "CustomElement" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "readAriaProperty", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/AriaReflectorMixin.js#L28" }, "return": { "type": { "text": "(name: \"shadowRoot\" | \"ariaActiveDescendantElement\" | \"ariaAtomic\" | \"ariaAutoComplete\" | \"ariaBrailleLabel\" | \"ariaBrailleRoleDescription\" | \"ariaBusy\" | \"ariaChecked\" | \"ariaColCount\" | \"ariaColIndex\" | \"ariaColIndexText\" | \"ariaColSpan\" | \"ariaControlsElements\" | \"ariaCurrent\" | \"ariaDescribedByElements\" | \"ariaDescription\" | \"ariaDetailsElements\" | \"ariaDisabled\" | \"ariaErrorMessageElements\" | \"ariaExpanded\" | \"ariaFlowToElements\" | \"ariaHasPopup\" | \"ariaHidden\" | \"ariaInvalid\" | \"ariaKeyShortcuts\" | \"ariaLabel\" | \"ariaLabelledByElements\" | \"ariaLevel\" | \"ariaLive\" | \"ariaModal\" | \"ariaMultiLine\" | \"ariaMultiSelectable\" | \"ariaOrientation\" | \"ariaOwnsElements\" | \"ariaPlaceholder\" | \"ariaPosInSet\" | \"ariaPressed\" | \"ariaReadOnly\" | \"ariaRelevant\" | \"ariaRequired\" | \"ariaRoleDescription\" | \"ariaRowCount\" | \"ariaRowIndex\" | \"ariaRowIndexText\" | \"ariaRowSpan\" | \"ariaSelected\" | \"ariaSetSize\" | \"ariaSort\" | \"ariaValueMax\" | \"ariaValueMin\" | \"ariaValueNow\" | \"ariaValueText\" | \"role\") => string | Element | ShadowRoot | readonly Element[]" } }, "inheritedFrom": { "name": "default", "module": "mixins/AriaReflectorMixin.js" } }, { "name": "updateAriaProperty", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/AriaReflectorMixin.js#L47" }, "return": { "type": { "text": ">(name: K, value: ARIAMixin[K]) => void" } }, "inheritedFrom": { "name": "default", "module": "mixins/AriaReflectorMixin.js" } }, { "name": "onResizeObserved", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ResizeObserverMixin.js#L23" }, "return": { "type": { "text": "(entry: ResizeObserverEntry) => void" } }, "inheritedFrom": { "name": "default", "module": "mixins/ResizeObserverMixin.js" } }, { "name": "observeResize", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ResizeObserverMixin.js#L26" }, "return": { "type": { "text": "() => void" } }, "inheritedFrom": { "name": "default", "module": "mixins/ResizeObserverMixin.js" } }, { "name": "unobserveResize", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ResizeObserverMixin.js#L31" }, "return": { "type": { "text": "() => void" } }, "inheritedFrom": { "name": "default", "module": "mixins/ResizeObserverMixin.js" } }, { "name": "compose", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L145" }, "type": { "text": "(parts: CompositionPart[]) => Composition" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#refsProxy", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1145" }, "type": { "text": "Record" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#refsCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1148" }, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#refsCompositionCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1151" }, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#composition", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1154" }, "type": { "text": "Composition" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#patching", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1156" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#pendingPatchRenders", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1159" }, "type": { "text": "[string, any, CustomElement][]" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#propAttributeCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1162" }, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#callbackArguments", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1165" }, "type": { "text": "CallbackArguments" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "elementInternals", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1172" }, "type": { "text": "ElementInternals" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "render", "kind": "field", "description": "Updates nodes based on data\nExpects data in JSON Merge Patch format", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1185" }, "type": { "text": "RenderDraw" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "propChangedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1213" }, "type": { "text": "(this: T, name: K, oldValue: K extends keyof T ? T[K] : unknown, newValue: K extends keyof T ? T[K] : unknown, changes?: K extends keyof T ? T[K] extends object ? Partial : T[K] : unknown) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attributeChangedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1234" }, "type": { "text": "(name: string, oldValue: string, newValue: string) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#template", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1284" }, "type": { "text": "DocumentFragment" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#onObserverPropertyChanged", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1294" }, "type": { "text": "(name: string, oldValue: any, newValue: any, changes: any) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "static", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1330" }, "type": { "text": "typeof CustomElement" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "patch", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1333" }, "type": { "text": "(patch: any) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "refs", "kind": "field", "description": "Proxy object that returns shadow DOM elements by tag.\nIf called before interpolation (eg: on composed), returns from template", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1404" }, "type": { "text": "Record" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attributeCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1391" }, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "callbackArguments", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1400" }, "type": { "text": "CallbackArguments | { composition: Composition; refs: Record; html: any; inline: (fn: (data: Partial) => any) => string; template: DocumentFragment; element: T; }" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "composition", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1403" }, "type": { "text": "Composition" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "connectedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1435" }, "type": { "text": "() => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "disconnectedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1441" }, "type": { "text": "() => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "elementName", "kind": "field", "static": true, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "observedAttributes", "kind": "field", "static": true, "type": { "text": "Iterable" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "interpolatesTemplate", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "supportsElementInternals", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "supportsElementInternalsRole", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "defined", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "registrations", "kind": "field", "static": true, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "expressions", "kind": "method", "static": true, "description": "Expressions are idempotent functions that are selectively called whenever\na render is requested.\nExpressions are constructed exactly as methods though differ in expected\narguments. The first argument should be destructured to ensure each used\nproperty is accessed at least once in order to inspect used properties.\n\nThe Composition API will inspect this function with a proxy for `this` to\ncatalog what observables are used by the expression. This allows the\nComposition API to build a cache as well as selective invoke the expression\nonly when needed.\n\nWhen used with in element templates, the element itself will be passed as\nits first argument.\n````js\n Button\n .prop('filled', 'boolean')\n .prop('outlined', 'boolean')\n .expresssions({\n _isFilledOrOutlined({filled, outlined}) {\n return (filled || outlined)\n },\n })\n .html`
`;\n````\n\nWhen used with external data source, that data source\nwill be passed to the expression with all properties being `null` at first\ninspection.\n````js\n const externalData = {first: 'John', last: 'Doe'};\n ContactCard\n .expresssions({\n _fullName({first, last}) {\n return [first, last].filter(Boolean).join(' ');\n },\n })\n myButton.render(externalData);\n````\n\nExpressions may be support argumentless calls by using default\nparameters with `this`.\n````js\n Button\n .expresssions({\n isFilledOrOutlined({filled, outlined} = this) {\n return (filled || outlined)\n },\n });\n myButton.isFilledorOutlined();\n````", "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends { [K in keyof any]: K extends `_${any}` ? ((data: INSTANCE, state?: Record) => string | boolean | null) : ((data?: INSTANCE, state?: Record) => string | boolean | null); } & ThisType>(this: CLASS, expressions: PROPS & ThisType) => CLASS & Class<{ [K in keyof PROPS]: K extends `_${any}` ? never : () => ReturnType; }, ARGS>" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "methods", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "overrides", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends Partial>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "props", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "idl", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "append", "kind": "field", "static": true, "description": "Append parts to composition", "type": { "text": "(this: T, ...parts: CompositionPart[]) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "recompose", "kind": "field", "static": true, "description": "After composition, invokes callback.\nMay be called multiple times.", "type": { "text": ", T3 extends CompositionCallback[\"composed\"]>(this: T1, callback: T3) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "css", "kind": "field", "static": true, "description": "Appends styles to composition", "type": { "text": "(this: T1, array: T2, ...rest: T2 extends string ? any : T2 extends TemplateStringsArray ? any[] : (HTMLStyleElement | CSSStyleSheet)[]) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "autoRegister", "kind": "field", "static": true, "description": "Registers class with customElements. If class is registered before then,\ndoes nothing.", "type": { "text": "(this: T, elementName: string) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "html", "kind": "field", "static": true, "description": "Appends DocumentFragment to composition", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1405" }, "type": { "text": "(this: T, string: TemplateStringsArray, ...substitutions: (string | Element | ((this: InstanceType, data: InstanceType, injections?: any) => any))[]) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "extend", "kind": "field", "static": true, "description": "Extends base class into a new class.\nUse to avoid mutating base class.", "type": { "text": " T2>(this: T1, customExtender?: T3) => T3 extends null ? T1 : T2" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "setStatic", "kind": "field", "static": true, "description": "Assigns static values to class", "type": { "text": " any) | string | number | boolean | any[] | object); }>(this: T1, source: T2 & ThisType) => T1 & T2" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "readonly", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "set", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "mixin", "kind": "field", "static": true, "description": "Returns result of calling mixin with current class", "type": { "text": " any, RETURN extends ReturnType, SUBCLASS extends ClassOf>(this: BASE, mixin: FN) => SUBCLASS & BASE" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "register", "kind": "field", "static": true, "description": "Registers class with window.customElements synchronously", "type": { "text": "(this: T, elementName?: string, force?: boolean) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "propList", "kind": "field", "static": true, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attrList", "kind": "field", "static": true, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "propChangedCallbacks", "kind": "field", "static": true, "type": { "text": "Map any)[]>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attributeChangedCallbacks", "kind": "field", "static": true, "type": { "text": "Map any)[]>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "prop", "kind": "field", "static": true, "description": "Creates observable property on instances (via prototype)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1007" }, "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "setPrototype", "kind": "field", "static": true, "description": "Creates observable property on instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any)>(this: CLASS, name: KEY, options: OPTIONS) => OPTIONS extends (...args2: any[]) => infer R ? R : OPTIONS extends ObserverPropertyType ? ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? unknown extends R ? object : R : OPTIONS extends { type: ObserverPropertyType; } ? ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? unknown extends R ? string : R : never" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "define", "kind": "field", "static": true, "description": "Define properties on instances via Object.defineProperties().\nAutomatically sets property non-enumerable if name begins with `_`.\nFunctions will be remapped as getters", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends { [P in keyof any]: { enumerable?: boolean; configurable?: boolean; writable?: boolean; value?: any; get?: ((this: INSTANCE) => any); set?: (this: INSTANCE, value: any) => void; } | ((this: INSTANCE, ...args: any[]) => any); }, VALUE extends { [KEY in keyof PROPS]: PROPS[KEY] extends (...args2: any[]) => infer R ? R : PROPS[KEY] extends TypedPropertyDescriptor ? R : never; }>(this: CLASS, props: PROPS & ThisType) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "undefine", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROP extends string, PROPS extends INSTANCE & Record>(this: CLASS, name: PROP) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "observe", "kind": "field", "static": true, "description": "Creates observable properties on instances", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends IDLParameter, VALUE extends { [KEY in keyof PROPS]: PROPS[KEY] extends (...args2: any[]) => infer R ? R : PROPS[KEY] extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : PROPS[KEY] extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : PROPS[KEY] extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : PROPS[KEY] extends ObserverOptions ? (unknown extends R ? string : R) : never; }>(this: CLASS, props: PROPS) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "defineStatic", "kind": "field", "static": true, "type": { "text": ">(this: T1, props: T2) => T1 & ParsedProps" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "events", "kind": "field", "static": true, "type": { "text": "(this: T, listeners?: CompositionEventListenerObject>, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "childEvents", "kind": "field", "static": true, "type": { "text": "(this: T, listenerMap: { [x: string]: CompositionEventListenerObject>; }, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "rootEvents", "kind": "field", "static": true, "type": { "text": "(this: T, listeners?: CompositionEventListenerObject>, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "on", "kind": "field", "static": true, "type": { "text": ", T3 extends CompositionCallback, T4 extends keyof T3>(this: T1, name: T3 | T4, callbacks?: T3[T4] & ThisType) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "off", "kind": "field", "static": true, "type": { "text": ", T3 extends CompositionCallback, T4 extends keyof T3>(this: T1, name: T3 | T4, callbacks?: T3[T4] & ThisType) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "offPropChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: ObjectOrObjectEntries<{ [P in keyof T2]?: (this: T2, oldValue: T2[P], newValue: T2[P], changes: any, element: T2) => void; }>) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "offAttributeChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: { [x: string]: (this: T2, oldValue: string, newValue: string, element: T2) => void; }) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "onPropChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: ObjectOrObjectEntries<{ [P in keyof T2]?: (this: T2, oldValue: T2[P], newValue: T2[P], changes: any, element: T2) => void; }>) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "onAttributeChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: { [x: string]: (this: T2, oldValue: string, newValue: string, element: T2) => void; }) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } } ], "slots": [ { "name": "", "description": "" } ], "cssParts": [], "events": [ { "name": "open", "type": { "text": "Event" } }, { "name": "drag-handle-active", "type": { "text": "Event" } }, { "name": "drag-handle-inactive", "type": { "text": "Event" } }, { "name": "pointer-or-touch-move", "type": { "text": "Event" } } ], "demos": [ { "url": "demo/components/bottomsheet.html" } ], "superclass": { "module": "core/CustomElement.js", "name": "default" }, "mixins": [ { "module": "mixins/ThemableMixin.js", "name": "default" }, { "module": "mixins/FlexboxMixin.js", "name": "default" }, { "module": "mixins/ShapeMixin.js", "name": "default" }, { "module": "mixins/AriaReflectorMixin.js", "name": "default" }, { "module": "mixins/DelegatesFocusMixin.js", "name": "default" }, { "module": "mixins/ResizeObserverMixin.js", "name": "default" } ], "description": "Bottom sheets show secondary content anchored to the bottom of the screen\n@see https://m3.material.io/components/bottom-sheets/specs" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "default", "module": "components/BottomSheet.js" } }, { "kind": "custom-element-definition", "name": "mdw-bottom-sheet", "declaration": { "name": "default", "module": "components/BottomSheet.js" } } ] }, { "kind": "javascript-module", "path": "components/Box.js", "declarations": [ { "kind": "class", "name": "Box", "tagName": "mdw-box", "customElement": true, "attributes": [ { "name": "color", "fieldName": "color", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "ink", "fieldName": "ink", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "type-style", "fieldName": "typeStyle", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "block", "fieldName": "block", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/FlexboxMixin.js" } }, { "name": "inline", "fieldName": "inline", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/FlexboxMixin.js" } }, { "name": "row", "fieldName": "row", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/FlexboxMixin.js" } }, { "name": "x", "fieldName": "x", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/FlexboxMixin.js" } }, { "name": "y", "fieldName": "y", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/FlexboxMixin.js" } }, { "name": "gap", "fieldName": "gap", "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "mixins/FlexboxMixin.js" } }, { "name": "padding", "fieldName": "padding", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/FlexboxMixin.js" } } ], "members": [ { "name": "block", "kind": "field", "description": "Set `display: block` on the host (boolean)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js#L9" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/FlexboxMixin.js" } }, { "name": "inline", "kind": "field", "description": "Use inline flex layout: `display: inline-flex` (boolean)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js#L11" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/FlexboxMixin.js" } }, { "name": "row", "kind": "field", "description": "Switch main axis to horizontal: `flex-direction: row` (boolean)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js#L13" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/FlexboxMixin.js" } }, { "name": "x", "kind": "field", "description": "Main-axis alignment / justification.\nAllowed: 'start'|'center'|'end'|'between'|'around'|'stretch'|'baseline'.\nDefault: 'start'.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js#L19" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/FlexboxMixin.js" } }, { "name": "y", "kind": "field", "description": "Cross-axis alignment / alignment of items.\nSame allowed values as `x`. Default: 'start'.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js#L29" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/FlexboxMixin.js" } }, { "name": "gap", "kind": "field", "description": "Gap between children. Accepts preset numeric strings (e.g. '8') mapped to px, or floats.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js#L36" }, "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "mixins/FlexboxMixin.js" } }, { "name": "padding", "kind": "field", "description": "Padding preset or numeric value (e.g. 'pane', '8', '16').", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js#L38" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/FlexboxMixin.js" } }, { "name": "color", "kind": "field", "description": "Palette or surface token used to select background/ink tokens.\nExamples: 'primary', 'background', 'surface-container-low'.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L52" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "ink", "kind": "field", "description": "Explicit ink override token (e.g. 'outline', 'on-primary', 'inverse-on-surface', 'inherit').\nMaps to `--mdw-ink`.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L57" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "typeStyle", "kind": "field", "description": "Typographic style shortcut that maps to type scale variables\n(e.g. 'headline-large', 'body-medium').", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L62" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "prototype", "kind": "field", "static": true, "type": { "text": "CustomElement" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "compose", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L145" }, "type": { "text": "(parts: CompositionPart[]) => Composition" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#refsProxy", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1145" }, "type": { "text": "Record" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#refsCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1148" }, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#refsCompositionCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1151" }, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#composition", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1154" }, "type": { "text": "Composition" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#patching", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1156" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#pendingPatchRenders", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1159" }, "type": { "text": "[string, any, CustomElement][]" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#propAttributeCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1162" }, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#callbackArguments", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1165" }, "type": { "text": "CallbackArguments" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "elementInternals", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1172" }, "type": { "text": "ElementInternals" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "render", "kind": "field", "description": "Updates nodes based on data\nExpects data in JSON Merge Patch format", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1185" }, "type": { "text": "RenderDraw" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "propChangedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1213" }, "type": { "text": "(this: T, name: K, oldValue: K extends keyof T ? T[K] : unknown, newValue: K extends keyof T ? T[K] : unknown, changes?: K extends keyof T ? T[K] extends object ? Partial : T[K] : unknown) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attributeChangedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1234" }, "type": { "text": "(name: string, oldValue: string, newValue: string) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#template", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1284" }, "type": { "text": "DocumentFragment" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#onObserverPropertyChanged", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1294" }, "type": { "text": "(name: string, oldValue: any, newValue: any, changes: any) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "static", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1330" }, "type": { "text": "typeof CustomElement" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "patch", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1333" }, "type": { "text": "(patch: any) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "refs", "kind": "field", "description": "Proxy object that returns shadow DOM elements by tag.\nIf called before interpolation (eg: on composed), returns from template", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1404" }, "type": { "text": "Record" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attributeCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1391" }, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "callbackArguments", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1400" }, "type": { "text": "CallbackArguments | { composition: Composition; refs: Record; html: any; inline: (fn: (data: Partial) => any) => string; template: DocumentFragment; element: T; }" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "composition", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1403" }, "type": { "text": "Composition" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "connectedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1435" }, "type": { "text": "() => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "disconnectedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1441" }, "type": { "text": "() => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "delegatesFocus", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1175" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "elementName", "kind": "field", "static": true, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "observedAttributes", "kind": "field", "static": true, "type": { "text": "Iterable" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "interpolatesTemplate", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "supportsElementInternals", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "supportsElementInternalsRole", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "defined", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "registrations", "kind": "field", "static": true, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "expressions", "kind": "method", "static": true, "description": "Expressions are idempotent functions that are selectively called whenever\na render is requested.\nExpressions are constructed exactly as methods though differ in expected\narguments. The first argument should be destructured to ensure each used\nproperty is accessed at least once in order to inspect used properties.\n\nThe Composition API will inspect this function with a proxy for `this` to\ncatalog what observables are used by the expression. This allows the\nComposition API to build a cache as well as selective invoke the expression\nonly when needed.\n\nWhen used with in element templates, the element itself will be passed as\nits first argument.\n````js\n Button\n .prop('filled', 'boolean')\n .prop('outlined', 'boolean')\n .expresssions({\n _isFilledOrOutlined({filled, outlined}) {\n return (filled || outlined)\n },\n })\n .html`
`;\n````\n\nWhen used with external data source, that data source\nwill be passed to the expression with all properties being `null` at first\ninspection.\n````js\n const externalData = {first: 'John', last: 'Doe'};\n ContactCard\n .expresssions({\n _fullName({first, last}) {\n return [first, last].filter(Boolean).join(' ');\n },\n })\n myButton.render(externalData);\n````\n\nExpressions may be support argumentless calls by using default\nparameters with `this`.\n````js\n Button\n .expresssions({\n isFilledOrOutlined({filled, outlined} = this) {\n return (filled || outlined)\n },\n });\n myButton.isFilledorOutlined();\n````", "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends { [K in keyof any]: K extends `_${any}` ? ((data: INSTANCE, state?: Record) => string | boolean | null) : ((data?: INSTANCE, state?: Record) => string | boolean | null); } & ThisType>(this: CLASS, expressions: PROPS & ThisType) => CLASS & Class<{ [K in keyof PROPS]: K extends `_${any}` ? never : () => ReturnType; }, ARGS>" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "methods", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "overrides", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends Partial>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "props", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "idl", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "append", "kind": "field", "static": true, "description": "Append parts to composition", "type": { "text": "(this: T, ...parts: CompositionPart[]) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "recompose", "kind": "field", "static": true, "description": "After composition, invokes callback.\nMay be called multiple times.", "type": { "text": ", T3 extends CompositionCallback[\"composed\"]>(this: T1, callback: T3) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "css", "kind": "field", "static": true, "description": "Appends styles to composition", "type": { "text": "(this: T1, array: T2, ...rest: T2 extends string ? any : T2 extends TemplateStringsArray ? any[] : (HTMLStyleElement | CSSStyleSheet)[]) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "autoRegister", "kind": "field", "static": true, "description": "Registers class with customElements. If class is registered before then,\ndoes nothing.", "type": { "text": "(this: T, elementName: string) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "html", "kind": "field", "static": true, "description": "Appends DocumentFragment to composition", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1405" }, "type": { "text": "(this: T, string: TemplateStringsArray, ...substitutions: (string | Element | ((this: InstanceType, data: InstanceType, injections?: any) => any))[]) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "extend", "kind": "field", "static": true, "description": "Extends base class into a new class.\nUse to avoid mutating base class.", "type": { "text": " T2>(this: T1, customExtender?: T3) => T3 extends null ? T1 : T2" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "setStatic", "kind": "field", "static": true, "description": "Assigns static values to class", "type": { "text": " any) | string | number | boolean | any[] | object); }>(this: T1, source: T2 & ThisType) => T1 & T2" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "readonly", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "set", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "mixin", "kind": "field", "static": true, "description": "Returns result of calling mixin with current class", "type": { "text": " any, RETURN extends ReturnType, SUBCLASS extends ClassOf>(this: BASE, mixin: FN) => SUBCLASS & BASE" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "register", "kind": "field", "static": true, "description": "Registers class with window.customElements synchronously", "type": { "text": "(this: T, elementName?: string, force?: boolean) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "propList", "kind": "field", "static": true, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attrList", "kind": "field", "static": true, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "propChangedCallbacks", "kind": "field", "static": true, "type": { "text": "Map any)[]>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attributeChangedCallbacks", "kind": "field", "static": true, "type": { "text": "Map any)[]>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "prop", "kind": "field", "static": true, "description": "Creates observable property on instances (via prototype)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1007" }, "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "setPrototype", "kind": "field", "static": true, "description": "Creates observable property on instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any)>(this: CLASS, name: KEY, options: OPTIONS) => OPTIONS extends (...args2: any[]) => infer R ? R : OPTIONS extends ObserverPropertyType ? ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? unknown extends R ? object : R : OPTIONS extends { type: ObserverPropertyType; } ? ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? unknown extends R ? string : R : never" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "define", "kind": "field", "static": true, "description": "Define properties on instances via Object.defineProperties().\nAutomatically sets property non-enumerable if name begins with `_`.\nFunctions will be remapped as getters", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends { [P in keyof any]: { enumerable?: boolean; configurable?: boolean; writable?: boolean; value?: any; get?: ((this: INSTANCE) => any); set?: (this: INSTANCE, value: any) => void; } | ((this: INSTANCE, ...args: any[]) => any); }, VALUE extends { [KEY in keyof PROPS]: PROPS[KEY] extends (...args2: any[]) => infer R ? R : PROPS[KEY] extends TypedPropertyDescriptor ? R : never; }>(this: CLASS, props: PROPS & ThisType) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "undefine", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROP extends string, PROPS extends INSTANCE & Record>(this: CLASS, name: PROP) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "observe", "kind": "field", "static": true, "description": "Creates observable properties on instances", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends IDLParameter, VALUE extends { [KEY in keyof PROPS]: PROPS[KEY] extends (...args2: any[]) => infer R ? R : PROPS[KEY] extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : PROPS[KEY] extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : PROPS[KEY] extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : PROPS[KEY] extends ObserverOptions ? (unknown extends R ? string : R) : never; }>(this: CLASS, props: PROPS) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "defineStatic", "kind": "field", "static": true, "type": { "text": ">(this: T1, props: T2) => T1 & ParsedProps" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "events", "kind": "field", "static": true, "type": { "text": "(this: T, listeners?: CompositionEventListenerObject>, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "childEvents", "kind": "field", "static": true, "type": { "text": "(this: T, listenerMap: { [x: string]: CompositionEventListenerObject>; }, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "rootEvents", "kind": "field", "static": true, "type": { "text": "(this: T, listeners?: CompositionEventListenerObject>, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "on", "kind": "field", "static": true, "type": { "text": ", T3 extends CompositionCallback, T4 extends keyof T3>(this: T1, name: T3 | T4, callbacks?: T3[T4] & ThisType) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "off", "kind": "field", "static": true, "type": { "text": ", T3 extends CompositionCallback, T4 extends keyof T3>(this: T1, name: T3 | T4, callbacks?: T3[T4] & ThisType) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "offPropChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: ObjectOrObjectEntries<{ [P in keyof T2]?: (this: T2, oldValue: T2[P], newValue: T2[P], changes: any, element: T2) => void; }>) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "offAttributeChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: { [x: string]: (this: T2, oldValue: string, newValue: string, element: T2) => void; }) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "onPropChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: ObjectOrObjectEntries<{ [P in keyof T2]?: (this: T2, oldValue: T2[P], newValue: T2[P], changes: any, element: T2) => void; }>) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "onAttributeChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: { [x: string]: (this: T2, oldValue: string, newValue: string, element: T2) => void; }) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } } ], "slots": [ { "name": "", "description": "" } ], "cssParts": [], "events": [], "demos": [], "superclass": { "module": "core/CustomElement.js", "name": "default" }, "mixins": [ { "module": "mixins/ThemableMixin.js", "name": "default" }, { "module": "mixins/FlexboxMixin.js", "name": "default" } ], "description": "Boxes are stateless elements that may have a color and ink.\nThey should have simple geometry for rendering and layout." } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "default", "module": "components/Box.js" } }, { "kind": "custom-element-definition", "name": "mdw-box", "declaration": { "name": "default", "module": "components/Box.js" } } ] }, { "kind": "javascript-module", "path": "components/Button.js", "declarations": [ { "kind": "class", "name": "Button", "tagName": "mdw-button", "customElement": true, "attributes": [ { "name": "color", "fieldName": "color", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "ink", "fieldName": "ink", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "type-style", "fieldName": "typeStyle", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "density", "fieldName": "density", "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "mixins/DensityMixin.js" } }, { "name": "disabled", "fieldName": "disabled", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "focused", "fieldName": "focused", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "hovered", "fieldName": "hovered", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "pressed", "fieldName": "pressed", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "shape-top", "fieldName": "shapeTop", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shape-bottom", "fieldName": "shapeBottom", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shape-start", "fieldName": "shapeStart", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shape-end", "fieldName": "shapeEnd", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shape-style", "fieldName": "shapeStyle", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "outlined", "description": "Whether the button should render an outline.", "fieldName": "outlined", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "aria-controls", "fieldName": "ariaControls", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "autocomplete", "fieldName": "autocomplete", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "name", "fieldName": "name", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "readonly", "fieldName": "readOnly", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "formnovalidate", "fieldName": "formNoValidate", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "checked", "fieldName": "defaultChecked", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "required", "fieldName": "required", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "type", "description": "The underlying control `type` (button, submit, reset, file).", "fieldName": "type", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "value", "fieldName": "_defaultValue", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "aria-label", "fieldName": "ariaLabel", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "accept", "fieldName": "accept", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "alt", "fieldName": "alt", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "dirname", "fieldName": "dirName", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "formenctype", "fieldName": "formEnctype", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "formmethod", "fieldName": "formMethod", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "formtarget", "fieldName": "formTarget", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "max", "fieldName": "max", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "maxlength", "fieldName": "maxLength", "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "min", "fieldName": "min", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "minlength", "fieldName": "minLength", "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "multiple", "fieldName": "multiple", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "pattern", "fieldName": "pattern", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "placeholder", "fieldName": "placeholder", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "size", "fieldName": "size", "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "src", "description": "Image source URL for an icon.", "fieldName": "src", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "step", "fieldName": "step", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "indeterminate", "fieldName": "indeterminate", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "href", "fieldName": "href", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/HyperlinkMixin.js" } }, { "name": "target", "fieldName": "target", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/HyperlinkMixin.js" } }, { "name": "download", "fieldName": "download", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/HyperlinkMixin.js" } }, { "name": "ping", "fieldName": "ping", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/HyperlinkMixin.js" } }, { "name": "rel", "fieldName": "rel", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/HyperlinkMixin.js" } }, { "name": "hreflang", "fieldName": "hreflang", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/HyperlinkMixin.js" } }, { "name": "referrerpolicy", "fieldName": "referrerPolicy", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/HyperlinkMixin.js" } }, { "name": "elevated", "description": "Bound to [elevated] specifying whether the element should be elevated.", "fieldName": "elevated", "type": { "text": "boolean" } }, { "name": "filled", "description": "Visual filled variant; may be \"tonal\" or boolean-filled token.", "fieldName": "filled", "type": { "text": "string" } }, { "name": "icon", "description": "Icon name (uses internal `mdw-icon` when set).", "fieldName": "icon", "type": { "text": "string" } }, { "name": "icon-ink", "description": "Ink color override for the icon.", "fieldName": "iconInk", "type": { "text": "string" } }, { "name": "svg", "description": "Inline SVG markup to render as icon.", "fieldName": "svg", "type": { "text": "string" } }, { "name": "view-box", "description": "SVG `viewBox` attribute for inline SVG icons.", "fieldName": "viewBox", "type": { "text": "string" } }, { "name": "svg-path", "description": "Path data for an inline SVG icon.", "fieldName": "svgPath", "type": { "text": "string" } }, { "name": "state-layer", "type": { "text": "boolean" }, "description": "Show the visual state layer element when true", "fieldName": "stateLayer", "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } } ], "members": [ { "name": "delegatesFocus", "kind": "field", "description": "When true, the element delegates focus to an internal focus target.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/DelegatesFocusMixin.js#L15" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "href", "kind": "field", "description": "The URL that the hyperlink points to.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L34" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/HyperlinkMixin.js" } }, { "name": "target", "kind": "field", "description": "The browsing context in which to open the linked resource (e.g. '_blank').", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L36" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/HyperlinkMixin.js" } }, { "name": "download", "kind": "field", "description": "Suggested filename for download.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L38" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/HyperlinkMixin.js" } }, { "name": "ping", "kind": "field", "description": "URLs to be pinged when the link is followed.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L40" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/HyperlinkMixin.js" } }, { "name": "rel", "kind": "field", "description": "Link relationship tokens (e.g. 'noopener', 'noreferrer').", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L42" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/HyperlinkMixin.js" } }, { "name": "hreflang", "kind": "field", "description": "Language of the linked resource.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L44" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/HyperlinkMixin.js" } }, { "name": "referrerPolicy", "kind": "field", "description": "Referrer policy for the link (serialized to 'referrerpolicy' attribute).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L46" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/HyperlinkMixin.js" } }, { "name": "origin", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L49" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/HyperlinkMixin.js" } }, { "name": "protocol", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L50" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/HyperlinkMixin.js" } }, { "name": "username", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L51" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/HyperlinkMixin.js" } }, { "name": "password", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L52" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/HyperlinkMixin.js" } }, { "name": "host", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L53" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/HyperlinkMixin.js" } }, { "name": "hostname", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L54" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/HyperlinkMixin.js" } }, { "name": "port", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L55" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/HyperlinkMixin.js" } }, { "name": "pathname", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L56" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/HyperlinkMixin.js" } }, { "name": "search", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L57" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/HyperlinkMixin.js" } }, { "name": "hash", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L58" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/HyperlinkMixin.js" } }, { "name": "disabled", "kind": "field", "description": "Whether the element is disabled (affects interactive states)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L14" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "focused", "kind": "field", "description": "Force focus state (independent of document)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L16" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "hovered", "kind": "field", "description": "Force hover state (independent of interaction)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L18" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "pressed", "kind": "field", "description": "Force pressed state (independent of interaction)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L20" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "stateLayer", "kind": "field", "description": "Show the visual state layer element when true", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Button.js#L37" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "disabledState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L171" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "hoveredState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L38" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "focusedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L39" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "pressedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L40" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "touchedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L41" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "pointedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L44" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "stateTargetElement", "kind": "field", "description": "Returns the element used as the state target for visual states\n(e.g., pressed/hover). Typically the internal control element.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Button.js#L34" }, "type": { "text": "HTMLElement" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "ariaControls", "kind": "field", "description": "ARIA 'controls' attribute (string).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L32" }, "type": { "text": "string" } }, { "name": "autocomplete", "kind": "field", "description": "Autocomplete token for the associated control (string).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L34" }, "type": { "text": "string" } }, { "name": "name", "kind": "field", "description": "Name attribute for the control used in forms.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L36" }, "type": { "text": "string" } }, { "name": "readOnly", "kind": "field", "description": "Read-only state reflected to control via 'readonly' attribute.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L38" }, "type": { "text": "boolean" } }, { "name": "formNoValidate", "kind": "field", "description": "When true, form validation is skipped for this control (formnovalidate).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L40" }, "type": { "text": "boolean" } }, { "name": "defaultChecked", "kind": "field", "description": "Default checked state for checkable controls (checkbox/radio).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L42" }, "type": { "text": "boolean" } }, { "name": "required", "kind": "field", "description": "Whether the control is required for form submission.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L47" }, "type": { "text": "boolean" } }, { "name": "type", "kind": "field", "description": "Control type token (e.g. 'text','checkbox','radio','file').\nThe underlying control `type` (button, submit, reset, file).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Button.js#L42" }, "type": { "text": "string" } }, { "name": "erroredState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L65" }, "type": { "text": "boolean" } }, { "name": "defaultValue", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L66" }, "type": { "text": "string" } }, { "name": "value", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L108" }, "type": { "text": "string" } }, { "name": "checked", "kind": "field", "description": "Part of FormAssociatedMixin for simplicity.\nEnumerability doesn't guarantee checked state will be passed or used.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L145" }, "type": { "text": "boolean" } }, { "name": "form", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L160" }, "type": { "text": "HTMLFormElement" } }, { "name": "validity", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L161" }, "type": { "text": "ValidityState" } }, { "name": "validationMessage", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L162" }, "type": { "text": "string" } }, { "name": "willValidate", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L163" }, "type": { "text": "boolean" } }, { "name": "labels", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L168" }, "type": { "text": "NodeList" } }, { "name": "focusableOnDisabled", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ControlMixin.js#L30" }, "type": { "text": "boolean" } }, { "name": "controlTagName", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L102" }, "type": { "text": "string" } }, { "name": "controlVoidElement", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ControlMixin.js#L32" }, "type": { "text": "boolean" } }, { "name": "accept", "kind": "field", "description": "Accepted file types for file input (e.g. '.png,.jpg').", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L41" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "alt", "kind": "field", "description": "Alternate text for images (for `type='image'`).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L43" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "dirName", "kind": "field", "description": "Directionality for form submission name (dirname attribute).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L45" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "formEnctype", "kind": "field", "description": "Form encoding type (formenctype).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L49" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "formMethod", "kind": "field", "description": "Form method when associated with a submit input (formmethod).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L51" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "formTarget", "kind": "field", "description": "Target browsing context for form submission (formtarget).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L53" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "max", "kind": "field", "description": "Max value or token for the input.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L58" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "maxLength", "kind": "field", "description": "Maximum length for text-like inputs.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L60" }, "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "min", "kind": "field", "description": "Min value or token for the input.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L62" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "minLength", "kind": "field", "description": "Minimum length for text-like inputs.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L64" }, "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "multiple", "kind": "field", "description": "When true, multiple values are allowed (e.g. file inputs).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L66" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "pattern", "kind": "field", "description": "Pattern used for validation (RegExp as string).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L68" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "placeholder", "kind": "field", "description": "Placeholder text shown when no value is present.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L70" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "size", "kind": "field", "description": "Suggested control size (number of characters).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L72" }, "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "src", "kind": "field", "description": "Source URL for image-type inputs.\nImage source URL for an icon.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Button.js#L69" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "step", "kind": "field", "description": "Step interval for numeric inputs.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L76" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "indeterminate", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L89" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "files", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L371" }, "type": { "text": "FileList" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "selectionDirection", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L384" }, "type": { "text": "\"none\" | \"forward\" | \"backward\"" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "selectionEnd", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L389" }, "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "selectionStart", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L394" }, "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "valueAsDate", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L399" }, "type": { "text": "Date" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "valueAsNumber", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L407" }, "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "height", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L415" }, "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "formAction", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L423" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "width", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L431" }, "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "color", "kind": "field", "description": "Palette or surface token used to select background/ink tokens.\nExamples: 'primary', 'background', 'surface-container-low'.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L52" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "ink", "kind": "field", "description": "Explicit ink override token (e.g. 'outline', 'on-primary', 'inverse-on-surface', 'inherit').\nMaps to `--mdw-ink`.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L57" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "typeStyle", "kind": "field", "description": "Typographic style shortcut that maps to type scale variables\n(e.g. 'headline-large', 'body-medium').", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L62" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "shapeTop", "kind": "field", "description": "Show top cut/shape on the element", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L9" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shapeBottom", "kind": "field", "description": "Show bottom cut/shape on the element", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L11" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shapeStart", "kind": "field", "description": "Show start-side cut/shape (logical start)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L13" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shapeEnd", "kind": "field", "description": "Show end-side cut/shape (logical end)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L15" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shapeStyle", "kind": "field", "description": "Predefined shape size/style name (none|extra-small|small|medium|large|extra-large|full|inherit)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L17" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "outlined", "kind": "field", "description": "When true, an outline is rendered around the element\nWhether the button should render an outline.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Button.js#L62" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "density", "kind": "field", "description": "Density level affecting spacing and compactness. Integer from -4 (dense) to 4 (spacious).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/DensityMixin.js#L9" }, "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "mixins/DensityMixin.js" } }, { "name": "elevated", "kind": "field", "description": "Bound to [elevated] specifying whether the element should be elevated.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Button.js#L58" }, "type": { "text": "boolean" } }, { "name": "filled", "kind": "field", "description": "Visual filled variant; may be \"tonal\" or boolean-filled token.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Button.js#L60" }, "type": { "text": "string" } }, { "name": "icon", "kind": "field", "description": "Icon name (uses internal `mdw-icon` when set).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Button.js#L64" }, "type": { "text": "string" } }, { "name": "iconInk", "kind": "field", "description": "Ink color override for the icon.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Button.js#L66" }, "type": { "text": "string" } }, { "name": "svg", "kind": "field", "description": "Inline SVG markup to render as icon.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Button.js#L71" }, "type": { "text": "string" } }, { "name": "viewBox", "kind": "field", "description": "SVG `viewBox` attribute for inline SVG icons.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Button.js#L73" }, "type": { "text": "string" } }, { "name": "svgPath", "kind": "field", "description": "Path data for an inline SVG icon.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Button.js#L75" }, "type": { "text": "string" } }, { "name": "hasIcon", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Button.js#L78" }, "return": { "type": { "text": "() => string" } } }, { "name": "iconVariation", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Button.js#L81" }, "return": { "type": { "text": "() => string" } } }, { "name": "prototype", "kind": "field", "static": true, "type": { "text": "CustomElement" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "addRipple", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/RippleMixin.js#L37" }, "return": { "type": { "text": "(x?: number, y?: number, hold?: boolean) => CustomElement & { hadRippleHeld: boolean; hadRippleReleased: boolean; rippleStarted: boolean; } & { rippleState: string; keepAlive: boolean; _positionX: number; _positionY: number; _radius: number; holdRipple: boolean; } & { _positionStyle: ElementStylerOptions | { styles: { minHeight: string; minWidth: string; boxShadow: string; top: string; left: string; }; }; } & { updatePosition(x?: number, y?: number, size?: number): void; handleRippleComplete(): void; }" } }, "inheritedFrom": { "name": "default", "module": "mixins/RippleMixin.js" } }, { "name": "performImplicitSubmission", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L175" }, "return": { "type": { "text": "(event: Event) => void" } }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "setRangeText", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L345" }, "return": { "type": { "text": "{ (replacement: string): void; (replacement: string, start: number, end: number, selectionMode?: SelectionMode): void; }" } }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "setSelectionRange", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L348" }, "return": { "type": { "text": "(start: number, end: number, direction?: \"none\" | \"forward\" | \"backward\") => void" } }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "showPicker", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L351" }, "return": { "type": { "text": "() => void" } }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "stepDown", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L354" }, "return": { "type": { "text": "(n?: number) => void" } }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "stepUp", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L360" }, "return": { "type": { "text": "(n?: number) => void" } }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "select", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L366" }, "return": { "type": { "text": "() => void" } }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "compose", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L145" }, "type": { "text": "(parts: CompositionPart[]) => Composition" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#refsProxy", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1145" }, "type": { "text": "Record" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#refsCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1148" }, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#refsCompositionCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1151" }, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#composition", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1154" }, "type": { "text": "Composition" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#patching", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1156" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#pendingPatchRenders", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1159" }, "type": { "text": "[string, any, CustomElement][]" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#propAttributeCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1162" }, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#callbackArguments", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1165" }, "type": { "text": "CallbackArguments" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "elementInternals", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1172" }, "type": { "text": "ElementInternals" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "render", "kind": "field", "description": "Updates nodes based on data\nExpects data in JSON Merge Patch format", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1185" }, "type": { "text": "RenderDraw" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "propChangedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1213" }, "type": { "text": "(this: T, name: K, oldValue: K extends keyof T ? T[K] : unknown, newValue: K extends keyof T ? T[K] : unknown, changes?: K extends keyof T ? T[K] extends object ? Partial : T[K] : unknown) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attributeChangedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1234" }, "type": { "text": "(name: string, oldValue: string, newValue: string) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#template", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1284" }, "type": { "text": "DocumentFragment" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#onObserverPropertyChanged", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1294" }, "type": { "text": "(name: string, oldValue: any, newValue: any, changes: any) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "static", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1330" }, "type": { "text": "typeof CustomElement" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "patch", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1333" }, "type": { "text": "(patch: any) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "refs", "kind": "field", "description": "Proxy object that returns shadow DOM elements by tag.\nIf called before interpolation (eg: on composed), returns from template", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1404" }, "type": { "text": "Record" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attributeCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1391" }, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "callbackArguments", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1400" }, "type": { "text": "CallbackArguments | { composition: Composition; refs: Record; html: any; inline: (fn: (data: Partial) => any) => string; template: DocumentFragment; element: T; }" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "composition", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1403" }, "type": { "text": "Composition" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "connectedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1435" }, "type": { "text": "() => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "disconnectedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1441" }, "type": { "text": "() => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "elementName", "kind": "field", "static": true, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "observedAttributes", "kind": "field", "static": true, "type": { "text": "Iterable" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "interpolatesTemplate", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "supportsElementInternals", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "supportsElementInternalsRole", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "defined", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "registrations", "kind": "field", "static": true, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "expressions", "kind": "method", "static": true, "description": "Expressions are idempotent functions that are selectively called whenever\na render is requested.\nExpressions are constructed exactly as methods though differ in expected\narguments. The first argument should be destructured to ensure each used\nproperty is accessed at least once in order to inspect used properties.\n\nThe Composition API will inspect this function with a proxy for `this` to\ncatalog what observables are used by the expression. This allows the\nComposition API to build a cache as well as selective invoke the expression\nonly when needed.\n\nWhen used with in element templates, the element itself will be passed as\nits first argument.\n````js\n Button\n .prop('filled', 'boolean')\n .prop('outlined', 'boolean')\n .expresssions({\n _isFilledOrOutlined({filled, outlined}) {\n return (filled || outlined)\n },\n })\n .html`
`;\n````\n\nWhen used with external data source, that data source\nwill be passed to the expression with all properties being `null` at first\ninspection.\n````js\n const externalData = {first: 'John', last: 'Doe'};\n ContactCard\n .expresssions({\n _fullName({first, last}) {\n return [first, last].filter(Boolean).join(' ');\n },\n })\n myButton.render(externalData);\n````\n\nExpressions may be support argumentless calls by using default\nparameters with `this`.\n````js\n Button\n .expresssions({\n isFilledOrOutlined({filled, outlined} = this) {\n return (filled || outlined)\n },\n });\n myButton.isFilledorOutlined();\n````", "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends { [K in keyof any]: K extends `_${any}` ? ((data: INSTANCE, state?: Record) => string | boolean | null) : ((data?: INSTANCE, state?: Record) => string | boolean | null); } & ThisType>(this: CLASS, expressions: PROPS & ThisType) => CLASS & Class<{ [K in keyof PROPS]: K extends `_${any}` ? never : () => ReturnType; }, ARGS>" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "methods", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "overrides", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends Partial>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "props", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "idl", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "append", "kind": "field", "static": true, "description": "Append parts to composition", "type": { "text": "(this: T, ...parts: CompositionPart[]) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "recompose", "kind": "field", "static": true, "description": "After composition, invokes callback.\nMay be called multiple times.", "type": { "text": ", T3 extends CompositionCallback[\"composed\"]>(this: T1, callback: T3) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "css", "kind": "field", "static": true, "description": "Appends styles to composition", "type": { "text": "(this: T1, array: T2, ...rest: T2 extends string ? any : T2 extends TemplateStringsArray ? any[] : (HTMLStyleElement | CSSStyleSheet)[]) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "autoRegister", "kind": "field", "static": true, "description": "Registers class with customElements. If class is registered before then,\ndoes nothing.", "type": { "text": "(this: T, elementName: string) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "html", "kind": "field", "static": true, "description": "Appends DocumentFragment to composition", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1405" }, "type": { "text": "(this: T, string: TemplateStringsArray, ...substitutions: (string | Element | ((this: InstanceType, data: InstanceType, injections?: any) => any))[]) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "extend", "kind": "field", "static": true, "description": "Extends base class into a new class.\nUse to avoid mutating base class.", "type": { "text": " T2>(this: T1, customExtender?: T3) => T3 extends null ? T1 : T2" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "setStatic", "kind": "field", "static": true, "description": "Assigns static values to class", "type": { "text": " any) | string | number | boolean | any[] | object); }>(this: T1, source: T2 & ThisType) => T1 & T2" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "readonly", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "set", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "mixin", "kind": "field", "static": true, "description": "Returns result of calling mixin with current class", "type": { "text": " any, RETURN extends ReturnType, SUBCLASS extends ClassOf>(this: BASE, mixin: FN) => SUBCLASS & BASE" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "register", "kind": "field", "static": true, "description": "Registers class with window.customElements synchronously", "type": { "text": "(this: T, elementName?: string, force?: boolean) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "propList", "kind": "field", "static": true, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attrList", "kind": "field", "static": true, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "propChangedCallbacks", "kind": "field", "static": true, "type": { "text": "Map any)[]>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attributeChangedCallbacks", "kind": "field", "static": true, "type": { "text": "Map any)[]>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "prop", "kind": "field", "static": true, "description": "Creates observable property on instances (via prototype)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1007" }, "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "setPrototype", "kind": "field", "static": true, "description": "Creates observable property on instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any)>(this: CLASS, name: KEY, options: OPTIONS) => OPTIONS extends (...args2: any[]) => infer R ? R : OPTIONS extends ObserverPropertyType ? ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? unknown extends R ? object : R : OPTIONS extends { type: ObserverPropertyType; } ? ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? unknown extends R ? string : R : never" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "define", "kind": "field", "static": true, "description": "Define properties on instances via Object.defineProperties().\nAutomatically sets property non-enumerable if name begins with `_`.\nFunctions will be remapped as getters", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends { [P in keyof any]: { enumerable?: boolean; configurable?: boolean; writable?: boolean; value?: any; get?: ((this: INSTANCE) => any); set?: (this: INSTANCE, value: any) => void; } | ((this: INSTANCE, ...args: any[]) => any); }, VALUE extends { [KEY in keyof PROPS]: PROPS[KEY] extends (...args2: any[]) => infer R ? R : PROPS[KEY] extends TypedPropertyDescriptor ? R : never; }>(this: CLASS, props: PROPS & ThisType) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "undefine", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROP extends string, PROPS extends INSTANCE & Record>(this: CLASS, name: PROP) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "observe", "kind": "field", "static": true, "description": "Creates observable properties on instances", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends IDLParameter, VALUE extends { [KEY in keyof PROPS]: PROPS[KEY] extends (...args2: any[]) => infer R ? R : PROPS[KEY] extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : PROPS[KEY] extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : PROPS[KEY] extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : PROPS[KEY] extends ObserverOptions ? (unknown extends R ? string : R) : never; }>(this: CLASS, props: PROPS) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "defineStatic", "kind": "field", "static": true, "type": { "text": ">(this: T1, props: T2) => T1 & ParsedProps" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "events", "kind": "field", "static": true, "type": { "text": "(this: T, listeners?: CompositionEventListenerObject>, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "childEvents", "kind": "field", "static": true, "type": { "text": "(this: T, listenerMap: { [x: string]: CompositionEventListenerObject>; }, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "rootEvents", "kind": "field", "static": true, "type": { "text": "(this: T, listeners?: CompositionEventListenerObject>, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "on", "kind": "field", "static": true, "type": { "text": ", T3 extends CompositionCallback, T4 extends keyof T3>(this: T1, name: T3 | T4, callbacks?: T3[T4] & ThisType) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "off", "kind": "field", "static": true, "type": { "text": ", T3 extends CompositionCallback, T4 extends keyof T3>(this: T1, name: T3 | T4, callbacks?: T3[T4] & ThisType) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "offPropChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: ObjectOrObjectEntries<{ [P in keyof T2]?: (this: T2, oldValue: T2[P], newValue: T2[P], changes: any, element: T2) => void; }>) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "offAttributeChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: { [x: string]: (this: T2, oldValue: string, newValue: string, element: T2) => void; }) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "onPropChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: ObjectOrObjectEntries<{ [P in keyof T2]?: (this: T2, oldValue: T2[P], newValue: T2[P], changes: any, element: T2) => void; }>) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "onAttributeChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: { [x: string]: (this: T2, oldValue: string, newValue: string, element: T2) => void; }) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } } ], "slots": [ { "name": "", "description": "{_defaultValue}" } ], "cssParts": [ { "name": "control" } ], "events": [], "demos": [ { "url": "demo/components/buttons.html" } ], "superclass": { "module": "core/CustomElement.js", "name": "default" }, "mixins": [ { "module": "mixins/ThemableMixin.js", "name": "default" }, { "module": "mixins/DensityMixin.js", "name": "default" }, { "module": "mixins/StateMixin.js", "name": "default" }, { "module": "mixins/ElevationMixin.js", "name": "default" }, { "module": "mixins/ShapeMixin.js", "name": "default" }, { "module": "mixins/RippleMixin.js", "name": "default" }, { "module": "mixins/InputMixin.js", "name": "default" }, { "module": "mixins/HyperlinkMixin.js", "name": "default" } ], "description": "Buttons prompt most actions in a UI.\n@see https://m3.material.io/components/buttons/specs" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "default", "module": "components/Button.js" } }, { "kind": "custom-element-definition", "name": "mdw-button", "declaration": { "name": "default", "module": "components/Button.js" } } ] }, { "kind": "javascript-module", "path": "components/Card.js", "declarations": [ { "kind": "class", "name": "Card", "tagName": "mdw-card", "customElement": true, "attributes": [ { "name": "color", "fieldName": "color", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "ink", "fieldName": "ink", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "type-style", "fieldName": "typeStyle", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "block", "fieldName": "block", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "inline", "fieldName": "inline", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "row", "fieldName": "row", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "x", "fieldName": "x", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "y", "fieldName": "y", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "gap", "fieldName": "gap", "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "padding", "fieldName": "padding", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "disabled", "fieldName": "disabled", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "focused", "fieldName": "focused", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "hovered", "fieldName": "hovered", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "pressed", "fieldName": "pressed", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "state-layer", "fieldName": "stateLayer", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "shape-top", "fieldName": "shapeTop", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shape-bottom", "fieldName": "shapeBottom", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shape-start", "fieldName": "shapeStart", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shape-end", "fieldName": "shapeEnd", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shape-style", "fieldName": "shapeStyle", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "outlined", "fieldName": "outlined", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "aria-controls", "fieldName": "ariaControls", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/FormAssociatedMixin.js" } }, { "name": "autocomplete", "fieldName": "autocomplete", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/FormAssociatedMixin.js" } }, { "name": "name", "fieldName": "name", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/FormAssociatedMixin.js" } }, { "name": "readonly", "fieldName": "readOnly", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/FormAssociatedMixin.js" } }, { "name": "formnovalidate", "fieldName": "formNoValidate", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/FormAssociatedMixin.js" } }, { "name": "checked", "fieldName": "defaultChecked", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/FormAssociatedMixin.js" } }, { "name": "required", "fieldName": "required", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/FormAssociatedMixin.js" } }, { "name": "type", "fieldName": "type", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/FormAssociatedMixin.js" } }, { "name": "value", "fieldName": "_defaultValue", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/FormAssociatedMixin.js" } }, { "name": "href", "fieldName": "href", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/HyperlinkMixin.js" } }, { "name": "target", "fieldName": "target", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/HyperlinkMixin.js" } }, { "name": "download", "fieldName": "download", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/HyperlinkMixin.js" } }, { "name": "ping", "fieldName": "ping", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/HyperlinkMixin.js" } }, { "name": "rel", "fieldName": "rel", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/HyperlinkMixin.js" } }, { "name": "hreflang", "fieldName": "hreflang", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/HyperlinkMixin.js" } }, { "name": "referrerpolicy", "fieldName": "referrerPolicy", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/HyperlinkMixin.js" } }, { "name": "elevated", "description": "Whether the card displays an elevated surface.", "fieldName": "elevated", "type": { "text": "boolean" } }, { "name": "filled", "description": "Whether the card uses a filled surface style.", "fieldName": "filled", "type": { "text": "boolean" } }, { "name": "actionable", "description": "When true, card renders an actionable control (clickable).", "fieldName": "actionable", "type": { "text": "boolean" } }, { "name": "action-label", "description": "Label for the action control used for accessibility.", "fieldName": "actionLabel", "type": { "text": "string" } }, { "name": "onaction", "description": "Event handler called when the card action is triggered.", "fieldName": "onaction", "type": { "text": "function" } } ], "members": [ { "name": "delegatesFocus", "kind": "field", "description": "When true, the element delegates focus to an internal focus target.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/DelegatesFocusMixin.js#L15" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "href", "kind": "field", "description": "The URL that the hyperlink points to.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L34" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/HyperlinkMixin.js" } }, { "name": "target", "kind": "field", "description": "The browsing context in which to open the linked resource (e.g. '_blank').", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L36" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/HyperlinkMixin.js" } }, { "name": "download", "kind": "field", "description": "Suggested filename for download.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L38" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/HyperlinkMixin.js" } }, { "name": "ping", "kind": "field", "description": "URLs to be pinged when the link is followed.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L40" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/HyperlinkMixin.js" } }, { "name": "rel", "kind": "field", "description": "Link relationship tokens (e.g. 'noopener', 'noreferrer').", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L42" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/HyperlinkMixin.js" } }, { "name": "hreflang", "kind": "field", "description": "Language of the linked resource.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L44" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/HyperlinkMixin.js" } }, { "name": "referrerPolicy", "kind": "field", "description": "Referrer policy for the link (serialized to 'referrerpolicy' attribute).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L46" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/HyperlinkMixin.js" } }, { "name": "origin", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L49" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/HyperlinkMixin.js" } }, { "name": "protocol", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L50" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/HyperlinkMixin.js" } }, { "name": "username", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L51" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/HyperlinkMixin.js" } }, { "name": "password", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L52" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/HyperlinkMixin.js" } }, { "name": "host", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L53" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/HyperlinkMixin.js" } }, { "name": "hostname", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L54" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/HyperlinkMixin.js" } }, { "name": "port", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L55" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/HyperlinkMixin.js" } }, { "name": "pathname", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L56" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/HyperlinkMixin.js" } }, { "name": "search", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L57" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/HyperlinkMixin.js" } }, { "name": "hash", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L58" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/HyperlinkMixin.js" } }, { "name": "disabled", "kind": "field", "description": "Whether the element is disabled (affects interactive states)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L14" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "focused", "kind": "field", "description": "Force focus state (independent of document)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L16" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "hovered", "kind": "field", "description": "Force hover state (independent of interaction)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L18" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "pressed", "kind": "field", "description": "Force pressed state (independent of interaction)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L20" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "stateLayer", "kind": "field", "description": "Show the visual state layer element when true", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L34" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "disabledState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L171" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "hoveredState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L38" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "focusedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L39" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "pressedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L40" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "touchedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L41" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "pointedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L44" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "stateTargetElement", "kind": "field", "description": "Element used as the target for state styling (pressed/focus).\nReturns the internal action control when actionable, otherwise the host.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Card.js#L48" }, "type": { "text": "HTMLElement" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "ariaControls", "kind": "field", "description": "ARIA 'controls' attribute (string).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L32" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/FormAssociatedMixin.js" } }, { "name": "autocomplete", "kind": "field", "description": "Autocomplete token for the associated control (string).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L34" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/FormAssociatedMixin.js" } }, { "name": "name", "kind": "field", "description": "Name attribute for the control used in forms.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L36" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/FormAssociatedMixin.js" } }, { "name": "readOnly", "kind": "field", "description": "Read-only state reflected to control via 'readonly' attribute.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L38" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/FormAssociatedMixin.js" } }, { "name": "formNoValidate", "kind": "field", "description": "When true, form validation is skipped for this control (formnovalidate).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L40" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/FormAssociatedMixin.js" } }, { "name": "defaultChecked", "kind": "field", "description": "Default checked state for checkable controls (checkbox/radio).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L42" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/FormAssociatedMixin.js" } }, { "name": "required", "kind": "field", "description": "Whether the control is required for form submission.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L47" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/FormAssociatedMixin.js" } }, { "name": "type", "kind": "field", "description": "Control type token (e.g. 'text','checkbox','radio','file').", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L49" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/FormAssociatedMixin.js" } }, { "name": "erroredState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L65" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/FormAssociatedMixin.js" } }, { "name": "defaultValue", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L66" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/FormAssociatedMixin.js" } }, { "name": "value", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L108" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/FormAssociatedMixin.js" } }, { "name": "checked", "kind": "field", "description": "Part of FormAssociatedMixin for simplicity.\nEnumerability doesn't guarantee checked state will be passed or used.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L145" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/FormAssociatedMixin.js" } }, { "name": "form", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L160" }, "type": { "text": "HTMLFormElement" }, "inheritedFrom": { "name": "default", "module": "mixins/FormAssociatedMixin.js" } }, { "name": "validity", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L161" }, "type": { "text": "ValidityState" }, "inheritedFrom": { "name": "default", "module": "mixins/FormAssociatedMixin.js" } }, { "name": "validationMessage", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L162" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/FormAssociatedMixin.js" } }, { "name": "willValidate", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L163" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/FormAssociatedMixin.js" } }, { "name": "labels", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L168" }, "type": { "text": "NodeList" }, "inheritedFrom": { "name": "default", "module": "mixins/FormAssociatedMixin.js" } }, { "name": "color", "kind": "field", "description": "Palette or surface token used to select background/ink tokens.\nExamples: 'primary', 'background', 'surface-container-low'.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L52" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "ink", "kind": "field", "description": "Explicit ink override token (e.g. 'outline', 'on-primary', 'inverse-on-surface', 'inherit').\nMaps to `--mdw-ink`.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L57" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "typeStyle", "kind": "field", "description": "Typographic style shortcut that maps to type scale variables\n(e.g. 'headline-large', 'body-medium').", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L62" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "shapeTop", "kind": "field", "description": "Show top cut/shape on the element", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L9" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shapeBottom", "kind": "field", "description": "Show bottom cut/shape on the element", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L11" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shapeStart", "kind": "field", "description": "Show start-side cut/shape (logical start)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L13" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shapeEnd", "kind": "field", "description": "Show end-side cut/shape (logical end)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L15" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shapeStyle", "kind": "field", "description": "Predefined shape size/style name (none|extra-small|small|medium|large|extra-large|full|inherit)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L17" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "outlined", "kind": "field", "description": "When true, an outline is rendered around the element", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L19" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "block", "kind": "field", "description": "Set `display: block` on the host (boolean)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js#L9" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "inline", "kind": "field", "description": "Use inline flex layout: `display: inline-flex` (boolean)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js#L11" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "row", "kind": "field", "description": "Switch main axis to horizontal: `flex-direction: row` (boolean)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js#L13" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "x", "kind": "field", "description": "Main-axis alignment / justification.\nAllowed: 'start'|'center'|'end'|'between'|'around'|'stretch'|'baseline'.\nDefault: 'start'.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js#L19" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "y", "kind": "field", "description": "Cross-axis alignment / alignment of items.\nSame allowed values as `x`. Default: 'start'.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js#L29" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "gap", "kind": "field", "description": "Gap between children. Accepts preset numeric strings (e.g. '8') mapped to px, or floats.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js#L36" }, "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "padding", "kind": "field", "description": "Padding preset or numeric value (e.g. 'pane', '8', '16').", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js#L38" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "elevated", "kind": "field", "description": "Whether the card displays an elevated surface.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Card.js#L32" }, "type": { "text": "boolean" } }, { "name": "filled", "kind": "field", "description": "Whether the card uses a filled surface style.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Card.js#L34" }, "type": { "text": "boolean" } }, { "name": "actionable", "kind": "field", "description": "When true, card renders an actionable control (clickable).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Card.js#L36" }, "type": { "text": "boolean" } }, { "name": "actionLabel", "kind": "field", "description": "Label for the action control used for accessibility.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Card.js#L38" }, "type": { "text": "string" } }, { "name": "onaction", "kind": "field", "description": "Event handler called when the card action is triggered.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Card.js#L40" }, "type": { "text": "EventListener" } }, { "name": "showBlocker", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Card.js#L51" }, "return": { "type": { "text": "() => boolean" } } }, { "name": "showButton", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Card.js#L52" }, "return": { "type": { "text": "() => boolean" } } }, { "name": "prototype", "kind": "field", "static": true, "type": { "text": "CustomElement" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "checkValidity", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L177" }, "return": { "type": { "text": "() => boolean" } }, "inheritedFrom": { "name": "default", "module": "mixins/FormAssociatedMixin.js" } }, { "name": "reportValidity", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L179" }, "return": { "type": { "text": "() => boolean" } }, "inheritedFrom": { "name": "default", "module": "mixins/FormAssociatedMixin.js" } }, { "name": "setCustomValidity", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L185" }, "return": { "type": { "text": "(error: string) => void" } }, "inheritedFrom": { "name": "default", "module": "mixins/FormAssociatedMixin.js" } }, { "name": "refreshFormAssociation", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L203" }, "return": { "type": { "text": "() => void" } }, "inheritedFrom": { "name": "default", "module": "mixins/FormAssociatedMixin.js" } }, { "name": "formIPCEvent", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L234" }, "return": { "type": { "text": "(event: CustomEvent<[string, string]>) => void" } }, "inheritedFrom": { "name": "default", "module": "mixins/FormAssociatedMixin.js" } }, { "name": "readAriaProperty", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/AriaReflectorMixin.js#L28" }, "return": { "type": { "text": "(name: \"shadowRoot\" | \"ariaActiveDescendantElement\" | \"ariaAtomic\" | \"ariaAutoComplete\" | \"ariaBrailleLabel\" | \"ariaBrailleRoleDescription\" | \"ariaBusy\" | \"ariaChecked\" | \"ariaColCount\" | \"ariaColIndex\" | \"ariaColIndexText\" | \"ariaColSpan\" | \"ariaControlsElements\" | \"ariaCurrent\" | \"ariaDescribedByElements\" | \"ariaDescription\" | \"ariaDetailsElements\" | \"ariaDisabled\" | \"ariaErrorMessageElements\" | \"ariaExpanded\" | \"ariaFlowToElements\" | \"ariaHasPopup\" | \"ariaHidden\" | \"ariaInvalid\" | \"ariaKeyShortcuts\" | \"ariaLabel\" | \"ariaLabelledByElements\" | \"ariaLevel\" | \"ariaLive\" | \"ariaModal\" | \"ariaMultiLine\" | \"ariaMultiSelectable\" | \"ariaOrientation\" | \"ariaOwnsElements\" | \"ariaPlaceholder\" | \"ariaPosInSet\" | \"ariaPressed\" | \"ariaReadOnly\" | \"ariaRelevant\" | \"ariaRequired\" | \"ariaRoleDescription\" | \"ariaRowCount\" | \"ariaRowIndex\" | \"ariaRowIndexText\" | \"ariaRowSpan\" | \"ariaSelected\" | \"ariaSetSize\" | \"ariaSort\" | \"ariaValueMax\" | \"ariaValueMin\" | \"ariaValueNow\" | \"ariaValueText\" | \"role\") => string | Element | ShadowRoot | readonly Element[]" } }, "inheritedFrom": { "name": "default", "module": "mixins/AriaReflectorMixin.js" } }, { "name": "updateAriaProperty", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/AriaReflectorMixin.js#L47" }, "return": { "type": { "text": ">(name: K, value: ARIAMixin[K]) => void" } }, "inheritedFrom": { "name": "default", "module": "mixins/AriaReflectorMixin.js" } }, { "name": "compose", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L145" }, "type": { "text": "(parts: CompositionPart[]) => Composition" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "#refsProxy", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1145" }, "type": { "text": "Record" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "#refsCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1148" }, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "#refsCompositionCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1151" }, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "#composition", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1154" }, "type": { "text": "Composition" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "#patching", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1156" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "#pendingPatchRenders", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1159" }, "type": { "text": "[string, any, CustomElement][]" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "#propAttributeCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1162" }, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "#callbackArguments", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1165" }, "type": { "text": "CallbackArguments" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "elementInternals", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1172" }, "type": { "text": "ElementInternals" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "render", "kind": "field", "description": "Updates nodes based on data\nExpects data in JSON Merge Patch format", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1185" }, "type": { "text": "RenderDraw" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "propChangedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1213" }, "type": { "text": "(this: T, name: K, oldValue: K extends keyof T ? T[K] : unknown, newValue: K extends keyof T ? T[K] : unknown, changes?: K extends keyof T ? T[K] extends object ? Partial : T[K] : unknown) => void" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "attributeChangedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1234" }, "type": { "text": "(name: string, oldValue: string, newValue: string) => void" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "#template", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1284" }, "type": { "text": "DocumentFragment" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "#onObserverPropertyChanged", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1294" }, "type": { "text": "(name: string, oldValue: any, newValue: any, changes: any) => void" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "static", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1330" }, "type": { "text": "typeof CustomElement" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "patch", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1333" }, "type": { "text": "(patch: any) => void" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "refs", "kind": "field", "description": "Proxy object that returns shadow DOM elements by tag.\nIf called before interpolation (eg: on composed), returns from template", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1404" }, "type": { "text": "Record" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "attributeCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1391" }, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "callbackArguments", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1400" }, "type": { "text": "CallbackArguments | { composition: Composition; refs: Record; html: any; inline: (fn: (data: Partial) => any) => string; template: DocumentFragment; element: T; }" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "composition", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1403" }, "type": { "text": "Composition" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "connectedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1435" }, "type": { "text": "() => void" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "disconnectedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1441" }, "type": { "text": "() => void" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "elementName", "kind": "field", "static": true, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "observedAttributes", "kind": "field", "static": true, "type": { "text": "Iterable" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "interpolatesTemplate", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "supportsElementInternals", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "supportsElementInternalsRole", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "defined", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "registrations", "kind": "field", "static": true, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "expressions", "kind": "method", "static": true, "description": "Expressions are idempotent functions that are selectively called whenever\na render is requested.\nExpressions are constructed exactly as methods though differ in expected\narguments. The first argument should be destructured to ensure each used\nproperty is accessed at least once in order to inspect used properties.\n\nThe Composition API will inspect this function with a proxy for `this` to\ncatalog what observables are used by the expression. This allows the\nComposition API to build a cache as well as selective invoke the expression\nonly when needed.\n\nWhen used with in element templates, the element itself will be passed as\nits first argument.\n````js\n Button\n .prop('filled', 'boolean')\n .prop('outlined', 'boolean')\n .expresssions({\n _isFilledOrOutlined({filled, outlined}) {\n return (filled || outlined)\n },\n })\n .html`
`;\n````\n\nWhen used with external data source, that data source\nwill be passed to the expression with all properties being `null` at first\ninspection.\n````js\n const externalData = {first: 'John', last: 'Doe'};\n ContactCard\n .expresssions({\n _fullName({first, last}) {\n return [first, last].filter(Boolean).join(' ');\n },\n })\n myButton.render(externalData);\n````\n\nExpressions may be support argumentless calls by using default\nparameters with `this`.\n````js\n Button\n .expresssions({\n isFilledOrOutlined({filled, outlined} = this) {\n return (filled || outlined)\n },\n });\n myButton.isFilledorOutlined();\n````", "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends { [K in keyof any]: K extends `_${any}` ? ((data: INSTANCE, state?: Record) => string | boolean | null) : ((data?: INSTANCE, state?: Record) => string | boolean | null); } & ThisType>(this: CLASS, expressions: PROPS & ThisType) => CLASS & Class<{ [K in keyof PROPS]: K extends `_${any}` ? never : () => ReturnType; }, ARGS>" } }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "methods", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "overrides", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends Partial>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "props", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "idl", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "append", "kind": "field", "static": true, "description": "Append parts to composition", "type": { "text": "(this: T, ...parts: CompositionPart[]) => T" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "recompose", "kind": "field", "static": true, "description": "After composition, invokes callback.\nMay be called multiple times.", "type": { "text": ", T3 extends CompositionCallback[\"composed\"]>(this: T1, callback: T3) => T1" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "css", "kind": "field", "static": true, "description": "Appends styles to composition", "type": { "text": "(this: T1, array: T2, ...rest: T2 extends string ? any : T2 extends TemplateStringsArray ? any[] : (HTMLStyleElement | CSSStyleSheet)[]) => T1" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "autoRegister", "kind": "field", "static": true, "description": "Registers class with customElements. If class is registered before then,\ndoes nothing.", "type": { "text": "(this: T, elementName: string) => T" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "html", "kind": "field", "static": true, "description": "Appends DocumentFragment to composition", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1405" }, "type": { "text": "(this: T, string: TemplateStringsArray, ...substitutions: (string | Element | ((this: InstanceType, data: InstanceType, injections?: any) => any))[]) => T" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "extend", "kind": "field", "static": true, "description": "Extends base class into a new class.\nUse to avoid mutating base class.", "type": { "text": " T2>(this: T1, customExtender?: T3) => T3 extends null ? T1 : T2" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "setStatic", "kind": "field", "static": true, "description": "Assigns static values to class", "type": { "text": " any) | string | number | boolean | any[] | object); }>(this: T1, source: T2 & ThisType) => T1 & T2" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "readonly", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "set", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "mixin", "kind": "field", "static": true, "description": "Returns result of calling mixin with current class", "type": { "text": " any, RETURN extends ReturnType, SUBCLASS extends ClassOf>(this: BASE, mixin: FN) => SUBCLASS & BASE" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "register", "kind": "field", "static": true, "description": "Registers class with window.customElements synchronously", "type": { "text": "(this: T, elementName?: string, force?: boolean) => T" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "propList", "kind": "field", "static": true, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "attrList", "kind": "field", "static": true, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "propChangedCallbacks", "kind": "field", "static": true, "type": { "text": "Map any)[]>" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "attributeChangedCallbacks", "kind": "field", "static": true, "type": { "text": "Map any)[]>" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "prop", "kind": "field", "static": true, "description": "Creates observable property on instances (via prototype)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1007" }, "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "setPrototype", "kind": "field", "static": true, "description": "Creates observable property on instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any)>(this: CLASS, name: KEY, options: OPTIONS) => OPTIONS extends (...args2: any[]) => infer R ? R : OPTIONS extends ObserverPropertyType ? ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? unknown extends R ? object : R : OPTIONS extends { type: ObserverPropertyType; } ? ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? unknown extends R ? string : R : never" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "define", "kind": "field", "static": true, "description": "Define properties on instances via Object.defineProperties().\nAutomatically sets property non-enumerable if name begins with `_`.\nFunctions will be remapped as getters", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends { [P in keyof any]: { enumerable?: boolean; configurable?: boolean; writable?: boolean; value?: any; get?: ((this: INSTANCE) => any); set?: (this: INSTANCE, value: any) => void; } | ((this: INSTANCE, ...args: any[]) => any); }, VALUE extends { [KEY in keyof PROPS]: PROPS[KEY] extends (...args2: any[]) => infer R ? R : PROPS[KEY] extends TypedPropertyDescriptor ? R : never; }>(this: CLASS, props: PROPS & ThisType) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "undefine", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROP extends string, PROPS extends INSTANCE & Record>(this: CLASS, name: PROP) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "observe", "kind": "field", "static": true, "description": "Creates observable properties on instances", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends IDLParameter, VALUE extends { [KEY in keyof PROPS]: PROPS[KEY] extends (...args2: any[]) => infer R ? R : PROPS[KEY] extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : PROPS[KEY] extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : PROPS[KEY] extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : PROPS[KEY] extends ObserverOptions ? (unknown extends R ? string : R) : never; }>(this: CLASS, props: PROPS) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "defineStatic", "kind": "field", "static": true, "type": { "text": ">(this: T1, props: T2) => T1 & ParsedProps" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "events", "kind": "field", "static": true, "type": { "text": "(this: T, listeners?: CompositionEventListenerObject>, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "childEvents", "kind": "field", "static": true, "type": { "text": "(this: T, listenerMap: { [x: string]: CompositionEventListenerObject>; }, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "rootEvents", "kind": "field", "static": true, "type": { "text": "(this: T, listeners?: CompositionEventListenerObject>, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "on", "kind": "field", "static": true, "type": { "text": ", T3 extends CompositionCallback, T4 extends keyof T3>(this: T1, name: T3 | T4, callbacks?: T3[T4] & ThisType) => T1" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "off", "kind": "field", "static": true, "type": { "text": ", T3 extends CompositionCallback, T4 extends keyof T3>(this: T1, name: T3 | T4, callbacks?: T3[T4] & ThisType) => T1" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "offPropChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: ObjectOrObjectEntries<{ [P in keyof T2]?: (this: T2, oldValue: T2[P], newValue: T2[P], changes: any, element: T2) => void; }>) => T1" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "offAttributeChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: { [x: string]: (this: T2, oldValue: string, newValue: string, element: T2) => void; }) => T1" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "onPropChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: ObjectOrObjectEntries<{ [P in keyof T2]?: (this: T2, oldValue: T2[P], newValue: T2[P], changes: any, element: T2) => void; }>) => T1" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "onAttributeChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: { [x: string]: (this: T2, oldValue: string, newValue: string, element: T2) => void; }) => T1" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } } ], "slots": [ { "name": "", "description": "" } ], "cssParts": [], "events": [ { "name": "action", "type": { "text": "Event" } } ], "demos": [ { "url": "demo/components/cards.html" } ], "superclass": { "module": "components/Box.js", "name": "default" }, "mixins": [ { "module": "mixins/StateMixin.js", "name": "default" }, { "module": "mixins/ElevationMixin.js", "name": "default" }, { "module": "mixins/ShapeMixin.js", "name": "default" }, { "module": "mixins/FormAssociatedMixin.js", "name": "default" }, { "module": "mixins/AriaReflectorMixin.js", "name": "default" }, { "module": "mixins/DelegatesFocusMixin.js", "name": "default" }, { "module": "mixins/HyperlinkMixin.js", "name": "default" } ], "description": "Cards display content and actions about a single subject.\n@see https://m3.material.io/components/cards/specs" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "default", "module": "components/Card.js" } }, { "kind": "custom-element-definition", "name": "mdw-card", "declaration": { "name": "default", "module": "components/Card.js" } } ] }, { "kind": "javascript-module", "path": "components/Checkbox.js", "declarations": [ { "kind": "class", "name": "Checkbox", "tagName": "mdw-checkbox", "customElement": true, "attributes": [ { "name": "color", "fieldName": "color", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "ink", "fieldName": "ink", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "type-style", "fieldName": "typeStyle", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "disabled", "fieldName": "disabled", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "focused", "fieldName": "focused", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "hovered", "fieldName": "hovered", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "pressed", "fieldName": "pressed", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "aria-controls", "fieldName": "ariaControls", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "autocomplete", "fieldName": "autocomplete", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "name", "fieldName": "name", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "readonly", "fieldName": "readOnly", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "formnovalidate", "fieldName": "formNoValidate", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "checked", "fieldName": "defaultChecked", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "required", "fieldName": "required", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "value", "fieldName": "_defaultValue", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "aria-label", "fieldName": "ariaLabel", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "accept", "fieldName": "accept", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "alt", "fieldName": "alt", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "dirname", "fieldName": "dirName", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "formenctype", "fieldName": "formEnctype", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "formmethod", "fieldName": "formMethod", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "formtarget", "fieldName": "formTarget", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "max", "fieldName": "max", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "maxlength", "fieldName": "maxLength", "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "min", "fieldName": "min", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "minlength", "fieldName": "minLength", "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "multiple", "fieldName": "multiple", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "pattern", "fieldName": "pattern", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "placeholder", "fieldName": "placeholder", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "size", "fieldName": "size", "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "src", "fieldName": "src", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "step", "fieldName": "step", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "indeterminate", "fieldName": "indeterminate", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "icon", "description": "Icon name to show for the checked state.", "fieldName": "icon", "type": { "text": "string" } }, { "name": "indeterminate-icon", "description": "Icon name to show when the control is indeterminate.", "fieldName": "indeterminateIcon", "type": { "text": "string" } }, { "name": "state-layer", "type": { "text": "boolean" }, "description": "Show the visual state layer element when true", "fieldName": "stateLayer", "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "type", "type": { "text": "string" }, "fieldName": "type", "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } } ], "members": [ { "name": "delegatesFocus", "kind": "field", "description": "When true, the element delegates focus to an internal focus target.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/DelegatesFocusMixin.js#L15" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "disabled", "kind": "field", "description": "Whether the element is disabled (affects interactive states)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L14" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "focused", "kind": "field", "description": "Force focus state (independent of document)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L16" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "hovered", "kind": "field", "description": "Force hover state (independent of interaction)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L18" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "pressed", "kind": "field", "description": "Force pressed state (independent of interaction)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L20" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "stateLayer", "kind": "field", "description": "Show the visual state layer element when true\nWhether the element renders a state layer for interaction feedback.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Checkbox.js#L23" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "disabledState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L171" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "hoveredState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L38" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "focusedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L39" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "pressedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L40" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "touchedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L41" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "pointedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L44" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "stateTargetElement", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ControlMixin.js#L66" }, "type": { "text": "HTMLElement" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "ariaControls", "kind": "field", "description": "ARIA 'controls' attribute (string).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L32" }, "type": { "text": "string" } }, { "name": "autocomplete", "kind": "field", "description": "Autocomplete token for the associated control (string).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L34" }, "type": { "text": "string" } }, { "name": "name", "kind": "field", "description": "Name attribute for the control used in forms.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L36" }, "type": { "text": "string" } }, { "name": "readOnly", "kind": "field", "description": "Read-only state reflected to control via 'readonly' attribute.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L38" }, "type": { "text": "boolean" } }, { "name": "formNoValidate", "kind": "field", "description": "When true, form validation is skipped for this control (formnovalidate).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L40" }, "type": { "text": "boolean" } }, { "name": "defaultChecked", "kind": "field", "description": "Default checked state for checkable controls (checkbox/radio).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L42" }, "type": { "text": "boolean" } }, { "name": "required", "kind": "field", "description": "Whether the control is required for form submission.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L47" }, "type": { "text": "boolean" } }, { "name": "type", "kind": "field", "description": "Control type token (e.g. 'text','checkbox','radio','file').\nThe underlying control input `type` value.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Checkbox.js#L25" }, "type": { "text": "string" } }, { "name": "erroredState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L65" }, "type": { "text": "boolean" } }, { "name": "defaultValue", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L66" }, "type": { "text": "string" } }, { "name": "value", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Checkbox.js#L31" }, "type": { "text": "string" } }, { "name": "checked", "kind": "field", "description": "Part of FormAssociatedMixin for simplicity.\nEnumerability doesn't guarantee checked state will be passed or used.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L145" }, "type": { "text": "boolean" } }, { "name": "form", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L160" }, "type": { "text": "HTMLFormElement" } }, { "name": "validity", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L161" }, "type": { "text": "ValidityState" } }, { "name": "validationMessage", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L162" }, "type": { "text": "string" } }, { "name": "willValidate", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L163" }, "type": { "text": "boolean" } }, { "name": "labels", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L168" }, "type": { "text": "NodeList" } }, { "name": "focusableOnDisabled", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ControlMixin.js#L30" }, "type": { "text": "boolean" } }, { "name": "controlTagName", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L102" }, "type": { "text": "string" } }, { "name": "controlVoidElement", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ControlMixin.js#L32" }, "type": { "text": "boolean" } }, { "name": "accept", "kind": "field", "description": "Accepted file types for file input (e.g. '.png,.jpg').", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L41" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "alt", "kind": "field", "description": "Alternate text for images (for `type='image'`).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L43" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "dirName", "kind": "field", "description": "Directionality for form submission name (dirname attribute).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L45" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "formEnctype", "kind": "field", "description": "Form encoding type (formenctype).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L49" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "formMethod", "kind": "field", "description": "Form method when associated with a submit input (formmethod).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L51" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "formTarget", "kind": "field", "description": "Target browsing context for form submission (formtarget).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L53" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "max", "kind": "field", "description": "Max value or token for the input.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L58" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "maxLength", "kind": "field", "description": "Maximum length for text-like inputs.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L60" }, "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "min", "kind": "field", "description": "Min value or token for the input.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L62" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "minLength", "kind": "field", "description": "Minimum length for text-like inputs.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L64" }, "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "multiple", "kind": "field", "description": "When true, multiple values are allowed (e.g. file inputs).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L66" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "pattern", "kind": "field", "description": "Pattern used for validation (RegExp as string).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L68" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "placeholder", "kind": "field", "description": "Placeholder text shown when no value is present.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L70" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "size", "kind": "field", "description": "Suggested control size (number of characters).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L72" }, "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "src", "kind": "field", "description": "Source URL for image-type inputs.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L74" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "step", "kind": "field", "description": "Step interval for numeric inputs.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L76" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "indeterminate", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L89" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "files", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L371" }, "type": { "text": "FileList" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "selectionDirection", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L384" }, "type": { "text": "\"none\" | \"forward\" | \"backward\"" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "selectionEnd", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L389" }, "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "selectionStart", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L394" }, "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "valueAsDate", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L399" }, "type": { "text": "Date" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "valueAsNumber", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L407" }, "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "height", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L415" }, "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "formAction", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L423" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "width", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L431" }, "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "color", "kind": "field", "description": "Palette or surface token used to select background/ink tokens.\nExamples: 'primary', 'background', 'surface-container-low'.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L52" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "ink", "kind": "field", "description": "Explicit ink override token (e.g. 'outline', 'on-primary', 'inverse-on-surface', 'inherit').\nMaps to `--mdw-ink`.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L57" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "typeStyle", "kind": "field", "description": "Typographic style shortcut that maps to type scale variables\n(e.g. 'headline-large', 'body-medium').", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L62" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "icon", "kind": "field", "description": "Icon name to show for the checked state.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Checkbox.js#L29" }, "type": { "text": "string" } }, { "name": "indeterminateIcon", "kind": "field", "description": "Icon name to show when the control is indeterminate.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Checkbox.js#L31" }, "type": { "text": "string" } }, { "name": "prototype", "kind": "field", "static": true, "type": { "text": "CustomElement" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "addRipple", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/RippleMixin.js#L37" }, "return": { "type": { "text": "(x?: number, y?: number, hold?: boolean) => CustomElement & { hadRippleHeld: boolean; hadRippleReleased: boolean; rippleStarted: boolean; } & { rippleState: string; keepAlive: boolean; _positionX: number; _positionY: number; _radius: number; holdRipple: boolean; } & { _positionStyle: ElementStylerOptions | { styles: { minHeight: string; minWidth: string; boxShadow: string; top: string; left: string; }; }; } & { updatePosition(x?: number, y?: number, size?: number): void; handleRippleComplete(): void; }" } }, "inheritedFrom": { "name": "default", "module": "mixins/RippleMixin.js" } }, { "name": "performImplicitSubmission", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L175" }, "return": { "type": { "text": "(event: Event) => void" } }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "setRangeText", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L345" }, "return": { "type": { "text": "{ (replacement: string): void; (replacement: string, start: number, end: number, selectionMode?: SelectionMode): void; }" } }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "setSelectionRange", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L348" }, "return": { "type": { "text": "(start: number, end: number, direction?: \"none\" | \"forward\" | \"backward\") => void" } }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "showPicker", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L351" }, "return": { "type": { "text": "() => void" } }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "stepDown", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L354" }, "return": { "type": { "text": "(n?: number) => void" } }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "stepUp", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L360" }, "return": { "type": { "text": "(n?: number) => void" } }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "select", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L366" }, "return": { "type": { "text": "() => void" } }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "compose", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L145" }, "type": { "text": "(parts: CompositionPart[]) => Composition" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#refsProxy", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1145" }, "type": { "text": "Record" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#refsCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1148" }, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#refsCompositionCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1151" }, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#composition", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1154" }, "type": { "text": "Composition" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#patching", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1156" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#pendingPatchRenders", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1159" }, "type": { "text": "[string, any, CustomElement][]" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#propAttributeCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1162" }, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#callbackArguments", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1165" }, "type": { "text": "CallbackArguments" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "elementInternals", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1172" }, "type": { "text": "ElementInternals" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "render", "kind": "field", "description": "Updates nodes based on data\nExpects data in JSON Merge Patch format", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1185" }, "type": { "text": "RenderDraw" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "propChangedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1213" }, "type": { "text": "(this: T, name: K, oldValue: K extends keyof T ? T[K] : unknown, newValue: K extends keyof T ? T[K] : unknown, changes?: K extends keyof T ? T[K] extends object ? Partial : T[K] : unknown) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attributeChangedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1234" }, "type": { "text": "(name: string, oldValue: string, newValue: string) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#template", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1284" }, "type": { "text": "DocumentFragment" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#onObserverPropertyChanged", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1294" }, "type": { "text": "(name: string, oldValue: any, newValue: any, changes: any) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "static", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1330" }, "type": { "text": "typeof CustomElement" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "patch", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1333" }, "type": { "text": "(patch: any) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "refs", "kind": "field", "description": "Proxy object that returns shadow DOM elements by tag.\nIf called before interpolation (eg: on composed), returns from template", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1404" }, "type": { "text": "Record" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attributeCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1391" }, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "callbackArguments", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1400" }, "type": { "text": "CallbackArguments | { composition: Composition; refs: Record; html: any; inline: (fn: (data: Partial) => any) => string; template: DocumentFragment; element: T; }" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "composition", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1403" }, "type": { "text": "Composition" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "connectedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1435" }, "type": { "text": "() => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "disconnectedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1441" }, "type": { "text": "() => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "elementName", "kind": "field", "static": true, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "observedAttributes", "kind": "field", "static": true, "type": { "text": "Iterable" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "interpolatesTemplate", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "supportsElementInternals", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "supportsElementInternalsRole", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "defined", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "registrations", "kind": "field", "static": true, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "expressions", "kind": "method", "static": true, "description": "Expressions are idempotent functions that are selectively called whenever\na render is requested.\nExpressions are constructed exactly as methods though differ in expected\narguments. The first argument should be destructured to ensure each used\nproperty is accessed at least once in order to inspect used properties.\n\nThe Composition API will inspect this function with a proxy for `this` to\ncatalog what observables are used by the expression. This allows the\nComposition API to build a cache as well as selective invoke the expression\nonly when needed.\n\nWhen used with in element templates, the element itself will be passed as\nits first argument.\n````js\n Button\n .prop('filled', 'boolean')\n .prop('outlined', 'boolean')\n .expresssions({\n _isFilledOrOutlined({filled, outlined}) {\n return (filled || outlined)\n },\n })\n .html`
`;\n````\n\nWhen used with external data source, that data source\nwill be passed to the expression with all properties being `null` at first\ninspection.\n````js\n const externalData = {first: 'John', last: 'Doe'};\n ContactCard\n .expresssions({\n _fullName({first, last}) {\n return [first, last].filter(Boolean).join(' ');\n },\n })\n myButton.render(externalData);\n````\n\nExpressions may be support argumentless calls by using default\nparameters with `this`.\n````js\n Button\n .expresssions({\n isFilledOrOutlined({filled, outlined} = this) {\n return (filled || outlined)\n },\n });\n myButton.isFilledorOutlined();\n````", "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends { [K in keyof any]: K extends `_${any}` ? ((data: INSTANCE, state?: Record) => string | boolean | null) : ((data?: INSTANCE, state?: Record) => string | boolean | null); } & ThisType>(this: CLASS, expressions: PROPS & ThisType) => CLASS & Class<{ [K in keyof PROPS]: K extends `_${any}` ? never : () => ReturnType; }, ARGS>" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "methods", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "overrides", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends Partial>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "props", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "idl", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "append", "kind": "field", "static": true, "description": "Append parts to composition", "type": { "text": "(this: T, ...parts: CompositionPart[]) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "recompose", "kind": "field", "static": true, "description": "After composition, invokes callback.\nMay be called multiple times.", "type": { "text": ", T3 extends CompositionCallback[\"composed\"]>(this: T1, callback: T3) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "css", "kind": "field", "static": true, "description": "Appends styles to composition", "type": { "text": "(this: T1, array: T2, ...rest: T2 extends string ? any : T2 extends TemplateStringsArray ? any[] : (HTMLStyleElement | CSSStyleSheet)[]) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "autoRegister", "kind": "field", "static": true, "description": "Registers class with customElements. If class is registered before then,\ndoes nothing.", "type": { "text": "(this: T, elementName: string) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "html", "kind": "field", "static": true, "description": "Appends DocumentFragment to composition", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1405" }, "type": { "text": "(this: T, string: TemplateStringsArray, ...substitutions: (string | Element | ((this: InstanceType, data: InstanceType, injections?: any) => any))[]) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "extend", "kind": "field", "static": true, "description": "Extends base class into a new class.\nUse to avoid mutating base class.", "type": { "text": " T2>(this: T1, customExtender?: T3) => T3 extends null ? T1 : T2" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "setStatic", "kind": "field", "static": true, "description": "Assigns static values to class", "type": { "text": " any) | string | number | boolean | any[] | object); }>(this: T1, source: T2 & ThisType) => T1 & T2" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "readonly", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "set", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "mixin", "kind": "field", "static": true, "description": "Returns result of calling mixin with current class", "type": { "text": " any, RETURN extends ReturnType, SUBCLASS extends ClassOf>(this: BASE, mixin: FN) => SUBCLASS & BASE" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "register", "kind": "field", "static": true, "description": "Registers class with window.customElements synchronously", "type": { "text": "(this: T, elementName?: string, force?: boolean) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "propList", "kind": "field", "static": true, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attrList", "kind": "field", "static": true, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "propChangedCallbacks", "kind": "field", "static": true, "type": { "text": "Map any)[]>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attributeChangedCallbacks", "kind": "field", "static": true, "type": { "text": "Map any)[]>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "prop", "kind": "field", "static": true, "description": "Creates observable property on instances (via prototype)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1007" }, "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "setPrototype", "kind": "field", "static": true, "description": "Creates observable property on instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any)>(this: CLASS, name: KEY, options: OPTIONS) => OPTIONS extends (...args2: any[]) => infer R ? R : OPTIONS extends ObserverPropertyType ? ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? unknown extends R ? object : R : OPTIONS extends { type: ObserverPropertyType; } ? ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? unknown extends R ? string : R : never" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "define", "kind": "field", "static": true, "description": "Define properties on instances via Object.defineProperties().\nAutomatically sets property non-enumerable if name begins with `_`.\nFunctions will be remapped as getters", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends { [P in keyof any]: { enumerable?: boolean; configurable?: boolean; writable?: boolean; value?: any; get?: ((this: INSTANCE) => any); set?: (this: INSTANCE, value: any) => void; } | ((this: INSTANCE, ...args: any[]) => any); }, VALUE extends { [KEY in keyof PROPS]: PROPS[KEY] extends (...args2: any[]) => infer R ? R : PROPS[KEY] extends TypedPropertyDescriptor ? R : never; }>(this: CLASS, props: PROPS & ThisType) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "undefine", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROP extends string, PROPS extends INSTANCE & Record>(this: CLASS, name: PROP) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "observe", "kind": "field", "static": true, "description": "Creates observable properties on instances", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends IDLParameter, VALUE extends { [KEY in keyof PROPS]: PROPS[KEY] extends (...args2: any[]) => infer R ? R : PROPS[KEY] extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : PROPS[KEY] extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : PROPS[KEY] extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : PROPS[KEY] extends ObserverOptions ? (unknown extends R ? string : R) : never; }>(this: CLASS, props: PROPS) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "defineStatic", "kind": "field", "static": true, "type": { "text": ">(this: T1, props: T2) => T1 & ParsedProps" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "events", "kind": "field", "static": true, "type": { "text": "(this: T, listeners?: CompositionEventListenerObject>, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "childEvents", "kind": "field", "static": true, "type": { "text": "(this: T, listenerMap: { [x: string]: CompositionEventListenerObject>; }, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "rootEvents", "kind": "field", "static": true, "type": { "text": "(this: T, listeners?: CompositionEventListenerObject>, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "on", "kind": "field", "static": true, "type": { "text": ", T3 extends CompositionCallback, T4 extends keyof T3>(this: T1, name: T3 | T4, callbacks?: T3[T4] & ThisType) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "off", "kind": "field", "static": true, "type": { "text": ", T3 extends CompositionCallback, T4 extends keyof T3>(this: T1, name: T3 | T4, callbacks?: T3[T4] & ThisType) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "offPropChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: ObjectOrObjectEntries<{ [P in keyof T2]?: (this: T2, oldValue: T2[P], newValue: T2[P], changes: any, element: T2) => void; }>) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "offAttributeChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: { [x: string]: (this: T2, oldValue: string, newValue: string, element: T2) => void; }) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "onPropChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: ObjectOrObjectEntries<{ [P in keyof T2]?: (this: T2, oldValue: T2[P], newValue: T2[P], changes: any, element: T2) => void; }>) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "onAttributeChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: { [x: string]: (this: T2, oldValue: string, newValue: string, element: T2) => void; }) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } } ], "slots": [ { "name": "", "description": "" } ], "cssParts": [ { "name": "control" } ], "events": [], "demos": [ { "url": "demo/components/checkbox.html" } ], "superclass": { "module": "core/CustomElement.js", "name": "default" }, "mixins": [ { "module": "mixins/ThemableMixin.js", "name": "default" }, { "module": "mixins/StateMixin.js", "name": "default" }, { "module": "mixins/RippleMixin.js", "name": "default" }, { "module": "mixins/InputMixin.js", "name": "default" }, { "module": "mixins/TouchTargetMixin.js", "name": "default" } ], "description": "Checkboxes let users select one or more items from a list, or turn an item on or off.\n@see https://m3.material.io/components/checkbox/specs" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "default", "module": "components/Checkbox.js" } }, { "kind": "custom-element-definition", "name": "mdw-checkbox", "declaration": { "name": "default", "module": "components/Checkbox.js" } } ] }, { "kind": "javascript-module", "path": "components/CheckboxIcon.js", "declarations": [ { "kind": "class", "name": "CheckboxIcon", "tagName": "mdw-checkbox-icon", "customElement": true, "attributes": [ { "name": "color", "fieldName": "color", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "ink", "fieldName": "ink", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "type-style", "fieldName": "typeStyle", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "shape-top", "fieldName": "shapeTop", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shape-bottom", "fieldName": "shapeBottom", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shape-start", "fieldName": "shapeStart", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shape-end", "fieldName": "shapeEnd", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shape-style", "fieldName": "shapeStyle", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "outlined", "fieldName": "outlined", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "selected", "description": "Whether the icon is selected (checked).", "fieldName": "selected", "type": { "text": "boolean" } }, { "name": "icon", "description": "Icon name to render inside the checkbox icon.", "fieldName": "icon", "type": { "text": "string" } }, { "name": "errored", "description": "Whether the associated control is in an error state.", "fieldName": "errored", "type": { "text": "boolean" } }, { "name": "disabled", "description": "Whether the associated control is disabled.", "fieldName": "disabled", "type": { "text": "boolean" } } ], "members": [ { "name": "disabled", "kind": "field", "description": "Whether the element is disabled (affects interactive states)\nWhether the associated control is disabled.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/CheckboxIcon.js#L22" }, "type": { "text": "boolean" } }, { "name": "focused", "kind": "field", "description": "Force focus state (independent of document)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L16" }, "type": { "text": "boolean" } }, { "name": "hovered", "kind": "field", "description": "Force hover state (independent of interaction)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L18" }, "type": { "text": "boolean" } }, { "name": "pressed", "kind": "field", "description": "Force pressed state (independent of interaction)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L20" }, "type": { "text": "boolean" } }, { "name": "stateLayer", "kind": "field", "description": "Show the visual state layer element when true", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L34" }, "type": { "text": "boolean" } }, { "name": "disabledState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L37" }, "type": { "text": "boolean" } }, { "name": "hoveredState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L38" }, "type": { "text": "boolean" } }, { "name": "focusedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L39" }, "type": { "text": "boolean" } }, { "name": "pressedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L40" }, "type": { "text": "boolean" } }, { "name": "touchedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L41" }, "type": { "text": "boolean" } }, { "name": "pointedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L44" }, "type": { "text": "boolean" } }, { "name": "stateTargetElement", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L50" }, "type": { "text": "HTMLElement" } }, { "name": "color", "kind": "field", "description": "Palette or surface token used to select background/ink tokens.\nExamples: 'primary', 'background', 'surface-container-low'.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L52" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "ink", "kind": "field", "description": "Explicit ink override token (e.g. 'outline', 'on-primary', 'inverse-on-surface', 'inherit').\nMaps to `--mdw-ink`.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L57" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "typeStyle", "kind": "field", "description": "Typographic style shortcut that maps to type scale variables\n(e.g. 'headline-large', 'body-medium').", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L62" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "shapeTop", "kind": "field", "description": "Show top cut/shape on the element", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L9" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shapeBottom", "kind": "field", "description": "Show bottom cut/shape on the element", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L11" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shapeStart", "kind": "field", "description": "Show start-side cut/shape (logical start)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L13" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shapeEnd", "kind": "field", "description": "Show end-side cut/shape (logical end)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L15" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shapeStyle", "kind": "field", "description": "Predefined shape size/style name (none|extra-small|small|medium|large|extra-large|full|inherit)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L17" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "outlined", "kind": "field", "description": "When true, an outline is rendered around the element", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L19" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "selected", "kind": "field", "description": "Whether the icon is selected (checked).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/CheckboxIcon.js#L16" }, "type": { "text": "boolean" } }, { "name": "icon", "kind": "field", "description": "Icon name to render inside the checkbox icon.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/CheckboxIcon.js#L18" }, "type": { "text": "string" } }, { "name": "errored", "kind": "field", "description": "Whether the associated control is in an error state.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/CheckboxIcon.js#L20" }, "type": { "text": "boolean" } }, { "name": "checked", "kind": "field", "description": "Alias for `selected` (quality-of-life property).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/CheckboxIcon.js#L26" }, "type": { "text": "boolean" } }, { "name": "prototype", "kind": "field", "static": true, "type": { "text": "CustomElement" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "compose", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L145" }, "type": { "text": "(parts: CompositionPart[]) => Composition" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#refsProxy", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1145" }, "type": { "text": "Record" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#refsCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1148" }, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#refsCompositionCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1151" }, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#composition", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1154" }, "type": { "text": "Composition" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#patching", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1156" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#pendingPatchRenders", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1159" }, "type": { "text": "[string, any, CustomElement][]" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#propAttributeCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1162" }, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#callbackArguments", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1165" }, "type": { "text": "CallbackArguments" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "elementInternals", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1172" }, "type": { "text": "ElementInternals" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "render", "kind": "field", "description": "Updates nodes based on data\nExpects data in JSON Merge Patch format", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1185" }, "type": { "text": "RenderDraw" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "propChangedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1213" }, "type": { "text": "(this: T, name: K, oldValue: K extends keyof T ? T[K] : unknown, newValue: K extends keyof T ? T[K] : unknown, changes?: K extends keyof T ? T[K] extends object ? Partial : T[K] : unknown) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attributeChangedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1234" }, "type": { "text": "(name: string, oldValue: string, newValue: string) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#template", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1284" }, "type": { "text": "DocumentFragment" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#onObserverPropertyChanged", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1294" }, "type": { "text": "(name: string, oldValue: any, newValue: any, changes: any) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "static", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1330" }, "type": { "text": "typeof CustomElement" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "patch", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1333" }, "type": { "text": "(patch: any) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "refs", "kind": "field", "description": "Proxy object that returns shadow DOM elements by tag.\nIf called before interpolation (eg: on composed), returns from template", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1404" }, "type": { "text": "Record" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attributeCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1391" }, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "callbackArguments", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1400" }, "type": { "text": "CallbackArguments | { composition: Composition; refs: Record; html: any; inline: (fn: (data: Partial) => any) => string; template: DocumentFragment; element: T; }" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "composition", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1403" }, "type": { "text": "Composition" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "connectedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1435" }, "type": { "text": "() => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "disconnectedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1441" }, "type": { "text": "() => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "delegatesFocus", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1175" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "elementName", "kind": "field", "static": true, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "observedAttributes", "kind": "field", "static": true, "type": { "text": "Iterable" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "interpolatesTemplate", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "supportsElementInternals", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "supportsElementInternalsRole", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "defined", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "registrations", "kind": "field", "static": true, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "expressions", "kind": "method", "static": true, "description": "Expressions are idempotent functions that are selectively called whenever\na render is requested.\nExpressions are constructed exactly as methods though differ in expected\narguments. The first argument should be destructured to ensure each used\nproperty is accessed at least once in order to inspect used properties.\n\nThe Composition API will inspect this function with a proxy for `this` to\ncatalog what observables are used by the expression. This allows the\nComposition API to build a cache as well as selective invoke the expression\nonly when needed.\n\nWhen used with in element templates, the element itself will be passed as\nits first argument.\n````js\n Button\n .prop('filled', 'boolean')\n .prop('outlined', 'boolean')\n .expresssions({\n _isFilledOrOutlined({filled, outlined}) {\n return (filled || outlined)\n },\n })\n .html`
`;\n````\n\nWhen used with external data source, that data source\nwill be passed to the expression with all properties being `null` at first\ninspection.\n````js\n const externalData = {first: 'John', last: 'Doe'};\n ContactCard\n .expresssions({\n _fullName({first, last}) {\n return [first, last].filter(Boolean).join(' ');\n },\n })\n myButton.render(externalData);\n````\n\nExpressions may be support argumentless calls by using default\nparameters with `this`.\n````js\n Button\n .expresssions({\n isFilledOrOutlined({filled, outlined} = this) {\n return (filled || outlined)\n },\n });\n myButton.isFilledorOutlined();\n````", "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends { [K in keyof any]: K extends `_${any}` ? ((data: INSTANCE, state?: Record) => string | boolean | null) : ((data?: INSTANCE, state?: Record) => string | boolean | null); } & ThisType>(this: CLASS, expressions: PROPS & ThisType) => CLASS & Class<{ [K in keyof PROPS]: K extends `_${any}` ? never : () => ReturnType; }, ARGS>" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "methods", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "overrides", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends Partial>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "props", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "idl", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "append", "kind": "field", "static": true, "description": "Append parts to composition", "type": { "text": "(this: T, ...parts: CompositionPart[]) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "recompose", "kind": "field", "static": true, "description": "After composition, invokes callback.\nMay be called multiple times.", "type": { "text": ", T3 extends CompositionCallback[\"composed\"]>(this: T1, callback: T3) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "css", "kind": "field", "static": true, "description": "Appends styles to composition", "type": { "text": "(this: T1, array: T2, ...rest: T2 extends string ? any : T2 extends TemplateStringsArray ? any[] : (HTMLStyleElement | CSSStyleSheet)[]) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "autoRegister", "kind": "field", "static": true, "description": "Registers class with customElements. If class is registered before then,\ndoes nothing.", "type": { "text": "(this: T, elementName: string) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "html", "kind": "field", "static": true, "description": "Appends DocumentFragment to composition", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1405" }, "type": { "text": "(this: T, string: TemplateStringsArray, ...substitutions: (string | Element | ((this: InstanceType, data: InstanceType, injections?: any) => any))[]) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "extend", "kind": "field", "static": true, "description": "Extends base class into a new class.\nUse to avoid mutating base class.", "type": { "text": " T2>(this: T1, customExtender?: T3) => T3 extends null ? T1 : T2" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "setStatic", "kind": "field", "static": true, "description": "Assigns static values to class", "type": { "text": " any) | string | number | boolean | any[] | object); }>(this: T1, source: T2 & ThisType) => T1 & T2" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "readonly", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "set", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "mixin", "kind": "field", "static": true, "description": "Returns result of calling mixin with current class", "type": { "text": " any, RETURN extends ReturnType, SUBCLASS extends ClassOf>(this: BASE, mixin: FN) => SUBCLASS & BASE" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "register", "kind": "field", "static": true, "description": "Registers class with window.customElements synchronously", "type": { "text": "(this: T, elementName?: string, force?: boolean) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "propList", "kind": "field", "static": true, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attrList", "kind": "field", "static": true, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "propChangedCallbacks", "kind": "field", "static": true, "type": { "text": "Map any)[]>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attributeChangedCallbacks", "kind": "field", "static": true, "type": { "text": "Map any)[]>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "prop", "kind": "field", "static": true, "description": "Creates observable property on instances (via prototype)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1007" }, "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "setPrototype", "kind": "field", "static": true, "description": "Creates observable property on instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any)>(this: CLASS, name: KEY, options: OPTIONS) => OPTIONS extends (...args2: any[]) => infer R ? R : OPTIONS extends ObserverPropertyType ? ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? unknown extends R ? object : R : OPTIONS extends { type: ObserverPropertyType; } ? ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? unknown extends R ? string : R : never" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "define", "kind": "field", "static": true, "description": "Define properties on instances via Object.defineProperties().\nAutomatically sets property non-enumerable if name begins with `_`.\nFunctions will be remapped as getters", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends { [P in keyof any]: { enumerable?: boolean; configurable?: boolean; writable?: boolean; value?: any; get?: ((this: INSTANCE) => any); set?: (this: INSTANCE, value: any) => void; } | ((this: INSTANCE, ...args: any[]) => any); }, VALUE extends { [KEY in keyof PROPS]: PROPS[KEY] extends (...args2: any[]) => infer R ? R : PROPS[KEY] extends TypedPropertyDescriptor ? R : never; }>(this: CLASS, props: PROPS & ThisType) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "undefine", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROP extends string, PROPS extends INSTANCE & Record>(this: CLASS, name: PROP) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "observe", "kind": "field", "static": true, "description": "Creates observable properties on instances", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends IDLParameter, VALUE extends { [KEY in keyof PROPS]: PROPS[KEY] extends (...args2: any[]) => infer R ? R : PROPS[KEY] extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : PROPS[KEY] extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : PROPS[KEY] extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : PROPS[KEY] extends ObserverOptions ? (unknown extends R ? string : R) : never; }>(this: CLASS, props: PROPS) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "defineStatic", "kind": "field", "static": true, "type": { "text": ">(this: T1, props: T2) => T1 & ParsedProps" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "events", "kind": "field", "static": true, "type": { "text": "(this: T, listeners?: CompositionEventListenerObject>, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "childEvents", "kind": "field", "static": true, "type": { "text": "(this: T, listenerMap: { [x: string]: CompositionEventListenerObject>; }, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "rootEvents", "kind": "field", "static": true, "type": { "text": "(this: T, listeners?: CompositionEventListenerObject>, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "on", "kind": "field", "static": true, "type": { "text": ", T3 extends CompositionCallback, T4 extends keyof T3>(this: T1, name: T3 | T4, callbacks?: T3[T4] & ThisType) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "off", "kind": "field", "static": true, "type": { "text": ", T3 extends CompositionCallback, T4 extends keyof T3>(this: T1, name: T3 | T4, callbacks?: T3[T4] & ThisType) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "offPropChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: ObjectOrObjectEntries<{ [P in keyof T2]?: (this: T2, oldValue: T2[P], newValue: T2[P], changes: any, element: T2) => void; }>) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "offAttributeChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: { [x: string]: (this: T2, oldValue: string, newValue: string, element: T2) => void; }) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "onPropChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: ObjectOrObjectEntries<{ [P in keyof T2]?: (this: T2, oldValue: T2[P], newValue: T2[P], changes: any, element: T2) => void; }>) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "onAttributeChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: { [x: string]: (this: T2, oldValue: string, newValue: string, element: T2) => void; }) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } } ], "slots": [], "cssParts": [], "events": [], "demos": [], "superclass": { "module": "core/CustomElement.js", "name": "default" }, "mixins": [ { "module": "mixins/ThemableMixin.js", "name": "default" }, { "module": "mixins/ShapeMixin.js", "name": "default" } ], "description": "CheckboxIcon is a visual helper for checkboxes, rendering the box and checkmark.\n@see https://m3.material.io/components/checkbox/specs" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "default", "module": "components/CheckboxIcon.js" } }, { "kind": "custom-element-definition", "name": "mdw-checkbox-icon", "declaration": { "name": "default", "module": "components/CheckboxIcon.js" } } ] }, { "kind": "javascript-module", "path": "components/Chip.js", "declarations": [ { "kind": "class", "name": "Chip", "tagName": "mdw-chip", "customElement": true, "attributes": [ { "name": "color", "fieldName": "color", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "ink", "fieldName": "ink", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "type-style", "fieldName": "typeStyle", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "density", "fieldName": "density", "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "disabled", "fieldName": "disabled", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "focused", "fieldName": "focused", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "hovered", "fieldName": "hovered", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "pressed", "fieldName": "pressed", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "shape-top", "fieldName": "shapeTop", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "shape-bottom", "fieldName": "shapeBottom", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "shape-start", "fieldName": "shapeStart", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "shape-end", "fieldName": "shapeEnd", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "shape-style", "fieldName": "shapeStyle", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "outlined", "fieldName": "outlined", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "aria-controls", "fieldName": "ariaControls", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "autocomplete", "fieldName": "autocomplete", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "name", "fieldName": "name", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "readonly", "fieldName": "readOnly", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "formnovalidate", "fieldName": "formNoValidate", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "checked", "fieldName": "defaultChecked", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "required", "fieldName": "required", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "type", "fieldName": "type", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "value", "fieldName": "_defaultValue", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "aria-label", "fieldName": "ariaLabel", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "accept", "fieldName": "accept", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "alt", "fieldName": "alt", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "dirname", "fieldName": "dirName", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "formenctype", "fieldName": "formEnctype", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "formmethod", "fieldName": "formMethod", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "formtarget", "fieldName": "formTarget", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "max", "fieldName": "max", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "maxlength", "fieldName": "maxLength", "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "min", "fieldName": "min", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "minlength", "fieldName": "minLength", "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "multiple", "fieldName": "multiple", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "pattern", "fieldName": "pattern", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "placeholder", "fieldName": "placeholder", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "size", "fieldName": "size", "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "src", "fieldName": "src", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "step", "fieldName": "step", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "indeterminate", "fieldName": "indeterminate", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "href", "fieldName": "href", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "target", "fieldName": "target", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "download", "fieldName": "download", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "ping", "fieldName": "ping", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "rel", "fieldName": "rel", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "hreflang", "fieldName": "hreflang", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "referrerpolicy", "fieldName": "referrerPolicy", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "elevated", "fieldName": "elevated", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "filled", "fieldName": "filled", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "icon", "fieldName": "icon", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "icon-ink", "fieldName": "iconInk", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "svg", "fieldName": "svg", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "view-box", "fieldName": "viewBox", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "svg-path", "fieldName": "svgPath", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "suggestion", "description": "When true, renders the chip as a suggestion variant.", "fieldName": "suggestion", "type": { "text": "boolean" } }, { "name": "state-layer", "type": { "text": "boolean" }, "description": "Show the visual state layer element when true", "fieldName": "stateLayer", "inheritedFrom": { "name": "default", "module": "components/Button.js" } } ], "members": [ { "name": "delegatesFocus", "kind": "field", "description": "When true, the element delegates focus to an internal focus target.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/DelegatesFocusMixin.js#L15" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "href", "kind": "field", "description": "The URL that the hyperlink points to.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L34" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "target", "kind": "field", "description": "The browsing context in which to open the linked resource (e.g. '_blank').", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L36" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "download", "kind": "field", "description": "Suggested filename for download.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L38" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "ping", "kind": "field", "description": "URLs to be pinged when the link is followed.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L40" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "rel", "kind": "field", "description": "Link relationship tokens (e.g. 'noopener', 'noreferrer').", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L42" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "hreflang", "kind": "field", "description": "Language of the linked resource.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L44" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "referrerPolicy", "kind": "field", "description": "Referrer policy for the link (serialized to 'referrerpolicy' attribute).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L46" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "origin", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L49" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "protocol", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L50" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "username", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L51" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "password", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L52" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "host", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L53" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "hostname", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L54" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "port", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L55" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "pathname", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L56" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "search", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L57" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "hash", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L58" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "disabled", "kind": "field", "description": "Whether the element is disabled (affects interactive states)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L14" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "focused", "kind": "field", "description": "Force focus state (independent of document)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L16" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "hovered", "kind": "field", "description": "Force hover state (independent of interaction)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L18" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "pressed", "kind": "field", "description": "Force pressed state (independent of interaction)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L20" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "disabledState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L171" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "hoveredState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L38" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "focusedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L39" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "pressedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L40" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "touchedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L41" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "pointedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L44" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "ariaControls", "kind": "field", "description": "ARIA 'controls' attribute (string).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L32" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "autocomplete", "kind": "field", "description": "Autocomplete token for the associated control (string).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L34" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "name", "kind": "field", "description": "Name attribute for the control used in forms.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L36" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "readOnly", "kind": "field", "description": "Read-only state reflected to control via 'readonly' attribute.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L38" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "formNoValidate", "kind": "field", "description": "When true, form validation is skipped for this control (formnovalidate).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L40" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "defaultChecked", "kind": "field", "description": "Default checked state for checkable controls (checkbox/radio).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L42" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "required", "kind": "field", "description": "Whether the control is required for form submission.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L47" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "erroredState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L65" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "defaultValue", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L66" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "value", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L108" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "checked", "kind": "field", "description": "Part of FormAssociatedMixin for simplicity.\nEnumerability doesn't guarantee checked state will be passed or used.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L145" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "form", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L160" }, "type": { "text": "HTMLFormElement" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "validity", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L161" }, "type": { "text": "ValidityState" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "validationMessage", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L162" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "willValidate", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L163" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "labels", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L168" }, "type": { "text": "NodeList" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "checkValidity", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ControlMixin.js#L69" }, "type": { "text": "(() => boolean) & (() => boolean)" } }, { "name": "reportValidity", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ControlMixin.js#L87" }, "type": { "text": "(() => boolean) & (() => boolean)" } }, { "name": "setCustomValidity", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ControlMixin.js#L96" }, "type": { "text": "((error: string) => void) & ((error: string) => void)" } }, { "name": "refreshFormAssociation", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L203" }, "type": { "text": "() => void" } }, { "name": "formAssociatedCallback", "kind": "field", "description": "New lifecycle callback. This is called when association with\n
is changed.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L225" }, "type": { "text": "(form: HTMLFormElement) => void" } }, { "name": "formIPCEvent", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L234" }, "type": { "text": "(event: CustomEvent<[string, string]>) => void" } }, { "name": "formDisabledCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L254" }, "type": { "text": "(disabled: boolean) => void" } }, { "name": "formResetCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L258" }, "type": { "text": "() => void" } }, { "name": "formStateRestoreCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L270" }, "type": { "text": "(state: string | FormData, mode: \"autocomplete\" | \"restore\") => void" } }, { "name": "focusableOnDisabled", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ControlMixin.js#L30" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "controlTagName", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L102" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "controlVoidElement", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ControlMixin.js#L32" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "onValueChangingContentAttribute", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ControlMixin.js#L43" }, "type": { "text": "() => void" } }, { "name": "accept", "kind": "field", "description": "Accepted file types for file input (e.g. '.png,.jpg').", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L41" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "alt", "kind": "field", "description": "Alternate text for images (for `type='image'`).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L43" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "dirName", "kind": "field", "description": "Directionality for form submission name (dirname attribute).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L45" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "formEnctype", "kind": "field", "description": "Form encoding type (formenctype).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L49" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "formMethod", "kind": "field", "description": "Form method when associated with a submit input (formmethod).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L51" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "formTarget", "kind": "field", "description": "Target browsing context for form submission (formtarget).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L53" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "max", "kind": "field", "description": "Max value or token for the input.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L58" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "maxLength", "kind": "field", "description": "Maximum length for text-like inputs.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L60" }, "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "min", "kind": "field", "description": "Min value or token for the input.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L62" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "minLength", "kind": "field", "description": "Minimum length for text-like inputs.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L64" }, "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "multiple", "kind": "field", "description": "When true, multiple values are allowed (e.g. file inputs).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L66" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "pattern", "kind": "field", "description": "Pattern used for validation (RegExp as string).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L68" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "placeholder", "kind": "field", "description": "Placeholder text shown when no value is present.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L70" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "size", "kind": "field", "description": "Suggested control size (number of characters).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L72" }, "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "step", "kind": "field", "description": "Step interval for numeric inputs.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L76" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "indeterminate", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L89" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "performImplicitSubmission", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L175" }, "type": { "text": "(event: Event) => void" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "setRangeText", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L345" }, "type": { "text": "{ (replacement: string): void; (replacement: string, start: number, end: number, selectionMode?: SelectionMode): void; }" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "setSelectionRange", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L348" }, "type": { "text": "(start: number, end: number, direction?: \"none\" | \"forward\" | \"backward\") => void" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "showPicker", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L351" }, "type": { "text": "() => void" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "stepDown", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L354" }, "type": { "text": "(n?: number) => void" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "stepUp", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L360" }, "type": { "text": "(n?: number) => void" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "select", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L366" }, "type": { "text": "() => void" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "files", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L371" }, "type": { "text": "FileList" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "selectionDirection", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L384" }, "type": { "text": "\"none\" | \"forward\" | \"backward\"" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "selectionEnd", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L389" }, "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "selectionStart", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L394" }, "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "valueAsDate", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L399" }, "type": { "text": "Date" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "valueAsNumber", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L407" }, "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "height", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L415" }, "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "formAction", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L423" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "width", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L431" }, "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "addRipple", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/RippleMixin.js#L37" }, "type": { "text": "(x?: number, y?: number, hold?: boolean) => CustomElement & { hadRippleHeld: boolean; hadRippleReleased: boolean; rippleStarted: boolean; } & { rippleState: string; keepAlive: boolean; _positionX: number; _positionY: number; _radius: number; holdRipple: boolean; } & { _positionStyle: ElementStylerOptions | { styles: { minHeight: string; minWidth: string; boxShadow: string; top: string; left: string; }; }; } & { updatePosition(x?: number, y?: number, size?: number): void; handleRippleComplete(): void; }" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "color", "kind": "field", "description": "Palette or surface token used to select background/ink tokens.\nExamples: 'primary', 'background', 'surface-container-low'.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L52" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "ink", "kind": "field", "description": "Explicit ink override token (e.g. 'outline', 'on-primary', 'inverse-on-surface', 'inherit').\nMaps to `--mdw-ink`.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L57" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "typeStyle", "kind": "field", "description": "Typographic style shortcut that maps to type scale variables\n(e.g. 'headline-large', 'body-medium').", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L62" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "shapeTop", "kind": "field", "description": "Show top cut/shape on the element", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L9" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "shapeBottom", "kind": "field", "description": "Show bottom cut/shape on the element", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L11" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "shapeStart", "kind": "field", "description": "Show start-side cut/shape (logical start)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L13" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "shapeEnd", "kind": "field", "description": "Show end-side cut/shape (logical end)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L15" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "shapeStyle", "kind": "field", "description": "Predefined shape size/style name (none|extra-small|small|medium|large|extra-large|full|inherit)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L17" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "density", "kind": "field", "description": "Density level affecting spacing and compactness. Integer from -4 (dense) to 4 (spacious).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/DensityMixin.js#L9" }, "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "suggestion", "kind": "field", "description": "When true, renders the chip as a suggestion variant.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Chip.js#L11" }, "type": { "text": "boolean" } }, { "name": "iconVariation", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Chip.js#L14" }, "return": { "type": { "text": "(() => string) & (() => string)" } }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "prototype", "kind": "field", "static": true, "type": { "text": "CustomElement" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "stateLayer", "kind": "field", "description": "Show the visual state layer element when true", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Button.js#L37" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "stateTargetElement", "kind": "field", "description": "Returns the element used as the state target for visual states\n(e.g., pressed/hover). Typically the internal control element.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Button.js#L34" }, "type": { "text": "HTMLElement" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "type", "kind": "field", "description": "Control type token (e.g. 'text','checkbox','radio','file').\nThe underlying control `type` (button, submit, reset, file).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Button.js#L42" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "src", "kind": "field", "description": "Source URL for image-type inputs.\nImage source URL for an icon.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Button.js#L69" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "outlined", "kind": "field", "description": "When true, an outline is rendered around the element\nWhether the button should render an outline.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Button.js#L62" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "elevated", "kind": "field", "description": "Bound to [elevated] specifying whether the element should be elevated.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Button.js#L58" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "filled", "kind": "field", "description": "Visual filled variant; may be \"tonal\" or boolean-filled token.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Button.js#L60" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "icon", "kind": "field", "description": "Icon name (uses internal `mdw-icon` when set).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Button.js#L64" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "iconInk", "kind": "field", "description": "Ink color override for the icon.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Button.js#L66" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "svg", "kind": "field", "description": "Inline SVG markup to render as icon.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Button.js#L71" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "viewBox", "kind": "field", "description": "SVG `viewBox` attribute for inline SVG icons.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Button.js#L73" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "svgPath", "kind": "field", "description": "Path data for an inline SVG icon.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Button.js#L75" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "hasIcon", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Button.js#L78" }, "return": { "type": { "text": "() => string" } }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "compose", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L145" }, "type": { "text": "(parts: CompositionPart[]) => Composition" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "#refsProxy", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1145" }, "type": { "text": "Record" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "#refsCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1148" }, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "#refsCompositionCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1151" }, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "#composition", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1154" }, "type": { "text": "Composition" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "#patching", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1156" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "#pendingPatchRenders", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1159" }, "type": { "text": "[string, any, CustomElement][]" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "#propAttributeCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1162" }, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "#callbackArguments", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1165" }, "type": { "text": "CallbackArguments" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "elementInternals", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1172" }, "type": { "text": "ElementInternals" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "render", "kind": "field", "description": "Updates nodes based on data\nExpects data in JSON Merge Patch format", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1185" }, "type": { "text": "RenderDraw" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "propChangedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1213" }, "type": { "text": "(this: T, name: K, oldValue: K extends keyof T ? T[K] : unknown, newValue: K extends keyof T ? T[K] : unknown, changes?: K extends keyof T ? T[K] extends object ? Partial : T[K] : unknown) => void" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "attributeChangedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1234" }, "type": { "text": "(name: string, oldValue: string, newValue: string) => void" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "#template", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1284" }, "type": { "text": "DocumentFragment" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "#onObserverPropertyChanged", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1294" }, "type": { "text": "(name: string, oldValue: any, newValue: any, changes: any) => void" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "static", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1330" }, "type": { "text": "typeof CustomElement" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "patch", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1333" }, "type": { "text": "(patch: any) => void" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "refs", "kind": "field", "description": "Proxy object that returns shadow DOM elements by tag.\nIf called before interpolation (eg: on composed), returns from template", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1404" }, "type": { "text": "Record" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "attributeCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1391" }, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "callbackArguments", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1400" }, "type": { "text": "CallbackArguments | { composition: Composition; refs: Record; html: any; inline: (fn: (data: Partial) => any) => string; template: DocumentFragment; element: T; }" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "composition", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1403" }, "type": { "text": "Composition" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "connectedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1435" }, "type": { "text": "() => void" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "disconnectedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1441" }, "type": { "text": "() => void" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "elementName", "kind": "field", "static": true, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "observedAttributes", "kind": "field", "static": true, "type": { "text": "Iterable" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "interpolatesTemplate", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "supportsElementInternals", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "supportsElementInternalsRole", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "defined", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "registrations", "kind": "field", "static": true, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "expressions", "kind": "method", "static": true, "description": "Expressions are idempotent functions that are selectively called whenever\na render is requested.\nExpressions are constructed exactly as methods though differ in expected\narguments. The first argument should be destructured to ensure each used\nproperty is accessed at least once in order to inspect used properties.\n\nThe Composition API will inspect this function with a proxy for `this` to\ncatalog what observables are used by the expression. This allows the\nComposition API to build a cache as well as selective invoke the expression\nonly when needed.\n\nWhen used with in element templates, the element itself will be passed as\nits first argument.\n````js\n Button\n .prop('filled', 'boolean')\n .prop('outlined', 'boolean')\n .expresssions({\n _isFilledOrOutlined({filled, outlined}) {\n return (filled || outlined)\n },\n })\n .html`
`;\n````\n\nWhen used with external data source, that data source\nwill be passed to the expression with all properties being `null` at first\ninspection.\n````js\n const externalData = {first: 'John', last: 'Doe'};\n ContactCard\n .expresssions({\n _fullName({first, last}) {\n return [first, last].filter(Boolean).join(' ');\n },\n })\n myButton.render(externalData);\n````\n\nExpressions may be support argumentless calls by using default\nparameters with `this`.\n````js\n Button\n .expresssions({\n isFilledOrOutlined({filled, outlined} = this) {\n return (filled || outlined)\n },\n });\n myButton.isFilledorOutlined();\n````", "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends { [K in keyof any]: K extends `_${any}` ? ((data: INSTANCE, state?: Record) => string | boolean | null) : ((data?: INSTANCE, state?: Record) => string | boolean | null); } & ThisType>(this: CLASS, expressions: PROPS & ThisType) => CLASS & Class<{ [K in keyof PROPS]: K extends `_${any}` ? never : () => ReturnType; }, ARGS>" } }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "methods", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "overrides", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends Partial>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "props", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "idl", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "append", "kind": "field", "static": true, "description": "Append parts to composition", "type": { "text": "(this: T, ...parts: CompositionPart[]) => T" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "recompose", "kind": "field", "static": true, "description": "After composition, invokes callback.\nMay be called multiple times.", "type": { "text": ", T3 extends CompositionCallback[\"composed\"]>(this: T1, callback: T3) => T1" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "css", "kind": "field", "static": true, "description": "Appends styles to composition", "type": { "text": "(this: T1, array: T2, ...rest: T2 extends string ? any : T2 extends TemplateStringsArray ? any[] : (HTMLStyleElement | CSSStyleSheet)[]) => T1" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "autoRegister", "kind": "field", "static": true, "description": "Registers class with customElements. If class is registered before then,\ndoes nothing.", "type": { "text": "(this: T, elementName: string) => T" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "html", "kind": "field", "static": true, "description": "Appends DocumentFragment to composition", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1405" }, "type": { "text": "(this: T, string: TemplateStringsArray, ...substitutions: (string | Element | ((this: InstanceType, data: InstanceType, injections?: any) => any))[]) => T" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "extend", "kind": "field", "static": true, "description": "Extends base class into a new class.\nUse to avoid mutating base class.", "type": { "text": " T2>(this: T1, customExtender?: T3) => T3 extends null ? T1 : T2" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "setStatic", "kind": "field", "static": true, "description": "Assigns static values to class", "type": { "text": " any) | string | number | boolean | any[] | object); }>(this: T1, source: T2 & ThisType) => T1 & T2" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "readonly", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "set", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "mixin", "kind": "field", "static": true, "description": "Returns result of calling mixin with current class", "type": { "text": " any, RETURN extends ReturnType, SUBCLASS extends ClassOf>(this: BASE, mixin: FN) => SUBCLASS & BASE" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "register", "kind": "field", "static": true, "description": "Registers class with window.customElements synchronously", "type": { "text": "(this: T, elementName?: string, force?: boolean) => T" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "propList", "kind": "field", "static": true, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "attrList", "kind": "field", "static": true, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "propChangedCallbacks", "kind": "field", "static": true, "type": { "text": "Map any)[]>" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "attributeChangedCallbacks", "kind": "field", "static": true, "type": { "text": "Map any)[]>" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "prop", "kind": "field", "static": true, "description": "Creates observable property on instances (via prototype)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1007" }, "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "setPrototype", "kind": "field", "static": true, "description": "Creates observable property on instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any)>(this: CLASS, name: KEY, options: OPTIONS) => OPTIONS extends (...args2: any[]) => infer R ? R : OPTIONS extends ObserverPropertyType ? ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? unknown extends R ? object : R : OPTIONS extends { type: ObserverPropertyType; } ? ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? unknown extends R ? string : R : never" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "define", "kind": "field", "static": true, "description": "Define properties on instances via Object.defineProperties().\nAutomatically sets property non-enumerable if name begins with `_`.\nFunctions will be remapped as getters", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends { [P in keyof any]: { enumerable?: boolean; configurable?: boolean; writable?: boolean; value?: any; get?: ((this: INSTANCE) => any); set?: (this: INSTANCE, value: any) => void; } | ((this: INSTANCE, ...args: any[]) => any); }, VALUE extends { [KEY in keyof PROPS]: PROPS[KEY] extends (...args2: any[]) => infer R ? R : PROPS[KEY] extends TypedPropertyDescriptor ? R : never; }>(this: CLASS, props: PROPS & ThisType) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "undefine", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROP extends string, PROPS extends INSTANCE & Record>(this: CLASS, name: PROP) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "observe", "kind": "field", "static": true, "description": "Creates observable properties on instances", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends IDLParameter, VALUE extends { [KEY in keyof PROPS]: PROPS[KEY] extends (...args2: any[]) => infer R ? R : PROPS[KEY] extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : PROPS[KEY] extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : PROPS[KEY] extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : PROPS[KEY] extends ObserverOptions ? (unknown extends R ? string : R) : never; }>(this: CLASS, props: PROPS) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "defineStatic", "kind": "field", "static": true, "type": { "text": ">(this: T1, props: T2) => T1 & ParsedProps" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "events", "kind": "field", "static": true, "type": { "text": "(this: T, listeners?: CompositionEventListenerObject>, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "childEvents", "kind": "field", "static": true, "type": { "text": "(this: T, listenerMap: { [x: string]: CompositionEventListenerObject>; }, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "rootEvents", "kind": "field", "static": true, "type": { "text": "(this: T, listeners?: CompositionEventListenerObject>, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "on", "kind": "field", "static": true, "type": { "text": ", T3 extends CompositionCallback, T4 extends keyof T3>(this: T1, name: T3 | T4, callbacks?: T3[T4] & ThisType) => T1" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "off", "kind": "field", "static": true, "type": { "text": ", T3 extends CompositionCallback, T4 extends keyof T3>(this: T1, name: T3 | T4, callbacks?: T3[T4] & ThisType) => T1" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "offPropChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: ObjectOrObjectEntries<{ [P in keyof T2]?: (this: T2, oldValue: T2[P], newValue: T2[P], changes: any, element: T2) => void; }>) => T1" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "offAttributeChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: { [x: string]: (this: T2, oldValue: string, newValue: string, element: T2) => void; }) => T1" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "onPropChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: ObjectOrObjectEntries<{ [P in keyof T2]?: (this: T2, oldValue: T2[P], newValue: T2[P], changes: any, element: T2) => void; }>) => T1" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "onAttributeChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: { [x: string]: (this: T2, oldValue: string, newValue: string, element: T2) => void; }) => T1" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } } ], "slots": [ { "name": "", "description": "{_defaultValue}" } ], "cssParts": [ { "name": "control" } ], "events": [ { "name": "value-changing-content-attribute", "type": { "text": "Event" } } ], "demos": [ { "url": "demo/components/chips.html" } ], "superclass": { "module": "components/Button.js", "name": "default" }, "mixins": [], "description": "Chips help people enter information, make selections, filter content, or trigger actions.\n@see https://m3.material.io/components/chips/specs" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "default", "module": "components/Chip.js" } }, { "kind": "custom-element-definition", "name": "mdw-chip", "declaration": { "name": "default", "module": "components/Chip.js" } } ] }, { "kind": "javascript-module", "path": "components/Dialog.js", "declarations": [ { "kind": "class", "name": "Dialog", "tagName": "mdw-dialog", "customElement": true, "attributes": [ { "name": "color", "fieldName": "color", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "ink", "fieldName": "ink", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "type-style", "fieldName": "typeStyle", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "shape-top", "fieldName": "shapeTop", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shape-bottom", "fieldName": "shapeBottom", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shape-start", "fieldName": "shapeStart", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shape-end", "fieldName": "shapeEnd", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shape-style", "fieldName": "shapeStyle", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "outlined", "fieldName": "outlined", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "open", "fieldName": "open", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/PopupMixin.js" } }, { "name": "modal", "fieldName": "modal", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/PopupMixin.js" } }, { "name": "native", "fieldName": "native", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/PopupMixin.js" } }, { "name": "scrollable", "fieldName": "scrollable", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/PopupMixin.js" } }, { "name": "match-source-width", "fieldName": "matchSourceWidth", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/PopupMixin.js" } }, { "name": "popup-margin", "fieldName": "popupMargin", "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "mixins/PopupMixin.js" } }, { "name": "dividers", "description": "Divider style for the dialog: 'full', 'inset', or empty.", "fieldName": "dividers", "type": { "text": "string" } }, { "name": "headline", "description": "Headline text displayed in the dialog header.", "fieldName": "headline", "type": { "text": "string" } }, { "name": "icon", "description": "Optional icon name shown in the dialog header.", "fieldName": "icon", "type": { "text": "string" } }, { "name": "default", "description": "Default action (value) for the dialog when submitting.", "fieldName": "default", "type": { "text": "string" } }, { "name": "cancel", "description": "Label for the cancel action button.", "fieldName": "cancel", "type": { "text": "string" } }, { "name": "confirm", "description": "Label for the confirm action button.", "fieldName": "confirm", "type": { "text": "string" } }, { "name": "flow", "type": { "text": "string" }, "fieldName": "flow", "inheritedFrom": { "name": "default", "module": "mixins/PopupMixin.js" } } ], "members": [ { "name": "delegatesFocus", "kind": "field", "description": "When true, the element delegates focus to an internal focus target.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/DelegatesFocusMixin.js#L15" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "open", "kind": "field", "description": "Whether the popup is currently open", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/PopupMixin.js#L84" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/PopupMixin.js" } }, { "name": "modal", "kind": "field", "description": "When true the popup behaves as a blocking modal", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/PopupMixin.js#L86" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/PopupMixin.js" } }, { "name": "native", "kind": "field", "description": "Use the native HTMLDialogElement when available", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/PopupMixin.js#L88" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/PopupMixin.js" } }, { "name": "scrollable", "kind": "field", "description": "Allow internal content to scroll when true", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/PopupMixin.js#L90" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/PopupMixin.js" } }, { "name": "matchSourceWidth", "kind": "field", "description": "When true, match the popup width to the source element", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/PopupMixin.js#L92" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/PopupMixin.js" } }, { "name": "flow", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Dialog.js#L130" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/PopupMixin.js" } }, { "name": "popupMargin", "kind": "field", "description": "Margin between popup and viewport/anchor (px)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/PopupMixin.js#L101" }, "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "mixins/PopupMixin.js" } }, { "name": "useHistory", "kind": "field", "description": "Whether to push/pop history entries when opening the popup", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/PopupMixin.js#L105" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/PopupMixin.js" } }, { "name": "returnValue", "kind": "field", "description": "Optional return value for dialog-like popups\nReturn the `returnValue` from the internal dialog element.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Dialog.js#L101" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/PopupMixin.js" } }, { "name": "disabled", "kind": "field", "description": "Whether the element is disabled (affects interactive states)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L14" }, "type": { "text": "boolean" } }, { "name": "focused", "kind": "field", "description": "Force focus state (independent of document)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L16" }, "type": { "text": "boolean" } }, { "name": "hovered", "kind": "field", "description": "Force hover state (independent of interaction)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L18" }, "type": { "text": "boolean" } }, { "name": "pressed", "kind": "field", "description": "Force pressed state (independent of interaction)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L20" }, "type": { "text": "boolean" } }, { "name": "stateLayer", "kind": "field", "description": "Show the visual state layer element when true", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L34" }, "type": { "text": "boolean" } }, { "name": "disabledState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L37" }, "type": { "text": "boolean" } }, { "name": "hoveredState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L38" }, "type": { "text": "boolean" } }, { "name": "focusedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L39" }, "type": { "text": "boolean" } }, { "name": "pressedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L40" }, "type": { "text": "boolean" } }, { "name": "touchedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L41" }, "type": { "text": "boolean" } }, { "name": "pointedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L44" }, "type": { "text": "boolean" } }, { "name": "stateTargetElement", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L50" }, "type": { "text": "HTMLElement" } }, { "name": "color", "kind": "field", "description": "Palette or surface token used to select background/ink tokens.\nExamples: 'primary', 'background', 'surface-container-low'.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L52" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "ink", "kind": "field", "description": "Explicit ink override token (e.g. 'outline', 'on-primary', 'inverse-on-surface', 'inherit').\nMaps to `--mdw-ink`.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L57" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "typeStyle", "kind": "field", "description": "Typographic style shortcut that maps to type scale variables\n(e.g. 'headline-large', 'body-medium').", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L62" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "shapeTop", "kind": "field", "description": "Show top cut/shape on the element", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L9" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shapeBottom", "kind": "field", "description": "Show bottom cut/shape on the element", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L11" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shapeStart", "kind": "field", "description": "Show start-side cut/shape (logical start)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L13" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shapeEnd", "kind": "field", "description": "Show end-side cut/shape (logical end)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L15" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shapeStyle", "kind": "field", "description": "Predefined shape size/style name (none|extra-small|small|medium|large|extra-large|full|inherit)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L17" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "outlined", "kind": "field", "description": "When true, an outline is rendered around the element", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L19" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "dividers", "kind": "field", "description": "Divider style for the dialog: 'full', 'inset', or empty.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Dialog.js#L107" }, "type": { "text": "\"\" | \"full\" | \"inset\"" } }, { "name": "headline", "kind": "field", "description": "Headline text displayed in the dialog header.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Dialog.js#L112" }, "type": { "text": "string" } }, { "name": "icon", "kind": "field", "description": "Optional icon name shown in the dialog header.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Dialog.js#L114" }, "type": { "text": "string" } }, { "name": "default", "kind": "field", "description": "Default action (value) for the dialog when submitting.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Dialog.js#L116" }, "type": { "text": "string" } }, { "name": "cancel", "kind": "field", "description": "Label for the cancel action button.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Dialog.js#L118" }, "type": { "text": "string" } }, { "name": "confirm", "kind": "field", "description": "Label for the confirm action button.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Dialog.js#L120" }, "type": { "text": "string" } }, { "name": "cancelAutoFocus", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Dialog.js#L150" }, "return": { "type": { "text": "() => boolean" } } }, { "name": "confirmAutoFocus", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Dialog.js#L151" }, "return": { "type": { "text": "() => boolean" } } }, { "name": "prototype", "kind": "field", "static": true, "type": { "text": "CustomElement" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "updatePopupPosition", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/PopupMixin.js#L138" }, "return": { "type": { "text": "(anchor?: Element | DOMRectLike) => void" } }, "inheritedFrom": { "name": "default", "module": "mixins/PopupMixin.js" } }, { "name": "onSlotChange", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/PopupMixin.js#L290" }, "return": { "type": { "text": "({ currentTarget }: Event & { currentTarget: HTMLSlotElement; }) => void" } }, "inheritedFrom": { "name": "default", "module": "mixins/PopupMixin.js" } }, { "name": "showPopup", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/PopupMixin.js#L303" }, "return": { "type": { "text": "(source?: HTMLElement | Event | PointerEvent | MouseEvent, focus?: boolean, flow?: string) => boolean" } }, "inheritedFrom": { "name": "default", "module": "mixins/PopupMixin.js" } }, { "name": "showModal", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/PopupMixin.js#L389" }, "return": { "type": { "text": "(source?: HTMLElement | Event | PointerEvent | MouseEvent, focus?: boolean, flow?: string) => boolean" } }, "inheritedFrom": { "name": "default", "module": "mixins/PopupMixin.js" } }, { "name": "show", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/PopupMixin.js#L404" }, "return": { "type": { "text": "(source?: HTMLElement | Event | PointerEvent | MouseEvent, focus?: boolean, flow?: string) => boolean" } }, "inheritedFrom": { "name": "default", "module": "mixins/PopupMixin.js" } }, { "name": "close", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/PopupMixin.js#L417" }, "return": { "type": { "text": "(returnValue?: any, returnFocus?: boolean) => boolean" } }, "inheritedFrom": { "name": "default", "module": "mixins/PopupMixin.js" } }, { "name": "compose", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L145" }, "type": { "text": "(parts: CompositionPart[]) => Composition" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#refsProxy", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1145" }, "type": { "text": "Record" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#refsCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1148" }, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#refsCompositionCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1151" }, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#composition", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1154" }, "type": { "text": "Composition" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#patching", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1156" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#pendingPatchRenders", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1159" }, "type": { "text": "[string, any, CustomElement][]" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#propAttributeCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1162" }, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#callbackArguments", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1165" }, "type": { "text": "CallbackArguments" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "elementInternals", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1172" }, "type": { "text": "ElementInternals" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "render", "kind": "field", "description": "Updates nodes based on data\nExpects data in JSON Merge Patch format", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1185" }, "type": { "text": "RenderDraw" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "propChangedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1213" }, "type": { "text": "(this: T, name: K, oldValue: K extends keyof T ? T[K] : unknown, newValue: K extends keyof T ? T[K] : unknown, changes?: K extends keyof T ? T[K] extends object ? Partial : T[K] : unknown) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attributeChangedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1234" }, "type": { "text": "(name: string, oldValue: string, newValue: string) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#template", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1284" }, "type": { "text": "DocumentFragment" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#onObserverPropertyChanged", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1294" }, "type": { "text": "(name: string, oldValue: any, newValue: any, changes: any) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "static", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1330" }, "type": { "text": "typeof CustomElement" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "patch", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1333" }, "type": { "text": "(patch: any) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "refs", "kind": "field", "description": "Proxy object that returns shadow DOM elements by tag.\nIf called before interpolation (eg: on composed), returns from template", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1404" }, "type": { "text": "Record" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attributeCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1391" }, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "callbackArguments", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1400" }, "type": { "text": "CallbackArguments | { composition: Composition; refs: Record; html: any; inline: (fn: (data: Partial) => any) => string; template: DocumentFragment; element: T; }" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "composition", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1403" }, "type": { "text": "Composition" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "connectedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1435" }, "type": { "text": "() => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "disconnectedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1441" }, "type": { "text": "() => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "elementName", "kind": "field", "static": true, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "observedAttributes", "kind": "field", "static": true, "type": { "text": "Iterable" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "interpolatesTemplate", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "supportsElementInternals", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "supportsElementInternalsRole", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "defined", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "registrations", "kind": "field", "static": true, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "expressions", "kind": "method", "static": true, "description": "Expressions are idempotent functions that are selectively called whenever\na render is requested.\nExpressions are constructed exactly as methods though differ in expected\narguments. The first argument should be destructured to ensure each used\nproperty is accessed at least once in order to inspect used properties.\n\nThe Composition API will inspect this function with a proxy for `this` to\ncatalog what observables are used by the expression. This allows the\nComposition API to build a cache as well as selective invoke the expression\nonly when needed.\n\nWhen used with in element templates, the element itself will be passed as\nits first argument.\n````js\n Button\n .prop('filled', 'boolean')\n .prop('outlined', 'boolean')\n .expresssions({\n _isFilledOrOutlined({filled, outlined}) {\n return (filled || outlined)\n },\n })\n .html`
`;\n````\n\nWhen used with external data source, that data source\nwill be passed to the expression with all properties being `null` at first\ninspection.\n````js\n const externalData = {first: 'John', last: 'Doe'};\n ContactCard\n .expresssions({\n _fullName({first, last}) {\n return [first, last].filter(Boolean).join(' ');\n },\n })\n myButton.render(externalData);\n````\n\nExpressions may be support argumentless calls by using default\nparameters with `this`.\n````js\n Button\n .expresssions({\n isFilledOrOutlined({filled, outlined} = this) {\n return (filled || outlined)\n },\n });\n myButton.isFilledorOutlined();\n````", "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends { [K in keyof any]: K extends `_${any}` ? ((data: INSTANCE, state?: Record) => string | boolean | null) : ((data?: INSTANCE, state?: Record) => string | boolean | null); } & ThisType>(this: CLASS, expressions: PROPS & ThisType) => CLASS & Class<{ [K in keyof PROPS]: K extends `_${any}` ? never : () => ReturnType; }, ARGS>" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "methods", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "overrides", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends Partial>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "props", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "idl", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "append", "kind": "field", "static": true, "description": "Append parts to composition", "type": { "text": "(this: T, ...parts: CompositionPart[]) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "recompose", "kind": "field", "static": true, "description": "After composition, invokes callback.\nMay be called multiple times.", "type": { "text": ", T3 extends CompositionCallback[\"composed\"]>(this: T1, callback: T3) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "css", "kind": "field", "static": true, "description": "Appends styles to composition", "type": { "text": "(this: T1, array: T2, ...rest: T2 extends string ? any : T2 extends TemplateStringsArray ? any[] : (HTMLStyleElement | CSSStyleSheet)[]) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "autoRegister", "kind": "field", "static": true, "description": "Registers class with customElements. If class is registered before then,\ndoes nothing.", "type": { "text": "(this: T, elementName: string) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "html", "kind": "field", "static": true, "description": "Appends DocumentFragment to composition", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1405" }, "type": { "text": "(this: T, string: TemplateStringsArray, ...substitutions: (string | Element | ((this: InstanceType, data: InstanceType, injections?: any) => any))[]) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "extend", "kind": "field", "static": true, "description": "Extends base class into a new class.\nUse to avoid mutating base class.", "type": { "text": " T2>(this: T1, customExtender?: T3) => T3 extends null ? T1 : T2" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "setStatic", "kind": "field", "static": true, "description": "Assigns static values to class", "type": { "text": " any) | string | number | boolean | any[] | object); }>(this: T1, source: T2 & ThisType) => T1 & T2" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "readonly", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "set", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "mixin", "kind": "field", "static": true, "description": "Returns result of calling mixin with current class", "type": { "text": " any, RETURN extends ReturnType, SUBCLASS extends ClassOf>(this: BASE, mixin: FN) => SUBCLASS & BASE" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "register", "kind": "field", "static": true, "description": "Registers class with window.customElements synchronously", "type": { "text": "(this: T, elementName?: string, force?: boolean) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "propList", "kind": "field", "static": true, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attrList", "kind": "field", "static": true, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "propChangedCallbacks", "kind": "field", "static": true, "type": { "text": "Map any)[]>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attributeChangedCallbacks", "kind": "field", "static": true, "type": { "text": "Map any)[]>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "prop", "kind": "field", "static": true, "description": "Creates observable property on instances (via prototype)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1007" }, "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "setPrototype", "kind": "field", "static": true, "description": "Creates observable property on instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any)>(this: CLASS, name: KEY, options: OPTIONS) => OPTIONS extends (...args2: any[]) => infer R ? R : OPTIONS extends ObserverPropertyType ? ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? unknown extends R ? object : R : OPTIONS extends { type: ObserverPropertyType; } ? ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? unknown extends R ? string : R : never" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "define", "kind": "field", "static": true, "description": "Define properties on instances via Object.defineProperties().\nAutomatically sets property non-enumerable if name begins with `_`.\nFunctions will be remapped as getters", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends { [P in keyof any]: { enumerable?: boolean; configurable?: boolean; writable?: boolean; value?: any; get?: ((this: INSTANCE) => any); set?: (this: INSTANCE, value: any) => void; } | ((this: INSTANCE, ...args: any[]) => any); }, VALUE extends { [KEY in keyof PROPS]: PROPS[KEY] extends (...args2: any[]) => infer R ? R : PROPS[KEY] extends TypedPropertyDescriptor ? R : never; }>(this: CLASS, props: PROPS & ThisType) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "undefine", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROP extends string, PROPS extends INSTANCE & Record>(this: CLASS, name: PROP) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "observe", "kind": "field", "static": true, "description": "Creates observable properties on instances", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends IDLParameter, VALUE extends { [KEY in keyof PROPS]: PROPS[KEY] extends (...args2: any[]) => infer R ? R : PROPS[KEY] extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : PROPS[KEY] extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : PROPS[KEY] extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : PROPS[KEY] extends ObserverOptions ? (unknown extends R ? string : R) : never; }>(this: CLASS, props: PROPS) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "defineStatic", "kind": "field", "static": true, "type": { "text": ">(this: T1, props: T2) => T1 & ParsedProps" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "events", "kind": "field", "static": true, "type": { "text": "(this: T, listeners?: CompositionEventListenerObject>, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "childEvents", "kind": "field", "static": true, "type": { "text": "(this: T, listenerMap: { [x: string]: CompositionEventListenerObject>; }, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "rootEvents", "kind": "field", "static": true, "type": { "text": "(this: T, listeners?: CompositionEventListenerObject>, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "on", "kind": "field", "static": true, "type": { "text": ", T3 extends CompositionCallback, T4 extends keyof T3>(this: T1, name: T3 | T4, callbacks?: T3[T4] & ThisType) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "off", "kind": "field", "static": true, "type": { "text": ", T3 extends CompositionCallback, T4 extends keyof T3>(this: T1, name: T3 | T4, callbacks?: T3[T4] & ThisType) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "offPropChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: ObjectOrObjectEntries<{ [P in keyof T2]?: (this: T2, oldValue: T2[P], newValue: T2[P], changes: any, element: T2) => void; }>) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "offAttributeChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: { [x: string]: (this: T2, oldValue: string, newValue: string, element: T2) => void; }) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "onPropChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: ObjectOrObjectEntries<{ [P in keyof T2]?: (this: T2, oldValue: T2[P], newValue: T2[P], changes: any, element: T2) => void; }>) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "onAttributeChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: { [x: string]: (this: T2, oldValue: string, newValue: string, element: T2) => void; }) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } } ], "slots": [ { "name": "headline", "description": "{headline}" }, { "name": "fixed", "description": "" }, { "name": "content", "description": "" }, { "name": "", "description": "" }, { "name": "actions", "description": "\n \n {cancel}\n {confirm}\n \n " } ], "cssParts": [], "events": [], "demos": [ { "url": "demo/components/dialogs.html" } ], "superclass": { "module": "core/CustomElement.js", "name": "default" }, "mixins": [ { "module": "mixins/ThemableMixin.js", "name": "default" }, { "module": "mixins/ShapeMixin.js", "name": "default" }, { "module": "mixins/PopupMixin.js", "name": "default" } ], "description": "Returns array of elements that *may* be focusable over tab\n@param {Node} root\n@return {Element[]}" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "default", "module": "components/Dialog.js" } }, { "kind": "custom-element-definition", "name": "mdw-dialog", "declaration": { "name": "default", "module": "components/Dialog.js" } } ] }, { "kind": "javascript-module", "path": "components/DialogActions.js", "declarations": [ { "kind": "class", "name": "DialogActions", "tagName": "mdw-dialog-actions", "customElement": true, "attributes": [], "members": [ { "name": "prototype", "kind": "field", "static": true, "type": { "text": "CustomElement" } } ], "slots": [ { "name": "", "description": "" } ], "cssParts": [], "events": [], "demos": [], "superclass": { "module": "global:", "name": "HTMLElement" }, "mixins": [], "description": "Dialog action regions contain primary and secondary actions for dialogs.\n@see https://m3.material.io/components/dialogs/specs" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "default", "module": "components/DialogActions.js" } }, { "kind": "custom-element-definition", "name": "mdw-dialog-actions", "declaration": { "name": "default", "module": "components/DialogActions.js" } } ] }, { "kind": "javascript-module", "path": "components/Display.js", "declarations": [ { "kind": "class", "name": "Display", "tagName": "mdw-display", "customElement": true, "attributes": [ { "name": "color", "fieldName": "color", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "ink", "fieldName": "ink", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "type-style", "fieldName": "typeStyle", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "block", "fieldName": "block", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "inline", "fieldName": "inline", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "row", "fieldName": "row", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "x", "fieldName": "x", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "y", "fieldName": "y", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "gap", "fieldName": "gap", "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "padding", "fieldName": "padding", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "text-padding", "fieldName": "textPadding", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/TypographyMixin.js" } }, { "name": "text-padding-top", "fieldName": "textPaddingTop", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/TypographyMixin.js" } }, { "name": "text-leading", "fieldName": "textLeading", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/TypographyMixin.js" } }, { "name": "text-padding-bottom", "fieldName": "textPaddingBottom", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/TypographyMixin.js" } }, { "name": "aria-level", "description": "Explicit aria-level; if set, overrides the computed level.", "fieldName": "ariaLevel", "type": { "text": "string" } }, { "name": "size", "description": "Display size controlling typographic scale: 'large'|'medium'|'small'.", "fieldName": "size", "type": { "text": "string" } } ], "members": [ { "name": "delegatesFocus", "kind": "field", "description": "When true, the element delegates focus to an internal focus target.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/DelegatesFocusMixin.js#L15" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "textPadding", "kind": "field", "description": "General vertical padding for text content (css length)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/TypographyMixin.js#L24" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/TypographyMixin.js" } }, { "name": "textPaddingTop", "kind": "field", "description": "Padding-top override for text content (css length)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/TypographyMixin.js#L26" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/TypographyMixin.js" } }, { "name": "textLeading", "kind": "field", "description": "Line-leading (extra top spacing) for text (css length or 'sp' units)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/TypographyMixin.js#L28" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/TypographyMixin.js" } }, { "name": "textPaddingBottom", "kind": "field", "description": "Padding-bottom override for text content (css length)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/TypographyMixin.js#L30" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/TypographyMixin.js" } }, { "name": "block", "kind": "field", "description": "Set `display: block` on the host (boolean)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js#L9" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "inline", "kind": "field", "description": "Use inline flex layout: `display: inline-flex` (boolean)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js#L11" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "row", "kind": "field", "description": "Switch main axis to horizontal: `flex-direction: row` (boolean)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js#L13" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "x", "kind": "field", "description": "Main-axis alignment / justification.\nAllowed: 'start'|'center'|'end'|'between'|'around'|'stretch'|'baseline'.\nDefault: 'start'.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js#L19" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "y", "kind": "field", "description": "Cross-axis alignment / alignment of items.\nSame allowed values as `x`. Default: 'start'.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js#L29" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "gap", "kind": "field", "description": "Gap between children. Accepts preset numeric strings (e.g. '8') mapped to px, or floats.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js#L36" }, "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "padding", "kind": "field", "description": "Padding preset or numeric value (e.g. 'pane', '8', '16').", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js#L38" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "color", "kind": "field", "description": "Palette or surface token used to select background/ink tokens.\nExamples: 'primary', 'background', 'surface-container-low'.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L52" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "ink", "kind": "field", "description": "Explicit ink override token (e.g. 'outline', 'on-primary', 'inverse-on-surface', 'inherit').\nMaps to `--mdw-ink`.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L57" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "typeStyle", "kind": "field", "description": "Typographic style shortcut that maps to type scale variables\n(e.g. 'headline-large', 'body-medium').", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L62" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "size", "kind": "field", "description": "Display size controlling typographic scale: 'large'|'medium'|'small'.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Display.js#L24" }, "type": { "text": "string" } }, { "name": "prototype", "kind": "field", "static": true, "type": { "text": "CustomElement" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "readAriaProperty", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/AriaReflectorMixin.js#L28" }, "return": { "type": { "text": "(name: \"shadowRoot\" | \"ariaActiveDescendantElement\" | \"ariaAtomic\" | \"ariaAutoComplete\" | \"ariaBrailleLabel\" | \"ariaBrailleRoleDescription\" | \"ariaBusy\" | \"ariaChecked\" | \"ariaColCount\" | \"ariaColIndex\" | \"ariaColIndexText\" | \"ariaColSpan\" | \"ariaControlsElements\" | \"ariaCurrent\" | \"ariaDescribedByElements\" | \"ariaDescription\" | \"ariaDetailsElements\" | \"ariaDisabled\" | \"ariaErrorMessageElements\" | \"ariaExpanded\" | \"ariaFlowToElements\" | \"ariaHasPopup\" | \"ariaHidden\" | \"ariaInvalid\" | \"ariaKeyShortcuts\" | \"ariaLabel\" | \"ariaLabelledByElements\" | \"ariaLevel\" | \"ariaLive\" | \"ariaModal\" | \"ariaMultiLine\" | \"ariaMultiSelectable\" | \"ariaOrientation\" | \"ariaOwnsElements\" | \"ariaPlaceholder\" | \"ariaPosInSet\" | \"ariaPressed\" | \"ariaReadOnly\" | \"ariaRelevant\" | \"ariaRequired\" | \"ariaRoleDescription\" | \"ariaRowCount\" | \"ariaRowIndex\" | \"ariaRowIndexText\" | \"ariaRowSpan\" | \"ariaSelected\" | \"ariaSetSize\" | \"ariaSort\" | \"ariaValueMax\" | \"ariaValueMin\" | \"ariaValueNow\" | \"ariaValueText\" | \"role\") => string | Element | ShadowRoot | readonly Element[]" } }, "inheritedFrom": { "name": "default", "module": "mixins/AriaReflectorMixin.js" } }, { "name": "updateAriaProperty", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/AriaReflectorMixin.js#L47" }, "return": { "type": { "text": ">(name: K, value: ARIAMixin[K]) => void" } }, "inheritedFrom": { "name": "default", "module": "mixins/AriaReflectorMixin.js" } }, { "name": "compose", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L145" }, "type": { "text": "(parts: CompositionPart[]) => Composition" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "#refsProxy", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1145" }, "type": { "text": "Record" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "#refsCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1148" }, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "#refsCompositionCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1151" }, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "#composition", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1154" }, "type": { "text": "Composition" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "#patching", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1156" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "#pendingPatchRenders", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1159" }, "type": { "text": "[string, any, CustomElement][]" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "#propAttributeCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1162" }, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "#callbackArguments", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1165" }, "type": { "text": "CallbackArguments" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "elementInternals", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1172" }, "type": { "text": "ElementInternals" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "render", "kind": "field", "description": "Updates nodes based on data\nExpects data in JSON Merge Patch format", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1185" }, "type": { "text": "RenderDraw" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "propChangedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1213" }, "type": { "text": "(this: T, name: K, oldValue: K extends keyof T ? T[K] : unknown, newValue: K extends keyof T ? T[K] : unknown, changes?: K extends keyof T ? T[K] extends object ? Partial : T[K] : unknown) => void" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "attributeChangedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1234" }, "type": { "text": "(name: string, oldValue: string, newValue: string) => void" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "#template", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1284" }, "type": { "text": "DocumentFragment" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "#onObserverPropertyChanged", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1294" }, "type": { "text": "(name: string, oldValue: any, newValue: any, changes: any) => void" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "static", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1330" }, "type": { "text": "typeof CustomElement" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "patch", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1333" }, "type": { "text": "(patch: any) => void" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "refs", "kind": "field", "description": "Proxy object that returns shadow DOM elements by tag.\nIf called before interpolation (eg: on composed), returns from template", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1404" }, "type": { "text": "Record" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "attributeCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1391" }, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "callbackArguments", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1400" }, "type": { "text": "CallbackArguments | { composition: Composition; refs: Record; html: any; inline: (fn: (data: Partial) => any) => string; template: DocumentFragment; element: T; }" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "composition", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1403" }, "type": { "text": "Composition" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "connectedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1435" }, "type": { "text": "() => void" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "disconnectedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1441" }, "type": { "text": "() => void" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "elementName", "kind": "field", "static": true, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "observedAttributes", "kind": "field", "static": true, "type": { "text": "Iterable" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "interpolatesTemplate", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "supportsElementInternals", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "supportsElementInternalsRole", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "defined", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "registrations", "kind": "field", "static": true, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "expressions", "kind": "method", "static": true, "description": "Expressions are idempotent functions that are selectively called whenever\na render is requested.\nExpressions are constructed exactly as methods though differ in expected\narguments. The first argument should be destructured to ensure each used\nproperty is accessed at least once in order to inspect used properties.\n\nThe Composition API will inspect this function with a proxy for `this` to\ncatalog what observables are used by the expression. This allows the\nComposition API to build a cache as well as selective invoke the expression\nonly when needed.\n\nWhen used with in element templates, the element itself will be passed as\nits first argument.\n````js\n Button\n .prop('filled', 'boolean')\n .prop('outlined', 'boolean')\n .expresssions({\n _isFilledOrOutlined({filled, outlined}) {\n return (filled || outlined)\n },\n })\n .html`
`;\n````\n\nWhen used with external data source, that data source\nwill be passed to the expression with all properties being `null` at first\ninspection.\n````js\n const externalData = {first: 'John', last: 'Doe'};\n ContactCard\n .expresssions({\n _fullName({first, last}) {\n return [first, last].filter(Boolean).join(' ');\n },\n })\n myButton.render(externalData);\n````\n\nExpressions may be support argumentless calls by using default\nparameters with `this`.\n````js\n Button\n .expresssions({\n isFilledOrOutlined({filled, outlined} = this) {\n return (filled || outlined)\n },\n });\n myButton.isFilledorOutlined();\n````", "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends { [K in keyof any]: K extends `_${any}` ? ((data: INSTANCE, state?: Record) => string | boolean | null) : ((data?: INSTANCE, state?: Record) => string | boolean | null); } & ThisType>(this: CLASS, expressions: PROPS & ThisType) => CLASS & Class<{ [K in keyof PROPS]: K extends `_${any}` ? never : () => ReturnType; }, ARGS>" } }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "methods", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "overrides", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends Partial>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "props", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "idl", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "append", "kind": "field", "static": true, "description": "Append parts to composition", "type": { "text": "(this: T, ...parts: CompositionPart[]) => T" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "recompose", "kind": "field", "static": true, "description": "After composition, invokes callback.\nMay be called multiple times.", "type": { "text": ", T3 extends CompositionCallback[\"composed\"]>(this: T1, callback: T3) => T1" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "css", "kind": "field", "static": true, "description": "Appends styles to composition", "type": { "text": "(this: T1, array: T2, ...rest: T2 extends string ? any : T2 extends TemplateStringsArray ? any[] : (HTMLStyleElement | CSSStyleSheet)[]) => T1" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "autoRegister", "kind": "field", "static": true, "description": "Registers class with customElements. If class is registered before then,\ndoes nothing.", "type": { "text": "(this: T, elementName: string) => T" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "html", "kind": "field", "static": true, "description": "Appends DocumentFragment to composition", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1405" }, "type": { "text": "(this: T, string: TemplateStringsArray, ...substitutions: (string | Element | ((this: InstanceType, data: InstanceType, injections?: any) => any))[]) => T" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "extend", "kind": "field", "static": true, "description": "Extends base class into a new class.\nUse to avoid mutating base class.", "type": { "text": " T2>(this: T1, customExtender?: T3) => T3 extends null ? T1 : T2" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "setStatic", "kind": "field", "static": true, "description": "Assigns static values to class", "type": { "text": " any) | string | number | boolean | any[] | object); }>(this: T1, source: T2 & ThisType) => T1 & T2" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "readonly", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "set", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "mixin", "kind": "field", "static": true, "description": "Returns result of calling mixin with current class", "type": { "text": " any, RETURN extends ReturnType, SUBCLASS extends ClassOf>(this: BASE, mixin: FN) => SUBCLASS & BASE" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "register", "kind": "field", "static": true, "description": "Registers class with window.customElements synchronously", "type": { "text": "(this: T, elementName?: string, force?: boolean) => T" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "propList", "kind": "field", "static": true, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "attrList", "kind": "field", "static": true, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "propChangedCallbacks", "kind": "field", "static": true, "type": { "text": "Map any)[]>" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "attributeChangedCallbacks", "kind": "field", "static": true, "type": { "text": "Map any)[]>" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "prop", "kind": "field", "static": true, "description": "Creates observable property on instances (via prototype)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1007" }, "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "setPrototype", "kind": "field", "static": true, "description": "Creates observable property on instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any)>(this: CLASS, name: KEY, options: OPTIONS) => OPTIONS extends (...args2: any[]) => infer R ? R : OPTIONS extends ObserverPropertyType ? ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? unknown extends R ? object : R : OPTIONS extends { type: ObserverPropertyType; } ? ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? unknown extends R ? string : R : never" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "define", "kind": "field", "static": true, "description": "Define properties on instances via Object.defineProperties().\nAutomatically sets property non-enumerable if name begins with `_`.\nFunctions will be remapped as getters", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends { [P in keyof any]: { enumerable?: boolean; configurable?: boolean; writable?: boolean; value?: any; get?: ((this: INSTANCE) => any); set?: (this: INSTANCE, value: any) => void; } | ((this: INSTANCE, ...args: any[]) => any); }, VALUE extends { [KEY in keyof PROPS]: PROPS[KEY] extends (...args2: any[]) => infer R ? R : PROPS[KEY] extends TypedPropertyDescriptor ? R : never; }>(this: CLASS, props: PROPS & ThisType) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "undefine", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROP extends string, PROPS extends INSTANCE & Record>(this: CLASS, name: PROP) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "observe", "kind": "field", "static": true, "description": "Creates observable properties on instances", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends IDLParameter, VALUE extends { [KEY in keyof PROPS]: PROPS[KEY] extends (...args2: any[]) => infer R ? R : PROPS[KEY] extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : PROPS[KEY] extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : PROPS[KEY] extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : PROPS[KEY] extends ObserverOptions ? (unknown extends R ? string : R) : never; }>(this: CLASS, props: PROPS) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "defineStatic", "kind": "field", "static": true, "type": { "text": ">(this: T1, props: T2) => T1 & ParsedProps" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "events", "kind": "field", "static": true, "type": { "text": "(this: T, listeners?: CompositionEventListenerObject>, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "childEvents", "kind": "field", "static": true, "type": { "text": "(this: T, listenerMap: { [x: string]: CompositionEventListenerObject>; }, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "rootEvents", "kind": "field", "static": true, "type": { "text": "(this: T, listeners?: CompositionEventListenerObject>, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "on", "kind": "field", "static": true, "type": { "text": ", T3 extends CompositionCallback, T4 extends keyof T3>(this: T1, name: T3 | T4, callbacks?: T3[T4] & ThisType) => T1" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "off", "kind": "field", "static": true, "type": { "text": ", T3 extends CompositionCallback, T4 extends keyof T3>(this: T1, name: T3 | T4, callbacks?: T3[T4] & ThisType) => T1" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "offPropChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: ObjectOrObjectEntries<{ [P in keyof T2]?: (this: T2, oldValue: T2[P], newValue: T2[P], changes: any, element: T2) => void; }>) => T1" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "offAttributeChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: { [x: string]: (this: T2, oldValue: string, newValue: string, element: T2) => void; }) => T1" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "onPropChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: ObjectOrObjectEntries<{ [P in keyof T2]?: (this: T2, oldValue: T2[P], newValue: T2[P], changes: any, element: T2) => void; }>) => T1" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "onAttributeChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: { [x: string]: (this: T2, oldValue: string, newValue: string, element: T2) => void; }) => T1" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } } ], "slots": [ { "name": "", "description": "" } ], "cssParts": [], "events": [], "demos": [], "superclass": { "module": "components/Box.js", "name": "default" }, "mixins": [ { "module": "mixins/AriaReflectorMixin.js", "name": "default" }, { "module": "mixins/TypographyMixin.js", "name": "default" } ], "description": "Material Design Type scale: Display\n@see https://m3.material.io/styles/typography/type-scale-tokens" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "default", "module": "components/Display.js" } }, { "kind": "custom-element-definition", "name": "mdw-display", "declaration": { "name": "default", "module": "components/Display.js" } } ] }, { "kind": "javascript-module", "path": "components/Divider.js", "declarations": [ { "kind": "class", "name": "Divider", "tagName": "mdw-divider", "customElement": true, "attributes": [ { "name": "color", "fieldName": "color", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "ink", "fieldName": "ink", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "type-style", "fieldName": "typeStyle", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "vertical", "description": "When true, render the divider vertically instead of horizontally.", "fieldName": "vertical", "type": { "text": "boolean" } } ], "members": [ { "name": "color", "kind": "field", "description": "Palette or surface token used to select background/ink tokens.\nExamples: 'primary', 'background', 'surface-container-low'.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L52" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "ink", "kind": "field", "description": "Explicit ink override token (e.g. 'outline', 'on-primary', 'inverse-on-surface', 'inherit').\nMaps to `--mdw-ink`.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L57" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "typeStyle", "kind": "field", "description": "Typographic style shortcut that maps to type scale variables\n(e.g. 'headline-large', 'body-medium').", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L62" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "vertical", "kind": "field", "description": "When true, render the divider vertically instead of horizontally.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Divider.js#L15" }, "type": { "text": "boolean" } }, { "name": "prototype", "kind": "field", "static": true, "type": { "text": "CustomElement" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "compose", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L145" }, "type": { "text": "(parts: CompositionPart[]) => Composition" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#refsProxy", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1145" }, "type": { "text": "Record" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#refsCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1148" }, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#refsCompositionCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1151" }, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#composition", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1154" }, "type": { "text": "Composition" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#patching", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1156" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#pendingPatchRenders", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1159" }, "type": { "text": "[string, any, CustomElement][]" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#propAttributeCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1162" }, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#callbackArguments", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1165" }, "type": { "text": "CallbackArguments" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "elementInternals", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1172" }, "type": { "text": "ElementInternals" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "render", "kind": "field", "description": "Updates nodes based on data\nExpects data in JSON Merge Patch format", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1185" }, "type": { "text": "RenderDraw" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "propChangedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1213" }, "type": { "text": "(this: T, name: K, oldValue: K extends keyof T ? T[K] : unknown, newValue: K extends keyof T ? T[K] : unknown, changes?: K extends keyof T ? T[K] extends object ? Partial : T[K] : unknown) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attributeChangedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1234" }, "type": { "text": "(name: string, oldValue: string, newValue: string) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#template", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1284" }, "type": { "text": "DocumentFragment" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#onObserverPropertyChanged", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1294" }, "type": { "text": "(name: string, oldValue: any, newValue: any, changes: any) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "static", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1330" }, "type": { "text": "typeof CustomElement" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "patch", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1333" }, "type": { "text": "(patch: any) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "refs", "kind": "field", "description": "Proxy object that returns shadow DOM elements by tag.\nIf called before interpolation (eg: on composed), returns from template", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1404" }, "type": { "text": "Record" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attributeCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1391" }, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "callbackArguments", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1400" }, "type": { "text": "CallbackArguments | { composition: Composition; refs: Record; html: any; inline: (fn: (data: Partial) => any) => string; template: DocumentFragment; element: T; }" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "composition", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1403" }, "type": { "text": "Composition" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "connectedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1435" }, "type": { "text": "() => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "disconnectedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1441" }, "type": { "text": "() => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "delegatesFocus", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1175" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "elementName", "kind": "field", "static": true, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "observedAttributes", "kind": "field", "static": true, "type": { "text": "Iterable" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "interpolatesTemplate", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "supportsElementInternals", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "supportsElementInternalsRole", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "defined", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "registrations", "kind": "field", "static": true, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "expressions", "kind": "method", "static": true, "description": "Expressions are idempotent functions that are selectively called whenever\na render is requested.\nExpressions are constructed exactly as methods though differ in expected\narguments. The first argument should be destructured to ensure each used\nproperty is accessed at least once in order to inspect used properties.\n\nThe Composition API will inspect this function with a proxy for `this` to\ncatalog what observables are used by the expression. This allows the\nComposition API to build a cache as well as selective invoke the expression\nonly when needed.\n\nWhen used with in element templates, the element itself will be passed as\nits first argument.\n````js\n Button\n .prop('filled', 'boolean')\n .prop('outlined', 'boolean')\n .expresssions({\n _isFilledOrOutlined({filled, outlined}) {\n return (filled || outlined)\n },\n })\n .html`
`;\n````\n\nWhen used with external data source, that data source\nwill be passed to the expression with all properties being `null` at first\ninspection.\n````js\n const externalData = {first: 'John', last: 'Doe'};\n ContactCard\n .expresssions({\n _fullName({first, last}) {\n return [first, last].filter(Boolean).join(' ');\n },\n })\n myButton.render(externalData);\n````\n\nExpressions may be support argumentless calls by using default\nparameters with `this`.\n````js\n Button\n .expresssions({\n isFilledOrOutlined({filled, outlined} = this) {\n return (filled || outlined)\n },\n });\n myButton.isFilledorOutlined();\n````", "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends { [K in keyof any]: K extends `_${any}` ? ((data: INSTANCE, state?: Record) => string | boolean | null) : ((data?: INSTANCE, state?: Record) => string | boolean | null); } & ThisType>(this: CLASS, expressions: PROPS & ThisType) => CLASS & Class<{ [K in keyof PROPS]: K extends `_${any}` ? never : () => ReturnType; }, ARGS>" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "methods", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "overrides", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends Partial>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "props", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "idl", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "append", "kind": "field", "static": true, "description": "Append parts to composition", "type": { "text": "(this: T, ...parts: CompositionPart[]) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "recompose", "kind": "field", "static": true, "description": "After composition, invokes callback.\nMay be called multiple times.", "type": { "text": ", T3 extends CompositionCallback[\"composed\"]>(this: T1, callback: T3) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "css", "kind": "field", "static": true, "description": "Appends styles to composition", "type": { "text": "(this: T1, array: T2, ...rest: T2 extends string ? any : T2 extends TemplateStringsArray ? any[] : (HTMLStyleElement | CSSStyleSheet)[]) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "autoRegister", "kind": "field", "static": true, "description": "Registers class with customElements. If class is registered before then,\ndoes nothing.", "type": { "text": "(this: T, elementName: string) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "html", "kind": "field", "static": true, "description": "Appends DocumentFragment to composition", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1405" }, "type": { "text": "(this: T, string: TemplateStringsArray, ...substitutions: (string | Element | ((this: InstanceType, data: InstanceType, injections?: any) => any))[]) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "extend", "kind": "field", "static": true, "description": "Extends base class into a new class.\nUse to avoid mutating base class.", "type": { "text": " T2>(this: T1, customExtender?: T3) => T3 extends null ? T1 : T2" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "setStatic", "kind": "field", "static": true, "description": "Assigns static values to class", "type": { "text": " any) | string | number | boolean | any[] | object); }>(this: T1, source: T2 & ThisType) => T1 & T2" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "readonly", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "set", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "mixin", "kind": "field", "static": true, "description": "Returns result of calling mixin with current class", "type": { "text": " any, RETURN extends ReturnType, SUBCLASS extends ClassOf>(this: BASE, mixin: FN) => SUBCLASS & BASE" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "register", "kind": "field", "static": true, "description": "Registers class with window.customElements synchronously", "type": { "text": "(this: T, elementName?: string, force?: boolean) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "propList", "kind": "field", "static": true, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attrList", "kind": "field", "static": true, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "propChangedCallbacks", "kind": "field", "static": true, "type": { "text": "Map any)[]>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attributeChangedCallbacks", "kind": "field", "static": true, "type": { "text": "Map any)[]>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "prop", "kind": "field", "static": true, "description": "Creates observable property on instances (via prototype)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1007" }, "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "setPrototype", "kind": "field", "static": true, "description": "Creates observable property on instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any)>(this: CLASS, name: KEY, options: OPTIONS) => OPTIONS extends (...args2: any[]) => infer R ? R : OPTIONS extends ObserverPropertyType ? ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? unknown extends R ? object : R : OPTIONS extends { type: ObserverPropertyType; } ? ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? unknown extends R ? string : R : never" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "define", "kind": "field", "static": true, "description": "Define properties on instances via Object.defineProperties().\nAutomatically sets property non-enumerable if name begins with `_`.\nFunctions will be remapped as getters", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends { [P in keyof any]: { enumerable?: boolean; configurable?: boolean; writable?: boolean; value?: any; get?: ((this: INSTANCE) => any); set?: (this: INSTANCE, value: any) => void; } | ((this: INSTANCE, ...args: any[]) => any); }, VALUE extends { [KEY in keyof PROPS]: PROPS[KEY] extends (...args2: any[]) => infer R ? R : PROPS[KEY] extends TypedPropertyDescriptor ? R : never; }>(this: CLASS, props: PROPS & ThisType) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "undefine", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROP extends string, PROPS extends INSTANCE & Record>(this: CLASS, name: PROP) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "observe", "kind": "field", "static": true, "description": "Creates observable properties on instances", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends IDLParameter, VALUE extends { [KEY in keyof PROPS]: PROPS[KEY] extends (...args2: any[]) => infer R ? R : PROPS[KEY] extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : PROPS[KEY] extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : PROPS[KEY] extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : PROPS[KEY] extends ObserverOptions ? (unknown extends R ? string : R) : never; }>(this: CLASS, props: PROPS) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "defineStatic", "kind": "field", "static": true, "type": { "text": ">(this: T1, props: T2) => T1 & ParsedProps" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "events", "kind": "field", "static": true, "type": { "text": "(this: T, listeners?: CompositionEventListenerObject>, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "childEvents", "kind": "field", "static": true, "type": { "text": "(this: T, listenerMap: { [x: string]: CompositionEventListenerObject>; }, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "rootEvents", "kind": "field", "static": true, "type": { "text": "(this: T, listeners?: CompositionEventListenerObject>, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "on", "kind": "field", "static": true, "type": { "text": ", T3 extends CompositionCallback, T4 extends keyof T3>(this: T1, name: T3 | T4, callbacks?: T3[T4] & ThisType) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "off", "kind": "field", "static": true, "type": { "text": ", T3 extends CompositionCallback, T4 extends keyof T3>(this: T1, name: T3 | T4, callbacks?: T3[T4] & ThisType) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "offPropChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: ObjectOrObjectEntries<{ [P in keyof T2]?: (this: T2, oldValue: T2[P], newValue: T2[P], changes: any, element: T2) => void; }>) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "offAttributeChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: { [x: string]: (this: T2, oldValue: string, newValue: string, element: T2) => void; }) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "onPropChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: ObjectOrObjectEntries<{ [P in keyof T2]?: (this: T2, oldValue: T2[P], newValue: T2[P], changes: any, element: T2) => void; }>) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "onAttributeChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: { [x: string]: (this: T2, oldValue: string, newValue: string, element: T2) => void; }) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } } ], "slots": [], "cssParts": [], "events": [], "demos": [ { "url": "demo/components/dividers.html" } ], "superclass": { "module": "core/CustomElement.js", "name": "default" }, "mixins": [ { "module": "mixins/ThemableMixin.js", "name": "default" } ], "description": "Dividers are thin lines that group content in lists or other containers\n@see https://m3.material.io/components/divider/specs" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "default", "module": "components/Divider.js" } }, { "kind": "custom-element-definition", "name": "mdw-divider", "declaration": { "name": "default", "module": "components/Divider.js" } } ] }, { "kind": "javascript-module", "path": "components/Fab.js", "declarations": [ { "kind": "class", "name": "Fab", "tagName": "mdw-fab", "customElement": true, "attributes": [ { "name": "color", "fieldName": "color", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "ink", "fieldName": "ink", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "type-style", "fieldName": "typeStyle", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "density", "fieldName": "density", "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "disabled", "fieldName": "disabled", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "focused", "fieldName": "focused", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "hovered", "fieldName": "hovered", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "pressed", "fieldName": "pressed", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "shape-top", "fieldName": "shapeTop", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "shape-bottom", "fieldName": "shapeBottom", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "shape-start", "fieldName": "shapeStart", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "shape-end", "fieldName": "shapeEnd", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "shape-style", "fieldName": "shapeStyle", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "outlined", "fieldName": "outlined", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "aria-controls", "fieldName": "ariaControls", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "autocomplete", "fieldName": "autocomplete", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "name", "fieldName": "name", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "readonly", "fieldName": "readOnly", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "formnovalidate", "fieldName": "formNoValidate", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "checked", "fieldName": "defaultChecked", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "required", "fieldName": "required", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "type", "fieldName": "type", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "value", "fieldName": "_defaultValue", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "aria-label", "fieldName": "ariaLabel", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "accept", "fieldName": "accept", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "alt", "fieldName": "alt", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "dirname", "fieldName": "dirName", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "formenctype", "fieldName": "formEnctype", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "formmethod", "fieldName": "formMethod", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "formtarget", "fieldName": "formTarget", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "max", "fieldName": "max", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "maxlength", "fieldName": "maxLength", "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "min", "fieldName": "min", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "minlength", "fieldName": "minLength", "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "multiple", "fieldName": "multiple", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "pattern", "fieldName": "pattern", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "placeholder", "fieldName": "placeholder", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "size", "fieldName": "size", "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "src", "fieldName": "src", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "step", "fieldName": "step", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "indeterminate", "fieldName": "indeterminate", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "href", "fieldName": "href", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "target", "fieldName": "target", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "download", "fieldName": "download", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "ping", "fieldName": "ping", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "rel", "fieldName": "rel", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "hreflang", "fieldName": "hreflang", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "referrerpolicy", "fieldName": "referrerPolicy", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "elevated", "description": "Whether the FAB uses elevated styling.", "fieldName": "elevated", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "filled", "description": "Filled variant; default is 'tonal' when omitted.", "fieldName": "filled", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "icon", "fieldName": "icon", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "icon-ink", "fieldName": "iconInk", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "svg", "fieldName": "svg", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "view-box", "fieldName": "viewBox", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "svg-path", "fieldName": "svgPath", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "tooltip", "fieldName": "tooltip", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/TooltipTriggerMixin.js" } }, { "name": "auto-tooltip", "fieldName": "autoTooltip", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/TooltipTriggerMixin.js" } }, { "name": "lowered", "description": "When true, render the lowered FAB variant (reduced elevation).", "fieldName": "lowered", "type": { "text": "boolean" } }, { "name": "extended", "description": "When true, the FAB is extended and shows a text label.", "fieldName": "extended", "type": { "text": "boolean" } }, { "name": "fab-size", "description": "FAB size: `null` (default), 'small' or 'large'.", "fieldName": "fabSize", "type": { "text": "string" } }, { "name": "state-layer", "type": { "text": "boolean" }, "description": "Show the visual state layer element when true", "fieldName": "stateLayer", "inheritedFrom": { "name": "default", "module": "components/Button.js" } } ], "members": [ { "name": "delegatesFocus", "kind": "field", "description": "When true, the element delegates focus to an internal focus target.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/DelegatesFocusMixin.js#L15" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "disabled", "kind": "field", "description": "Whether the element is disabled (affects interactive states)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L14" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "focused", "kind": "field", "description": "Force focus state (independent of document)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L16" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "hovered", "kind": "field", "description": "Force hover state (independent of interaction)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L18" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "pressed", "kind": "field", "description": "Force pressed state (independent of interaction)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L20" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "disabledState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L171" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "hoveredState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L38" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "focusedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L39" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "pressedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L40" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "touchedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L41" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "pointedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L44" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "TOOLTIP_MOUSE_IDLE_MS", "kind": "field", "description": "Idle delay before showing tooltip for mouse (ms)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/TooltipTriggerMixin.js#L15" }, "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "mixins/TooltipTriggerMixin.js" } }, { "name": "TOOLTIP_TOUCH_IDLE_MS", "kind": "field", "description": "Idle delay before showing tooltip for touch (ms)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/TooltipTriggerMixin.js#L17" }, "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "mixins/TooltipTriggerMixin.js" } }, { "name": "tooltipSlotId", "kind": "field", "description": "Slot id to use when cloning tooltip content", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/TooltipTriggerMixin.js#L33" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/TooltipTriggerMixin.js" } }, { "name": "tooltip", "kind": "field", "description": "Text or content id used as tooltip content", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/TooltipTriggerMixin.js#L37" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/TooltipTriggerMixin.js" } }, { "name": "autoTooltip", "kind": "field", "description": "When true, show tooltip automatically on hover/focus\nWhether to show the tooltip automatically (true when not extended).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Fab.js#L30" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/TooltipTriggerMixin.js" } }, { "name": "href", "kind": "field", "description": "The URL that the hyperlink points to.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L34" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "target", "kind": "field", "description": "The browsing context in which to open the linked resource (e.g. '_blank').", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L36" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "download", "kind": "field", "description": "Suggested filename for download.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L38" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "ping", "kind": "field", "description": "URLs to be pinged when the link is followed.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L40" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "rel", "kind": "field", "description": "Link relationship tokens (e.g. 'noopener', 'noreferrer').", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L42" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "hreflang", "kind": "field", "description": "Language of the linked resource.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L44" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "referrerPolicy", "kind": "field", "description": "Referrer policy for the link (serialized to 'referrerpolicy' attribute).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L46" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "origin", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L49" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "protocol", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L50" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "username", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L51" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "password", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L52" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "host", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L53" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "hostname", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L54" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "port", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L55" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "pathname", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L56" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "search", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L57" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "hash", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L58" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "ariaControls", "kind": "field", "description": "ARIA 'controls' attribute (string).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L32" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "autocomplete", "kind": "field", "description": "Autocomplete token for the associated control (string).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L34" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "name", "kind": "field", "description": "Name attribute for the control used in forms.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L36" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "readOnly", "kind": "field", "description": "Read-only state reflected to control via 'readonly' attribute.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L38" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "formNoValidate", "kind": "field", "description": "When true, form validation is skipped for this control (formnovalidate).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L40" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "defaultChecked", "kind": "field", "description": "Default checked state for checkable controls (checkbox/radio).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L42" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "required", "kind": "field", "description": "Whether the control is required for form submission.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L47" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "erroredState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L65" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "defaultValue", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L66" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "value", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Fab.js#L21" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "checked", "kind": "field", "description": "Part of FormAssociatedMixin for simplicity.\nEnumerability doesn't guarantee checked state will be passed or used.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L145" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "form", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L160" }, "type": { "text": "HTMLFormElement" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "validity", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L161" }, "type": { "text": "ValidityState" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "validationMessage", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L162" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "willValidate", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L163" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "labels", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L168" }, "type": { "text": "NodeList" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "checkValidity", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ControlMixin.js#L69" }, "type": { "text": "(() => boolean) & (() => boolean)" } }, { "name": "reportValidity", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ControlMixin.js#L87" }, "type": { "text": "(() => boolean) & (() => boolean)" } }, { "name": "setCustomValidity", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ControlMixin.js#L96" }, "type": { "text": "((error: string) => void) & ((error: string) => void)" } }, { "name": "refreshFormAssociation", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L203" }, "type": { "text": "() => void" } }, { "name": "formAssociatedCallback", "kind": "field", "description": "New lifecycle callback. This is called when association with\n
is changed.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L225" }, "type": { "text": "(form: HTMLFormElement) => void" } }, { "name": "formIPCEvent", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L234" }, "type": { "text": "(event: CustomEvent<[string, string]>) => void" } }, { "name": "formDisabledCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L254" }, "type": { "text": "(disabled: boolean) => void" } }, { "name": "formResetCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L258" }, "type": { "text": "() => void" } }, { "name": "formStateRestoreCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L270" }, "type": { "text": "(state: string | FormData, mode: \"autocomplete\" | \"restore\") => void" } }, { "name": "focusableOnDisabled", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ControlMixin.js#L30" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "controlTagName", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L102" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "controlVoidElement", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ControlMixin.js#L32" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "onValueChangingContentAttribute", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ControlMixin.js#L43" }, "type": { "text": "() => void" } }, { "name": "accept", "kind": "field", "description": "Accepted file types for file input (e.g. '.png,.jpg').", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L41" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "alt", "kind": "field", "description": "Alternate text for images (for `type='image'`).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L43" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "dirName", "kind": "field", "description": "Directionality for form submission name (dirname attribute).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L45" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "formEnctype", "kind": "field", "description": "Form encoding type (formenctype).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L49" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "formMethod", "kind": "field", "description": "Form method when associated with a submit input (formmethod).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L51" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "formTarget", "kind": "field", "description": "Target browsing context for form submission (formtarget).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L53" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "max", "kind": "field", "description": "Max value or token for the input.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L58" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "maxLength", "kind": "field", "description": "Maximum length for text-like inputs.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L60" }, "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "min", "kind": "field", "description": "Min value or token for the input.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L62" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "minLength", "kind": "field", "description": "Minimum length for text-like inputs.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L64" }, "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "multiple", "kind": "field", "description": "When true, multiple values are allowed (e.g. file inputs).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L66" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "pattern", "kind": "field", "description": "Pattern used for validation (RegExp as string).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L68" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "placeholder", "kind": "field", "description": "Placeholder text shown when no value is present.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L70" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "size", "kind": "field", "description": "Suggested control size (number of characters).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L72" }, "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "step", "kind": "field", "description": "Step interval for numeric inputs.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L76" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "indeterminate", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L89" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "performImplicitSubmission", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L175" }, "type": { "text": "(event: Event) => void" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "setRangeText", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L345" }, "type": { "text": "{ (replacement: string): void; (replacement: string, start: number, end: number, selectionMode?: SelectionMode): void; }" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "setSelectionRange", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L348" }, "type": { "text": "(start: number, end: number, direction?: \"none\" | \"forward\" | \"backward\") => void" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "showPicker", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L351" }, "type": { "text": "() => void" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "stepDown", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L354" }, "type": { "text": "(n?: number) => void" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "stepUp", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L360" }, "type": { "text": "(n?: number) => void" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "select", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L366" }, "type": { "text": "() => void" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "files", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L371" }, "type": { "text": "FileList" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "selectionDirection", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L384" }, "type": { "text": "\"none\" | \"forward\" | \"backward\"" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "selectionEnd", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L389" }, "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "selectionStart", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L394" }, "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "valueAsDate", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L399" }, "type": { "text": "Date" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "valueAsNumber", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L407" }, "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "height", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L415" }, "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "formAction", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L423" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "width", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L431" }, "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "addRipple", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/RippleMixin.js#L37" }, "type": { "text": "(x?: number, y?: number, hold?: boolean) => CustomElement & { hadRippleHeld: boolean; hadRippleReleased: boolean; rippleStarted: boolean; } & { rippleState: string; keepAlive: boolean; _positionX: number; _positionY: number; _radius: number; holdRipple: boolean; } & { _positionStyle: ElementStylerOptions | { styles: { minHeight: string; minWidth: string; boxShadow: string; top: string; left: string; }; }; } & { updatePosition(x?: number, y?: number, size?: number): void; handleRippleComplete(): void; }" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "color", "kind": "field", "description": "Palette or surface token used to select background/ink tokens.\nExamples: 'primary', 'background', 'surface-container-low'.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L52" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "ink", "kind": "field", "description": "Explicit ink override token (e.g. 'outline', 'on-primary', 'inverse-on-surface', 'inherit').\nMaps to `--mdw-ink`.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L57" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "typeStyle", "kind": "field", "description": "Typographic style shortcut that maps to type scale variables\n(e.g. 'headline-large', 'body-medium').", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L62" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "shapeTop", "kind": "field", "description": "Show top cut/shape on the element", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L9" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "shapeBottom", "kind": "field", "description": "Show bottom cut/shape on the element", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L11" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "shapeStart", "kind": "field", "description": "Show start-side cut/shape (logical start)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L13" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "shapeEnd", "kind": "field", "description": "Show end-side cut/shape (logical end)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L15" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "shapeStyle", "kind": "field", "description": "Predefined shape size/style name (none|extra-small|small|medium|large|extra-large|full|inherit)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L17" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "density", "kind": "field", "description": "Density level affecting spacing and compactness. Integer from -4 (dense) to 4 (spacious).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/DensityMixin.js#L9" }, "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "elevated", "kind": "field", "description": "Bound to [elevated] specifying whether the element should be elevated.\nWhether the FAB uses elevated styling.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Fab.js#L26" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "filled", "kind": "field", "description": "Visual filled variant; may be \"tonal\" or boolean-filled token.\nFilled variant; default is 'tonal' when omitted.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Fab.js#L24" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "lowered", "kind": "field", "description": "When true, render the lowered FAB variant (reduced elevation).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Fab.js#L15" }, "type": { "text": "boolean" } }, { "name": "extended", "kind": "field", "description": "When true, the FAB is extended and shows a text label.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Fab.js#L17" }, "type": { "text": "boolean" } }, { "name": "fabSize", "kind": "field", "description": "FAB size: `null` (default), 'small' or 'large'.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Fab.js#L19" }, "type": { "text": "\"small\" | \"large\"" } }, { "name": "prototype", "kind": "field", "static": true, "type": { "text": "CustomElement" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "cancelShowTooltip", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/TooltipTriggerMixin.js#L48" }, "return": { "type": { "text": "() => void" } }, "inheritedFrom": { "name": "default", "module": "mixins/TooltipTriggerMixin.js" } }, { "name": "scheduleHideTooltip", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/TooltipTriggerMixin.js#L53" }, "return": { "type": { "text": "(type: \"mouse\" | \"touch\" | \"keyboard\") => void" } }, "inheritedFrom": { "name": "default", "module": "mixins/TooltipTriggerMixin.js" } }, { "name": "scheduleShowTooltip", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/TooltipTriggerMixin.js#L78" }, "return": { "type": { "text": "(type: \"mouse\" | \"touch\" | \"keyboard\") => void" } }, "inheritedFrom": { "name": "default", "module": "mixins/TooltipTriggerMixin.js" } }, { "name": "showTooltip", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/TooltipTriggerMixin.js#L100" }, "return": { "type": { "text": "() => void" } }, "inheritedFrom": { "name": "default", "module": "mixins/TooltipTriggerMixin.js" } }, { "name": "hideTooltip", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/TooltipTriggerMixin.js#L127" }, "return": { "type": { "text": "(cancelSchedule?: boolean) => void" } }, "inheritedFrom": { "name": "default", "module": "mixins/TooltipTriggerMixin.js" } }, { "name": "updateTooltipPosition", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/TooltipTriggerMixin.js#L148" }, "return": { "type": { "text": "(domRect?: DOMRect) => void" } }, "inheritedFrom": { "name": "default", "module": "mixins/TooltipTriggerMixin.js" } }, { "name": "recloneTooltip", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/TooltipTriggerMixin.js#L201" }, "return": { "type": { "text": "() => void" } }, "inheritedFrom": { "name": "default", "module": "mixins/TooltipTriggerMixin.js" } }, { "name": "closeIfNotHovered", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/TooltipTriggerMixin.js#L214" }, "return": { "type": { "text": "() => void" } }, "inheritedFrom": { "name": "default", "module": "mixins/TooltipTriggerMixin.js" } }, { "name": "stateLayer", "kind": "field", "description": "Show the visual state layer element when true", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Button.js#L37" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "stateTargetElement", "kind": "field", "description": "Returns the element used as the state target for visual states\n(e.g., pressed/hover). Typically the internal control element.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Button.js#L34" }, "type": { "text": "HTMLElement" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "type", "kind": "field", "description": "Control type token (e.g. 'text','checkbox','radio','file').\nThe underlying control `type` (button, submit, reset, file).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Button.js#L42" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "src", "kind": "field", "description": "Source URL for image-type inputs.\nImage source URL for an icon.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Button.js#L69" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "outlined", "kind": "field", "description": "When true, an outline is rendered around the element\nWhether the button should render an outline.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Button.js#L62" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "icon", "kind": "field", "description": "Icon name (uses internal `mdw-icon` when set).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Button.js#L64" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "iconInk", "kind": "field", "description": "Ink color override for the icon.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Button.js#L66" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "svg", "kind": "field", "description": "Inline SVG markup to render as icon.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Button.js#L71" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "viewBox", "kind": "field", "description": "SVG `viewBox` attribute for inline SVG icons.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Button.js#L73" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "svgPath", "kind": "field", "description": "Path data for an inline SVG icon.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Button.js#L75" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "hasIcon", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Button.js#L78" }, "return": { "type": { "text": "() => string" } }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "iconVariation", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Button.js#L81" }, "return": { "type": { "text": "() => string" } }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "compose", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L145" }, "type": { "text": "(parts: CompositionPart[]) => Composition" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "#refsProxy", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1145" }, "type": { "text": "Record" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "#refsCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1148" }, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "#refsCompositionCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1151" }, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "#composition", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1154" }, "type": { "text": "Composition" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "#patching", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1156" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "#pendingPatchRenders", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1159" }, "type": { "text": "[string, any, CustomElement][]" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "#propAttributeCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1162" }, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "#callbackArguments", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1165" }, "type": { "text": "CallbackArguments" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "elementInternals", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1172" }, "type": { "text": "ElementInternals" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "render", "kind": "field", "description": "Updates nodes based on data\nExpects data in JSON Merge Patch format", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1185" }, "type": { "text": "RenderDraw" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "propChangedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1213" }, "type": { "text": "(this: T, name: K, oldValue: K extends keyof T ? T[K] : unknown, newValue: K extends keyof T ? T[K] : unknown, changes?: K extends keyof T ? T[K] extends object ? Partial : T[K] : unknown) => void" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "attributeChangedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1234" }, "type": { "text": "(name: string, oldValue: string, newValue: string) => void" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "#template", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1284" }, "type": { "text": "DocumentFragment" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "#onObserverPropertyChanged", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1294" }, "type": { "text": "(name: string, oldValue: any, newValue: any, changes: any) => void" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "static", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1330" }, "type": { "text": "typeof CustomElement" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "patch", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1333" }, "type": { "text": "(patch: any) => void" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "refs", "kind": "field", "description": "Proxy object that returns shadow DOM elements by tag.\nIf called before interpolation (eg: on composed), returns from template", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1404" }, "type": { "text": "Record" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "attributeCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1391" }, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "callbackArguments", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1400" }, "type": { "text": "CallbackArguments | { composition: Composition; refs: Record; html: any; inline: (fn: (data: Partial) => any) => string; template: DocumentFragment; element: T; }" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "composition", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1403" }, "type": { "text": "Composition" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "connectedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1435" }, "type": { "text": "() => void" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "disconnectedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1441" }, "type": { "text": "() => void" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "elementName", "kind": "field", "static": true, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "observedAttributes", "kind": "field", "static": true, "type": { "text": "Iterable" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "interpolatesTemplate", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "supportsElementInternals", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "supportsElementInternalsRole", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "defined", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "registrations", "kind": "field", "static": true, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "expressions", "kind": "method", "static": true, "description": "Expressions are idempotent functions that are selectively called whenever\na render is requested.\nExpressions are constructed exactly as methods though differ in expected\narguments. The first argument should be destructured to ensure each used\nproperty is accessed at least once in order to inspect used properties.\n\nThe Composition API will inspect this function with a proxy for `this` to\ncatalog what observables are used by the expression. This allows the\nComposition API to build a cache as well as selective invoke the expression\nonly when needed.\n\nWhen used with in element templates, the element itself will be passed as\nits first argument.\n````js\n Button\n .prop('filled', 'boolean')\n .prop('outlined', 'boolean')\n .expresssions({\n _isFilledOrOutlined({filled, outlined}) {\n return (filled || outlined)\n },\n })\n .html`
`;\n````\n\nWhen used with external data source, that data source\nwill be passed to the expression with all properties being `null` at first\ninspection.\n````js\n const externalData = {first: 'John', last: 'Doe'};\n ContactCard\n .expresssions({\n _fullName({first, last}) {\n return [first, last].filter(Boolean).join(' ');\n },\n })\n myButton.render(externalData);\n````\n\nExpressions may be support argumentless calls by using default\nparameters with `this`.\n````js\n Button\n .expresssions({\n isFilledOrOutlined({filled, outlined} = this) {\n return (filled || outlined)\n },\n });\n myButton.isFilledorOutlined();\n````", "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends { [K in keyof any]: K extends `_${any}` ? ((data: INSTANCE, state?: Record) => string | boolean | null) : ((data?: INSTANCE, state?: Record) => string | boolean | null); } & ThisType>(this: CLASS, expressions: PROPS & ThisType) => CLASS & Class<{ [K in keyof PROPS]: K extends `_${any}` ? never : () => ReturnType; }, ARGS>" } }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "methods", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "overrides", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends Partial>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "props", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "idl", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "append", "kind": "field", "static": true, "description": "Append parts to composition", "type": { "text": "(this: T, ...parts: CompositionPart[]) => T" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "recompose", "kind": "field", "static": true, "description": "After composition, invokes callback.\nMay be called multiple times.", "type": { "text": ", T3 extends CompositionCallback[\"composed\"]>(this: T1, callback: T3) => T1" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "css", "kind": "field", "static": true, "description": "Appends styles to composition", "type": { "text": "(this: T1, array: T2, ...rest: T2 extends string ? any : T2 extends TemplateStringsArray ? any[] : (HTMLStyleElement | CSSStyleSheet)[]) => T1" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "autoRegister", "kind": "field", "static": true, "description": "Registers class with customElements. If class is registered before then,\ndoes nothing.", "type": { "text": "(this: T, elementName: string) => T" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "html", "kind": "field", "static": true, "description": "Appends DocumentFragment to composition", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1405" }, "type": { "text": "(this: T, string: TemplateStringsArray, ...substitutions: (string | Element | ((this: InstanceType, data: InstanceType, injections?: any) => any))[]) => T" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "extend", "kind": "field", "static": true, "description": "Extends base class into a new class.\nUse to avoid mutating base class.", "type": { "text": " T2>(this: T1, customExtender?: T3) => T3 extends null ? T1 : T2" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "setStatic", "kind": "field", "static": true, "description": "Assigns static values to class", "type": { "text": " any) | string | number | boolean | any[] | object); }>(this: T1, source: T2 & ThisType) => T1 & T2" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "readonly", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "set", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "mixin", "kind": "field", "static": true, "description": "Returns result of calling mixin with current class", "type": { "text": " any, RETURN extends ReturnType, SUBCLASS extends ClassOf>(this: BASE, mixin: FN) => SUBCLASS & BASE" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "register", "kind": "field", "static": true, "description": "Registers class with window.customElements synchronously", "type": { "text": "(this: T, elementName?: string, force?: boolean) => T" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "propList", "kind": "field", "static": true, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "attrList", "kind": "field", "static": true, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "propChangedCallbacks", "kind": "field", "static": true, "type": { "text": "Map any)[]>" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "attributeChangedCallbacks", "kind": "field", "static": true, "type": { "text": "Map any)[]>" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "prop", "kind": "field", "static": true, "description": "Creates observable property on instances (via prototype)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1007" }, "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "setPrototype", "kind": "field", "static": true, "description": "Creates observable property on instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any)>(this: CLASS, name: KEY, options: OPTIONS) => OPTIONS extends (...args2: any[]) => infer R ? R : OPTIONS extends ObserverPropertyType ? ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? unknown extends R ? object : R : OPTIONS extends { type: ObserverPropertyType; } ? ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? unknown extends R ? string : R : never" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "define", "kind": "field", "static": true, "description": "Define properties on instances via Object.defineProperties().\nAutomatically sets property non-enumerable if name begins with `_`.\nFunctions will be remapped as getters", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends { [P in keyof any]: { enumerable?: boolean; configurable?: boolean; writable?: boolean; value?: any; get?: ((this: INSTANCE) => any); set?: (this: INSTANCE, value: any) => void; } | ((this: INSTANCE, ...args: any[]) => any); }, VALUE extends { [KEY in keyof PROPS]: PROPS[KEY] extends (...args2: any[]) => infer R ? R : PROPS[KEY] extends TypedPropertyDescriptor ? R : never; }>(this: CLASS, props: PROPS & ThisType) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "undefine", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROP extends string, PROPS extends INSTANCE & Record>(this: CLASS, name: PROP) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "observe", "kind": "field", "static": true, "description": "Creates observable properties on instances", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends IDLParameter, VALUE extends { [KEY in keyof PROPS]: PROPS[KEY] extends (...args2: any[]) => infer R ? R : PROPS[KEY] extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : PROPS[KEY] extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : PROPS[KEY] extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : PROPS[KEY] extends ObserverOptions ? (unknown extends R ? string : R) : never; }>(this: CLASS, props: PROPS) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "defineStatic", "kind": "field", "static": true, "type": { "text": ">(this: T1, props: T2) => T1 & ParsedProps" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "events", "kind": "field", "static": true, "type": { "text": "(this: T, listeners?: CompositionEventListenerObject>, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "childEvents", "kind": "field", "static": true, "type": { "text": "(this: T, listenerMap: { [x: string]: CompositionEventListenerObject>; }, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "rootEvents", "kind": "field", "static": true, "type": { "text": "(this: T, listeners?: CompositionEventListenerObject>, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "on", "kind": "field", "static": true, "type": { "text": ", T3 extends CompositionCallback, T4 extends keyof T3>(this: T1, name: T3 | T4, callbacks?: T3[T4] & ThisType) => T1" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "off", "kind": "field", "static": true, "type": { "text": ", T3 extends CompositionCallback, T4 extends keyof T3>(this: T1, name: T3 | T4, callbacks?: T3[T4] & ThisType) => T1" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "offPropChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: ObjectOrObjectEntries<{ [P in keyof T2]?: (this: T2, oldValue: T2[P], newValue: T2[P], changes: any, element: T2) => void; }>) => T1" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "offAttributeChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: { [x: string]: (this: T2, oldValue: string, newValue: string, element: T2) => void; }) => T1" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "onPropChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: ObjectOrObjectEntries<{ [P in keyof T2]?: (this: T2, oldValue: T2[P], newValue: T2[P], changes: any, element: T2) => void; }>) => T1" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "onAttributeChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: { [x: string]: (this: T2, oldValue: string, newValue: string, element: T2) => void; }) => T1" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } } ], "slots": [ { "name": "", "description": "{_defaultValue}" } ], "cssParts": [ { "name": "control" } ], "events": [ { "name": "value-changing-content-attribute", "type": { "text": "Event" } } ], "demos": [], "superclass": { "module": "components/Button.js", "name": "default" }, "mixins": [ { "module": "mixins/TooltipTriggerMixin.js", "name": "default" } ], "description": "Floating action buttons (FABs) help people take primary actions.\n@see https://m3.material.io/components/floating-action-button/specs\n@see https://m3.material.io/components/extended-fab/specs" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "default", "module": "components/Fab.js" } }, { "kind": "custom-element-definition", "name": "mdw-fab", "declaration": { "name": "default", "module": "components/Fab.js" } } ] }, { "kind": "javascript-module", "path": "components/FabContainer.js", "declarations": [ { "kind": "class", "name": "FabContainer", "tagName": "mdw-fab-container", "customElement": true, "attributes": [ { "name": "hide-breakpoint", "description": "Hide the FAB container at this min-width (pixels).", "fieldName": "hideBreakpoint", "type": { "text": "number" } } ], "members": [ { "name": "delegatesFocus", "kind": "field", "description": "When true, the element delegates focus to an internal focus target.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/DelegatesFocusMixin.js#L15" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "hideBreakpoint", "kind": "field", "description": "Hide the FAB container at this min-width (pixels).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/FabContainer.js#L14" }, "type": { "text": "number" } }, { "name": "prototype", "kind": "field", "static": true, "type": { "text": "CustomElement" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "compose", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L145" }, "type": { "text": "(parts: CompositionPart[]) => Composition" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#refsProxy", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1145" }, "type": { "text": "Record" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#refsCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1148" }, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#refsCompositionCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1151" }, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#composition", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1154" }, "type": { "text": "Composition" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#patching", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1156" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#pendingPatchRenders", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1159" }, "type": { "text": "[string, any, CustomElement][]" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#propAttributeCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1162" }, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#callbackArguments", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1165" }, "type": { "text": "CallbackArguments" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "elementInternals", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1172" }, "type": { "text": "ElementInternals" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "render", "kind": "field", "description": "Updates nodes based on data\nExpects data in JSON Merge Patch format", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1185" }, "type": { "text": "RenderDraw" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "propChangedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1213" }, "type": { "text": "(this: T, name: K, oldValue: K extends keyof T ? T[K] : unknown, newValue: K extends keyof T ? T[K] : unknown, changes?: K extends keyof T ? T[K] extends object ? Partial : T[K] : unknown) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attributeChangedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1234" }, "type": { "text": "(name: string, oldValue: string, newValue: string) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#template", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1284" }, "type": { "text": "DocumentFragment" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#onObserverPropertyChanged", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1294" }, "type": { "text": "(name: string, oldValue: any, newValue: any, changes: any) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "static", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1330" }, "type": { "text": "typeof CustomElement" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "patch", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1333" }, "type": { "text": "(patch: any) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "refs", "kind": "field", "description": "Proxy object that returns shadow DOM elements by tag.\nIf called before interpolation (eg: on composed), returns from template", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1404" }, "type": { "text": "Record" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attributeCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1391" }, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "callbackArguments", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1400" }, "type": { "text": "CallbackArguments | { composition: Composition; refs: Record; html: any; inline: (fn: (data: Partial) => any) => string; template: DocumentFragment; element: T; }" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "composition", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1403" }, "type": { "text": "Composition" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "connectedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1435" }, "type": { "text": "() => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "disconnectedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1441" }, "type": { "text": "() => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "elementName", "kind": "field", "static": true, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "observedAttributes", "kind": "field", "static": true, "type": { "text": "Iterable" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "interpolatesTemplate", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "supportsElementInternals", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "supportsElementInternalsRole", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "defined", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "registrations", "kind": "field", "static": true, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "expressions", "kind": "method", "static": true, "description": "Expressions are idempotent functions that are selectively called whenever\na render is requested.\nExpressions are constructed exactly as methods though differ in expected\narguments. The first argument should be destructured to ensure each used\nproperty is accessed at least once in order to inspect used properties.\n\nThe Composition API will inspect this function with a proxy for `this` to\ncatalog what observables are used by the expression. This allows the\nComposition API to build a cache as well as selective invoke the expression\nonly when needed.\n\nWhen used with in element templates, the element itself will be passed as\nits first argument.\n````js\n Button\n .prop('filled', 'boolean')\n .prop('outlined', 'boolean')\n .expresssions({\n _isFilledOrOutlined({filled, outlined}) {\n return (filled || outlined)\n },\n })\n .html`
`;\n````\n\nWhen used with external data source, that data source\nwill be passed to the expression with all properties being `null` at first\ninspection.\n````js\n const externalData = {first: 'John', last: 'Doe'};\n ContactCard\n .expresssions({\n _fullName({first, last}) {\n return [first, last].filter(Boolean).join(' ');\n },\n })\n myButton.render(externalData);\n````\n\nExpressions may be support argumentless calls by using default\nparameters with `this`.\n````js\n Button\n .expresssions({\n isFilledOrOutlined({filled, outlined} = this) {\n return (filled || outlined)\n },\n });\n myButton.isFilledorOutlined();\n````", "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends { [K in keyof any]: K extends `_${any}` ? ((data: INSTANCE, state?: Record) => string | boolean | null) : ((data?: INSTANCE, state?: Record) => string | boolean | null); } & ThisType>(this: CLASS, expressions: PROPS & ThisType) => CLASS & Class<{ [K in keyof PROPS]: K extends `_${any}` ? never : () => ReturnType; }, ARGS>" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "methods", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "overrides", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends Partial>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "props", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "idl", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "append", "kind": "field", "static": true, "description": "Append parts to composition", "type": { "text": "(this: T, ...parts: CompositionPart[]) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "recompose", "kind": "field", "static": true, "description": "After composition, invokes callback.\nMay be called multiple times.", "type": { "text": ", T3 extends CompositionCallback[\"composed\"]>(this: T1, callback: T3) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "css", "kind": "field", "static": true, "description": "Appends styles to composition", "type": { "text": "(this: T1, array: T2, ...rest: T2 extends string ? any : T2 extends TemplateStringsArray ? any[] : (HTMLStyleElement | CSSStyleSheet)[]) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "autoRegister", "kind": "field", "static": true, "description": "Registers class with customElements. If class is registered before then,\ndoes nothing.", "type": { "text": "(this: T, elementName: string) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "html", "kind": "field", "static": true, "description": "Appends DocumentFragment to composition", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1405" }, "type": { "text": "(this: T, string: TemplateStringsArray, ...substitutions: (string | Element | ((this: InstanceType, data: InstanceType, injections?: any) => any))[]) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "extend", "kind": "field", "static": true, "description": "Extends base class into a new class.\nUse to avoid mutating base class.", "type": { "text": " T2>(this: T1, customExtender?: T3) => T3 extends null ? T1 : T2" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "setStatic", "kind": "field", "static": true, "description": "Assigns static values to class", "type": { "text": " any) | string | number | boolean | any[] | object); }>(this: T1, source: T2 & ThisType) => T1 & T2" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "readonly", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "set", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "mixin", "kind": "field", "static": true, "description": "Returns result of calling mixin with current class", "type": { "text": " any, RETURN extends ReturnType, SUBCLASS extends ClassOf>(this: BASE, mixin: FN) => SUBCLASS & BASE" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "register", "kind": "field", "static": true, "description": "Registers class with window.customElements synchronously", "type": { "text": "(this: T, elementName?: string, force?: boolean) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "propList", "kind": "field", "static": true, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attrList", "kind": "field", "static": true, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "propChangedCallbacks", "kind": "field", "static": true, "type": { "text": "Map any)[]>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attributeChangedCallbacks", "kind": "field", "static": true, "type": { "text": "Map any)[]>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "prop", "kind": "field", "static": true, "description": "Creates observable property on instances (via prototype)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1007" }, "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "setPrototype", "kind": "field", "static": true, "description": "Creates observable property on instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any)>(this: CLASS, name: KEY, options: OPTIONS) => OPTIONS extends (...args2: any[]) => infer R ? R : OPTIONS extends ObserverPropertyType ? ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? unknown extends R ? object : R : OPTIONS extends { type: ObserverPropertyType; } ? ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? unknown extends R ? string : R : never" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "define", "kind": "field", "static": true, "description": "Define properties on instances via Object.defineProperties().\nAutomatically sets property non-enumerable if name begins with `_`.\nFunctions will be remapped as getters", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends { [P in keyof any]: { enumerable?: boolean; configurable?: boolean; writable?: boolean; value?: any; get?: ((this: INSTANCE) => any); set?: (this: INSTANCE, value: any) => void; } | ((this: INSTANCE, ...args: any[]) => any); }, VALUE extends { [KEY in keyof PROPS]: PROPS[KEY] extends (...args2: any[]) => infer R ? R : PROPS[KEY] extends TypedPropertyDescriptor ? R : never; }>(this: CLASS, props: PROPS & ThisType) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "undefine", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROP extends string, PROPS extends INSTANCE & Record>(this: CLASS, name: PROP) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "observe", "kind": "field", "static": true, "description": "Creates observable properties on instances", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends IDLParameter, VALUE extends { [KEY in keyof PROPS]: PROPS[KEY] extends (...args2: any[]) => infer R ? R : PROPS[KEY] extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : PROPS[KEY] extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : PROPS[KEY] extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : PROPS[KEY] extends ObserverOptions ? (unknown extends R ? string : R) : never; }>(this: CLASS, props: PROPS) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "defineStatic", "kind": "field", "static": true, "type": { "text": ">(this: T1, props: T2) => T1 & ParsedProps" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "events", "kind": "field", "static": true, "type": { "text": "(this: T, listeners?: CompositionEventListenerObject>, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "childEvents", "kind": "field", "static": true, "type": { "text": "(this: T, listenerMap: { [x: string]: CompositionEventListenerObject>; }, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "rootEvents", "kind": "field", "static": true, "type": { "text": "(this: T, listeners?: CompositionEventListenerObject>, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "on", "kind": "field", "static": true, "type": { "text": ", T3 extends CompositionCallback, T4 extends keyof T3>(this: T1, name: T3 | T4, callbacks?: T3[T4] & ThisType) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "off", "kind": "field", "static": true, "type": { "text": ", T3 extends CompositionCallback, T4 extends keyof T3>(this: T1, name: T3 | T4, callbacks?: T3[T4] & ThisType) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "offPropChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: ObjectOrObjectEntries<{ [P in keyof T2]?: (this: T2, oldValue: T2[P], newValue: T2[P], changes: any, element: T2) => void; }>) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "offAttributeChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: { [x: string]: (this: T2, oldValue: string, newValue: string, element: T2) => void; }) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "onPropChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: ObjectOrObjectEntries<{ [P in keyof T2]?: (this: T2, oldValue: T2[P], newValue: T2[P], changes: any, element: T2) => void; }>) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "onAttributeChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: { [x: string]: (this: T2, oldValue: string, newValue: string, element: T2) => void; }) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } } ], "slots": [ { "name": "", "description": "" } ], "cssParts": [], "events": [], "demos": [], "superclass": { "module": "core/CustomElement.js", "name": "default" }, "mixins": [ { "module": "mixins/DelegatesFocusMixin.js", "name": "default" } ], "description": "Container for Floating Action Buttons (FAB) used to position FABs.\n@see https://m3.material.io/components/floating-action-button/specs" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "default", "module": "components/FabContainer.js" } }, { "kind": "custom-element-definition", "name": "mdw-fab-container", "declaration": { "name": "default", "module": "components/FabContainer.js" } } ] }, { "kind": "javascript-module", "path": "components/FilterChip.js", "declarations": [ { "kind": "class", "name": "FilterChip", "tagName": "mdw-filter-chip", "customElement": true, "attributes": [ { "name": "color", "fieldName": "color", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "ink", "fieldName": "ink", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "type-style", "fieldName": "typeStyle", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "density", "fieldName": "density", "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "disabled", "fieldName": "disabled", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "focused", "fieldName": "focused", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "hovered", "fieldName": "hovered", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "pressed", "fieldName": "pressed", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "shape-top", "fieldName": "shapeTop", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "shape-bottom", "fieldName": "shapeBottom", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "shape-start", "fieldName": "shapeStart", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "shape-end", "fieldName": "shapeEnd", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "shape-style", "fieldName": "shapeStyle", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "outlined", "fieldName": "outlined", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "aria-controls", "fieldName": "ariaControls", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "autocomplete", "fieldName": "autocomplete", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "name", "fieldName": "name", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "readonly", "fieldName": "readOnly", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "formnovalidate", "fieldName": "formNoValidate", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "checked", "fieldName": "defaultChecked", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "required", "fieldName": "required", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "type", "description": "Type of the chip; defaults to 'checkbox' for filter behavior.", "fieldName": "type", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "value", "fieldName": "_defaultValue", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "aria-label", "fieldName": "ariaLabel", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "accept", "fieldName": "accept", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "alt", "fieldName": "alt", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "dirname", "fieldName": "dirName", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "formenctype", "fieldName": "formEnctype", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "formmethod", "fieldName": "formMethod", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "formtarget", "fieldName": "formTarget", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "max", "fieldName": "max", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "maxlength", "fieldName": "maxLength", "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "min", "fieldName": "min", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "minlength", "fieldName": "minLength", "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "multiple", "fieldName": "multiple", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "pattern", "fieldName": "pattern", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "placeholder", "fieldName": "placeholder", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "size", "fieldName": "size", "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "src", "fieldName": "src", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "step", "fieldName": "step", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "indeterminate", "fieldName": "indeterminate", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "href", "fieldName": "href", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "target", "fieldName": "target", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "download", "fieldName": "download", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "ping", "fieldName": "ping", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "rel", "fieldName": "rel", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "hreflang", "fieldName": "hreflang", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "referrerpolicy", "fieldName": "referrerPolicy", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "elevated", "fieldName": "elevated", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "filled", "fieldName": "filled", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "icon", "fieldName": "icon", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "icon-ink", "fieldName": "iconInk", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "svg", "fieldName": "svg", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "view-box", "fieldName": "viewBox", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "svg-path", "fieldName": "svgPath", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "suggestion", "fieldName": "suggestion", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "dropdown", "description": "When true, shows a dropdown caret as the trailing icon.", "fieldName": "dropdown", "type": { "text": "boolean" } }, { "name": "trailing-src", "description": "Source URL for a trailing image/icon.", "fieldName": "trailingSrc", "type": { "text": "string" } }, { "name": "trailing-icon", "description": "Name of the trailing icon to show.", "fieldName": "trailingIcon", "type": { "text": "string" } }, { "name": "state-layer", "type": { "text": "boolean" }, "description": "Show the visual state layer element when true", "fieldName": "stateLayer", "inheritedFrom": { "name": "default", "module": "components/Chip.js" } } ], "members": [ { "name": "delegatesFocus", "kind": "field", "description": "When true, the element delegates focus to an internal focus target.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/DelegatesFocusMixin.js#L15" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "href", "kind": "field", "description": "The URL that the hyperlink points to.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L34" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "target", "kind": "field", "description": "The browsing context in which to open the linked resource (e.g. '_blank').", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L36" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "download", "kind": "field", "description": "Suggested filename for download.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L38" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "ping", "kind": "field", "description": "URLs to be pinged when the link is followed.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L40" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "rel", "kind": "field", "description": "Link relationship tokens (e.g. 'noopener', 'noreferrer').", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L42" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "hreflang", "kind": "field", "description": "Language of the linked resource.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L44" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "referrerPolicy", "kind": "field", "description": "Referrer policy for the link (serialized to 'referrerpolicy' attribute).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L46" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "origin", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L49" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "protocol", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L50" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "username", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L51" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "password", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L52" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "host", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L53" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "hostname", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L54" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "port", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L55" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "pathname", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L56" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "search", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L57" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "hash", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L58" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "disabled", "kind": "field", "description": "Whether the element is disabled (affects interactive states)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L14" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "focused", "kind": "field", "description": "Force focus state (independent of document)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L16" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "hovered", "kind": "field", "description": "Force hover state (independent of interaction)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L18" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "pressed", "kind": "field", "description": "Force pressed state (independent of interaction)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L20" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "stateLayer", "kind": "field", "description": "Show the visual state layer element when true", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Button.js#L37" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "disabledState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L171" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "hoveredState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L38" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "focusedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L39" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "pressedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L40" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "touchedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L41" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "pointedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L44" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "stateTargetElement", "kind": "field", "description": "Returns the element used as the state target for visual states\n(e.g., pressed/hover). Typically the internal control element.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Button.js#L34" }, "type": { "text": "HTMLElement" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "ariaControls", "kind": "field", "description": "ARIA 'controls' attribute (string).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L32" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "autocomplete", "kind": "field", "description": "Autocomplete token for the associated control (string).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L34" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "name", "kind": "field", "description": "Name attribute for the control used in forms.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L36" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "readOnly", "kind": "field", "description": "Read-only state reflected to control via 'readonly' attribute.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L38" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "formNoValidate", "kind": "field", "description": "When true, form validation is skipped for this control (formnovalidate).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L40" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "defaultChecked", "kind": "field", "description": "Default checked state for checkable controls (checkbox/radio).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L42" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "required", "kind": "field", "description": "Whether the control is required for form submission.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L47" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "type", "kind": "field", "description": "Control type token (e.g. 'text','checkbox','radio','file').\nThe underlying control `type` (button, submit, reset, file).\nType of the chip; defaults to 'checkbox' for filter behavior.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/FilterChip.js#L14" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "erroredState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L65" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "defaultValue", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L66" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "value", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L108" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "checked", "kind": "field", "description": "Part of FormAssociatedMixin for simplicity.\nEnumerability doesn't guarantee checked state will be passed or used.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L145" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "form", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L160" }, "type": { "text": "HTMLFormElement" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "validity", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L161" }, "type": { "text": "ValidityState" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "validationMessage", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L162" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "willValidate", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L163" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "labels", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L168" }, "type": { "text": "NodeList" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "checkValidity", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ControlMixin.js#L69" }, "type": { "text": "(() => boolean) & (() => boolean)" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "reportValidity", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ControlMixin.js#L87" }, "type": { "text": "(() => boolean) & (() => boolean)" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "setCustomValidity", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ControlMixin.js#L96" }, "type": { "text": "((error: string) => void) & ((error: string) => void)" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "refreshFormAssociation", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L203" }, "type": { "text": "() => void" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "formAssociatedCallback", "kind": "field", "description": "New lifecycle callback. This is called when association with\n is changed.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L225" }, "type": { "text": "(form: HTMLFormElement) => void" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "formIPCEvent", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L234" }, "type": { "text": "(event: CustomEvent<[string, string]>) => void" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "formDisabledCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L254" }, "type": { "text": "(disabled: boolean) => void" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "formResetCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L258" }, "type": { "text": "() => void" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "formStateRestoreCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L270" }, "type": { "text": "(state: string | FormData, mode: \"autocomplete\" | \"restore\") => void" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "focusableOnDisabled", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ControlMixin.js#L30" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "controlTagName", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L102" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "controlVoidElement", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ControlMixin.js#L32" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "onValueChangingContentAttribute", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ControlMixin.js#L43" }, "type": { "text": "() => void" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "accept", "kind": "field", "description": "Accepted file types for file input (e.g. '.png,.jpg').", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L41" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "alt", "kind": "field", "description": "Alternate text for images (for `type='image'`).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L43" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "dirName", "kind": "field", "description": "Directionality for form submission name (dirname attribute).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L45" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "formEnctype", "kind": "field", "description": "Form encoding type (formenctype).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L49" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "formMethod", "kind": "field", "description": "Form method when associated with a submit input (formmethod).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L51" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "formTarget", "kind": "field", "description": "Target browsing context for form submission (formtarget).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L53" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "max", "kind": "field", "description": "Max value or token for the input.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L58" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "maxLength", "kind": "field", "description": "Maximum length for text-like inputs.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L60" }, "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "min", "kind": "field", "description": "Min value or token for the input.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L62" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "minLength", "kind": "field", "description": "Minimum length for text-like inputs.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L64" }, "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "multiple", "kind": "field", "description": "When true, multiple values are allowed (e.g. file inputs).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L66" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "pattern", "kind": "field", "description": "Pattern used for validation (RegExp as string).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L68" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "placeholder", "kind": "field", "description": "Placeholder text shown when no value is present.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L70" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "size", "kind": "field", "description": "Suggested control size (number of characters).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L72" }, "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "src", "kind": "field", "description": "Source URL for image-type inputs.\nImage source URL for an icon.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Button.js#L69" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "step", "kind": "field", "description": "Step interval for numeric inputs.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L76" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "indeterminate", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L89" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "performImplicitSubmission", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L175" }, "type": { "text": "(event: Event) => void" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "setRangeText", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L345" }, "type": { "text": "{ (replacement: string): void; (replacement: string, start: number, end: number, selectionMode?: SelectionMode): void; }" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "setSelectionRange", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L348" }, "type": { "text": "(start: number, end: number, direction?: \"none\" | \"forward\" | \"backward\") => void" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "showPicker", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L351" }, "type": { "text": "() => void" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "stepDown", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L354" }, "type": { "text": "(n?: number) => void" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "stepUp", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L360" }, "type": { "text": "(n?: number) => void" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "select", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L366" }, "type": { "text": "() => void" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "files", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L371" }, "type": { "text": "FileList" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "selectionDirection", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L384" }, "type": { "text": "\"none\" | \"forward\" | \"backward\"" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "selectionEnd", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L389" }, "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "selectionStart", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L394" }, "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "valueAsDate", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L399" }, "type": { "text": "Date" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "valueAsNumber", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L407" }, "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "height", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L415" }, "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "formAction", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L423" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "width", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L431" }, "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "addRipple", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/RippleMixin.js#L37" }, "type": { "text": "(x?: number, y?: number, hold?: boolean) => CustomElement & { hadRippleHeld: boolean; hadRippleReleased: boolean; rippleStarted: boolean; } & { rippleState: string; keepAlive: boolean; _positionX: number; _positionY: number; _radius: number; holdRipple: boolean; } & { _positionStyle: ElementStylerOptions | { styles: { minHeight: string; minWidth: string; boxShadow: string; top: string; left: string; }; }; } & { updatePosition(x?: number, y?: number, size?: number): void; handleRippleComplete(): void; }" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "color", "kind": "field", "description": "Palette or surface token used to select background/ink tokens.\nExamples: 'primary', 'background', 'surface-container-low'.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L52" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "ink", "kind": "field", "description": "Explicit ink override token (e.g. 'outline', 'on-primary', 'inverse-on-surface', 'inherit').\nMaps to `--mdw-ink`.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L57" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "typeStyle", "kind": "field", "description": "Typographic style shortcut that maps to type scale variables\n(e.g. 'headline-large', 'body-medium').", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L62" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "shapeTop", "kind": "field", "description": "Show top cut/shape on the element", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L9" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "shapeBottom", "kind": "field", "description": "Show bottom cut/shape on the element", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L11" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "shapeStart", "kind": "field", "description": "Show start-side cut/shape (logical start)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L13" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "shapeEnd", "kind": "field", "description": "Show end-side cut/shape (logical end)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L15" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "shapeStyle", "kind": "field", "description": "Predefined shape size/style name (none|extra-small|small|medium|large|extra-large|full|inherit)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L17" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "outlined", "kind": "field", "description": "When true, an outline is rendered around the element\nWhether the button should render an outline.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Button.js#L62" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "density", "kind": "field", "description": "Density level affecting spacing and compactness. Integer from -4 (dense) to 4 (spacious).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/DensityMixin.js#L9" }, "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "elevated", "kind": "field", "description": "Bound to [elevated] specifying whether the element should be elevated.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Button.js#L58" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "filled", "kind": "field", "description": "Visual filled variant; may be \"tonal\" or boolean-filled token.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Button.js#L60" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "icon", "kind": "field", "description": "Icon name (uses internal `mdw-icon` when set).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Button.js#L64" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "iconInk", "kind": "field", "description": "Ink color override for the icon.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Button.js#L66" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "svg", "kind": "field", "description": "Inline SVG markup to render as icon.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Button.js#L71" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "viewBox", "kind": "field", "description": "SVG `viewBox` attribute for inline SVG icons.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Button.js#L73" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "svgPath", "kind": "field", "description": "Path data for an inline SVG icon.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Button.js#L75" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "hasIcon", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Button.js#L78" }, "type": { "text": "() => string" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "dropdown", "kind": "field", "description": "When true, shows a dropdown caret as the trailing icon.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/FilterChip.js#L16" }, "type": { "text": "boolean" } }, { "name": "trailingSrc", "kind": "field", "description": "Source URL for a trailing image/icon.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/FilterChip.js#L18" }, "type": { "text": "string" } }, { "name": "trailingIcon", "kind": "field", "description": "Name of the trailing icon to show.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/FilterChip.js#L20" }, "type": { "text": "string" } }, { "name": "iconVariation", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/FilterChip.js#L29" }, "return": { "type": { "text": "(() => string) & (() => string) & (() => string)" } }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "computedTrailingIcon", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/FilterChip.js#L23" }, "return": { "type": { "text": "() => string" } } }, { "name": "prototype", "kind": "field", "static": true, "type": { "text": "CustomElement" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "suggestion", "kind": "field", "description": "When true, renders the chip as a suggestion variant.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Chip.js#L11" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "compose", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L145" }, "type": { "text": "(parts: CompositionPart[]) => Composition" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "#refsProxy", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1145" }, "type": { "text": "Record" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "#refsCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1148" }, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "#refsCompositionCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1151" }, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "#composition", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1154" }, "type": { "text": "Composition" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "#patching", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1156" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "#pendingPatchRenders", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1159" }, "type": { "text": "[string, any, CustomElement][]" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "#propAttributeCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1162" }, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "#callbackArguments", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1165" }, "type": { "text": "CallbackArguments" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "elementInternals", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1172" }, "type": { "text": "ElementInternals" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "render", "kind": "field", "description": "Updates nodes based on data\nExpects data in JSON Merge Patch format", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1185" }, "type": { "text": "RenderDraw" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "propChangedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1213" }, "type": { "text": "(this: T, name: K, oldValue: K extends keyof T ? T[K] : unknown, newValue: K extends keyof T ? T[K] : unknown, changes?: K extends keyof T ? T[K] extends object ? Partial : T[K] : unknown) => void" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "attributeChangedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1234" }, "type": { "text": "(name: string, oldValue: string, newValue: string) => void" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "#template", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1284" }, "type": { "text": "DocumentFragment" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "#onObserverPropertyChanged", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1294" }, "type": { "text": "(name: string, oldValue: any, newValue: any, changes: any) => void" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "static", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1330" }, "type": { "text": "typeof CustomElement" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "patch", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1333" }, "type": { "text": "(patch: any) => void" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "refs", "kind": "field", "description": "Proxy object that returns shadow DOM elements by tag.\nIf called before interpolation (eg: on composed), returns from template", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1404" }, "type": { "text": "Record" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "attributeCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1391" }, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "callbackArguments", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1400" }, "type": { "text": "CallbackArguments | { composition: Composition; refs: Record; html: any; inline: (fn: (data: Partial) => any) => string; template: DocumentFragment; element: T; }" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "composition", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1403" }, "type": { "text": "Composition" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "connectedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1435" }, "type": { "text": "() => void" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "disconnectedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1441" }, "type": { "text": "() => void" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "elementName", "kind": "field", "static": true, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "observedAttributes", "kind": "field", "static": true, "type": { "text": "Iterable" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "interpolatesTemplate", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "supportsElementInternals", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "supportsElementInternalsRole", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "defined", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "registrations", "kind": "field", "static": true, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "expressions", "kind": "method", "static": true, "description": "Expressions are idempotent functions that are selectively called whenever\na render is requested.\nExpressions are constructed exactly as methods though differ in expected\narguments. The first argument should be destructured to ensure each used\nproperty is accessed at least once in order to inspect used properties.\n\nThe Composition API will inspect this function with a proxy for `this` to\ncatalog what observables are used by the expression. This allows the\nComposition API to build a cache as well as selective invoke the expression\nonly when needed.\n\nWhen used with in element templates, the element itself will be passed as\nits first argument.\n````js\n Button\n .prop('filled', 'boolean')\n .prop('outlined', 'boolean')\n .expresssions({\n _isFilledOrOutlined({filled, outlined}) {\n return (filled || outlined)\n },\n })\n .html`
`;\n````\n\nWhen used with external data source, that data source\nwill be passed to the expression with all properties being `null` at first\ninspection.\n````js\n const externalData = {first: 'John', last: 'Doe'};\n ContactCard\n .expresssions({\n _fullName({first, last}) {\n return [first, last].filter(Boolean).join(' ');\n },\n })\n myButton.render(externalData);\n````\n\nExpressions may be support argumentless calls by using default\nparameters with `this`.\n````js\n Button\n .expresssions({\n isFilledOrOutlined({filled, outlined} = this) {\n return (filled || outlined)\n },\n });\n myButton.isFilledorOutlined();\n````", "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends { [K in keyof any]: K extends `_${any}` ? ((data: INSTANCE, state?: Record) => string | boolean | null) : ((data?: INSTANCE, state?: Record) => string | boolean | null); } & ThisType>(this: CLASS, expressions: PROPS & ThisType) => CLASS & Class<{ [K in keyof PROPS]: K extends `_${any}` ? never : () => ReturnType; }, ARGS>" } }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "methods", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "overrides", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends Partial>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "props", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "idl", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "append", "kind": "field", "static": true, "description": "Append parts to composition", "type": { "text": "(this: T, ...parts: CompositionPart[]) => T" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "recompose", "kind": "field", "static": true, "description": "After composition, invokes callback.\nMay be called multiple times.", "type": { "text": ", T3 extends CompositionCallback[\"composed\"]>(this: T1, callback: T3) => T1" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "css", "kind": "field", "static": true, "description": "Appends styles to composition", "type": { "text": "(this: T1, array: T2, ...rest: T2 extends string ? any : T2 extends TemplateStringsArray ? any[] : (HTMLStyleElement | CSSStyleSheet)[]) => T1" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "autoRegister", "kind": "field", "static": true, "description": "Registers class with customElements. If class is registered before then,\ndoes nothing.", "type": { "text": "(this: T, elementName: string) => T" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "html", "kind": "field", "static": true, "description": "Appends DocumentFragment to composition", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1405" }, "type": { "text": "(this: T, string: TemplateStringsArray, ...substitutions: (string | Element | ((this: InstanceType, data: InstanceType, injections?: any) => any))[]) => T" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "extend", "kind": "field", "static": true, "description": "Extends base class into a new class.\nUse to avoid mutating base class.", "type": { "text": " T2>(this: T1, customExtender?: T3) => T3 extends null ? T1 : T2" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "setStatic", "kind": "field", "static": true, "description": "Assigns static values to class", "type": { "text": " any) | string | number | boolean | any[] | object); }>(this: T1, source: T2 & ThisType) => T1 & T2" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "readonly", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "set", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "mixin", "kind": "field", "static": true, "description": "Returns result of calling mixin with current class", "type": { "text": " any, RETURN extends ReturnType, SUBCLASS extends ClassOf>(this: BASE, mixin: FN) => SUBCLASS & BASE" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "register", "kind": "field", "static": true, "description": "Registers class with window.customElements synchronously", "type": { "text": "(this: T, elementName?: string, force?: boolean) => T" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "propList", "kind": "field", "static": true, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "attrList", "kind": "field", "static": true, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "propChangedCallbacks", "kind": "field", "static": true, "type": { "text": "Map any)[]>" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "attributeChangedCallbacks", "kind": "field", "static": true, "type": { "text": "Map any)[]>" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "prop", "kind": "field", "static": true, "description": "Creates observable property on instances (via prototype)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1007" }, "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "setPrototype", "kind": "field", "static": true, "description": "Creates observable property on instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any)>(this: CLASS, name: KEY, options: OPTIONS) => OPTIONS extends (...args2: any[]) => infer R ? R : OPTIONS extends ObserverPropertyType ? ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? unknown extends R ? object : R : OPTIONS extends { type: ObserverPropertyType; } ? ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? unknown extends R ? string : R : never" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "define", "kind": "field", "static": true, "description": "Define properties on instances via Object.defineProperties().\nAutomatically sets property non-enumerable if name begins with `_`.\nFunctions will be remapped as getters", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends { [P in keyof any]: { enumerable?: boolean; configurable?: boolean; writable?: boolean; value?: any; get?: ((this: INSTANCE) => any); set?: (this: INSTANCE, value: any) => void; } | ((this: INSTANCE, ...args: any[]) => any); }, VALUE extends { [KEY in keyof PROPS]: PROPS[KEY] extends (...args2: any[]) => infer R ? R : PROPS[KEY] extends TypedPropertyDescriptor ? R : never; }>(this: CLASS, props: PROPS & ThisType) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "undefine", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROP extends string, PROPS extends INSTANCE & Record>(this: CLASS, name: PROP) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "observe", "kind": "field", "static": true, "description": "Creates observable properties on instances", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends IDLParameter, VALUE extends { [KEY in keyof PROPS]: PROPS[KEY] extends (...args2: any[]) => infer R ? R : PROPS[KEY] extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : PROPS[KEY] extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : PROPS[KEY] extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : PROPS[KEY] extends ObserverOptions ? (unknown extends R ? string : R) : never; }>(this: CLASS, props: PROPS) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "defineStatic", "kind": "field", "static": true, "type": { "text": ">(this: T1, props: T2) => T1 & ParsedProps" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "events", "kind": "field", "static": true, "type": { "text": "(this: T, listeners?: CompositionEventListenerObject>, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "childEvents", "kind": "field", "static": true, "type": { "text": "(this: T, listenerMap: { [x: string]: CompositionEventListenerObject>; }, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "rootEvents", "kind": "field", "static": true, "type": { "text": "(this: T, listeners?: CompositionEventListenerObject>, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "on", "kind": "field", "static": true, "type": { "text": ", T3 extends CompositionCallback, T4 extends keyof T3>(this: T1, name: T3 | T4, callbacks?: T3[T4] & ThisType) => T1" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "off", "kind": "field", "static": true, "type": { "text": ", T3 extends CompositionCallback, T4 extends keyof T3>(this: T1, name: T3 | T4, callbacks?: T3[T4] & ThisType) => T1" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "offPropChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: ObjectOrObjectEntries<{ [P in keyof T2]?: (this: T2, oldValue: T2[P], newValue: T2[P], changes: any, element: T2) => void; }>) => T1" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "offAttributeChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: { [x: string]: (this: T2, oldValue: string, newValue: string, element: T2) => void; }) => T1" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "onPropChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: ObjectOrObjectEntries<{ [P in keyof T2]?: (this: T2, oldValue: T2[P], newValue: T2[P], changes: any, element: T2) => void; }>) => T1" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } }, { "name": "onAttributeChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: { [x: string]: (this: T2, oldValue: string, newValue: string, element: T2) => void; }) => T1" }, "inheritedFrom": { "name": "default", "module": "components/Chip.js" } } ], "slots": [ { "name": "", "description": "{_defaultValue}" } ], "cssParts": [ { "name": "control" } ], "events": [ { "name": "value-changing-content-attribute", "type": { "text": "Event" } } ], "demos": [], "superclass": { "module": "components/Chip.js", "name": "default" }, "mixins": [], "description": "Filter chips use tags or descriptive words to filter content.\nThey can be a good alternative to toggle buttons or checkboxes.\n@see https://m3.material.io/components/chips/specs" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "default", "module": "components/FilterChip.js" } }, { "kind": "custom-element-definition", "name": "mdw-filter-chip", "declaration": { "name": "default", "module": "components/FilterChip.js" } } ] }, { "kind": "javascript-module", "path": "components/Grid.js", "declarations": [ { "kind": "class", "name": "Grid", "tagName": "mdw-grid", "customElement": true, "attributes": [ { "name": "color", "fieldName": "color", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "ink", "fieldName": "ink", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "type-style", "fieldName": "typeStyle", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "block", "fieldName": "block", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "inline", "fieldName": "inline", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "row", "fieldName": "row", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "x", "fieldName": "x", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "y", "fieldName": "y", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "gap", "fieldName": "gap", "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "padding", "fieldName": "padding", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "grid", "description": "Enable CSS grid layout for children.", "fieldName": "grid", "type": { "text": "boolean" } }, { "name": "columns", "description": "Explicit number of columns; when set, disables auto column calculation.", "fieldName": "columns", "type": { "text": "number" } } ], "members": [ { "name": "block", "kind": "field", "description": "Set `display: block` on the host (boolean)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js#L9" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "inline", "kind": "field", "description": "Use inline flex layout: `display: inline-flex` (boolean)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js#L11" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "row", "kind": "field", "description": "Switch main axis to horizontal: `flex-direction: row` (boolean)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js#L13" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "x", "kind": "field", "description": "Main-axis alignment / justification.\nAllowed: 'start'|'center'|'end'|'between'|'around'|'stretch'|'baseline'.\nDefault: 'start'.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js#L19" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "y", "kind": "field", "description": "Cross-axis alignment / alignment of items.\nSame allowed values as `x`. Default: 'start'.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js#L29" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "gap", "kind": "field", "description": "Gap between children. Accepts preset numeric strings (e.g. '8') mapped to px, or floats.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js#L36" }, "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "padding", "kind": "field", "description": "Padding preset or numeric value (e.g. 'pane', '8', '16').", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js#L38" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "color", "kind": "field", "description": "Palette or surface token used to select background/ink tokens.\nExamples: 'primary', 'background', 'surface-container-low'.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L52" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "ink", "kind": "field", "description": "Explicit ink override token (e.g. 'outline', 'on-primary', 'inverse-on-surface', 'inherit').\nMaps to `--mdw-ink`.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L57" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "typeStyle", "kind": "field", "description": "Typographic style shortcut that maps to type scale variables\n(e.g. 'headline-large', 'body-medium').", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L62" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "grid", "kind": "field", "description": "Enable CSS grid layout for children.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Grid.js#L15" }, "type": { "text": "boolean" } }, { "name": "columns", "kind": "field", "description": "Explicit number of columns; when set, disables auto column calculation.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Grid.js#L17" }, "type": { "text": "number" } }, { "name": "prototype", "kind": "field", "static": true, "type": { "text": "CustomElement" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "onResizeObserved", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ResizeObserverMixin.js#L23" }, "return": { "type": { "text": "(entry: ResizeObserverEntry) => void" } }, "inheritedFrom": { "name": "default", "module": "mixins/ResizeObserverMixin.js" } }, { "name": "observeResize", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ResizeObserverMixin.js#L26" }, "return": { "type": { "text": "() => void" } }, "inheritedFrom": { "name": "default", "module": "mixins/ResizeObserverMixin.js" } }, { "name": "unobserveResize", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ResizeObserverMixin.js#L31" }, "return": { "type": { "text": "() => void" } }, "inheritedFrom": { "name": "default", "module": "mixins/ResizeObserverMixin.js" } }, { "name": "compose", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L145" }, "type": { "text": "(parts: CompositionPart[]) => Composition" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "#refsProxy", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1145" }, "type": { "text": "Record" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "#refsCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1148" }, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "#refsCompositionCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1151" }, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "#composition", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1154" }, "type": { "text": "Composition" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "#patching", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1156" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "#pendingPatchRenders", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1159" }, "type": { "text": "[string, any, CustomElement][]" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "#propAttributeCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1162" }, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "#callbackArguments", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1165" }, "type": { "text": "CallbackArguments" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "elementInternals", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1172" }, "type": { "text": "ElementInternals" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "render", "kind": "field", "description": "Updates nodes based on data\nExpects data in JSON Merge Patch format", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1185" }, "type": { "text": "RenderDraw" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "propChangedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1213" }, "type": { "text": "(this: T, name: K, oldValue: K extends keyof T ? T[K] : unknown, newValue: K extends keyof T ? T[K] : unknown, changes?: K extends keyof T ? T[K] extends object ? Partial : T[K] : unknown) => void" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "attributeChangedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1234" }, "type": { "text": "(name: string, oldValue: string, newValue: string) => void" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "#template", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1284" }, "type": { "text": "DocumentFragment" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "#onObserverPropertyChanged", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1294" }, "type": { "text": "(name: string, oldValue: any, newValue: any, changes: any) => void" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "static", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1330" }, "type": { "text": "typeof CustomElement" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "patch", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1333" }, "type": { "text": "(patch: any) => void" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "refs", "kind": "field", "description": "Proxy object that returns shadow DOM elements by tag.\nIf called before interpolation (eg: on composed), returns from template", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1404" }, "type": { "text": "Record" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "attributeCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1391" }, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "callbackArguments", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1400" }, "type": { "text": "CallbackArguments | { composition: Composition; refs: Record; html: any; inline: (fn: (data: Partial) => any) => string; template: DocumentFragment; element: T; }" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "composition", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1403" }, "type": { "text": "Composition" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "connectedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1435" }, "type": { "text": "() => void" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "disconnectedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1441" }, "type": { "text": "() => void" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "delegatesFocus", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1175" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "elementName", "kind": "field", "static": true, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "observedAttributes", "kind": "field", "static": true, "type": { "text": "Iterable" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "interpolatesTemplate", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "supportsElementInternals", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "supportsElementInternalsRole", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "defined", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "registrations", "kind": "field", "static": true, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "expressions", "kind": "method", "static": true, "description": "Expressions are idempotent functions that are selectively called whenever\na render is requested.\nExpressions are constructed exactly as methods though differ in expected\narguments. The first argument should be destructured to ensure each used\nproperty is accessed at least once in order to inspect used properties.\n\nThe Composition API will inspect this function with a proxy for `this` to\ncatalog what observables are used by the expression. This allows the\nComposition API to build a cache as well as selective invoke the expression\nonly when needed.\n\nWhen used with in element templates, the element itself will be passed as\nits first argument.\n````js\n Button\n .prop('filled', 'boolean')\n .prop('outlined', 'boolean')\n .expresssions({\n _isFilledOrOutlined({filled, outlined}) {\n return (filled || outlined)\n },\n })\n .html`
`;\n````\n\nWhen used with external data source, that data source\nwill be passed to the expression with all properties being `null` at first\ninspection.\n````js\n const externalData = {first: 'John', last: 'Doe'};\n ContactCard\n .expresssions({\n _fullName({first, last}) {\n return [first, last].filter(Boolean).join(' ');\n },\n })\n myButton.render(externalData);\n````\n\nExpressions may be support argumentless calls by using default\nparameters with `this`.\n````js\n Button\n .expresssions({\n isFilledOrOutlined({filled, outlined} = this) {\n return (filled || outlined)\n },\n });\n myButton.isFilledorOutlined();\n````", "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends { [K in keyof any]: K extends `_${any}` ? ((data: INSTANCE, state?: Record) => string | boolean | null) : ((data?: INSTANCE, state?: Record) => string | boolean | null); } & ThisType>(this: CLASS, expressions: PROPS & ThisType) => CLASS & Class<{ [K in keyof PROPS]: K extends `_${any}` ? never : () => ReturnType; }, ARGS>" } }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "methods", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "overrides", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends Partial>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "props", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "idl", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "append", "kind": "field", "static": true, "description": "Append parts to composition", "type": { "text": "(this: T, ...parts: CompositionPart[]) => T" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "recompose", "kind": "field", "static": true, "description": "After composition, invokes callback.\nMay be called multiple times.", "type": { "text": ", T3 extends CompositionCallback[\"composed\"]>(this: T1, callback: T3) => T1" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "css", "kind": "field", "static": true, "description": "Appends styles to composition", "type": { "text": "(this: T1, array: T2, ...rest: T2 extends string ? any : T2 extends TemplateStringsArray ? any[] : (HTMLStyleElement | CSSStyleSheet)[]) => T1" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "autoRegister", "kind": "field", "static": true, "description": "Registers class with customElements. If class is registered before then,\ndoes nothing.", "type": { "text": "(this: T, elementName: string) => T" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "html", "kind": "field", "static": true, "description": "Appends DocumentFragment to composition", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1405" }, "type": { "text": "(this: T, string: TemplateStringsArray, ...substitutions: (string | Element | ((this: InstanceType, data: InstanceType, injections?: any) => any))[]) => T" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "extend", "kind": "field", "static": true, "description": "Extends base class into a new class.\nUse to avoid mutating base class.", "type": { "text": " T2>(this: T1, customExtender?: T3) => T3 extends null ? T1 : T2" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "setStatic", "kind": "field", "static": true, "description": "Assigns static values to class", "type": { "text": " any) | string | number | boolean | any[] | object); }>(this: T1, source: T2 & ThisType) => T1 & T2" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "readonly", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "set", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "mixin", "kind": "field", "static": true, "description": "Returns result of calling mixin with current class", "type": { "text": " any, RETURN extends ReturnType, SUBCLASS extends ClassOf>(this: BASE, mixin: FN) => SUBCLASS & BASE" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "register", "kind": "field", "static": true, "description": "Registers class with window.customElements synchronously", "type": { "text": "(this: T, elementName?: string, force?: boolean) => T" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "propList", "kind": "field", "static": true, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "attrList", "kind": "field", "static": true, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "propChangedCallbacks", "kind": "field", "static": true, "type": { "text": "Map any)[]>" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "attributeChangedCallbacks", "kind": "field", "static": true, "type": { "text": "Map any)[]>" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "prop", "kind": "field", "static": true, "description": "Creates observable property on instances (via prototype)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1007" }, "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "setPrototype", "kind": "field", "static": true, "description": "Creates observable property on instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any)>(this: CLASS, name: KEY, options: OPTIONS) => OPTIONS extends (...args2: any[]) => infer R ? R : OPTIONS extends ObserverPropertyType ? ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? unknown extends R ? object : R : OPTIONS extends { type: ObserverPropertyType; } ? ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? unknown extends R ? string : R : never" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "define", "kind": "field", "static": true, "description": "Define properties on instances via Object.defineProperties().\nAutomatically sets property non-enumerable if name begins with `_`.\nFunctions will be remapped as getters", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends { [P in keyof any]: { enumerable?: boolean; configurable?: boolean; writable?: boolean; value?: any; get?: ((this: INSTANCE) => any); set?: (this: INSTANCE, value: any) => void; } | ((this: INSTANCE, ...args: any[]) => any); }, VALUE extends { [KEY in keyof PROPS]: PROPS[KEY] extends (...args2: any[]) => infer R ? R : PROPS[KEY] extends TypedPropertyDescriptor ? R : never; }>(this: CLASS, props: PROPS & ThisType) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "undefine", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROP extends string, PROPS extends INSTANCE & Record>(this: CLASS, name: PROP) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "observe", "kind": "field", "static": true, "description": "Creates observable properties on instances", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends IDLParameter, VALUE extends { [KEY in keyof PROPS]: PROPS[KEY] extends (...args2: any[]) => infer R ? R : PROPS[KEY] extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : PROPS[KEY] extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : PROPS[KEY] extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : PROPS[KEY] extends ObserverOptions ? (unknown extends R ? string : R) : never; }>(this: CLASS, props: PROPS) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "defineStatic", "kind": "field", "static": true, "type": { "text": ">(this: T1, props: T2) => T1 & ParsedProps" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "events", "kind": "field", "static": true, "type": { "text": "(this: T, listeners?: CompositionEventListenerObject>, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "childEvents", "kind": "field", "static": true, "type": { "text": "(this: T, listenerMap: { [x: string]: CompositionEventListenerObject>; }, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "rootEvents", "kind": "field", "static": true, "type": { "text": "(this: T, listeners?: CompositionEventListenerObject>, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "on", "kind": "field", "static": true, "type": { "text": ", T3 extends CompositionCallback, T4 extends keyof T3>(this: T1, name: T3 | T4, callbacks?: T3[T4] & ThisType) => T1" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "off", "kind": "field", "static": true, "type": { "text": ", T3 extends CompositionCallback, T4 extends keyof T3>(this: T1, name: T3 | T4, callbacks?: T3[T4] & ThisType) => T1" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "offPropChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: ObjectOrObjectEntries<{ [P in keyof T2]?: (this: T2, oldValue: T2[P], newValue: T2[P], changes: any, element: T2) => void; }>) => T1" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "offAttributeChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: { [x: string]: (this: T2, oldValue: string, newValue: string, element: T2) => void; }) => T1" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "onPropChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: ObjectOrObjectEntries<{ [P in keyof T2]?: (this: T2, oldValue: T2[P], newValue: T2[P], changes: any, element: T2) => void; }>) => T1" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "onAttributeChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: { [x: string]: (this: T2, oldValue: string, newValue: string, element: T2) => void; }) => T1" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } } ], "slots": [ { "name": "", "description": "" } ], "cssParts": [], "events": [], "demos": [], "superclass": { "module": "components/Box.js", "name": "default" }, "mixins": [ { "module": "mixins/ResizeObserverMixin.js", "name": "default" } ], "description": "Grid layout for arranging content into responsive columns.\n@see https://m3.material.io/foundations/layout/understanding-layout/parts-of-layout" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "default", "module": "components/Grid.js" } }, { "kind": "custom-element-definition", "name": "mdw-grid", "declaration": { "name": "default", "module": "components/Grid.js" } } ] }, { "kind": "javascript-module", "path": "components/Headline.js", "declarations": [ { "kind": "class", "name": "Headline", "tagName": "mdw-headline", "customElement": true, "attributes": [ { "name": "color", "fieldName": "color", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "ink", "fieldName": "ink", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "type-style", "fieldName": "typeStyle", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "block", "fieldName": "block", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "inline", "fieldName": "inline", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "row", "fieldName": "row", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "x", "fieldName": "x", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "y", "fieldName": "y", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "gap", "fieldName": "gap", "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "padding", "fieldName": "padding", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "text-padding", "fieldName": "textPadding", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "text-padding-top", "fieldName": "textPaddingTop", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "text-leading", "fieldName": "textLeading", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "text-padding-bottom", "fieldName": "textPaddingBottom", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "aria-level", "fieldName": "ariaLevel", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "size", "fieldName": "size", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } } ], "members": [ { "name": "delegatesFocus", "kind": "field", "description": "When true, the element delegates focus to an internal focus target.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/DelegatesFocusMixin.js#L15" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "textPadding", "kind": "field", "description": "General vertical padding for text content (css length)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/TypographyMixin.js#L24" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "textPaddingTop", "kind": "field", "description": "Padding-top override for text content (css length)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/TypographyMixin.js#L26" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "textLeading", "kind": "field", "description": "Line-leading (extra top spacing) for text (css length or 'sp' units)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/TypographyMixin.js#L28" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "textPaddingBottom", "kind": "field", "description": "Padding-bottom override for text content (css length)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/TypographyMixin.js#L30" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "readAriaProperty", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/AriaReflectorMixin.js#L28" }, "type": { "text": "(name: \"shadowRoot\" | \"ariaActiveDescendantElement\" | \"ariaAtomic\" | \"ariaAutoComplete\" | \"ariaBrailleLabel\" | \"ariaBrailleRoleDescription\" | \"ariaBusy\" | \"ariaChecked\" | \"ariaColCount\" | \"ariaColIndex\" | \"ariaColIndexText\" | \"ariaColSpan\" | \"ariaControlsElements\" | \"ariaCurrent\" | \"ariaDescribedByElements\" | \"ariaDescription\" | \"ariaDetailsElements\" | \"ariaDisabled\" | \"ariaErrorMessageElements\" | \"ariaExpanded\" | \"ariaFlowToElements\" | \"ariaHasPopup\" | \"ariaHidden\" | \"ariaInvalid\" | \"ariaKeyShortcuts\" | \"ariaLabel\" | \"ariaLabelledByElements\" | \"ariaLevel\" | \"ariaLive\" | \"ariaModal\" | \"ariaMultiLine\" | \"ariaMultiSelectable\" | \"ariaOrientation\" | \"ariaOwnsElements\" | \"ariaPlaceholder\" | \"ariaPosInSet\" | \"ariaPressed\" | \"ariaReadOnly\" | \"ariaRelevant\" | \"ariaRequired\" | \"ariaRoleDescription\" | \"ariaRowCount\" | \"ariaRowIndex\" | \"ariaRowIndexText\" | \"ariaRowSpan\" | \"ariaSelected\" | \"ariaSetSize\" | \"ariaSort\" | \"ariaValueMax\" | \"ariaValueMin\" | \"ariaValueNow\" | \"ariaValueText\" | \"role\") => string | Element | ShadowRoot | readonly Element[]" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "updateAriaProperty", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/AriaReflectorMixin.js#L47" }, "type": { "text": ">(name: K, value: ARIAMixin[K]) => void" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "block", "kind": "field", "description": "Set `display: block` on the host (boolean)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js#L9" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "inline", "kind": "field", "description": "Use inline flex layout: `display: inline-flex` (boolean)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js#L11" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "row", "kind": "field", "description": "Switch main axis to horizontal: `flex-direction: row` (boolean)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js#L13" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "x", "kind": "field", "description": "Main-axis alignment / justification.\nAllowed: 'start'|'center'|'end'|'between'|'around'|'stretch'|'baseline'.\nDefault: 'start'.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js#L19" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "y", "kind": "field", "description": "Cross-axis alignment / alignment of items.\nSame allowed values as `x`. Default: 'start'.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js#L29" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "gap", "kind": "field", "description": "Gap between children. Accepts preset numeric strings (e.g. '8') mapped to px, or floats.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js#L36" }, "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "padding", "kind": "field", "description": "Padding preset or numeric value (e.g. 'pane', '8', '16').", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js#L38" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "color", "kind": "field", "description": "Palette or surface token used to select background/ink tokens.\nExamples: 'primary', 'background', 'surface-container-low'.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L52" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "ink", "kind": "field", "description": "Explicit ink override token (e.g. 'outline', 'on-primary', 'inverse-on-surface', 'inherit').\nMaps to `--mdw-ink`.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L57" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "typeStyle", "kind": "field", "description": "Typographic style shortcut that maps to type scale variables\n(e.g. 'headline-large', 'body-medium').", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L62" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "prototype", "kind": "field", "static": true, "type": { "text": "CustomElement" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "size", "kind": "field", "description": "Display size controlling typographic scale: 'large'|'medium'|'small'.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Display.js#L24" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "compose", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L145" }, "type": { "text": "(parts: CompositionPart[]) => Composition" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "#refsProxy", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1145" }, "type": { "text": "Record" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "#refsCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1148" }, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "#refsCompositionCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1151" }, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "#composition", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1154" }, "type": { "text": "Composition" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "#patching", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1156" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "#pendingPatchRenders", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1159" }, "type": { "text": "[string, any, CustomElement][]" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "#propAttributeCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1162" }, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "#callbackArguments", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1165" }, "type": { "text": "CallbackArguments" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "elementInternals", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1172" }, "type": { "text": "ElementInternals" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "render", "kind": "field", "description": "Updates nodes based on data\nExpects data in JSON Merge Patch format", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1185" }, "type": { "text": "RenderDraw" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "propChangedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1213" }, "type": { "text": "(this: T, name: K, oldValue: K extends keyof T ? T[K] : unknown, newValue: K extends keyof T ? T[K] : unknown, changes?: K extends keyof T ? T[K] extends object ? Partial : T[K] : unknown) => void" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "attributeChangedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1234" }, "type": { "text": "(name: string, oldValue: string, newValue: string) => void" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "#template", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1284" }, "type": { "text": "DocumentFragment" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "#onObserverPropertyChanged", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1294" }, "type": { "text": "(name: string, oldValue: any, newValue: any, changes: any) => void" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "static", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1330" }, "type": { "text": "typeof CustomElement" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "patch", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1333" }, "type": { "text": "(patch: any) => void" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "refs", "kind": "field", "description": "Proxy object that returns shadow DOM elements by tag.\nIf called before interpolation (eg: on composed), returns from template", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1404" }, "type": { "text": "Record" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "attributeCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1391" }, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "callbackArguments", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1400" }, "type": { "text": "CallbackArguments | { composition: Composition; refs: Record; html: any; inline: (fn: (data: Partial) => any) => string; template: DocumentFragment; element: T; }" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "composition", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1403" }, "type": { "text": "Composition" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "connectedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1435" }, "type": { "text": "() => void" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "disconnectedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1441" }, "type": { "text": "() => void" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "elementName", "kind": "field", "static": true, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "observedAttributes", "kind": "field", "static": true, "type": { "text": "Iterable" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "interpolatesTemplate", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "supportsElementInternals", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "supportsElementInternalsRole", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "defined", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "registrations", "kind": "field", "static": true, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "expressions", "kind": "method", "static": true, "description": "Expressions are idempotent functions that are selectively called whenever\na render is requested.\nExpressions are constructed exactly as methods though differ in expected\narguments. The first argument should be destructured to ensure each used\nproperty is accessed at least once in order to inspect used properties.\n\nThe Composition API will inspect this function with a proxy for `this` to\ncatalog what observables are used by the expression. This allows the\nComposition API to build a cache as well as selective invoke the expression\nonly when needed.\n\nWhen used with in element templates, the element itself will be passed as\nits first argument.\n````js\n Button\n .prop('filled', 'boolean')\n .prop('outlined', 'boolean')\n .expresssions({\n _isFilledOrOutlined({filled, outlined}) {\n return (filled || outlined)\n },\n })\n .html`
`;\n````\n\nWhen used with external data source, that data source\nwill be passed to the expression with all properties being `null` at first\ninspection.\n````js\n const externalData = {first: 'John', last: 'Doe'};\n ContactCard\n .expresssions({\n _fullName({first, last}) {\n return [first, last].filter(Boolean).join(' ');\n },\n })\n myButton.render(externalData);\n````\n\nExpressions may be support argumentless calls by using default\nparameters with `this`.\n````js\n Button\n .expresssions({\n isFilledOrOutlined({filled, outlined} = this) {\n return (filled || outlined)\n },\n });\n myButton.isFilledorOutlined();\n````", "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends { [K in keyof any]: K extends `_${any}` ? ((data: INSTANCE, state?: Record) => string | boolean | null) : ((data?: INSTANCE, state?: Record) => string | boolean | null); } & ThisType>(this: CLASS, expressions: PROPS & ThisType) => CLASS & Class<{ [K in keyof PROPS]: K extends `_${any}` ? never : () => ReturnType; }, ARGS>" } }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "methods", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "overrides", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends Partial>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "props", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "idl", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "append", "kind": "field", "static": true, "description": "Append parts to composition", "type": { "text": "(this: T, ...parts: CompositionPart[]) => T" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "recompose", "kind": "field", "static": true, "description": "After composition, invokes callback.\nMay be called multiple times.", "type": { "text": ", T3 extends CompositionCallback[\"composed\"]>(this: T1, callback: T3) => T1" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "css", "kind": "field", "static": true, "description": "Appends styles to composition", "type": { "text": "(this: T1, array: T2, ...rest: T2 extends string ? any : T2 extends TemplateStringsArray ? any[] : (HTMLStyleElement | CSSStyleSheet)[]) => T1" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "autoRegister", "kind": "field", "static": true, "description": "Registers class with customElements. If class is registered before then,\ndoes nothing.", "type": { "text": "(this: T, elementName: string) => T" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "html", "kind": "field", "static": true, "description": "Appends DocumentFragment to composition", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1405" }, "type": { "text": "(this: T, string: TemplateStringsArray, ...substitutions: (string | Element | ((this: InstanceType, data: InstanceType, injections?: any) => any))[]) => T" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "extend", "kind": "field", "static": true, "description": "Extends base class into a new class.\nUse to avoid mutating base class.", "type": { "text": " T2>(this: T1, customExtender?: T3) => T3 extends null ? T1 : T2" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "setStatic", "kind": "field", "static": true, "description": "Assigns static values to class", "type": { "text": " any) | string | number | boolean | any[] | object); }>(this: T1, source: T2 & ThisType) => T1 & T2" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "readonly", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "set", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "mixin", "kind": "field", "static": true, "description": "Returns result of calling mixin with current class", "type": { "text": " any, RETURN extends ReturnType, SUBCLASS extends ClassOf>(this: BASE, mixin: FN) => SUBCLASS & BASE" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "register", "kind": "field", "static": true, "description": "Registers class with window.customElements synchronously", "type": { "text": "(this: T, elementName?: string, force?: boolean) => T" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "propList", "kind": "field", "static": true, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "attrList", "kind": "field", "static": true, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "propChangedCallbacks", "kind": "field", "static": true, "type": { "text": "Map any)[]>" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "attributeChangedCallbacks", "kind": "field", "static": true, "type": { "text": "Map any)[]>" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "prop", "kind": "field", "static": true, "description": "Creates observable property on instances (via prototype)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1007" }, "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "setPrototype", "kind": "field", "static": true, "description": "Creates observable property on instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any)>(this: CLASS, name: KEY, options: OPTIONS) => OPTIONS extends (...args2: any[]) => infer R ? R : OPTIONS extends ObserverPropertyType ? ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? unknown extends R ? object : R : OPTIONS extends { type: ObserverPropertyType; } ? ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? unknown extends R ? string : R : never" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "define", "kind": "field", "static": true, "description": "Define properties on instances via Object.defineProperties().\nAutomatically sets property non-enumerable if name begins with `_`.\nFunctions will be remapped as getters", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends { [P in keyof any]: { enumerable?: boolean; configurable?: boolean; writable?: boolean; value?: any; get?: ((this: INSTANCE) => any); set?: (this: INSTANCE, value: any) => void; } | ((this: INSTANCE, ...args: any[]) => any); }, VALUE extends { [KEY in keyof PROPS]: PROPS[KEY] extends (...args2: any[]) => infer R ? R : PROPS[KEY] extends TypedPropertyDescriptor ? R : never; }>(this: CLASS, props: PROPS & ThisType) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "undefine", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROP extends string, PROPS extends INSTANCE & Record>(this: CLASS, name: PROP) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "observe", "kind": "field", "static": true, "description": "Creates observable properties on instances", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends IDLParameter, VALUE extends { [KEY in keyof PROPS]: PROPS[KEY] extends (...args2: any[]) => infer R ? R : PROPS[KEY] extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : PROPS[KEY] extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : PROPS[KEY] extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : PROPS[KEY] extends ObserverOptions ? (unknown extends R ? string : R) : never; }>(this: CLASS, props: PROPS) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "defineStatic", "kind": "field", "static": true, "type": { "text": ">(this: T1, props: T2) => T1 & ParsedProps" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "events", "kind": "field", "static": true, "type": { "text": "(this: T, listeners?: CompositionEventListenerObject>, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "childEvents", "kind": "field", "static": true, "type": { "text": "(this: T, listenerMap: { [x: string]: CompositionEventListenerObject>; }, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "rootEvents", "kind": "field", "static": true, "type": { "text": "(this: T, listeners?: CompositionEventListenerObject>, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "on", "kind": "field", "static": true, "type": { "text": ", T3 extends CompositionCallback, T4 extends keyof T3>(this: T1, name: T3 | T4, callbacks?: T3[T4] & ThisType) => T1" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "off", "kind": "field", "static": true, "type": { "text": ", T3 extends CompositionCallback, T4 extends keyof T3>(this: T1, name: T3 | T4, callbacks?: T3[T4] & ThisType) => T1" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "offPropChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: ObjectOrObjectEntries<{ [P in keyof T2]?: (this: T2, oldValue: T2[P], newValue: T2[P], changes: any, element: T2) => void; }>) => T1" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "offAttributeChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: { [x: string]: (this: T2, oldValue: string, newValue: string, element: T2) => void; }) => T1" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "onPropChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: ObjectOrObjectEntries<{ [P in keyof T2]?: (this: T2, oldValue: T2[P], newValue: T2[P], changes: any, element: T2) => void; }>) => T1" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "onAttributeChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: { [x: string]: (this: T2, oldValue: string, newValue: string, element: T2) => void; }) => T1" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } } ], "slots": [ { "name": "", "description": "" } ], "cssParts": [], "events": [], "demos": [], "superclass": { "module": "components/Display.js", "name": "default" }, "mixins": [], "description": "Material Design Type scale: Headline.\n@see https://m3.material.io/styles/typography/type-scale-tokens" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "default", "module": "components/Headline.js" } }, { "kind": "custom-element-definition", "name": "mdw-headline", "declaration": { "name": "default", "module": "components/Headline.js" } } ] }, { "kind": "javascript-module", "path": "components/Icon.js", "declarations": [ { "kind": "class", "name": "Icon", "tagName": "mdw-icon", "customElement": true, "attributes": [ { "name": "color", "fieldName": "color", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "ink", "fieldName": "ink", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "type-style", "fieldName": "typeStyle", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "icon", "description": "Icon name used with SVG aliases or font glyphs.", "fieldName": "icon", "type": { "text": "string" } }, { "name": "disabled", "description": "Whether the icon is disabled; affects image appearance.", "fieldName": "disabled", "type": { "text": "boolean" } }, { "name": "alt", "description": "Alternative text for image-backed icons.", "fieldName": "alt", "type": { "text": "string" } }, { "name": "src", "description": "Image source URL for an icon.", "fieldName": "src", "type": { "text": "string" } }, { "name": "svg", "description": "URL to an external SVG resource.", "fieldName": "svg", "type": { "text": "string" } }, { "name": "svg-path", "description": "Inline SVG path data to render as the icon.", "fieldName": "svgPath", "type": { "text": "string" } }, { "name": "srcset", "description": "Image `srcset` attribute for responsive icon images.", "fieldName": "srcset", "type": { "text": "string" } }, { "name": "sizes", "description": "Image `sizes` attribute for responsive icon images.", "fieldName": "sizes", "type": { "text": "string" } }, { "name": "variation", "description": "Variation suffix used when resolving icon aliases (e.g., 'filled').", "fieldName": "variation", "type": { "text": "string" } }, { "name": "crossorigin", "description": "`crossorigin` attribute for image requests.", "fieldName": "crossOrigin", "type": { "text": "string" } }, { "name": "usemap", "description": "`usemap` attribute for image maps.", "fieldName": "useMap", "type": { "text": "string" } }, { "name": "ismap", "description": "`ismap` boolean attribute for image maps.", "fieldName": "isMap", "type": { "text": "boolean" } }, { "name": "referrerpolicy", "description": "`referrerpolicy` attribute for image requests.", "fieldName": "referrerPolicy", "type": { "text": "string" } }, { "name": "decoding", "description": "Preferred image decoding mode: 'async' | 'sync' | 'auto'.", "fieldName": "decoding", "type": { "text": "string" } }, { "name": "loading", "description": "Image loading hint: 'eager' | 'lazy'.", "fieldName": "loading", "type": { "text": "string" } }, { "name": "width", "description": "Rendered width in CSS pixels.", "fieldName": "width", "type": { "text": "number" } }, { "name": "height", "description": "Rendered height in CSS pixels.", "fieldName": "height", "type": { "text": "number" } }, { "name": "force-font", "description": "Force using font glyphs instead of SVG when true.", "fieldName": "forceFont", "type": { "text": "boolean" } }, { "name": "view-box", "description": "viewBox used for SVG rendering.", "fieldName": "viewBox", "type": { "text": "string" } }, { "name": "font-class", "description": "CSS class applied to font-based icons.", "fieldName": "fontClass", "type": { "text": "string" } }, { "name": "font-library", "description": "URL to Material Symbols CSS when using font-based icons.", "fieldName": "fontLibrary", "type": { "text": "string" } } ], "members": [ { "name": "color", "kind": "field", "description": "Palette or surface token used to select background/ink tokens.\nExamples: 'primary', 'background', 'surface-container-low'.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L52" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "ink", "kind": "field", "description": "Explicit ink override token (e.g. 'outline', 'on-primary', 'inverse-on-surface', 'inherit').\nMaps to `--mdw-ink`.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L57" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "typeStyle", "kind": "field", "description": "Typographic style shortcut that maps to type scale variables\n(e.g. 'headline-large', 'body-medium').", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L62" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "naturalWidth", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Icon.js#L24" }, "type": { "text": "number" } }, { "name": "naturalHeight", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Icon.js#L25" }, "type": { "text": "number" } }, { "name": "complete", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Icon.js#L26" }, "type": { "text": "boolean" } }, { "name": "currentSrc", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Icon.js#L27" }, "type": { "text": "string" } }, { "name": "x", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Icon.js#L28" }, "type": { "text": "number" } }, { "name": "y", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Icon.js#L29" }, "type": { "text": "number" } }, { "name": "decode", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Icon.js#L30" }, "type": { "text": "() => Promise" } }, { "name": "icon", "kind": "field", "description": "Icon name used with SVG aliases or font glyphs.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Icon.js#L34" }, "type": { "text": "string" } }, { "name": "disabled", "kind": "field", "description": "Whether the icon is disabled; affects image appearance.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Icon.js#L36" }, "type": { "text": "boolean" } }, { "name": "alt", "kind": "field", "description": "Alternative text for image-backed icons.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Icon.js#L38" }, "type": { "text": "string" } }, { "name": "src", "kind": "field", "description": "Image source URL for an icon.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Icon.js#L40" }, "type": { "text": "string" } }, { "name": "svg", "kind": "field", "description": "URL to an external SVG resource.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Icon.js#L42" }, "type": { "text": "string" } }, { "name": "svgPath", "kind": "field", "description": "Inline SVG path data to render as the icon.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Icon.js#L44" }, "type": { "text": "string" } }, { "name": "srcset", "kind": "field", "description": "Image `srcset` attribute for responsive icon images.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Icon.js#L46" }, "type": { "text": "string" } }, { "name": "sizes", "kind": "field", "description": "Image `sizes` attribute for responsive icon images.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Icon.js#L48" }, "type": { "text": "string" } }, { "name": "variation", "kind": "field", "description": "Variation suffix used when resolving icon aliases (e.g., 'filled').", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Icon.js#L50" }, "type": { "text": "string" } }, { "name": "crossOrigin", "kind": "field", "description": "`crossorigin` attribute for image requests.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Icon.js#L52" }, "type": { "text": "string" } }, { "name": "useMap", "kind": "field", "description": "`usemap` attribute for image maps.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Icon.js#L54" }, "type": { "text": "string" } }, { "name": "isMap", "kind": "field", "description": "`ismap` boolean attribute for image maps.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Icon.js#L56" }, "type": { "text": "boolean" } }, { "name": "referrerPolicy", "kind": "field", "description": "`referrerpolicy` attribute for image requests.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Icon.js#L58" }, "type": { "text": "string" } }, { "name": "decoding", "kind": "field", "description": "Preferred image decoding mode: 'async' | 'sync' | 'auto'.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Icon.js#L60" }, "type": { "text": "\"async\" | \"sync\" | \"auto\"" } }, { "name": "loading", "kind": "field", "description": "Image loading hint: 'eager' | 'lazy'.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Icon.js#L62" }, "type": { "text": "\"eager\" | \"lazy\"" } }, { "name": "width", "kind": "field", "description": "Rendered width in CSS pixels.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Icon.js#L64" }, "type": { "text": "number" } }, { "name": "height", "kind": "field", "description": "Rendered height in CSS pixels.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Icon.js#L66" }, "type": { "text": "number" } }, { "name": "forceFont", "kind": "field", "description": "Force using font glyphs instead of SVG when true.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Icon.js#L68" }, "type": { "text": "boolean" } }, { "name": "viewBox", "kind": "field", "description": "viewBox used for SVG rendering.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Icon.js#L71" }, "type": { "text": "string" } }, { "name": "fontClass", "kind": "field", "description": "CSS class applied to font-based icons.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Icon.js#L73" }, "type": { "text": "string" } }, { "name": "fontLibrary", "kind": "field", "description": "URL to Material Symbols CSS when using font-based icons.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Icon.js#L75" }, "type": { "text": "string" } }, { "name": "showSVG", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Icon.js#L118" }, "type": { "text": "() => boolean" } }, { "name": "prototype", "kind": "field", "static": true, "type": { "text": "CustomElement" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "compose", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L145" }, "type": { "text": "(parts: CompositionPart[]) => Composition" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#refsProxy", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1145" }, "type": { "text": "Record" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#refsCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1148" }, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#refsCompositionCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1151" }, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#composition", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1154" }, "type": { "text": "Composition" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#patching", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1156" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#pendingPatchRenders", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1159" }, "type": { "text": "[string, any, CustomElement][]" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#propAttributeCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1162" }, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#callbackArguments", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1165" }, "type": { "text": "CallbackArguments" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "elementInternals", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1172" }, "type": { "text": "ElementInternals" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "render", "kind": "field", "description": "Updates nodes based on data\nExpects data in JSON Merge Patch format", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1185" }, "type": { "text": "RenderDraw" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "propChangedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1213" }, "type": { "text": "(this: T, name: K, oldValue: K extends keyof T ? T[K] : unknown, newValue: K extends keyof T ? T[K] : unknown, changes?: K extends keyof T ? T[K] extends object ? Partial : T[K] : unknown) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attributeChangedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1234" }, "type": { "text": "(name: string, oldValue: string, newValue: string) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#template", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1284" }, "type": { "text": "DocumentFragment" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#onObserverPropertyChanged", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1294" }, "type": { "text": "(name: string, oldValue: any, newValue: any, changes: any) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "static", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1330" }, "type": { "text": "typeof CustomElement" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "patch", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1333" }, "type": { "text": "(patch: any) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "refs", "kind": "field", "description": "Proxy object that returns shadow DOM elements by tag.\nIf called before interpolation (eg: on composed), returns from template", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1404" }, "type": { "text": "Record" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attributeCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1391" }, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "callbackArguments", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1400" }, "type": { "text": "CallbackArguments | { composition: Composition; refs: Record; html: any; inline: (fn: (data: Partial) => any) => string; template: DocumentFragment; element: T; }" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "composition", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1403" }, "type": { "text": "Composition" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "connectedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1435" }, "type": { "text": "() => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "disconnectedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1441" }, "type": { "text": "() => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "delegatesFocus", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1175" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "elementName", "kind": "field", "static": true, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "observedAttributes", "kind": "field", "static": true, "type": { "text": "Iterable" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "interpolatesTemplate", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "supportsElementInternals", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "supportsElementInternalsRole", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "defined", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "registrations", "kind": "field", "static": true, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "expressions", "kind": "method", "static": true, "description": "Expressions are idempotent functions that are selectively called whenever\na render is requested.\nExpressions are constructed exactly as methods though differ in expected\narguments. The first argument should be destructured to ensure each used\nproperty is accessed at least once in order to inspect used properties.\n\nThe Composition API will inspect this function with a proxy for `this` to\ncatalog what observables are used by the expression. This allows the\nComposition API to build a cache as well as selective invoke the expression\nonly when needed.\n\nWhen used with in element templates, the element itself will be passed as\nits first argument.\n````js\n Button\n .prop('filled', 'boolean')\n .prop('outlined', 'boolean')\n .expresssions({\n _isFilledOrOutlined({filled, outlined}) {\n return (filled || outlined)\n },\n })\n .html`
`;\n````\n\nWhen used with external data source, that data source\nwill be passed to the expression with all properties being `null` at first\ninspection.\n````js\n const externalData = {first: 'John', last: 'Doe'};\n ContactCard\n .expresssions({\n _fullName({first, last}) {\n return [first, last].filter(Boolean).join(' ');\n },\n })\n myButton.render(externalData);\n````\n\nExpressions may be support argumentless calls by using default\nparameters with `this`.\n````js\n Button\n .expresssions({\n isFilledOrOutlined({filled, outlined} = this) {\n return (filled || outlined)\n },\n });\n myButton.isFilledorOutlined();\n````", "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends { [K in keyof any]: K extends `_${any}` ? ((data: INSTANCE, state?: Record) => string | boolean | null) : ((data?: INSTANCE, state?: Record) => string | boolean | null); } & ThisType>(this: CLASS, expressions: PROPS & ThisType) => CLASS & Class<{ [K in keyof PROPS]: K extends `_${any}` ? never : () => ReturnType; }, ARGS>" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "methods", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "overrides", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends Partial>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "props", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "idl", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "append", "kind": "field", "static": true, "description": "Append parts to composition", "type": { "text": "(this: T, ...parts: CompositionPart[]) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "recompose", "kind": "field", "static": true, "description": "After composition, invokes callback.\nMay be called multiple times.", "type": { "text": ", T3 extends CompositionCallback[\"composed\"]>(this: T1, callback: T3) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "css", "kind": "field", "static": true, "description": "Appends styles to composition", "type": { "text": "(this: T1, array: T2, ...rest: T2 extends string ? any : T2 extends TemplateStringsArray ? any[] : (HTMLStyleElement | CSSStyleSheet)[]) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "autoRegister", "kind": "field", "static": true, "description": "Registers class with customElements. If class is registered before then,\ndoes nothing.", "type": { "text": "(this: T, elementName: string) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "html", "kind": "field", "static": true, "description": "Appends DocumentFragment to composition", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1405" }, "type": { "text": "(this: T, string: TemplateStringsArray, ...substitutions: (string | Element | ((this: InstanceType, data: InstanceType, injections?: any) => any))[]) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "extend", "kind": "field", "static": true, "description": "Extends base class into a new class.\nUse to avoid mutating base class.", "type": { "text": " T2>(this: T1, customExtender?: T3) => T3 extends null ? T1 : T2" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "setStatic", "kind": "field", "static": true, "description": "Assigns static values to class", "type": { "text": " any) | string | number | boolean | any[] | object); }>(this: T1, source: T2 & ThisType) => T1 & T2" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "readonly", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "set", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "mixin", "kind": "field", "static": true, "description": "Returns result of calling mixin with current class", "type": { "text": " any, RETURN extends ReturnType, SUBCLASS extends ClassOf>(this: BASE, mixin: FN) => SUBCLASS & BASE" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "register", "kind": "field", "static": true, "description": "Registers class with window.customElements synchronously", "type": { "text": "(this: T, elementName?: string, force?: boolean) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "propList", "kind": "field", "static": true, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attrList", "kind": "field", "static": true, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "propChangedCallbacks", "kind": "field", "static": true, "type": { "text": "Map any)[]>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attributeChangedCallbacks", "kind": "field", "static": true, "type": { "text": "Map any)[]>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "prop", "kind": "field", "static": true, "description": "Creates observable property on instances (via prototype)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1007" }, "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "setPrototype", "kind": "field", "static": true, "description": "Creates observable property on instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any)>(this: CLASS, name: KEY, options: OPTIONS) => OPTIONS extends (...args2: any[]) => infer R ? R : OPTIONS extends ObserverPropertyType ? ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? unknown extends R ? object : R : OPTIONS extends { type: ObserverPropertyType; } ? ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? unknown extends R ? string : R : never" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "define", "kind": "field", "static": true, "description": "Define properties on instances via Object.defineProperties().\nAutomatically sets property non-enumerable if name begins with `_`.\nFunctions will be remapped as getters", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends { [P in keyof any]: { enumerable?: boolean; configurable?: boolean; writable?: boolean; value?: any; get?: ((this: INSTANCE) => any); set?: (this: INSTANCE, value: any) => void; } | ((this: INSTANCE, ...args: any[]) => any); }, VALUE extends { [KEY in keyof PROPS]: PROPS[KEY] extends (...args2: any[]) => infer R ? R : PROPS[KEY] extends TypedPropertyDescriptor ? R : never; }>(this: CLASS, props: PROPS & ThisType) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "undefine", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROP extends string, PROPS extends INSTANCE & Record>(this: CLASS, name: PROP) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "observe", "kind": "field", "static": true, "description": "Creates observable properties on instances", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends IDLParameter, VALUE extends { [KEY in keyof PROPS]: PROPS[KEY] extends (...args2: any[]) => infer R ? R : PROPS[KEY] extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : PROPS[KEY] extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : PROPS[KEY] extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : PROPS[KEY] extends ObserverOptions ? (unknown extends R ? string : R) : never; }>(this: CLASS, props: PROPS) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "defineStatic", "kind": "field", "static": true, "type": { "text": ">(this: T1, props: T2) => T1 & ParsedProps" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "events", "kind": "field", "static": true, "type": { "text": "(this: T, listeners?: CompositionEventListenerObject>, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "childEvents", "kind": "field", "static": true, "type": { "text": "(this: T, listenerMap: { [x: string]: CompositionEventListenerObject>; }, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "rootEvents", "kind": "field", "static": true, "type": { "text": "(this: T, listeners?: CompositionEventListenerObject>, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "on", "kind": "field", "static": true, "type": { "text": ", T3 extends CompositionCallback, T4 extends keyof T3>(this: T1, name: T3 | T4, callbacks?: T3[T4] & ThisType) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "off", "kind": "field", "static": true, "type": { "text": ", T3 extends CompositionCallback, T4 extends keyof T3>(this: T1, name: T3 | T4, callbacks?: T3[T4] & ThisType) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "offPropChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: ObjectOrObjectEntries<{ [P in keyof T2]?: (this: T2, oldValue: T2[P], newValue: T2[P], changes: any, element: T2) => void; }>) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "offAttributeChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: { [x: string]: (this: T2, oldValue: string, newValue: string, element: T2) => void; }) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "onPropChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: ObjectOrObjectEntries<{ [P in keyof T2]?: (this: T2, oldValue: T2[P], newValue: T2[P], changes: any, element: T2) => void; }>) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "onAttributeChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: { [x: string]: (this: T2, oldValue: string, newValue: string, element: T2) => void; }) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } } ], "slots": [], "cssParts": [], "events": [], "demos": [ { "url": "demo/components/icon.html" } ], "superclass": { "module": "core/CustomElement.js", "name": "default" }, "mixins": [ { "module": "mixins/ThemableMixin.js", "name": "default" } ], "description": "@typedef {'align'|'border'|'hspace'|'longDesc'|'lowsrc'|'name'|'vspace'} DeprecatedHTMLImageElementProperties" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "default", "module": "components/Icon.js" } }, { "kind": "custom-element-definition", "name": "mdw-icon", "declaration": { "name": "default", "module": "components/Icon.js" } } ] }, { "kind": "javascript-module", "path": "components/IconButton.js", "declarations": [ { "kind": "class", "name": "IconButton", "tagName": "mdw-icon-button", "customElement": true, "attributes": [ { "name": "color", "fieldName": "color", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "ink", "fieldName": "ink", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "type-style", "fieldName": "typeStyle", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "density", "fieldName": "density", "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "disabled", "fieldName": "disabled", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "focused", "fieldName": "focused", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "hovered", "fieldName": "hovered", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "pressed", "fieldName": "pressed", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "shape-top", "fieldName": "shapeTop", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "shape-bottom", "fieldName": "shapeBottom", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "shape-start", "fieldName": "shapeStart", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "shape-end", "fieldName": "shapeEnd", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "shape-style", "fieldName": "shapeStyle", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "outlined", "fieldName": "outlined", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "aria-controls", "fieldName": "ariaControls", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "autocomplete", "fieldName": "autocomplete", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "name", "fieldName": "name", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "readonly", "fieldName": "readOnly", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "formnovalidate", "fieldName": "formNoValidate", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "checked", "fieldName": "defaultChecked", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "required", "fieldName": "required", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "type", "fieldName": "type", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "value", "fieldName": "_defaultValue", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "aria-label", "fieldName": "ariaLabel", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "accept", "fieldName": "accept", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "alt", "fieldName": "alt", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "dirname", "fieldName": "dirName", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "formenctype", "fieldName": "formEnctype", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "formmethod", "fieldName": "formMethod", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "formtarget", "fieldName": "formTarget", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "max", "fieldName": "max", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "maxlength", "fieldName": "maxLength", "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "min", "fieldName": "min", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "minlength", "fieldName": "minLength", "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "multiple", "fieldName": "multiple", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "pattern", "fieldName": "pattern", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "placeholder", "fieldName": "placeholder", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "size", "fieldName": "size", "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "src", "fieldName": "src", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "step", "fieldName": "step", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "indeterminate", "fieldName": "indeterminate", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "href", "fieldName": "href", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "target", "fieldName": "target", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "download", "fieldName": "download", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "ping", "fieldName": "ping", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "rel", "fieldName": "rel", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "hreflang", "fieldName": "hreflang", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "referrerpolicy", "fieldName": "referrerPolicy", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "elevated", "fieldName": "elevated", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "filled", "fieldName": "filled", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "icon", "fieldName": "icon", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "icon-ink", "fieldName": "iconInk", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "svg", "fieldName": "svg", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "view-box", "fieldName": "viewBox", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "svg-path", "fieldName": "svgPath", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "tooltip", "fieldName": "tooltip", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/TooltipTriggerMixin.js" } }, { "name": "auto-tooltip", "description": "When present, enables automatic tooltip behavior from the mixin.", "fieldName": "autoTooltip", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/TooltipTriggerMixin.js" } }, { "name": "state-layer", "type": { "text": "boolean" }, "description": "Show the visual state layer element when true", "fieldName": "stateLayer", "inheritedFrom": { "name": "default", "module": "components/Button.js" } } ], "members": [ { "name": "delegatesFocus", "kind": "field", "description": "When true, the element delegates focus to an internal focus target.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/DelegatesFocusMixin.js#L15" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "disabled", "kind": "field", "description": "Whether the element is disabled (affects interactive states)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L14" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "focused", "kind": "field", "description": "Force focus state (independent of document)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L16" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "hovered", "kind": "field", "description": "Force hover state (independent of interaction)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L18" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "pressed", "kind": "field", "description": "Force pressed state (independent of interaction)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L20" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "disabledState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L171" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "hoveredState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L38" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "focusedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L39" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "pressedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L40" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "touchedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L41" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "pointedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L44" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "TOOLTIP_MOUSE_IDLE_MS", "kind": "field", "description": "Idle delay before showing tooltip for mouse (ms)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/TooltipTriggerMixin.js#L15" }, "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "mixins/TooltipTriggerMixin.js" } }, { "name": "TOOLTIP_TOUCH_IDLE_MS", "kind": "field", "description": "Idle delay before showing tooltip for touch (ms)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/TooltipTriggerMixin.js#L17" }, "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "mixins/TooltipTriggerMixin.js" } }, { "name": "tooltipSlotId", "kind": "field", "description": "Slot id to use when cloning tooltip content", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/TooltipTriggerMixin.js#L33" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/TooltipTriggerMixin.js" } }, { "name": "tooltip", "kind": "field", "description": "Text or content id used as tooltip content", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/TooltipTriggerMixin.js#L37" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/TooltipTriggerMixin.js" } }, { "name": "autoTooltip", "kind": "field", "description": "When true, show tooltip automatically on hover/focus\nWhen present, enables automatic tooltip behavior from the mixin.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/IconButton.js#L30" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/TooltipTriggerMixin.js" } }, { "name": "href", "kind": "field", "description": "The URL that the hyperlink points to.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L34" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "target", "kind": "field", "description": "The browsing context in which to open the linked resource (e.g. '_blank').", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L36" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "download", "kind": "field", "description": "Suggested filename for download.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L38" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "ping", "kind": "field", "description": "URLs to be pinged when the link is followed.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L40" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "rel", "kind": "field", "description": "Link relationship tokens (e.g. 'noopener', 'noreferrer').", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L42" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "hreflang", "kind": "field", "description": "Language of the linked resource.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L44" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "referrerPolicy", "kind": "field", "description": "Referrer policy for the link (serialized to 'referrerpolicy' attribute).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L46" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "origin", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L49" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "protocol", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L50" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "username", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L51" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "password", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L52" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "host", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L53" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "hostname", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L54" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "port", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L55" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "pathname", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L56" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "search", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L57" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "hash", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L58" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "ariaControls", "kind": "field", "description": "ARIA 'controls' attribute (string).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L32" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "autocomplete", "kind": "field", "description": "Autocomplete token for the associated control (string).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L34" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "name", "kind": "field", "description": "Name attribute for the control used in forms.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L36" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "readOnly", "kind": "field", "description": "Read-only state reflected to control via 'readonly' attribute.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L38" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "formNoValidate", "kind": "field", "description": "When true, form validation is skipped for this control (formnovalidate).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L40" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "defaultChecked", "kind": "field", "description": "Default checked state for checkable controls (checkbox/radio).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L42" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "required", "kind": "field", "description": "Whether the control is required for form submission.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L47" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "erroredState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L65" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "defaultValue", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L66" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "value", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L108" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "checked", "kind": "field", "description": "Part of FormAssociatedMixin for simplicity.\nEnumerability doesn't guarantee checked state will be passed or used.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L145" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "form", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L160" }, "type": { "text": "HTMLFormElement" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "validity", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L161" }, "type": { "text": "ValidityState" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "validationMessage", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L162" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "willValidate", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L163" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "labels", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L168" }, "type": { "text": "NodeList" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "checkValidity", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ControlMixin.js#L69" }, "type": { "text": "(() => boolean) & (() => boolean)" } }, { "name": "reportValidity", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ControlMixin.js#L87" }, "type": { "text": "(() => boolean) & (() => boolean)" } }, { "name": "setCustomValidity", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ControlMixin.js#L96" }, "type": { "text": "((error: string) => void) & ((error: string) => void)" } }, { "name": "refreshFormAssociation", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L203" }, "type": { "text": "() => void" } }, { "name": "formAssociatedCallback", "kind": "field", "description": "New lifecycle callback. This is called when association with\n is changed.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L225" }, "type": { "text": "(form: HTMLFormElement) => void" } }, { "name": "formIPCEvent", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L234" }, "type": { "text": "(event: CustomEvent<[string, string]>) => void" } }, { "name": "formDisabledCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L254" }, "type": { "text": "(disabled: boolean) => void" } }, { "name": "formResetCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L258" }, "type": { "text": "() => void" } }, { "name": "formStateRestoreCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L270" }, "type": { "text": "(state: string | FormData, mode: \"autocomplete\" | \"restore\") => void" } }, { "name": "focusableOnDisabled", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ControlMixin.js#L30" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "controlTagName", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L102" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "controlVoidElement", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ControlMixin.js#L32" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "onValueChangingContentAttribute", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ControlMixin.js#L43" }, "type": { "text": "() => void" } }, { "name": "accept", "kind": "field", "description": "Accepted file types for file input (e.g. '.png,.jpg').", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L41" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "alt", "kind": "field", "description": "Alternate text for images (for `type='image'`).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L43" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "dirName", "kind": "field", "description": "Directionality for form submission name (dirname attribute).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L45" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "formEnctype", "kind": "field", "description": "Form encoding type (formenctype).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L49" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "formMethod", "kind": "field", "description": "Form method when associated with a submit input (formmethod).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L51" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "formTarget", "kind": "field", "description": "Target browsing context for form submission (formtarget).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L53" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "max", "kind": "field", "description": "Max value or token for the input.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L58" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "maxLength", "kind": "field", "description": "Maximum length for text-like inputs.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L60" }, "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "min", "kind": "field", "description": "Min value or token for the input.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L62" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "minLength", "kind": "field", "description": "Minimum length for text-like inputs.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L64" }, "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "multiple", "kind": "field", "description": "When true, multiple values are allowed (e.g. file inputs).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L66" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "pattern", "kind": "field", "description": "Pattern used for validation (RegExp as string).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L68" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "placeholder", "kind": "field", "description": "Placeholder text shown when no value is present.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L70" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "size", "kind": "field", "description": "Suggested control size (number of characters).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L72" }, "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "step", "kind": "field", "description": "Step interval for numeric inputs.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L76" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "indeterminate", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L89" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "performImplicitSubmission", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L175" }, "type": { "text": "(event: Event) => void" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "setRangeText", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L345" }, "type": { "text": "{ (replacement: string): void; (replacement: string, start: number, end: number, selectionMode?: SelectionMode): void; }" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "setSelectionRange", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L348" }, "type": { "text": "(start: number, end: number, direction?: \"none\" | \"forward\" | \"backward\") => void" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "showPicker", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L351" }, "type": { "text": "() => void" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "stepDown", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L354" }, "type": { "text": "(n?: number) => void" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "stepUp", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L360" }, "type": { "text": "(n?: number) => void" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "select", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L366" }, "type": { "text": "() => void" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "files", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L371" }, "type": { "text": "FileList" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "selectionDirection", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L384" }, "type": { "text": "\"none\" | \"forward\" | \"backward\"" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "selectionEnd", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L389" }, "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "selectionStart", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L394" }, "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "valueAsDate", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L399" }, "type": { "text": "Date" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "valueAsNumber", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L407" }, "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "height", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L415" }, "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "formAction", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L423" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "width", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L431" }, "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "addRipple", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/RippleMixin.js#L37" }, "type": { "text": "(x?: number, y?: number, hold?: boolean) => CustomElement & { hadRippleHeld: boolean; hadRippleReleased: boolean; rippleStarted: boolean; } & { rippleState: string; keepAlive: boolean; _positionX: number; _positionY: number; _radius: number; holdRipple: boolean; } & { _positionStyle: ElementStylerOptions | { styles: { minHeight: string; minWidth: string; boxShadow: string; top: string; left: string; }; }; } & { updatePosition(x?: number, y?: number, size?: number): void; handleRippleComplete(): void; }" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "color", "kind": "field", "description": "Palette or surface token used to select background/ink tokens.\nExamples: 'primary', 'background', 'surface-container-low'.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/IconButton.js#L81" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "ink", "kind": "field", "description": "Explicit ink override token (e.g. 'outline', 'on-primary', 'inverse-on-surface', 'inherit').\nMaps to `--mdw-ink`.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L57" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "typeStyle", "kind": "field", "description": "Typographic style shortcut that maps to type scale variables\n(e.g. 'headline-large', 'body-medium').", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L62" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "shapeTop", "kind": "field", "description": "Show top cut/shape on the element", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L9" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "shapeBottom", "kind": "field", "description": "Show bottom cut/shape on the element", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L11" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "shapeStart", "kind": "field", "description": "Show start-side cut/shape (logical start)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L13" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "shapeEnd", "kind": "field", "description": "Show end-side cut/shape (logical end)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L15" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "shapeStyle", "kind": "field", "description": "Predefined shape size/style name (none|extra-small|small|medium|large|extra-large|full|inherit)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L17" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "density", "kind": "field", "description": "Density level affecting spacing and compactness. Integer from -4 (dense) to 4 (spacious).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/DensityMixin.js#L9" }, "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "iconVariation", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/IconButton.js#L33" }, "return": { "type": { "text": "(() => string) & (() => string)" } }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "prototype", "kind": "field", "static": true, "type": { "text": "CustomElement" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "cancelShowTooltip", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/TooltipTriggerMixin.js#L48" }, "return": { "type": { "text": "() => void" } }, "inheritedFrom": { "name": "default", "module": "mixins/TooltipTriggerMixin.js" } }, { "name": "scheduleHideTooltip", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/TooltipTriggerMixin.js#L53" }, "return": { "type": { "text": "(type: \"mouse\" | \"touch\" | \"keyboard\") => void" } }, "inheritedFrom": { "name": "default", "module": "mixins/TooltipTriggerMixin.js" } }, { "name": "scheduleShowTooltip", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/TooltipTriggerMixin.js#L78" }, "return": { "type": { "text": "(type: \"mouse\" | \"touch\" | \"keyboard\") => void" } }, "inheritedFrom": { "name": "default", "module": "mixins/TooltipTriggerMixin.js" } }, { "name": "showTooltip", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/TooltipTriggerMixin.js#L100" }, "return": { "type": { "text": "() => void" } }, "inheritedFrom": { "name": "default", "module": "mixins/TooltipTriggerMixin.js" } }, { "name": "hideTooltip", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/TooltipTriggerMixin.js#L127" }, "return": { "type": { "text": "(cancelSchedule?: boolean) => void" } }, "inheritedFrom": { "name": "default", "module": "mixins/TooltipTriggerMixin.js" } }, { "name": "updateTooltipPosition", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/TooltipTriggerMixin.js#L148" }, "return": { "type": { "text": "(domRect?: DOMRect) => void" } }, "inheritedFrom": { "name": "default", "module": "mixins/TooltipTriggerMixin.js" } }, { "name": "recloneTooltip", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/TooltipTriggerMixin.js#L201" }, "return": { "type": { "text": "() => void" } }, "inheritedFrom": { "name": "default", "module": "mixins/TooltipTriggerMixin.js" } }, { "name": "closeIfNotHovered", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/TooltipTriggerMixin.js#L214" }, "return": { "type": { "text": "() => void" } }, "inheritedFrom": { "name": "default", "module": "mixins/TooltipTriggerMixin.js" } }, { "name": "stateLayer", "kind": "field", "description": "Show the visual state layer element when true", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Button.js#L37" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "stateTargetElement", "kind": "field", "description": "Returns the element used as the state target for visual states\n(e.g., pressed/hover). Typically the internal control element.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Button.js#L34" }, "type": { "text": "HTMLElement" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "type", "kind": "field", "description": "Control type token (e.g. 'text','checkbox','radio','file').\nThe underlying control `type` (button, submit, reset, file).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Button.js#L42" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "src", "kind": "field", "description": "Source URL for image-type inputs.\nImage source URL for an icon.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Button.js#L69" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "outlined", "kind": "field", "description": "When true, an outline is rendered around the element\nWhether the button should render an outline.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Button.js#L62" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "elevated", "kind": "field", "description": "Bound to [elevated] specifying whether the element should be elevated.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Button.js#L58" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "filled", "kind": "field", "description": "Visual filled variant; may be \"tonal\" or boolean-filled token.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Button.js#L60" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "icon", "kind": "field", "description": "Icon name (uses internal `mdw-icon` when set).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Button.js#L64" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "iconInk", "kind": "field", "description": "Ink color override for the icon.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Button.js#L66" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "svg", "kind": "field", "description": "Inline SVG markup to render as icon.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Button.js#L71" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "viewBox", "kind": "field", "description": "SVG `viewBox` attribute for inline SVG icons.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Button.js#L73" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "svgPath", "kind": "field", "description": "Path data for an inline SVG icon.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Button.js#L75" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "hasIcon", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Button.js#L78" }, "return": { "type": { "text": "() => string" } }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "compose", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L145" }, "type": { "text": "(parts: CompositionPart[]) => Composition" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "#refsProxy", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1145" }, "type": { "text": "Record" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "#refsCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1148" }, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "#refsCompositionCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1151" }, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "#composition", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1154" }, "type": { "text": "Composition" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "#patching", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1156" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "#pendingPatchRenders", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1159" }, "type": { "text": "[string, any, CustomElement][]" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "#propAttributeCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1162" }, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "#callbackArguments", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1165" }, "type": { "text": "CallbackArguments" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "elementInternals", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1172" }, "type": { "text": "ElementInternals" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "render", "kind": "field", "description": "Updates nodes based on data\nExpects data in JSON Merge Patch format", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1185" }, "type": { "text": "RenderDraw" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "propChangedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1213" }, "type": { "text": "(this: T, name: K, oldValue: K extends keyof T ? T[K] : unknown, newValue: K extends keyof T ? T[K] : unknown, changes?: K extends keyof T ? T[K] extends object ? Partial : T[K] : unknown) => void" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "attributeChangedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1234" }, "type": { "text": "(name: string, oldValue: string, newValue: string) => void" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "#template", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1284" }, "type": { "text": "DocumentFragment" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "#onObserverPropertyChanged", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1294" }, "type": { "text": "(name: string, oldValue: any, newValue: any, changes: any) => void" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "static", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1330" }, "type": { "text": "typeof CustomElement" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "patch", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1333" }, "type": { "text": "(patch: any) => void" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "refs", "kind": "field", "description": "Proxy object that returns shadow DOM elements by tag.\nIf called before interpolation (eg: on composed), returns from template", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1404" }, "type": { "text": "Record" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "attributeCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1391" }, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "callbackArguments", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1400" }, "type": { "text": "CallbackArguments | { composition: Composition; refs: Record; html: any; inline: (fn: (data: Partial) => any) => string; template: DocumentFragment; element: T; }" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "composition", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1403" }, "type": { "text": "Composition" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "connectedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1435" }, "type": { "text": "() => void" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "disconnectedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1441" }, "type": { "text": "() => void" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "elementName", "kind": "field", "static": true, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "observedAttributes", "kind": "field", "static": true, "type": { "text": "Iterable" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "interpolatesTemplate", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "supportsElementInternals", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "supportsElementInternalsRole", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "defined", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "registrations", "kind": "field", "static": true, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "expressions", "kind": "method", "static": true, "description": "Expressions are idempotent functions that are selectively called whenever\na render is requested.\nExpressions are constructed exactly as methods though differ in expected\narguments. The first argument should be destructured to ensure each used\nproperty is accessed at least once in order to inspect used properties.\n\nThe Composition API will inspect this function with a proxy for `this` to\ncatalog what observables are used by the expression. This allows the\nComposition API to build a cache as well as selective invoke the expression\nonly when needed.\n\nWhen used with in element templates, the element itself will be passed as\nits first argument.\n````js\n Button\n .prop('filled', 'boolean')\n .prop('outlined', 'boolean')\n .expresssions({\n _isFilledOrOutlined({filled, outlined}) {\n return (filled || outlined)\n },\n })\n .html`
`;\n````\n\nWhen used with external data source, that data source\nwill be passed to the expression with all properties being `null` at first\ninspection.\n````js\n const externalData = {first: 'John', last: 'Doe'};\n ContactCard\n .expresssions({\n _fullName({first, last}) {\n return [first, last].filter(Boolean).join(' ');\n },\n })\n myButton.render(externalData);\n````\n\nExpressions may be support argumentless calls by using default\nparameters with `this`.\n````js\n Button\n .expresssions({\n isFilledOrOutlined({filled, outlined} = this) {\n return (filled || outlined)\n },\n });\n myButton.isFilledorOutlined();\n````", "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends { [K in keyof any]: K extends `_${any}` ? ((data: INSTANCE, state?: Record) => string | boolean | null) : ((data?: INSTANCE, state?: Record) => string | boolean | null); } & ThisType>(this: CLASS, expressions: PROPS & ThisType) => CLASS & Class<{ [K in keyof PROPS]: K extends `_${any}` ? never : () => ReturnType; }, ARGS>" } }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "methods", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "overrides", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends Partial>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "props", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "idl", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "append", "kind": "field", "static": true, "description": "Append parts to composition", "type": { "text": "(this: T, ...parts: CompositionPart[]) => T" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "recompose", "kind": "field", "static": true, "description": "After composition, invokes callback.\nMay be called multiple times.", "type": { "text": ", T3 extends CompositionCallback[\"composed\"]>(this: T1, callback: T3) => T1" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "css", "kind": "field", "static": true, "description": "Appends styles to composition", "type": { "text": "(this: T1, array: T2, ...rest: T2 extends string ? any : T2 extends TemplateStringsArray ? any[] : (HTMLStyleElement | CSSStyleSheet)[]) => T1" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "autoRegister", "kind": "field", "static": true, "description": "Registers class with customElements. If class is registered before then,\ndoes nothing.", "type": { "text": "(this: T, elementName: string) => T" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "html", "kind": "field", "static": true, "description": "Appends DocumentFragment to composition", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1405" }, "type": { "text": "(this: T, string: TemplateStringsArray, ...substitutions: (string | Element | ((this: InstanceType, data: InstanceType, injections?: any) => any))[]) => T" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "extend", "kind": "field", "static": true, "description": "Extends base class into a new class.\nUse to avoid mutating base class.", "type": { "text": " T2>(this: T1, customExtender?: T3) => T3 extends null ? T1 : T2" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "setStatic", "kind": "field", "static": true, "description": "Assigns static values to class", "type": { "text": " any) | string | number | boolean | any[] | object); }>(this: T1, source: T2 & ThisType) => T1 & T2" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "readonly", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "set", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "mixin", "kind": "field", "static": true, "description": "Returns result of calling mixin with current class", "type": { "text": " any, RETURN extends ReturnType, SUBCLASS extends ClassOf>(this: BASE, mixin: FN) => SUBCLASS & BASE" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "register", "kind": "field", "static": true, "description": "Registers class with window.customElements synchronously", "type": { "text": "(this: T, elementName?: string, force?: boolean) => T" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "propList", "kind": "field", "static": true, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "attrList", "kind": "field", "static": true, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "propChangedCallbacks", "kind": "field", "static": true, "type": { "text": "Map any)[]>" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "attributeChangedCallbacks", "kind": "field", "static": true, "type": { "text": "Map any)[]>" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "prop", "kind": "field", "static": true, "description": "Creates observable property on instances (via prototype)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1007" }, "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "setPrototype", "kind": "field", "static": true, "description": "Creates observable property on instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any)>(this: CLASS, name: KEY, options: OPTIONS) => OPTIONS extends (...args2: any[]) => infer R ? R : OPTIONS extends ObserverPropertyType ? ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? unknown extends R ? object : R : OPTIONS extends { type: ObserverPropertyType; } ? ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? unknown extends R ? string : R : never" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "define", "kind": "field", "static": true, "description": "Define properties on instances via Object.defineProperties().\nAutomatically sets property non-enumerable if name begins with `_`.\nFunctions will be remapped as getters", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends { [P in keyof any]: { enumerable?: boolean; configurable?: boolean; writable?: boolean; value?: any; get?: ((this: INSTANCE) => any); set?: (this: INSTANCE, value: any) => void; } | ((this: INSTANCE, ...args: any[]) => any); }, VALUE extends { [KEY in keyof PROPS]: PROPS[KEY] extends (...args2: any[]) => infer R ? R : PROPS[KEY] extends TypedPropertyDescriptor ? R : never; }>(this: CLASS, props: PROPS & ThisType) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "undefine", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROP extends string, PROPS extends INSTANCE & Record>(this: CLASS, name: PROP) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "observe", "kind": "field", "static": true, "description": "Creates observable properties on instances", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends IDLParameter, VALUE extends { [KEY in keyof PROPS]: PROPS[KEY] extends (...args2: any[]) => infer R ? R : PROPS[KEY] extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : PROPS[KEY] extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : PROPS[KEY] extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : PROPS[KEY] extends ObserverOptions ? (unknown extends R ? string : R) : never; }>(this: CLASS, props: PROPS) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "defineStatic", "kind": "field", "static": true, "type": { "text": ">(this: T1, props: T2) => T1 & ParsedProps" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "events", "kind": "field", "static": true, "type": { "text": "(this: T, listeners?: CompositionEventListenerObject>, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "childEvents", "kind": "field", "static": true, "type": { "text": "(this: T, listenerMap: { [x: string]: CompositionEventListenerObject>; }, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "rootEvents", "kind": "field", "static": true, "type": { "text": "(this: T, listeners?: CompositionEventListenerObject>, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "on", "kind": "field", "static": true, "type": { "text": ", T3 extends CompositionCallback, T4 extends keyof T3>(this: T1, name: T3 | T4, callbacks?: T3[T4] & ThisType) => T1" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "off", "kind": "field", "static": true, "type": { "text": ", T3 extends CompositionCallback, T4 extends keyof T3>(this: T1, name: T3 | T4, callbacks?: T3[T4] & ThisType) => T1" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "offPropChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: ObjectOrObjectEntries<{ [P in keyof T2]?: (this: T2, oldValue: T2[P], newValue: T2[P], changes: any, element: T2) => void; }>) => T1" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "offAttributeChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: { [x: string]: (this: T2, oldValue: string, newValue: string, element: T2) => void; }) => T1" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "onPropChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: ObjectOrObjectEntries<{ [P in keyof T2]?: (this: T2, oldValue: T2[P], newValue: T2[P], changes: any, element: T2) => void; }>) => T1" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "onAttributeChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: { [x: string]: (this: T2, oldValue: string, newValue: string, element: T2) => void; }) => T1" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } } ], "slots": [ { "name": "", "description": "{_defaultValue}" } ], "cssParts": [ { "name": "control" } ], "events": [ { "name": "value-changing-content-attribute", "type": { "text": "Event" } } ], "demos": [], "superclass": { "module": "components/Button.js", "name": "default" }, "mixins": [ { "module": "mixins/TooltipTriggerMixin.js", "name": "default" } ], "description": "Icon buttons are compact buttons that use an icon to represent an action.\n@see https://m3.material.io/components/icon-buttons/specs" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "default", "module": "components/IconButton.js" } }, { "kind": "custom-element-definition", "name": "mdw-icon-button", "declaration": { "name": "default", "module": "components/IconButton.js" } } ] }, { "kind": "javascript-module", "path": "components/Input.js", "declarations": [ { "kind": "class", "name": "Input", "tagName": "mdw-input", "customElement": true, "attributes": [ { "name": "color", "fieldName": "color", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "ink", "fieldName": "ink", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "type-style", "fieldName": "typeStyle", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "disabled", "fieldName": "disabled", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "focused", "fieldName": "focused", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "hovered", "fieldName": "hovered", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "pressed", "fieldName": "pressed", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "aria-controls", "fieldName": "ariaControls", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "autocomplete", "fieldName": "autocomplete", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "name", "fieldName": "name", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "readonly", "fieldName": "readOnly", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "formnovalidate", "fieldName": "formNoValidate", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "checked", "fieldName": "defaultChecked", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "required", "fieldName": "required", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "type", "fieldName": "type", "type": { "text": "array" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "value", "fieldName": "_defaultValue", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "aria-label", "fieldName": "ariaLabel", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "accept", "fieldName": "accept", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "alt", "fieldName": "alt", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "dirname", "fieldName": "dirName", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "formenctype", "fieldName": "formEnctype", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "formmethod", "fieldName": "formMethod", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "formtarget", "fieldName": "formTarget", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "max", "fieldName": "max", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "maxlength", "fieldName": "maxLength", "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "min", "fieldName": "min", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "minlength", "fieldName": "minLength", "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "multiple", "fieldName": "multiple", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "pattern", "fieldName": "pattern", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "placeholder", "fieldName": "placeholder", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "size", "fieldName": "size", "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "src", "fieldName": "src", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "step", "fieldName": "step", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "indeterminate", "fieldName": "indeterminate", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "density", "fieldName": "density", "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "mixins/TextFieldMixin.js" } }, { "name": "shape-top", "fieldName": "shapeTop", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/TextFieldMixin.js" } }, { "name": "shape-bottom", "fieldName": "shapeBottom", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/TextFieldMixin.js" } }, { "name": "shape-start", "fieldName": "shapeStart", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/TextFieldMixin.js" } }, { "name": "shape-end", "fieldName": "shapeEnd", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/TextFieldMixin.js" } }, { "name": "shape-style", "fieldName": "shapeStyle", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/TextFieldMixin.js" } }, { "name": "outlined", "fieldName": "outlined", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/TextFieldMixin.js" } }, { "name": "icon", "fieldName": "icon", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/TextFieldMixin.js" } }, { "name": "icon-variation", "fieldName": "iconVariation", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/TextFieldMixin.js" } }, { "name": "label", "fieldName": "label", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/TextFieldMixin.js" } }, { "name": "filled", "fieldName": "filled", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/TextFieldMixin.js" } }, { "name": "input-prefix", "fieldName": "inputPrefix", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/TextFieldMixin.js" } }, { "name": "input-suffix", "fieldName": "inputSuffix", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/TextFieldMixin.js" } }, { "name": "trailing-icon", "fieldName": "trailingIcon", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/TextFieldMixin.js" } }, { "name": "trailing-icon-ink", "fieldName": "trailingIconInk", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/TextFieldMixin.js" } }, { "name": "trailing-icon-label", "fieldName": "trailingIconLabel", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/TextFieldMixin.js" } }, { "name": "supporting", "fieldName": "supporting", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/TextFieldMixin.js" } }, { "name": "error", "fieldName": "error", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/TextFieldMixin.js" } }, { "name": "autocomplete-inline", "description": "When true, the component inserts the best suggestion into the input field\nas inline text. The appended portion of the suggestion is selected so the\nuser can accept it (e.g. press Enter) or continue typing to replace it.\nTypically combined with `autosuggestInline` to display candidates while\ntyping.", "fieldName": "autocompleteInline", "type": { "text": "boolean" } }, { "name": "autocomplete-list", "description": "When set and not `'custom'`, `applyAutocompleteList()` filters the\nlistbox options to items that start * with the typed text. This controls\ndropdown filtering but does not itself cause inline insertion.", "fieldName": "autocompleteList", "type": { "text": "string" } }, { "name": "autosuggest-inline", "description": "When true, the component advances/searches suggestion candidates as the\nuser types (calls `changeSuggestion({ startsWith })`). If\n`autosuggestInline` is true and `autocompleteInline` is also true the\ncurrent candidate will be shown inline; if `autocompleteInline` is false\nonly the candidate selection changes (no inline text insertion).", "fieldName": "autosuggestInline", "type": { "text": "boolean" } }, { "name": "auto-select", "description": "If true, when listbox is open, arrow navigation will automatically select options.", "fieldName": "autoSelect", "type": { "text": "boolean" } }, { "name": "accept-on-escape", "description": "If true, when listbox is open, accepts current suggestion (same as Enter).", "fieldName": "acceptOnEscape", "type": { "text": "boolean" } }, { "name": "state-layer", "type": { "text": "boolean" }, "description": "Show the visual state layer element when true", "fieldName": "stateLayer", "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } } ], "members": [ { "name": "delegatesFocus", "kind": "field", "description": "When true, the element delegates focus to an internal focus target.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/DelegatesFocusMixin.js#L15" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "onResizeObserved", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Input.js#L154" }, "type": { "text": "((entry: ResizeObserverEntry) => void) & (() => void)" }, "inheritedFrom": { "name": "default", "module": "mixins/ResizeObserverMixin.js" } }, { "name": "observeResize", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ResizeObserverMixin.js#L26" }, "type": { "text": "() => void" }, "inheritedFrom": { "name": "default", "module": "mixins/ResizeObserverMixin.js" } }, { "name": "unobserveResize", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ResizeObserverMixin.js#L31" }, "type": { "text": "() => void" }, "inheritedFrom": { "name": "default", "module": "mixins/ResizeObserverMixin.js" } }, { "name": "disabled", "kind": "field", "description": "Whether the element is disabled (affects interactive states)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L14" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "focused", "kind": "field", "description": "Force focus state (independent of document)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L16" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "hovered", "kind": "field", "description": "Force hover state (independent of interaction)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L18" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "pressed", "kind": "field", "description": "Force pressed state (independent of interaction)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L20" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "stateLayer", "kind": "field", "description": "Show the visual state layer element when true\nShow an internal visual state layer element", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/TextFieldMixin.js#L17" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "disabledState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L171" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "hoveredState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L38" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "focusedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L39" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "pressedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L40" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "touchedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L41" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "pointedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L44" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "stateTargetElement", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Input.js#L151" }, "type": { "text": "HTMLElement" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "color", "kind": "field", "description": "Palette or surface token used to select background/ink tokens.\nExamples: 'primary', 'background', 'surface-container-low'.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L52" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "ink", "kind": "field", "description": "Explicit ink override token (e.g. 'outline', 'on-primary', 'inverse-on-surface', 'inherit').\nMaps to `--mdw-ink`.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L57" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "typeStyle", "kind": "field", "description": "Typographic style shortcut that maps to type scale variables\n(e.g. 'headline-large', 'body-medium').", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L62" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "shapeTop", "kind": "field", "description": "Show top cut/shape on the element", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L9" }, "type": { "text": "boolean" } }, { "name": "shapeBottom", "kind": "field", "description": "Show bottom cut/shape on the element", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L11" }, "type": { "text": "boolean" } }, { "name": "shapeStart", "kind": "field", "description": "Show start-side cut/shape (logical start)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L13" }, "type": { "text": "boolean" } }, { "name": "shapeEnd", "kind": "field", "description": "Show end-side cut/shape (logical end)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L15" }, "type": { "text": "boolean" } }, { "name": "shapeStyle", "kind": "field", "description": "Predefined shape size/style name (none|extra-small|small|medium|large|extra-large|full|inherit)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L17" }, "type": { "text": "string" } }, { "name": "outlined", "kind": "field", "description": "When true, an outline is rendered around the element\nWhen true, use outlined styling", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/TextFieldMixin.js#L31" }, "type": { "text": "boolean" } }, { "name": "density", "kind": "field", "description": "Density level affecting spacing and compactness. Integer from -4 (dense) to 4 (spacious).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/DensityMixin.js#L9" }, "type": { "text": "number" } }, { "name": "ariaControls", "kind": "field", "description": "ARIA 'controls' attribute (string).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L32" }, "type": { "text": "string" } }, { "name": "autocomplete", "kind": "field", "description": "Autocomplete token for the associated control (string).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L34" }, "type": { "text": "string" } }, { "name": "name", "kind": "field", "description": "Name attribute for the control used in forms.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L36" }, "type": { "text": "string" } }, { "name": "readOnly", "kind": "field", "description": "Read-only state reflected to control via 'readonly' attribute.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L38" }, "type": { "text": "boolean" } }, { "name": "formNoValidate", "kind": "field", "description": "When true, form validation is skipped for this control (formnovalidate).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L40" }, "type": { "text": "boolean" } }, { "name": "defaultChecked", "kind": "field", "description": "Default checked state for checkable controls (checkbox/radio).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L42" }, "type": { "text": "boolean" } }, { "name": "required", "kind": "field", "description": "Whether the control is required for form submission.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L47" }, "type": { "text": "boolean" } }, { "name": "type", "kind": "field", "description": "Control type token (e.g. 'text','checkbox','radio','file').\nInput type (text, password, email, etc.)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Input.js#L119" }, "type": { "text": "string" } }, { "name": "erroredState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/TextFieldMixin.js#L50" }, "type": { "text": "boolean" } }, { "name": "defaultValue", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L66" }, "type": { "text": "string" } }, { "name": "value", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Input.js#L859" }, "type": { "text": "string" } }, { "name": "checked", "kind": "field", "description": "Part of FormAssociatedMixin for simplicity.\nEnumerability doesn't guarantee checked state will be passed or used.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L145" }, "type": { "text": "boolean" } }, { "name": "form", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L160" }, "type": { "text": "HTMLFormElement" } }, { "name": "validity", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L161" }, "type": { "text": "ValidityState" } }, { "name": "validationMessage", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L162" }, "type": { "text": "string" } }, { "name": "willValidate", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L163" }, "type": { "text": "boolean" } }, { "name": "labels", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L168" }, "type": { "text": "NodeList" } }, { "name": "checkValidity", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ControlMixin.js#L69" }, "type": { "text": "(() => boolean) & (() => boolean)" } }, { "name": "reportValidity", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ControlMixin.js#L87" }, "type": { "text": "(() => boolean) & (() => boolean)" } }, { "name": "setCustomValidity", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ControlMixin.js#L96" }, "type": { "text": "((error: string) => void) & ((error: string) => void)" } }, { "name": "refreshFormAssociation", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L203" }, "type": { "text": "() => void" } }, { "name": "formAssociatedCallback", "kind": "field", "description": "New lifecycle callback. This is called when association with\n is changed.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L225" }, "type": { "text": "(form: HTMLFormElement) => void" } }, { "name": "formIPCEvent", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L234" }, "type": { "text": "(event: CustomEvent<[string, string]>) => void" } }, { "name": "formDisabledCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L254" }, "type": { "text": "(disabled: boolean) => void" } }, { "name": "formResetCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L258" }, "type": { "text": "() => void" } }, { "name": "formStateRestoreCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L270" }, "type": { "text": "(state: string | FormData, mode: \"autocomplete\" | \"restore\") => void" } }, { "name": "focusableOnDisabled", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ControlMixin.js#L30" }, "type": { "text": "boolean" } }, { "name": "controlTagName", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L102" }, "type": { "text": "string" } }, { "name": "controlVoidElement", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ControlMixin.js#L32" }, "type": { "text": "boolean" } }, { "name": "onValueChangingContentAttribute", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ControlMixin.js#L43" }, "type": { "text": "() => void" } }, { "name": "icon", "kind": "field", "description": "Leading icon key/name to render inside the field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/TextFieldMixin.js#L23" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/TextFieldMixin.js" } }, { "name": "iconVariation", "kind": "field", "description": "Variation of the icon display (e.g., filled)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/TextFieldMixin.js#L25" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/TextFieldMixin.js" } }, { "name": "label", "kind": "field", "description": "Floating label text for the field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Input.js#L434" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/TextFieldMixin.js" } }, { "name": "filled", "kind": "field", "description": "When true, use filled styling", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/TextFieldMixin.js#L29" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/TextFieldMixin.js" } }, { "name": "inputPrefix", "kind": "field", "description": "Prefix text shown before the input", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/TextFieldMixin.js#L33" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/TextFieldMixin.js" } }, { "name": "inputSuffix", "kind": "field", "description": "Suffix text shown after the input", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/TextFieldMixin.js#L35" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/TextFieldMixin.js" } }, { "name": "trailingIcon", "kind": "field", "description": "Trailing icon key/name", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Input.js#L693" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/TextFieldMixin.js" } }, { "name": "trailingIconInk", "kind": "field", "description": "Ink/color token for the trailing icon", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/TextFieldMixin.js#L39" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/TextFieldMixin.js" } }, { "name": "trailingIconLabel", "kind": "field", "description": "Accessible label for the trailing icon", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/TextFieldMixin.js#L41" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/TextFieldMixin.js" } }, { "name": "supporting", "kind": "field", "description": "Supporting/helper text shown beneath the field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/TextFieldMixin.js#L43" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/TextFieldMixin.js" } }, { "name": "error", "kind": "field", "description": "Error message text", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/TextFieldMixin.js#L45" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/TextFieldMixin.js" } }, { "name": "placeholder", "kind": "field", "description": "Placeholder text (DOMString)\nPlaceholder text shown when no value is present.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L70" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "computePlaceholder", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/TextFieldMixin.js#L53" }, "type": { "text": "() => string" }, "inheritedFrom": { "name": "default", "module": "mixins/TextFieldMixin.js" } }, { "name": "shouldShowSupporting", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/TextFieldMixin.js#L58" }, "type": { "text": "() => boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/TextFieldMixin.js" } }, { "name": "computeSupportingText", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/TextFieldMixin.js#L62" }, "type": { "text": "() => string" }, "inheritedFrom": { "name": "default", "module": "mixins/TextFieldMixin.js" } }, { "name": "populatedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Input.js#L790" }, "type": { "text": "(() => boolean) & (() => boolean)" }, "inheritedFrom": { "name": "default", "module": "mixins/TextFieldMixin.js" } }, { "name": "computedIconVariation", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/TextFieldMixin.js#L77" }, "type": { "text": "() => string" }, "inheritedFrom": { "name": "default", "module": "mixins/TextFieldMixin.js" } }, { "name": "accept", "kind": "field", "description": "Accepted file types for file input (e.g. '.png,.jpg').", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L41" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "alt", "kind": "field", "description": "Alternate text for images (for `type='image'`).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L43" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "dirName", "kind": "field", "description": "Directionality for form submission name (dirname attribute).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L45" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "formEnctype", "kind": "field", "description": "Form encoding type (formenctype).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L49" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "formMethod", "kind": "field", "description": "Form method when associated with a submit input (formmethod).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L51" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "formTarget", "kind": "field", "description": "Target browsing context for form submission (formtarget).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L53" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "max", "kind": "field", "description": "Max value or token for the input.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L58" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "maxLength", "kind": "field", "description": "Maximum length for text-like inputs.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L60" }, "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "min", "kind": "field", "description": "Min value or token for the input.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L62" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "minLength", "kind": "field", "description": "Minimum length for text-like inputs.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L64" }, "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "multiple", "kind": "field", "description": "When true, multiple values are allowed (e.g. file inputs).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L66" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "pattern", "kind": "field", "description": "Pattern used for validation (RegExp as string).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L68" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "size", "kind": "field", "description": "Suggested control size (number of characters).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L72" }, "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "src", "kind": "field", "description": "Source URL for image-type inputs.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L74" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "step", "kind": "field", "description": "Step interval for numeric inputs.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L76" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "indeterminate", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L89" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "performImplicitSubmission", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L175" }, "type": { "text": "(event: Event) => void" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "setRangeText", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L345" }, "type": { "text": "{ (replacement: string): void; (replacement: string, start: number, end: number, selectionMode?: SelectionMode): void; }" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "setSelectionRange", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L348" }, "type": { "text": "(start: number, end: number, direction?: \"none\" | \"forward\" | \"backward\") => void" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "showPicker", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L351" }, "type": { "text": "() => void" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "stepDown", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L354" }, "type": { "text": "(n?: number) => void" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "stepUp", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L360" }, "type": { "text": "(n?: number) => void" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "select", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L366" }, "type": { "text": "() => void" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "files", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L371" }, "type": { "text": "FileList" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "selectionDirection", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L384" }, "type": { "text": "\"none\" | \"forward\" | \"backward\"" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "selectionEnd", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L389" }, "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "selectionStart", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L394" }, "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "valueAsDate", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L399" }, "type": { "text": "Date" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "valueAsNumber", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L407" }, "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "height", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L415" }, "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "formAction", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L423" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "width", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L431" }, "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "autocompleteInline", "kind": "field", "description": "When true, the component inserts the best suggestion into the input field\nas inline text. The appended portion of the suggestion is selected so the\nuser can accept it (e.g. press Enter) or continue typing to replace it.\nTypically combined with `autosuggestInline` to display candidates while\ntyping.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Input.js#L56" }, "type": { "text": "boolean" } }, { "name": "autocompleteList", "kind": "field", "description": "When set and not `'custom'`, `applyAutocompleteList()` filters the\nlistbox options to items that start * with the typed text. This controls\ndropdown filtering but does not itself cause inline insertion.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Input.js#L64" }, "type": { "text": "string" } }, { "name": "autosuggestInline", "kind": "field", "description": "When true, the component advances/searches suggestion candidates as the\nuser types (calls `changeSuggestion({ startsWith })`). If\n`autosuggestInline` is true and `autocompleteInline` is also true the\ncurrent candidate will be shown inline; if `autocompleteInline` is false\nonly the candidate selection changes (no inline text insertion).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Input.js#L73" }, "type": { "text": "boolean" } }, { "name": "autoSelect", "kind": "field", "description": "If true, when listbox is open, arrow navigation will automatically select options.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Input.js#L76" }, "type": { "text": "boolean" } }, { "name": "acceptOnEscape", "kind": "field", "description": "If true, when listbox is open, accepts current suggestion (same as Enter).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Input.js#L82" }, "type": { "text": "boolean" } }, { "name": "listbox", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Input.js#L136" }, "type": { "text": "CustomElement & { delegatesFocus: boolean; } & { _ariaRole: string; } & { _onConnectAriaValues: Map<\"ariaAtomic\" | \"ariaAutoComplete\" | \"ariaBrailleLabel\" | \"ariaBrailleRoleDescription\" | \"ariaBusy\" | \"ariaChecked\" | \"ariaColCount\" | \"ariaColIndex\" | \"ariaColIndexText\" | \"ariaColSpan\" | \"ariaCurrent\" | \"ariaDescription\" | \"ariaDisabled\" | \"ariaExpanded\" | \"ariaHasPopup\" | \"ariaHidden\" | \"ariaInvalid\" | \"ariaKeyShortcuts\" | \"ariaLabel\" | \"ariaLevel\" | \"ariaLive\" | \"ariaModal\" | \"ariaMultiLine\" | \"ariaMultiSelectable\" | \"ariaOrientation\" | \"ariaPlaceholder\" | \"ariaPosInSet\" | \"ariaPressed\" | \"ariaReadOnly\" | \"ariaRelevant\" | \"ariaRequired\" | \"ariaRoleDescription\" | \"ariaRowCount\" | \"ariaRowIndex\" | \"ariaRowIndexText\" | \"ariaRowSpan\" | \"ariaSelected\" | \"ariaSetSize\" | \"ariaSort\" | \"ariaValueMax\" | \"ariaValueMin\" | \"ariaValueNow\" | \"ariaValueText\" | \"role\", string>; } & { readAriaProperty(name: \"shadowRoot\" | \"ariaActiveDescendantElement\" | \"ariaAtomic\" | \"ariaAutoComplete\" | \"ariaBrailleLabel\" | \"ariaBrailleRoleDescription\" | \"ariaBusy\" | \"ariaChecked\" | \"ariaColCount\" | \"ariaColIndex\" | \"ariaColIndexText\" | \"ariaColSpan\" | \"ariaControlsElements\" | \"ariaCurrent\" | \"ariaDescribedByElements\" | \"ariaDescription\" | \"ariaDetailsElements\" | \"ariaDisabled\" | \"ariaErrorMessageElements\" | \"ariaExpanded\" | \"ariaFlowToElements\" | \"ariaHasPopup\" | \"ariaHidden\" | \"ariaInvalid\" | \"ariaKeyShortcuts\" | \"ariaLabel\" | \"ariaLabelledByElements\" | \"ariaLevel\" | \"ariaLive\" | \"ariaModal\" | \"ariaMultiLine\" | \"ariaMultiSelectable\" | \"ariaOrientation\" | \"ariaOwnsElements\" | \"ariaPlaceholder\" | \"ariaPosInSet\" | \"ariaPressed\" | \"ariaReadOnly\" | \"ariaRelevant\" | \"ariaRequired\" | \"ariaRoleDescription\" | \"ariaRowCount\" | \"ariaRowIndex\" | \"ariaRowIndexText\" | \"ariaRowSpan\" | \"ariaSelected\" | \"ariaSetSize\" | \"ariaSort\" | \"ariaValueMax\" | \"ariaValueMin\" | \"ariaValueNow\" | \"ariaValueText\" | \"role\"): string | Element | ShadowRoot | readonly Element[]; updateAriaProperty>(name: K, value: ARIAMixin[K]): void; } & { kbdNav: string; _kbdFocusable: boolean; } & { kbdNavQuery: string; kbdNavFocusableWhenDisabled: boolean; ariaOrientationDefault: \"horizontal\" | \"vertical\"; } & { kbdNavChildren: NodeListOf; } & { _ariaOrientationIsVertical(): boolean; focusCurrentOrFirst(): HTMLElement; focusNext(current?: HTMLElement, loop?: boolean, reverse?: boolean): HTMLElement; focusPrevious(current?: HTMLElement, loop?: boolean): HTMLElement; focus(options?: FocusOptions): void; refreshTabIndexes(): void; } & { disabled: boolean; focused: boolean; hovered: boolean; pressed: boolean; _lastInteraction: \"mouse\" | \"touch\" | \"key\" | \"pen\"; _hovered: boolean; _focused: boolean; _focusedSynthetic: boolean; _keyPressed: boolean; _keyReleased: boolean; _pointerPressed: boolean; stateLayer: boolean; } & { disabledState: boolean; hoveredState: boolean; focusedState: boolean; pressedState: boolean; touchedState: boolean; pointedState: boolean; } & { stateTargetElement: HTMLElement; } & { _ipcListener: EventListener; _ipcTarget: EventTarget; _files: FileList; } & { ariaControls: string; autocomplete: string; name: string; readOnly: boolean; formNoValidate: boolean; defaultChecked: boolean; _checkedDirty: boolean; _checked: boolean; required: boolean; type: string; _defaultValue: string; _value: string; _valueDirty: boolean; _userInteracted: boolean; _invalid: boolean; _badInput: boolean; _validationMessage: string; _formDisabled: boolean; _formReset: boolean; } & { erroredState: boolean; defaultValue: string; _valueBehavior: \"value\" | \"default/on\" | \"default\" | \"filename\"; } & { _onSetValue(value: string): void; _onSetChecked(checked: boolean): void; } & { value: string; checked: boolean; } & { form: HTMLFormElement; validity: ValidityState; validationMessage: string; willValidate: boolean; labels: NodeList; } & { disabledState: boolean; } & { checkValidity(): boolean; reportValidity(): boolean; setCustomValidity(error: string): void; _notifyRadioChange(key: string, value: string): void; refreshFormAssociation(): void; formAssociatedCallback(form: HTMLFormElement): void; formIPCEvent(event: CustomEvent<[string, string]>): void; formDisabledCallback(disabled: boolean): void; formResetCallback(): void; formStateRestoreCallback(state: string | FormData, mode: \"autocomplete\" | \"restore\"): void; _updateFormAssociatedValue(): void; } & { density: number; } & { block: boolean; inline: boolean; row: boolean; x: string; y: string; gap: number; padding: string; } & { color: string; ink: string; typeStyle: string; } & { _ariaRole: string; color: { empty: string; }; } & { multiple: boolean; size: number; } & { _ariaRole: string; _optionsCollection: HTMLCollectionOf; } & { readAriaProperty(name: \"shadowRoot\" | \"ariaActiveDescendantElement\" | \"ariaAtomic\" | \"ariaAutoComplete\" | \"ariaBrailleLabel\" | \"ariaBrailleRoleDescription\" | \"ariaBusy\" | \"ariaChecked\" | \"ariaColCount\" | \"ariaColIndex\" | \"ariaColIndexText\" | \"ariaColSpan\" | \"ariaControlsElements\" | \"ariaCurrent\" | \"ariaDescribedByElements\" | \"ariaDescription\" | \"ariaDetailsElements\" | \"ariaDisabled\" | \"ariaErrorMessageElements\" | \"ariaExpanded\" | \"ariaFlowToElements\" | \"ariaHasPopup\" | \"ariaHidden\" | \"ariaInvalid\" | \"ariaKeyShortcuts\" | \"ariaLabel\" | \"ariaLabelledByElements\" | \"ariaLevel\" | \"ariaLive\" | \"ariaModal\" | \"ariaMultiLine\" | \"ariaMultiSelectable\" | \"ariaOrientation\" | \"ariaOwnsElements\" | \"ariaPlaceholder\" | \"ariaPosInSet\" | \"ariaPressed\" | \"ariaReadOnly\" | \"ariaRelevant\" | \"ariaRequired\" | \"ariaRoleDescription\" | \"ariaRowCount\" | \"ariaRowIndex\" | \"ariaRowIndexText\" | \"ariaRowSpan\" | \"ariaSelected\" | \"ariaSetSize\" | \"ariaSort\" | \"ariaValueMax\" | \"ariaValueMin\" | \"ariaValueNow\" | \"ariaValueText\" | \"role\"): string | Element | ShadowRoot | readonly Element[]; updateAriaProperty>(name: K, value: ARIAMixin[K]): void; } & { disabled: boolean; focused: boolean; hovered: boolean; pressed: boolean; _lastInteraction: \"mouse\" | \"touch\" | \"key\" | \"pen\"; _hovered: boolean; _focused: boolean; _focusedSynthetic: boolean; _keyPressed: boolean; _keyReleased: boolean; _pointerPressed: boolean; stateLayer: boolean; } & { disabledState: boolean; hoveredState: boolean; focusedState: boolean; pressedState: boolean; touchedState: boolean; pointedState: boolean; } & { stateTargetElement: HTMLElement; } & { _lastRippleWeakRef: WeakRef; _rippleAdded: boolean; } & { _lastRipple: CustomElement & { hadRippleHeld: boolean; hadRippleReleased: boolean; rippleStarted: boolean; } & { rippleState: string; keepAlive: boolean; _positionX: number; _positionY: number; _radius: number; holdRipple: boolean; } & { _positionStyle: ElementStylerOptions | { styles: { minHeight: string; minWidth: string; boxShadow: string; top: string; left: string; }; }; } & { updatePosition(x?: number, y?: number, size?: number): void; handleRippleComplete(): void; }; } & { addRipple(x?: number, y?: number, hold?: boolean): CustomElement & { hadRippleHeld: boolean; hadRippleReleased: boolean; rippleStarted: boolean; } & { rippleState: string; keepAlive: boolean; _positionX: number; _positionY: number; _radius: number; holdRipple: boolean; } & { _positionStyle: ElementStylerOptions | { styles: { minHeight: string; minWidth: string; boxShadow: string; top: string; left: string; }; }; } & { updatePosition(x?: number, y?: number, size?: number): void; handleRippleComplete(): void; }; } & { color: string; ink: string; typeStyle: string; } & { _ariaRole: string; stateLayer: boolean; } & { leading: string; avatar: string; avatarColor: string; avatarSrc: string; src: string; alt: string; icon: string; iconInk: string; iconSrc: string; iconVariation: string; checkbox: string; radio: string; selectionColor: string; selected: boolean; supporting: string; trailing: string; trailingIcon: string; trailingIconInk: string; trailingIconSrc: string; divider: string; video: boolean; lines: number; _supportingSlotted: boolean; } & { disabledState: boolean; } & { isInteractive: () => boolean; hasSupporting: () => boolean; checkboxClass: () => string; radioClass: () => string; computedIconVariation: () => string; } & { _ariaRole: string; _index: number; _selectedDirty: boolean; isInteractive: boolean; } & { _label: string; _text: string; defaultSelected: boolean; _selected: boolean; _value: string; _formDisabled: boolean; } & { selected: boolean; disabledState: boolean; } & { index: number; form: HTMLFormElement; text: string; label: string; value: string; } & { formDisabledCallback(formDisabled: boolean): void; focus(options?: FocusOptions): void; } & { anchorAriaLabelledBy: () => string; anchorAriaDescribedBy: () => string; computedIconVariation: () => string; }> & HTMLOptionsCollection; _selectedOptionsCollection: any; _handlingSelectedness: boolean; _handleFormReset: boolean; } & { options: HTMLCollectionOf; } & { readAriaProperty(name: \"shadowRoot\" | \"ariaActiveDescendantElement\" | \"ariaAtomic\" | \"ariaAutoComplete\" | \"ariaBrailleLabel\" | \"ariaBrailleRoleDescription\" | \"ariaBusy\" | \"ariaChecked\" | \"ariaColCount\" | \"ariaColIndex\" | \"ariaColIndexText\" | \"ariaColSpan\" | \"ariaControlsElements\" | \"ariaCurrent\" | \"ariaDescribedByElements\" | \"ariaDescription\" | \"ariaDetailsElements\" | \"ariaDisabled\" | \"ariaErrorMessageElements\" | \"ariaExpanded\" | \"ariaFlowToElements\" | \"ariaHasPopup\" | \"ariaHidden\" | \"ariaInvalid\" | \"ariaKeyShortcuts\" | \"ariaLabel\" | \"ariaLabelledByElements\" | \"ariaLevel\" | \"ariaLive\" | \"ariaModal\" | \"ariaMultiLine\" | \"ariaMultiSelectable\" | \"ariaOrientation\" | \"ariaOwnsElements\" | \"ariaPlaceholder\" | \"ariaPosInSet\" | \"ariaPressed\" | \"ariaReadOnly\" | \"ariaRelevant\" | \"ariaRequired\" | \"ariaRoleDescription\" | \"ariaRowCount\" | \"ariaRowIndex\" | \"ariaRowIndexText\" | \"ariaRowSpan\" | \"ariaSelected\" | \"ariaSetSize\" | \"ariaSort\" | \"ariaValueMax\" | \"ariaValueMin\" | \"ariaValueNow\" | \"ariaValueText\" | \"role\"): string | Element | ShadowRoot | readonly Element[]; updateAriaProperty>(name: K, value: ARIAMixin[K]): void; } & { disabled: boolean; focused: boolean; hovered: boolean; pressed: boolean; _lastInteraction: \"mouse\" | \"touch\" | \"key\" | \"pen\"; _hovered: boolean; _focused: boolean; _focusedSynthetic: boolean; _keyPressed: boolean; _keyReleased: boolean; _pointerPressed: boolean; stateLayer: boolean; } & { disabledState: boolean; hoveredState: boolean; focusedState: boolean; pressedState: boolean; touchedState: boolean; pointedState: boolean; } & { stateTargetElement: HTMLElement; } & { _lastRippleWeakRef: WeakRef; _rippleAdded: boolean; } & { _lastRipple: CustomElement & { hadRippleHeld: boolean; hadRippleReleased: boolean; rippleStarted: boolean; } & { rippleState: string; keepAlive: boolean; _positionX: number; _positionY: number; _radius: number; holdRipple: boolean; } & { _positionStyle: ElementStylerOptions | { styles: { minHeight: string; minWidth: string; boxShadow: string; top: string; left: string; }; }; } & { updatePosition(x?: number, y?: number, size?: number): void; handleRippleComplete(): void; }; } & { addRipple(x?: number, y?: number, hold?: boolean): CustomElement & { hadRippleHeld: boolean; hadRippleReleased: boolean; rippleStarted: boolean; } & { rippleState: string; keepAlive: boolean; _positionX: number; _positionY: number; _radius: number; holdRipple: boolean; } & { _positionStyle: ElementStylerOptions | { styles: { minHeight: string; minWidth: string; boxShadow: string; top: string; left: string; }; }; } & { updatePosition(x?: number, y?: number, size?: number): void; handleRippleComplete(): void; }; } & { color: string; ink: string; typeStyle: string; } & { _ariaRole: string; stateLayer: boolean; } & { leading: string; avatar: string; avatarColor: string; avatarSrc: string; src: string; alt: string; icon: string; iconInk: string; iconSrc: string; iconVariation: string; checkbox: string; radio: string; selectionColor: string; selected: boolean; supporting: string; trailing: string; trailingIcon: string; trailingIconInk: string; trailingIconSrc: string; divider: string; video: boolean; lines: number; _supportingSlotted: boolean; } & { disabledState: boolean; } & { isInteractive: () => boolean; hasSupporting: () => boolean; checkboxClass: () => string; radioClass: () => string; computedIconVariation: () => string; } & { _ariaRole: string; _index: number; _selectedDirty: boolean; isInteractive: boolean; } & { _label: string; _text: string; defaultSelected: boolean; _selected: boolean; _value: string; _formDisabled: boolean; } & { selected: boolean; disabledState: boolean; } & { index: number; form: HTMLFormElement; text: string; label: string; value: string; } & { formDisabledCallback(formDisabled: boolean): void; focus(options?: FocusOptions): void; } & { anchorAriaLabelledBy: () => string; anchorAriaDescribedBy: () => string; computedIconVariation: () => string; }> & HTMLOptionsCollection; selectedOptions: HTMLCollectionOf; } & { readAriaProperty(name: \"shadowRoot\" | \"ariaActiveDescendantElement\" | \"ariaAtomic\" | \"ariaAutoComplete\" | \"ariaBrailleLabel\" | \"ariaBrailleRoleDescription\" | \"ariaBusy\" | \"ariaChecked\" | \"ariaColCount\" | \"ariaColIndex\" | \"ariaColIndexText\" | \"ariaColSpan\" | \"ariaControlsElements\" | \"ariaCurrent\" | \"ariaDescribedByElements\" | \"ariaDescription\" | \"ariaDetailsElements\" | \"ariaDisabled\" | \"ariaErrorMessageElements\" | \"ariaExpanded\" | \"ariaFlowToElements\" | \"ariaHasPopup\" | \"ariaHidden\" | \"ariaInvalid\" | \"ariaKeyShortcuts\" | \"ariaLabel\" | \"ariaLabelledByElements\" | \"ariaLevel\" | \"ariaLive\" | \"ariaModal\" | \"ariaMultiLine\" | \"ariaMultiSelectable\" | \"ariaOrientation\" | \"ariaOwnsElements\" | \"ariaPlaceholder\" | \"ariaPosInSet\" | \"ariaPressed\" | \"ariaReadOnly\" | \"ariaRelevant\" | \"ariaRequired\" | \"ariaRoleDescription\" | \"ariaRowCount\" | \"ariaRowIndex\" | \"ariaRowIndexText\" | \"ariaRowSpan\" | \"ariaSelected\" | \"ariaSetSize\" | \"ariaSort\" | \"ariaValueMax\" | \"ariaValueMin\" | \"ariaValueNow\" | \"ariaValueText\" | \"role\"): string | Element | ShadowRoot | readonly Element[]; updateAriaProperty>(name: K, value: ARIAMixin[K]): void; } & { disabled: boolean; focused: boolean; hovered: boolean; pressed: boolean; _lastInteraction: \"mouse\" | \"touch\" | \"key\" | \"pen\"; _hovered: boolean; _focused: boolean; _focusedSynthetic: boolean; _keyPressed: boolean; _keyReleased: boolean; _pointerPressed: boolean; stateLayer: boolean; } & { disabledState: boolean; hoveredState: boolean; focusedState: boolean; pressedState: boolean; touchedState: boolean; pointedState: boolean; } & { stateTargetElement: HTMLElement; } & { _lastRippleWeakRef: WeakRef; _rippleAdded: boolean; } & { _lastRipple: CustomElement & { hadRippleHeld: boolean; hadRippleReleased: boolean; rippleStarted: boolean; } & { rippleState: string; keepAlive: boolean; _positionX: number; _positionY: number; _radius: number; holdRipple: boolean; } & { _positionStyle: ElementStylerOptions | { styles: { minHeight: string; minWidth: string; boxShadow: string; top: string; left: string; }; }; } & { updatePosition(x?: number, y?: number, size?: number): void; handleRippleComplete(): void; }; } & { addRipple(x?: number, y?: number, hold?: boolean): CustomElement & { hadRippleHeld: boolean; hadRippleReleased: boolean; rippleStarted: boolean; } & { rippleState: string; keepAlive: boolean; _positionX: number; _positionY: number; _radius: number; holdRipple: boolean; } & { _positionStyle: ElementStylerOptions | { styles: { minHeight: string; minWidth: string; boxShadow: string; top: string; left: string; }; }; } & { updatePosition(x?: number, y?: number, size?: number): void; handleRippleComplete(): void; }; } & { color: string; ink: string; typeStyle: string; } & { _ariaRole: string; stateLayer: boolean; } & { leading: string; avatar: string; avatarColor: string; avatarSrc: string; src: string; alt: string; icon: string; iconInk: string; iconSrc: string; iconVariation: string; checkbox: string; radio: string; selectionColor: string; selected: boolean; supporting: string; trailing: string; trailingIcon: string; trailingIconInk: string; trailingIconSrc: string; divider: string; video: boolean; lines: number; _supportingSlotted: boolean; } & { disabledState: boolean; } & { isInteractive: () => boolean; hasSupporting: () => boolean; checkboxClass: () => string; radioClass: () => string; computedIconVariation: () => string; } & { _ariaRole: string; _index: number; _selectedDirty: boolean; isInteractive: boolean; } & { _label: string; _text: string; defaultSelected: boolean; _selected: boolean; _value: string; _formDisabled: boolean; } & { selected: boolean; disabledState: boolean; } & { index: number; form: HTMLFormElement; text: string; label: string; value: string; } & { formDisabledCallback(formDisabled: boolean): void; focus(options?: FocusOptions): void; } & { anchorAriaLabelledBy: () => string; anchorAriaDescribedBy: () => string; computedIconVariation: () => string; }>; type: \"select-multiple\" | \"select-one\"; kbdNavQuery: string; kbdNavFocusableWhenDisabled: boolean; } & { length: number; selectedIndex: number; value: string; add: (element: HTMLOptionElement | HTMLOptGroupElement, before?: number | HTMLElement) => void; } & { _selectedOptionsGenerator(): Generator; } & { readAriaProperty(name: \"shadowRoot\" | \"ariaActiveDescendantElement\" | \"ariaAtomic\" | \"ariaAutoComplete\" | \"ariaBrailleLabel\" | \"ariaBrailleRoleDescription\" | \"ariaBusy\" | \"ariaChecked\" | \"ariaColCount\" | \"ariaColIndex\" | \"ariaColIndexText\" | \"ariaColSpan\" | \"ariaControlsElements\" | \"ariaCurrent\" | \"ariaDescribedByElements\" | \"ariaDescription\" | \"ariaDetailsElements\" | \"ariaDisabled\" | \"ariaErrorMessageElements\" | \"ariaExpanded\" | \"ariaFlowToElements\" | \"ariaHasPopup\" | \"ariaHidden\" | \"ariaInvalid\" | \"ariaKeyShortcuts\" | \"ariaLabel\" | \"ariaLabelledByElements\" | \"ariaLevel\" | \"ariaLive\" | \"ariaModal\" | \"ariaMultiLine\" | \"ariaMultiSelectable\" | \"ariaOrientation\" | \"ariaOwnsElements\" | \"ariaPlaceholder\" | \"ariaPosInSet\" | \"ariaPressed\" | \"ariaReadOnly\" | \"ariaRelevant\" | \"ariaRequired\" | \"ariaRoleDescription\" | \"ariaRowCount\" | \"ariaRowIndex\" | \"ariaRowIndexText\" | \"ariaRowSpan\" | \"ariaSelected\" | \"ariaSetSize\" | \"ariaSort\" | \"ariaValueMax\" | \"ariaValueMin\" | \"ariaValueNow\" | \"ariaValueText\" | \"role\"): string | Element | ShadowRoot | readonly Element[]; updateAriaProperty>(name: K, value: ARIAMixin[K]): void; } & { disabled: boolean; focused: boolean; hovered: boolean; pressed: boolean; _lastInteraction: \"mouse\" | \"touch\" | \"key\" | \"pen\"; _hovered: boolean; _focused: boolean; _focusedSynthetic: boolean; _keyPressed: boolean; _keyReleased: boolean; _pointerPressed: boolean; stateLayer: boolean; } & { disabledState: boolean; hoveredState: boolean; focusedState: boolean; pressedState: boolean; touchedState: boolean; pointedState: boolean; } & { stateTargetElement: HTMLElement; } & { _lastRippleWeakRef: WeakRef; _rippleAdded: boolean; } & { _lastRipple: CustomElement & { hadRippleHeld: boolean; hadRippleReleased: boolean; rippleStarted: boolean; } & { rippleState: string; keepAlive: boolean; _positionX: number; _positionY: number; _radius: number; holdRipple: boolean; } & { _positionStyle: ElementStylerOptions | { styles: { minHeight: string; minWidth: string; boxShadow: string; top: string; left: string; }; }; } & { updatePosition(x?: number, y?: number, size?: number): void; handleRippleComplete(): void; }; } & { addRipple(x?: number, y?: number, hold?: boolean): CustomElement & { hadRippleHeld: boolean; hadRippleReleased: boolean; rippleStarted: boolean; } & { rippleState: string; keepAlive: boolean; _positionX: number; _positionY: number; _radius: number; holdRipple: boolean; } & { _positionStyle: ElementStylerOptions | { styles: { minHeight: string; minWidth: string; boxShadow: string; top: string; left: string; }; }; } & { updatePosition(x?: number, y?: number, size?: number): void; handleRippleComplete(): void; }; } & { color: string; ink: string; typeStyle: string; } & { _ariaRole: string; stateLayer: boolean; } & { leading: string; avatar: string; avatarColor: string; avatarSrc: string; src: string; alt: string; icon: string; iconInk: string; iconSrc: string; iconVariation: string; checkbox: string; radio: string; selectionColor: string; selected: boolean; supporting: string; trailing: string; trailingIcon: string; trailingIconInk: string; trailingIconSrc: string; divider: string; video: boolean; lines: number; _supportingSlotted: boolean; } & { disabledState: boolean; } & { isInteractive: () => boolean; hasSupporting: () => boolean; checkboxClass: () => string; radioClass: () => string; computedIconVariation: () => string; } & { _ariaRole: string; _index: number; _selectedDirty: boolean; isInteractive: boolean; } & { _label: string; _text: string; defaultSelected: boolean; _selected: boolean; _value: string; _formDisabled: boolean; } & { selected: boolean; disabledState: boolean; } & { index: number; form: HTMLFormElement; text: string; label: string; value: string; } & { formDisabledCallback(formDisabled: boolean): void; focus(options?: FocusOptions): void; } & { anchorAriaLabelledBy: () => string; anchorAriaDescribedBy: () => string; computedIconVariation: () => string; } & HTMLOptionElement, void, unknown>; [Symbol.iterator](): Generator; } & { readAriaProperty(name: \"shadowRoot\" | \"ariaActiveDescendantElement\" | \"ariaAtomic\" | \"ariaAutoComplete\" | \"ariaBrailleLabel\" | \"ariaBrailleRoleDescription\" | \"ariaBusy\" | \"ariaChecked\" | \"ariaColCount\" | \"ariaColIndex\" | \"ariaColIndexText\" | \"ariaColSpan\" | \"ariaControlsElements\" | \"ariaCurrent\" | \"ariaDescribedByElements\" | \"ariaDescription\" | \"ariaDetailsElements\" | \"ariaDisabled\" | \"ariaErrorMessageElements\" | \"ariaExpanded\" | \"ariaFlowToElements\" | \"ariaHasPopup\" | \"ariaHidden\" | \"ariaInvalid\" | \"ariaKeyShortcuts\" | \"ariaLabel\" | \"ariaLabelledByElements\" | \"ariaLevel\" | \"ariaLive\" | \"ariaModal\" | \"ariaMultiLine\" | \"ariaMultiSelectable\" | \"ariaOrientation\" | \"ariaOwnsElements\" | \"ariaPlaceholder\" | \"ariaPosInSet\" | \"ariaPressed\" | \"ariaReadOnly\" | \"ariaRelevant\" | \"ariaRequired\" | \"ariaRoleDescription\" | \"ariaRowCount\" | \"ariaRowIndex\" | \"ariaRowIndexText\" | \"ariaRowSpan\" | \"ariaSelected\" | \"ariaSetSize\" | \"ariaSort\" | \"ariaValueMax\" | \"ariaValueMin\" | \"ariaValueNow\" | \"ariaValueText\" | \"role\"): string | Element | ShadowRoot | readonly Element[]; updateAriaProperty>(name: K, value: ARIAMixin[K]): void; } & { disabled: boolean; focused: boolean; hovered: boolean; pressed: boolean; _lastInteraction: \"mouse\" | \"touch\" | \"key\" | \"pen\"; _hovered: boolean; _focused: boolean; _focusedSynthetic: boolean; _keyPressed: boolean; _keyReleased: boolean; _pointerPressed: boolean; stateLayer: boolean; } & { disabledState: boolean; hoveredState: boolean; focusedState: boolean; pressedState: boolean; touchedState: boolean; pointedState: boolean; } & { stateTargetElement: HTMLElement; } & { _lastRippleWeakRef: WeakRef; _rippleAdded: boolean; } & { _lastRipple: CustomElement & { hadRippleHeld: boolean; hadRippleReleased: boolean; rippleStarted: boolean; } & { rippleState: string; keepAlive: boolean; _positionX: number; _positionY: number; _radius: number; holdRipple: boolean; } & { _positionStyle: ElementStylerOptions | { styles: { minHeight: string; minWidth: string; boxShadow: string; top: string; left: string; }; }; } & { updatePosition(x?: number, y?: number, size?: number): void; handleRippleComplete(): void; }; } & { addRipple(x?: number, y?: number, hold?: boolean): CustomElement & { hadRippleHeld: boolean; hadRippleReleased: boolean; rippleStarted: boolean; } & { rippleState: string; keepAlive: boolean; _positionX: number; _positionY: number; _radius: number; holdRipple: boolean; } & { _positionStyle: ElementStylerOptions | { styles: { minHeight: string; minWidth: string; boxShadow: string; top: string; left: string; }; }; } & { updatePosition(x?: number, y?: number, size?: number): void; handleRippleComplete(): void; }; } & { color: string; ink: string; typeStyle: string; } & { _ariaRole: string; stateLayer: boolean; } & { leading: string; avatar: string; avatarColor: string; avatarSrc: string; src: string; alt: string; icon: string; iconInk: string; iconSrc: string; iconVariation: string; checkbox: string; radio: string; selectionColor: string; selected: boolean; supporting: string; trailing: string; trailingIcon: string; trailingIconInk: string; trailingIconSrc: string; divider: string; video: boolean; lines: number; _supportingSlotted: boolean; } & { disabledState: boolean; } & { isInteractive: () => boolean; hasSupporting: () => boolean; checkboxClass: () => string; radioClass: () => string; computedIconVariation: () => string; } & { _ariaRole: string; _index: number; _selectedDirty: boolean; isInteractive: boolean; } & { _label: string; _text: string; defaultSelected: boolean; _selected: boolean; _value: string; _formDisabled: boolean; } & { selected: boolean; disabledState: boolean; } & { index: number; form: HTMLFormElement; text: string; label: string; value: string; } & { formDisabledCallback(formDisabled: boolean): void; focus(options?: FocusOptions): void; } & { anchorAriaLabelledBy: () => string; anchorAriaDescribedBy: () => string; computedIconVariation: () => string; } & HTMLOptionElement, void, unknown>; focus(): void; item(index: number): CustomElement & { delegatesFocus: boolean; } & { href: string; target: string; download: string; ping: string; rel: string; hreflang: string; referrerPolicy: string; } & { origin: string; protocol: string; username: string; password: string; host: string; hostname: string; port: string; pathname: string; search: string; hash: string; } & object & { _ariaRole: string; } & { _onConnectAriaValues: Map<\"ariaAtomic\" | \"ariaAutoComplete\" | \"ariaBrailleLabel\" | \"ariaBrailleRoleDescription\" | \"ariaBusy\" | \"ariaChecked\" | \"ariaColCount\" | \"ariaColIndex\" | \"ariaColIndexText\" | \"ariaColSpan\" | \"ariaCurrent\" | \"ariaDescription\" | \"ariaDisabled\" | \"ariaExpanded\" | \"ariaHasPopup\" | \"ariaHidden\" | \"ariaInvalid\" | \"ariaKeyShortcuts\" | \"ariaLabel\" | \"ariaLevel\" | \"ariaLive\" | \"ariaModal\" | \"ariaMultiLine\" | \"ariaMultiSelectable\" | \"ariaOrientation\" | \"ariaPlaceholder\" | \"ariaPosInSet\" | \"ariaPressed\" | \"ariaReadOnly\" | \"ariaRelevant\" | \"ariaRequired\" | \"ariaRoleDescription\" | \"ariaRowCount\" | \"ariaRowIndex\" | \"ariaRowIndexText\" | \"ariaRowSpan\" | \"ariaSelected\" | \"ariaSetSize\" | \"ariaSort\" | \"ariaValueMax\" | \"ariaValueMin\" | \"ariaValueNow\" | \"ariaValueText\" | \"role\", string>; } & { readAriaProperty(name: \"shadowRoot\" | \"ariaActiveDescendantElement\" | \"ariaAtomic\" | \"ariaAutoComplete\" | \"ariaBrailleLabel\" | \"ariaBrailleRoleDescription\" | \"ariaBusy\" | \"ariaChecked\" | \"ariaColCount\" | \"ariaColIndex\" | \"ariaColIndexText\" | \"ariaColSpan\" | \"ariaControlsElements\" | \"ariaCurrent\" | \"ariaDescribedByElements\" | \"ariaDescription\" | \"ariaDetailsElements\" | \"ariaDisabled\" | \"ariaErrorMessageElements\" | \"ariaExpanded\" | \"ariaFlowToElements\" | \"ariaHasPopup\" | \"ariaHidden\" | \"ariaInvalid\" | \"ariaKeyShortcuts\" | \"ariaLabel\" | \"ariaLabelledByElements\" | \"ariaLevel\" | \"ariaLive\" | \"ariaModal\" | \"ariaMultiLine\" | \"ariaMultiSelectable\" | \"ariaOrientation\" | \"ariaOwnsElements\" | \"ariaPlaceholder\" | \"ariaPosInSet\" | \"ariaPressed\" | \"ariaReadOnly\" | \"ariaRelevant\" | \"ariaRequired\" | \"ariaRoleDescription\" | \"ariaRowCount\" | \"ariaRowIndex\" | \"ariaRowIndexText\" | \"ariaRowSpan\" | \"ariaSelected\" | \"ariaSetSize\" | \"ariaSort\" | \"ariaValueMax\" | \"ariaValueMin\" | \"ariaValueNow\" | \"ariaValueText\" | \"role\"): string | Element | ShadowRoot | readonly Element[]; updateAriaProperty>(name: K, value: ARIAMixin[K]): void; } & { disabled: boolean; focused: boolean; hovered: boolean; pressed: boolean; _lastInteraction: \"mouse\" | \"touch\" | \"key\" | \"pen\"; _hovered: boolean; _focused: boolean; _focusedSynthetic: boolean; _keyPressed: boolean; _keyReleased: boolean; _pointerPressed: boolean; stateLayer: boolean; } & { disabledState: boolean; hoveredState: boolean; focusedState: boolean; pressedState: boolean; touchedState: boolean; pointedState: boolean; } & { stateTargetElement: HTMLElement; } & { _lastRippleWeakRef: WeakRef; _rippleAdded: boolean; } & { _lastRipple: CustomElement & { hadRippleHeld: boolean; hadRippleReleased: boolean; rippleStarted: boolean; } & { rippleState: string; keepAlive: boolean; _positionX: number; _positionY: number; _radius: number; holdRipple: boolean; } & { _positionStyle: ElementStylerOptions | { styles: { minHeight: string; minWidth: string; boxShadow: string; top: string; left: string; }; }; } & { updatePosition(x?: number, y?: number, size?: number): void; handleRippleComplete(): void; }; } & { addRipple(x?: number, y?: number, hold?: boolean): CustomElement & { hadRippleHeld: boolean; hadRippleReleased: boolean; rippleStarted: boolean; } & { rippleState: string; keepAlive: boolean; _positionX: number; _positionY: number; _radius: number; holdRipple: boolean; } & { _positionStyle: ElementStylerOptions | { styles: { minHeight: string; minWidth: string; boxShadow: string; top: string; left: string; }; }; } & { updatePosition(x?: number, y?: number, size?: number): void; handleRippleComplete(): void; }; } & { color: string; ink: string; typeStyle: string; } & { _ariaRole: string; stateLayer: boolean; } & { leading: string; avatar: string; avatarColor: string; avatarSrc: string; src: string; alt: string; icon: string; iconInk: string; iconSrc: string; iconVariation: string; checkbox: string; radio: string; selectionColor: string; selected: boolean; supporting: string; trailing: string; trailingIcon: string; trailingIconInk: string; trailingIconSrc: string; divider: string; video: boolean; lines: number; _supportingSlotted: boolean; } & { disabledState: boolean; } & { isInteractive: () => boolean; hasSupporting: () => boolean; checkboxClass: () => string; radioClass: () => string; computedIconVariation: () => string; } & { _ariaRole: string; _index: number; _selectedDirty: boolean; isInteractive: boolean; } & { _label: string; _text: string; defaultSelected: boolean; _selected: boolean; _value: string; _formDisabled: boolean; } & { selected: boolean; disabledState: boolean; } & { index: number; form: HTMLFormElement; text: string; label: string; value: string; } & { formDisabledCallback(formDisabled: boolean): void; focus(options?: FocusOptions): void; } & { anchorAriaLabelledBy: () => string; anchorAriaDescribedBy: () => string; computedIconVariation: () => string; }; namedItem(name: string): CustomElement & { delegatesFocus: boolean; } & { href: string; target: string; download: string; ping: string; rel: string; hreflang: string; referrerPolicy: string; } & { origin: string; protocol: string; username: string; password: string; host: string; hostname: string; port: string; pathname: string; search: string; hash: string; } & object & { _ariaRole: string; } & { _onConnectAriaValues: Map<\"ariaAtomic\" | \"ariaAutoComplete\" | \"ariaBrailleLabel\" | \"ariaBrailleRoleDescription\" | \"ariaBusy\" | \"ariaChecked\" | \"ariaColCount\" | \"ariaColIndex\" | \"ariaColIndexText\" | \"ariaColSpan\" | \"ariaCurrent\" | \"ariaDescription\" | \"ariaDisabled\" | \"ariaExpanded\" | \"ariaHasPopup\" | \"ariaHidden\" | \"ariaInvalid\" | \"ariaKeyShortcuts\" | \"ariaLabel\" | \"ariaLevel\" | \"ariaLive\" | \"ariaModal\" | \"ariaMultiLine\" | \"ariaMultiSelectable\" | \"ariaOrientation\" | \"ariaPlaceholder\" | \"ariaPosInSet\" | \"ariaPressed\" | \"ariaReadOnly\" | \"ariaRelevant\" | \"ariaRequired\" | \"ariaRoleDescription\" | \"ariaRowCount\" | \"ariaRowIndex\" | \"ariaRowIndexText\" | \"ariaRowSpan\" | \"ariaSelected\" | \"ariaSetSize\" | \"ariaSort\" | \"ariaValueMax\" | \"ariaValueMin\" | \"ariaValueNow\" | \"ariaValueText\" | \"role\", string>; } & { readAriaProperty(name: \"shadowRoot\" | \"ariaActiveDescendantElement\" | \"ariaAtomic\" | \"ariaAutoComplete\" | \"ariaBrailleLabel\" | \"ariaBrailleRoleDescription\" | \"ariaBusy\" | \"ariaChecked\" | \"ariaColCount\" | \"ariaColIndex\" | \"ariaColIndexText\" | \"ariaColSpan\" | \"ariaControlsElements\" | \"ariaCurrent\" | \"ariaDescribedByElements\" | \"ariaDescription\" | \"ariaDetailsElements\" | \"ariaDisabled\" | \"ariaErrorMessageElements\" | \"ariaExpanded\" | \"ariaFlowToElements\" | \"ariaHasPopup\" | \"ariaHidden\" | \"ariaInvalid\" | \"ariaKeyShortcuts\" | \"ariaLabel\" | \"ariaLabelledByElements\" | \"ariaLevel\" | \"ariaLive\" | \"ariaModal\" | \"ariaMultiLine\" | \"ariaMultiSelectable\" | \"ariaOrientation\" | \"ariaOwnsElements\" | \"ariaPlaceholder\" | \"ariaPosInSet\" | \"ariaPressed\" | \"ariaReadOnly\" | \"ariaRelevant\" | \"ariaRequired\" | \"ariaRoleDescription\" | \"ariaRowCount\" | \"ariaRowIndex\" | \"ariaRowIndexText\" | \"ariaRowSpan\" | \"ariaSelected\" | \"ariaSetSize\" | \"ariaSort\" | \"ariaValueMax\" | \"ariaValueMin\" | \"ariaValueNow\" | \"ariaValueText\" | \"role\"): string | Element | ShadowRoot | readonly Element[]; updateAriaProperty>(name: K, value: ARIAMixin[K]): void; } & { disabled: boolean; focused: boolean; hovered: boolean; pressed: boolean; _lastInteraction: \"mouse\" | \"touch\" | \"key\" | \"pen\"; _hovered: boolean; _focused: boolean; _focusedSynthetic: boolean; _keyPressed: boolean; _keyReleased: boolean; _pointerPressed: boolean; stateLayer: boolean; } & { disabledState: boolean; hoveredState: boolean; focusedState: boolean; pressedState: boolean; touchedState: boolean; pointedState: boolean; } & { stateTargetElement: HTMLElement; } & { _lastRippleWeakRef: WeakRef; _rippleAdded: boolean; } & { _lastRipple: CustomElement & { hadRippleHeld: boolean; hadRippleReleased: boolean; rippleStarted: boolean; } & { rippleState: string; keepAlive: boolean; _positionX: number; _positionY: number; _radius: number; holdRipple: boolean; } & { _positionStyle: ElementStylerOptions | { styles: { minHeight: string; minWidth: string; boxShadow: string; top: string; left: string; }; }; } & { updatePosition(x?: number, y?: number, size?: number): void; handleRippleComplete(): void; }; } & { addRipple(x?: number, y?: number, hold?: boolean): CustomElement & { hadRippleHeld: boolean; hadRippleReleased: boolean; rippleStarted: boolean; } & { rippleState: string; keepAlive: boolean; _positionX: number; _positionY: number; _radius: number; holdRipple: boolean; } & { _positionStyle: ElementStylerOptions | { styles: { minHeight: string; minWidth: string; boxShadow: string; top: string; left: string; }; }; } & { updatePosition(x?: number, y?: number, size?: number): void; handleRippleComplete(): void; }; } & { color: string; ink: string; typeStyle: string; } & { _ariaRole: string; stateLayer: boolean; } & { leading: string; avatar: string; avatarColor: string; avatarSrc: string; src: string; alt: string; icon: string; iconInk: string; iconSrc: string; iconVariation: string; checkbox: string; radio: string; selectionColor: string; selected: boolean; supporting: string; trailing: string; trailingIcon: string; trailingIconInk: string; trailingIconSrc: string; divider: string; video: boolean; lines: number; _supportingSlotted: boolean; } & { disabledState: boolean; } & { isInteractive: () => boolean; hasSupporting: () => boolean; checkboxClass: () => string; radioClass: () => string; computedIconVariation: () => string; } & { _ariaRole: string; _index: number; _selectedDirty: boolean; isInteractive: boolean; } & { _label: string; _text: string; defaultSelected: boolean; _selected: boolean; _value: string; _formDisabled: boolean; } & { selected: boolean; disabledState: boolean; } & { index: number; form: HTMLFormElement; text: string; label: string; value: string; } & { formDisabledCallback(formDisabled: boolean): void; focus(options?: FocusOptions): void; } & { anchorAriaLabelledBy: () => string; anchorAriaDescribedBy: () => string; computedIconVariation: () => string; }; onListboxClick(event: Event): void; }" } }, { "name": "onListboxClick", "kind": "field", "description": "Listbox should close if clicking own selection", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Input.js#L162" }, "type": { "text": "(event: Event) => void" } }, { "name": "onListboxChange", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Input.js#L170" }, "type": { "text": "(event: Event) => void" } }, { "name": "onPopupFocusout", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Input.js#L194" }, "type": { "text": "({ relatedTarget }: FocusEvent) => void" } }, { "name": "applyAutocompleteList", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Input.js#L204" }, "type": { "text": "() => void" } }, { "name": "showListbox", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Input.js#L213" }, "type": { "text": "() => void" } }, { "name": "closeListbox", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Input.js#L245" }, "type": { "text": "() => void" } }, { "name": "toggleListbox", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Input.js#L256" }, "type": { "text": "() => void" } }, { "name": "suggestOption", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Input.js#L267" }, "type": { "text": "(option: Pick) => void" } }, { "name": "acceptSuggestion", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Input.js#L314" }, "type": { "text": "(emitChange?: boolean) => void" } }, { "name": "changeSuggestion", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Input.js#L341" }, "type": { "text": "({ first, last, next, previous, startsWith, value, label }: { first?: boolean; last?: boolean; next?: boolean; previous?: boolean; startsWith?: string; value?: string; label?: string; }) => void" } }, { "name": "resetSuggestion", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Input.js#L432" }, "type": { "text": "() => void" } }, { "name": "refreshMultiple", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Input.js#L439" }, "type": { "text": "() => void" } }, { "name": "populateInputFromListbox", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Input.js#L484" }, "type": { "text": "() => void" } }, { "name": "onChipClose", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Input.js#L500" }, "type": { "text": "({ currentTarget }: CloseEvent & { currentTarget: HTMLElement; }) => void" } }, { "name": "showTrailingIcon", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Input.js#L714" }, "type": { "text": "() => string" } }, { "name": "computedTrailingIcon", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Input.js#L723" }, "type": { "text": "() => string" } }, { "name": "controlTypeAttrValue", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Input.js#L732" }, "type": { "text": "() => string" } }, { "name": "controlReadonlyAttrValue", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Input.js#L736" }, "type": { "text": "() => boolean" } }, { "name": "controlIsSelect", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Input.js#L740" }, "type": { "text": "() => boolean" } }, { "name": "ariaExpandedAttrValue", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Input.js#L743" }, "type": { "text": "() => string" } }, { "name": "ariaControlsAttrValue", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Input.js#L747" }, "type": { "text": "() => string" } }, { "name": "ariaAutocompleteAttrValue", "kind": "field", "description": "Compute `aria-autocomplete` to describe the widget's behavior to AT.\n\nARIA values:\n- `none` : no autocomplete behavior is provided\n- `inline`: the textbox shows an inline completion the user can accept\n- `list` : a popup listbox provides choices (no inline insertion)\n- `both` : both inline completion and a listbox are available\n\nComponent mapping:\n- `autocompleteInline` -> inline completion behavior\n- `autocompleteList` (non-null) -> listbox filtering / dropdown present\n- `autosuggestInline` -> drives candidate selection as user types\n\nNote: the current implementation reports `'both'` when a named\n`autocompleteList` is present (even if `autocompleteInline` is false).\nA stricter mapping would return `list` when only a listbox is present\nand `both` only when both `autocompleteInline` and a listbox exist.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Input.js#L770" }, "type": { "text": "() => \"both\" | \"inline\"" } }, { "name": "ariaActiveDescendantAttrValue", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Input.js#L778" }, "type": { "text": "() => \"\" | \"aria-active\"" } }, { "name": "ariaActiveLabel", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Input.js#L783" }, "type": { "text": "() => string" } }, { "name": "controlRoleAttrValue", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Input.js#L786" }, "type": { "text": "() => string" } }, { "name": "prototype", "kind": "field", "static": true, "type": { "text": "CustomElement" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "compose", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L145" }, "type": { "text": "(parts: CompositionPart[]) => Composition" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#refsProxy", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1145" }, "type": { "text": "Record" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#refsCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1148" }, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#refsCompositionCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1151" }, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#composition", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1154" }, "type": { "text": "Composition" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#patching", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1156" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#pendingPatchRenders", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1159" }, "type": { "text": "[string, any, CustomElement][]" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#propAttributeCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1162" }, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#callbackArguments", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1165" }, "type": { "text": "CallbackArguments" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "elementInternals", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1172" }, "type": { "text": "ElementInternals" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "render", "kind": "field", "description": "Updates nodes based on data\nExpects data in JSON Merge Patch format", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1185" }, "type": { "text": "RenderDraw" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "propChangedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1213" }, "type": { "text": "(this: T, name: K, oldValue: K extends keyof T ? T[K] : unknown, newValue: K extends keyof T ? T[K] : unknown, changes?: K extends keyof T ? T[K] extends object ? Partial : T[K] : unknown) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attributeChangedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1234" }, "type": { "text": "(name: string, oldValue: string, newValue: string) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#template", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1284" }, "type": { "text": "DocumentFragment" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#onObserverPropertyChanged", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1294" }, "type": { "text": "(name: string, oldValue: any, newValue: any, changes: any) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "static", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1330" }, "type": { "text": "typeof CustomElement" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "patch", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1333" }, "type": { "text": "(patch: any) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "refs", "kind": "field", "description": "Proxy object that returns shadow DOM elements by tag.\nIf called before interpolation (eg: on composed), returns from template", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1404" }, "type": { "text": "Record" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attributeCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1391" }, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "callbackArguments", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1400" }, "type": { "text": "CallbackArguments | { composition: Composition; refs: Record; html: any; inline: (fn: (data: Partial) => any) => string; template: DocumentFragment; element: T; }" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "composition", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1403" }, "type": { "text": "Composition" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "connectedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1435" }, "type": { "text": "() => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "disconnectedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1441" }, "type": { "text": "() => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "elementName", "kind": "field", "static": true, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "observedAttributes", "kind": "field", "static": true, "type": { "text": "Iterable" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "interpolatesTemplate", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "supportsElementInternals", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "supportsElementInternalsRole", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "defined", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "registrations", "kind": "field", "static": true, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "expressions", "kind": "method", "static": true, "description": "Expressions are idempotent functions that are selectively called whenever\na render is requested.\nExpressions are constructed exactly as methods though differ in expected\narguments. The first argument should be destructured to ensure each used\nproperty is accessed at least once in order to inspect used properties.\n\nThe Composition API will inspect this function with a proxy for `this` to\ncatalog what observables are used by the expression. This allows the\nComposition API to build a cache as well as selective invoke the expression\nonly when needed.\n\nWhen used with in element templates, the element itself will be passed as\nits first argument.\n````js\n Button\n .prop('filled', 'boolean')\n .prop('outlined', 'boolean')\n .expresssions({\n _isFilledOrOutlined({filled, outlined}) {\n return (filled || outlined)\n },\n })\n .html`
`;\n````\n\nWhen used with external data source, that data source\nwill be passed to the expression with all properties being `null` at first\ninspection.\n````js\n const externalData = {first: 'John', last: 'Doe'};\n ContactCard\n .expresssions({\n _fullName({first, last}) {\n return [first, last].filter(Boolean).join(' ');\n },\n })\n myButton.render(externalData);\n````\n\nExpressions may be support argumentless calls by using default\nparameters with `this`.\n````js\n Button\n .expresssions({\n isFilledOrOutlined({filled, outlined} = this) {\n return (filled || outlined)\n },\n });\n myButton.isFilledorOutlined();\n````", "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends { [K in keyof any]: K extends `_${any}` ? ((data: INSTANCE, state?: Record) => string | boolean | null) : ((data?: INSTANCE, state?: Record) => string | boolean | null); } & ThisType>(this: CLASS, expressions: PROPS & ThisType) => CLASS & Class<{ [K in keyof PROPS]: K extends `_${any}` ? never : () => ReturnType; }, ARGS>" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "methods", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "overrides", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends Partial>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "props", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "idl", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "append", "kind": "field", "static": true, "description": "Append parts to composition", "type": { "text": "(this: T, ...parts: CompositionPart[]) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "recompose", "kind": "field", "static": true, "description": "After composition, invokes callback.\nMay be called multiple times.", "type": { "text": ", T3 extends CompositionCallback[\"composed\"]>(this: T1, callback: T3) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "css", "kind": "field", "static": true, "description": "Appends styles to composition", "type": { "text": "(this: T1, array: T2, ...rest: T2 extends string ? any : T2 extends TemplateStringsArray ? any[] : (HTMLStyleElement | CSSStyleSheet)[]) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "autoRegister", "kind": "field", "static": true, "description": "Registers class with customElements. If class is registered before then,\ndoes nothing.", "type": { "text": "(this: T, elementName: string) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "html", "kind": "field", "static": true, "description": "Appends DocumentFragment to composition", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1405" }, "type": { "text": "(this: T, string: TemplateStringsArray, ...substitutions: (string | Element | ((this: InstanceType, data: InstanceType, injections?: any) => any))[]) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "extend", "kind": "field", "static": true, "description": "Extends base class into a new class.\nUse to avoid mutating base class.", "type": { "text": " T2>(this: T1, customExtender?: T3) => T3 extends null ? T1 : T2" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "setStatic", "kind": "field", "static": true, "description": "Assigns static values to class", "type": { "text": " any) | string | number | boolean | any[] | object); }>(this: T1, source: T2 & ThisType) => T1 & T2" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "readonly", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "set", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "mixin", "kind": "field", "static": true, "description": "Returns result of calling mixin with current class", "type": { "text": " any, RETURN extends ReturnType, SUBCLASS extends ClassOf>(this: BASE, mixin: FN) => SUBCLASS & BASE" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "register", "kind": "field", "static": true, "description": "Registers class with window.customElements synchronously", "type": { "text": "(this: T, elementName?: string, force?: boolean) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "propList", "kind": "field", "static": true, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attrList", "kind": "field", "static": true, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "propChangedCallbacks", "kind": "field", "static": true, "type": { "text": "Map any)[]>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attributeChangedCallbacks", "kind": "field", "static": true, "type": { "text": "Map any)[]>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "prop", "kind": "field", "static": true, "description": "Creates observable property on instances (via prototype)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1007" }, "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "setPrototype", "kind": "field", "static": true, "description": "Creates observable property on instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any)>(this: CLASS, name: KEY, options: OPTIONS) => OPTIONS extends (...args2: any[]) => infer R ? R : OPTIONS extends ObserverPropertyType ? ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? unknown extends R ? object : R : OPTIONS extends { type: ObserverPropertyType; } ? ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? unknown extends R ? string : R : never" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "define", "kind": "field", "static": true, "description": "Define properties on instances via Object.defineProperties().\nAutomatically sets property non-enumerable if name begins with `_`.\nFunctions will be remapped as getters", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends { [P in keyof any]: { enumerable?: boolean; configurable?: boolean; writable?: boolean; value?: any; get?: ((this: INSTANCE) => any); set?: (this: INSTANCE, value: any) => void; } | ((this: INSTANCE, ...args: any[]) => any); }, VALUE extends { [KEY in keyof PROPS]: PROPS[KEY] extends (...args2: any[]) => infer R ? R : PROPS[KEY] extends TypedPropertyDescriptor ? R : never; }>(this: CLASS, props: PROPS & ThisType) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "undefine", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROP extends string, PROPS extends INSTANCE & Record>(this: CLASS, name: PROP) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "observe", "kind": "field", "static": true, "description": "Creates observable properties on instances", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends IDLParameter, VALUE extends { [KEY in keyof PROPS]: PROPS[KEY] extends (...args2: any[]) => infer R ? R : PROPS[KEY] extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : PROPS[KEY] extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : PROPS[KEY] extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : PROPS[KEY] extends ObserverOptions ? (unknown extends R ? string : R) : never; }>(this: CLASS, props: PROPS) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "defineStatic", "kind": "field", "static": true, "type": { "text": ">(this: T1, props: T2) => T1 & ParsedProps" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "events", "kind": "field", "static": true, "type": { "text": "(this: T, listeners?: CompositionEventListenerObject>, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "childEvents", "kind": "field", "static": true, "type": { "text": "(this: T, listenerMap: { [x: string]: CompositionEventListenerObject>; }, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "rootEvents", "kind": "field", "static": true, "type": { "text": "(this: T, listeners?: CompositionEventListenerObject>, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "on", "kind": "field", "static": true, "type": { "text": ", T3 extends CompositionCallback, T4 extends keyof T3>(this: T1, name: T3 | T4, callbacks?: T3[T4] & ThisType) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "off", "kind": "field", "static": true, "type": { "text": ", T3 extends CompositionCallback, T4 extends keyof T3>(this: T1, name: T3 | T4, callbacks?: T3[T4] & ThisType) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "offPropChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: ObjectOrObjectEntries<{ [P in keyof T2]?: (this: T2, oldValue: T2[P], newValue: T2[P], changes: any, element: T2) => void; }>) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "offAttributeChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: { [x: string]: (this: T2, oldValue: string, newValue: string, element: T2) => void; }) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "onPropChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: ObjectOrObjectEntries<{ [P in keyof T2]?: (this: T2, oldValue: T2[P], newValue: T2[P], changes: any, element: T2) => void; }>) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "onAttributeChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: { [x: string]: (this: T2, oldValue: string, newValue: string, element: T2) => void; }) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } } ], "slots": [ { "name": "supporting", "description": "" }, { "name": "", "description": "" } ], "cssParts": [ { "name": "control" } ], "events": [ { "name": "resize-observed", "type": { "text": "Event" } }, { "name": "value-changing-content-attribute", "type": { "text": "Event" } }, { "name": "listbox-click", "type": { "text": "Event" } }, { "name": "listbox-change", "type": { "text": "Event" } }, { "name": "popup-focusout", "type": { "text": "Event" } }, { "name": "chip-close", "type": { "text": "Event" } } ], "demos": [], "superclass": { "module": "core/CustomElement.js", "name": "default" }, "mixins": [ { "module": "mixins/ThemableMixin.js", "name": "default" }, { "module": "mixins/StateMixin.js", "name": "default" }, { "module": "mixins/InputMixin.js", "name": "default" }, { "module": "mixins/TextFieldMixin.js", "name": "default" }, { "module": "mixins/ResizeObserverMixin.js", "name": "default" } ], "description": "@typedef {import('./Listbox.js').default} Listbox" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "default", "module": "components/Input.js" } }, { "kind": "custom-element-definition", "name": "mdw-input", "declaration": { "name": "default", "module": "components/Input.js" } } ] }, { "kind": "javascript-module", "path": "components/InputChip.js", "declarations": [ { "kind": "class", "name": "InputChip", "tagName": "mdw-input-chip", "customElement": true, "attributes": [ { "name": "color", "fieldName": "color", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "ink", "fieldName": "ink", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "type-style", "fieldName": "typeStyle", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "block", "fieldName": "block", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "inline", "fieldName": "inline", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "row", "fieldName": "row", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "x", "fieldName": "x", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "y", "fieldName": "y", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "gap", "fieldName": "gap", "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "padding", "fieldName": "padding", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "shape-top", "fieldName": "shapeTop", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shape-bottom", "fieldName": "shapeBottom", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shape-start", "fieldName": "shapeStart", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shape-end", "fieldName": "shapeEnd", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shape-style", "fieldName": "shapeStyle", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "href", "fieldName": "href", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/HyperlinkMixin.js" } }, { "name": "target", "fieldName": "target", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/HyperlinkMixin.js" } }, { "name": "download", "fieldName": "download", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/HyperlinkMixin.js" } }, { "name": "ping", "fieldName": "ping", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/HyperlinkMixin.js" } }, { "name": "rel", "fieldName": "rel", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/HyperlinkMixin.js" } }, { "name": "hreflang", "fieldName": "hreflang", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/HyperlinkMixin.js" } }, { "name": "referrerpolicy", "fieldName": "referrerPolicy", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/HyperlinkMixin.js" } }, { "name": "avatar", "description": "Render the chip in avatar (larger) style.", "fieldName": "avatar", "type": { "text": "boolean" } }, { "name": "close-button", "description": "Show a close action button inside the chip.", "fieldName": "closeButton", "type": { "text": "boolean" } }, { "name": "close-icon", "description": "Icon name to use for the close button (default: 'close').", "fieldName": "closeIcon", "type": { "text": "string" } }, { "name": "close-ink", "description": "Ink color used for the close icon (default: inherit).", "fieldName": "closeInk", "type": { "text": "string" } }, { "name": "readonly", "description": "Reflects the `readonly` attribute; prevents editing/closing when true.", "fieldName": "readOnly", "type": { "text": "boolean" } }, { "name": "disabled", "description": "Whether the chip is disabled.", "fieldName": "disabled", "type": { "text": "boolean" } }, { "name": "icon", "description": "Leading icon name for the chip.", "fieldName": "icon", "type": { "text": "string" } }, { "name": "icon-ink", "description": "Ink color for the leading icon.", "fieldName": "iconInk", "type": { "text": "string" } }, { "name": "src", "description": "Image `src` for an avatar or image-backed icon.", "fieldName": "src", "type": { "text": "string" } }, { "name": "svg", "description": "External SVG URL to render as the icon.", "fieldName": "svg", "type": { "text": "string" } }, { "name": "view-box", "description": "SVG `viewBox` used for inline SVG rendering.", "fieldName": "viewBox", "type": { "text": "string" } }, { "name": "svg-path", "description": "SVG path data to render as the icon.", "fieldName": "svgPath", "type": { "text": "string" } }, { "name": "onclose", "description": "Event handler/callback for the `close` event.", "fieldName": "onclose", "type": { "text": "function" } }, { "name": "selected", "description": "Selection state used by chip-selection patterns.", "fieldName": "selected", "type": { "text": "boolean" } }, { "name": "outlined", "type": { "text": "boolean" }, "description": "When true, an outline is rendered around the element", "fieldName": "outlined", "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } } ], "members": [ { "name": "delegatesFocus", "kind": "field", "description": "When true, the element delegates focus to an internal focus target.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/DelegatesFocusMixin.js#L15" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "href", "kind": "field", "description": "The URL that the hyperlink points to.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L34" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/HyperlinkMixin.js" } }, { "name": "target", "kind": "field", "description": "The browsing context in which to open the linked resource (e.g. '_blank').", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L36" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/HyperlinkMixin.js" } }, { "name": "download", "kind": "field", "description": "Suggested filename for download.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L38" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/HyperlinkMixin.js" } }, { "name": "ping", "kind": "field", "description": "URLs to be pinged when the link is followed.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L40" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/HyperlinkMixin.js" } }, { "name": "rel", "kind": "field", "description": "Link relationship tokens (e.g. 'noopener', 'noreferrer').", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L42" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/HyperlinkMixin.js" } }, { "name": "hreflang", "kind": "field", "description": "Language of the linked resource.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L44" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/HyperlinkMixin.js" } }, { "name": "referrerPolicy", "kind": "field", "description": "Referrer policy for the link (serialized to 'referrerpolicy' attribute).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L46" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/HyperlinkMixin.js" } }, { "name": "origin", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L49" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/HyperlinkMixin.js" } }, { "name": "protocol", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L50" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/HyperlinkMixin.js" } }, { "name": "username", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L51" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/HyperlinkMixin.js" } }, { "name": "password", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L52" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/HyperlinkMixin.js" } }, { "name": "host", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L53" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/HyperlinkMixin.js" } }, { "name": "hostname", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L54" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/HyperlinkMixin.js" } }, { "name": "port", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L55" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/HyperlinkMixin.js" } }, { "name": "pathname", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L56" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/HyperlinkMixin.js" } }, { "name": "search", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L57" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/HyperlinkMixin.js" } }, { "name": "hash", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L58" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/HyperlinkMixin.js" } }, { "name": "disabled", "kind": "field", "description": "Whether the element is disabled (affects interactive states)\nWhether the chip is disabled.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/InputChip.js#L37" }, "type": { "text": "boolean" } }, { "name": "focused", "kind": "field", "description": "Force focus state (independent of document)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L16" }, "type": { "text": "boolean" } }, { "name": "hovered", "kind": "field", "description": "Force hover state (independent of interaction)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L18" }, "type": { "text": "boolean" } }, { "name": "pressed", "kind": "field", "description": "Force pressed state (independent of interaction)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L20" }, "type": { "text": "boolean" } }, { "name": "stateLayer", "kind": "field", "description": "Show the visual state layer element when true", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L34" }, "type": { "text": "boolean" } }, { "name": "disabledState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L37" }, "type": { "text": "boolean" } }, { "name": "hoveredState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L38" }, "type": { "text": "boolean" } }, { "name": "focusedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L39" }, "type": { "text": "boolean" } }, { "name": "pressedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L40" }, "type": { "text": "boolean" } }, { "name": "touchedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L41" }, "type": { "text": "boolean" } }, { "name": "pointedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L44" }, "type": { "text": "boolean" } }, { "name": "stateTargetElement", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L50" }, "type": { "text": "HTMLElement" } }, { "name": "color", "kind": "field", "description": "Palette or surface token used to select background/ink tokens.\nExamples: 'primary', 'background', 'surface-container-low'.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L52" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "ink", "kind": "field", "description": "Explicit ink override token (e.g. 'outline', 'on-primary', 'inverse-on-surface', 'inherit').\nMaps to `--mdw-ink`.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L57" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "typeStyle", "kind": "field", "description": "Typographic style shortcut that maps to type scale variables\n(e.g. 'headline-large', 'body-medium').", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L62" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "shapeTop", "kind": "field", "description": "Show top cut/shape on the element", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L9" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shapeBottom", "kind": "field", "description": "Show bottom cut/shape on the element", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L11" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shapeStart", "kind": "field", "description": "Show start-side cut/shape (logical start)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L13" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shapeEnd", "kind": "field", "description": "Show end-side cut/shape (logical end)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L15" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shapeStyle", "kind": "field", "description": "Predefined shape size/style name (none|extra-small|small|medium|large|extra-large|full|inherit)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L17" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "outlined", "kind": "field", "description": "When true, an outline is rendered around the element", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/InputChip.js#L64" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "block", "kind": "field", "description": "Set `display: block` on the host (boolean)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js#L9" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "inline", "kind": "field", "description": "Use inline flex layout: `display: inline-flex` (boolean)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js#L11" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "row", "kind": "field", "description": "Switch main axis to horizontal: `flex-direction: row` (boolean)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js#L13" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "x", "kind": "field", "description": "Main-axis alignment / justification.\nAllowed: 'start'|'center'|'end'|'between'|'around'|'stretch'|'baseline'.\nDefault: 'start'.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js#L19" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "y", "kind": "field", "description": "Cross-axis alignment / alignment of items.\nSame allowed values as `x`. Default: 'start'.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js#L29" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "gap", "kind": "field", "description": "Gap between children. Accepts preset numeric strings (e.g. '8') mapped to px, or floats.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js#L36" }, "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "padding", "kind": "field", "description": "Padding preset or numeric value (e.g. 'pane', '8', '16').", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js#L38" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "avatar", "kind": "field", "description": "Render the chip in avatar (larger) style.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/InputChip.js#L22" }, "type": { "text": "boolean" } }, { "name": "closeButton", "kind": "field", "description": "Show a close action button inside the chip.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/InputChip.js#L25" }, "type": { "text": "boolean" } }, { "name": "closeIcon", "kind": "field", "description": "Icon name to use for the close button (default: 'close').", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/InputChip.js#L28" }, "type": { "text": "string" } }, { "name": "closeInk", "kind": "field", "description": "Ink color used for the close icon (default: inherit).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/InputChip.js#L31" }, "type": { "text": "string" } }, { "name": "readOnly", "kind": "field", "description": "Reflects the `readonly` attribute; prevents editing/closing when true.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/InputChip.js#L34" }, "type": { "text": "boolean" } }, { "name": "icon", "kind": "field", "description": "Leading icon name for the chip.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/InputChip.js#L40" }, "type": { "text": "string" } }, { "name": "iconInk", "kind": "field", "description": "Ink color for the leading icon.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/InputChip.js#L43" }, "type": { "text": "string" } }, { "name": "src", "kind": "field", "description": "Image `src` for an avatar or image-backed icon.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/InputChip.js#L46" }, "type": { "text": "string" } }, { "name": "svg", "kind": "field", "description": "External SVG URL to render as the icon.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/InputChip.js#L49" }, "type": { "text": "string" } }, { "name": "viewBox", "kind": "field", "description": "SVG `viewBox` used for inline SVG rendering.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/InputChip.js#L52" }, "type": { "text": "string" } }, { "name": "svgPath", "kind": "field", "description": "SVG path data to render as the icon.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/InputChip.js#L55" }, "type": { "text": "string" } }, { "name": "selected", "kind": "field", "description": "Selection state used by chip-selection patterns.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/InputChip.js#L61" }, "type": { "text": "boolean" } }, { "name": "hasIcon", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/InputChip.js#L67" }, "return": { "type": { "text": "() => string" } } }, { "name": "showCloseIcon", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/InputChip.js#L70" }, "return": { "type": { "text": "() => boolean" } } }, { "name": "prototype", "kind": "field", "static": true, "type": { "text": "CustomElement" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "compose", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L145" }, "type": { "text": "(parts: CompositionPart[]) => Composition" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "#refsProxy", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1145" }, "type": { "text": "Record" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "#refsCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1148" }, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "#refsCompositionCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1151" }, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "#composition", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1154" }, "type": { "text": "Composition" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "#patching", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1156" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "#pendingPatchRenders", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1159" }, "type": { "text": "[string, any, CustomElement][]" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "#propAttributeCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1162" }, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "#callbackArguments", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1165" }, "type": { "text": "CallbackArguments" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "elementInternals", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1172" }, "type": { "text": "ElementInternals" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "render", "kind": "field", "description": "Updates nodes based on data\nExpects data in JSON Merge Patch format", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1185" }, "type": { "text": "RenderDraw" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "propChangedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1213" }, "type": { "text": "(this: T, name: K, oldValue: K extends keyof T ? T[K] : unknown, newValue: K extends keyof T ? T[K] : unknown, changes?: K extends keyof T ? T[K] extends object ? Partial : T[K] : unknown) => void" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "attributeChangedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1234" }, "type": { "text": "(name: string, oldValue: string, newValue: string) => void" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "#template", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1284" }, "type": { "text": "DocumentFragment" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "#onObserverPropertyChanged", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1294" }, "type": { "text": "(name: string, oldValue: any, newValue: any, changes: any) => void" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "static", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1330" }, "type": { "text": "typeof CustomElement" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "patch", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1333" }, "type": { "text": "(patch: any) => void" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "refs", "kind": "field", "description": "Proxy object that returns shadow DOM elements by tag.\nIf called before interpolation (eg: on composed), returns from template", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1404" }, "type": { "text": "Record" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "attributeCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1391" }, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "callbackArguments", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1400" }, "type": { "text": "CallbackArguments | { composition: Composition; refs: Record; html: any; inline: (fn: (data: Partial) => any) => string; template: DocumentFragment; element: T; }" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "composition", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1403" }, "type": { "text": "Composition" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "connectedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1435" }, "type": { "text": "() => void" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "disconnectedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1441" }, "type": { "text": "() => void" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "elementName", "kind": "field", "static": true, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "observedAttributes", "kind": "field", "static": true, "type": { "text": "Iterable" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "interpolatesTemplate", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "supportsElementInternals", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "supportsElementInternalsRole", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "defined", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "registrations", "kind": "field", "static": true, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "expressions", "kind": "method", "static": true, "description": "Expressions are idempotent functions that are selectively called whenever\na render is requested.\nExpressions are constructed exactly as methods though differ in expected\narguments. The first argument should be destructured to ensure each used\nproperty is accessed at least once in order to inspect used properties.\n\nThe Composition API will inspect this function with a proxy for `this` to\ncatalog what observables are used by the expression. This allows the\nComposition API to build a cache as well as selective invoke the expression\nonly when needed.\n\nWhen used with in element templates, the element itself will be passed as\nits first argument.\n````js\n Button\n .prop('filled', 'boolean')\n .prop('outlined', 'boolean')\n .expresssions({\n _isFilledOrOutlined({filled, outlined}) {\n return (filled || outlined)\n },\n })\n .html`
`;\n````\n\nWhen used with external data source, that data source\nwill be passed to the expression with all properties being `null` at first\ninspection.\n````js\n const externalData = {first: 'John', last: 'Doe'};\n ContactCard\n .expresssions({\n _fullName({first, last}) {\n return [first, last].filter(Boolean).join(' ');\n },\n })\n myButton.render(externalData);\n````\n\nExpressions may be support argumentless calls by using default\nparameters with `this`.\n````js\n Button\n .expresssions({\n isFilledOrOutlined({filled, outlined} = this) {\n return (filled || outlined)\n },\n });\n myButton.isFilledorOutlined();\n````", "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends { [K in keyof any]: K extends `_${any}` ? ((data: INSTANCE, state?: Record) => string | boolean | null) : ((data?: INSTANCE, state?: Record) => string | boolean | null); } & ThisType>(this: CLASS, expressions: PROPS & ThisType) => CLASS & Class<{ [K in keyof PROPS]: K extends `_${any}` ? never : () => ReturnType; }, ARGS>" } }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "methods", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "overrides", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends Partial>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "props", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "idl", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "append", "kind": "field", "static": true, "description": "Append parts to composition", "type": { "text": "(this: T, ...parts: CompositionPart[]) => T" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "recompose", "kind": "field", "static": true, "description": "After composition, invokes callback.\nMay be called multiple times.", "type": { "text": ", T3 extends CompositionCallback[\"composed\"]>(this: T1, callback: T3) => T1" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "css", "kind": "field", "static": true, "description": "Appends styles to composition", "type": { "text": "(this: T1, array: T2, ...rest: T2 extends string ? any : T2 extends TemplateStringsArray ? any[] : (HTMLStyleElement | CSSStyleSheet)[]) => T1" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "autoRegister", "kind": "field", "static": true, "description": "Registers class with customElements. If class is registered before then,\ndoes nothing.", "type": { "text": "(this: T, elementName: string) => T" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "html", "kind": "field", "static": true, "description": "Appends DocumentFragment to composition", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1405" }, "type": { "text": "(this: T, string: TemplateStringsArray, ...substitutions: (string | Element | ((this: InstanceType, data: InstanceType, injections?: any) => any))[]) => T" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "extend", "kind": "field", "static": true, "description": "Extends base class into a new class.\nUse to avoid mutating base class.", "type": { "text": " T2>(this: T1, customExtender?: T3) => T3 extends null ? T1 : T2" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "setStatic", "kind": "field", "static": true, "description": "Assigns static values to class", "type": { "text": " any) | string | number | boolean | any[] | object); }>(this: T1, source: T2 & ThisType) => T1 & T2" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "readonly", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "set", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "mixin", "kind": "field", "static": true, "description": "Returns result of calling mixin with current class", "type": { "text": " any, RETURN extends ReturnType, SUBCLASS extends ClassOf>(this: BASE, mixin: FN) => SUBCLASS & BASE" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "register", "kind": "field", "static": true, "description": "Registers class with window.customElements synchronously", "type": { "text": "(this: T, elementName?: string, force?: boolean) => T" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "propList", "kind": "field", "static": true, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "attrList", "kind": "field", "static": true, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "propChangedCallbacks", "kind": "field", "static": true, "type": { "text": "Map any)[]>" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "attributeChangedCallbacks", "kind": "field", "static": true, "type": { "text": "Map any)[]>" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "prop", "kind": "field", "static": true, "description": "Creates observable property on instances (via prototype)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1007" }, "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "setPrototype", "kind": "field", "static": true, "description": "Creates observable property on instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any)>(this: CLASS, name: KEY, options: OPTIONS) => OPTIONS extends (...args2: any[]) => infer R ? R : OPTIONS extends ObserverPropertyType ? ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? unknown extends R ? object : R : OPTIONS extends { type: ObserverPropertyType; } ? ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? unknown extends R ? string : R : never" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "define", "kind": "field", "static": true, "description": "Define properties on instances via Object.defineProperties().\nAutomatically sets property non-enumerable if name begins with `_`.\nFunctions will be remapped as getters", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends { [P in keyof any]: { enumerable?: boolean; configurable?: boolean; writable?: boolean; value?: any; get?: ((this: INSTANCE) => any); set?: (this: INSTANCE, value: any) => void; } | ((this: INSTANCE, ...args: any[]) => any); }, VALUE extends { [KEY in keyof PROPS]: PROPS[KEY] extends (...args2: any[]) => infer R ? R : PROPS[KEY] extends TypedPropertyDescriptor ? R : never; }>(this: CLASS, props: PROPS & ThisType) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "undefine", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROP extends string, PROPS extends INSTANCE & Record>(this: CLASS, name: PROP) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "observe", "kind": "field", "static": true, "description": "Creates observable properties on instances", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends IDLParameter, VALUE extends { [KEY in keyof PROPS]: PROPS[KEY] extends (...args2: any[]) => infer R ? R : PROPS[KEY] extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : PROPS[KEY] extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : PROPS[KEY] extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : PROPS[KEY] extends ObserverOptions ? (unknown extends R ? string : R) : never; }>(this: CLASS, props: PROPS) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "defineStatic", "kind": "field", "static": true, "type": { "text": ">(this: T1, props: T2) => T1 & ParsedProps" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "events", "kind": "field", "static": true, "type": { "text": "(this: T, listeners?: CompositionEventListenerObject>, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "childEvents", "kind": "field", "static": true, "type": { "text": "(this: T, listenerMap: { [x: string]: CompositionEventListenerObject>; }, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "rootEvents", "kind": "field", "static": true, "type": { "text": "(this: T, listeners?: CompositionEventListenerObject>, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "on", "kind": "field", "static": true, "type": { "text": ", T3 extends CompositionCallback, T4 extends keyof T3>(this: T1, name: T3 | T4, callbacks?: T3[T4] & ThisType) => T1" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "off", "kind": "field", "static": true, "type": { "text": ", T3 extends CompositionCallback, T4 extends keyof T3>(this: T1, name: T3 | T4, callbacks?: T3[T4] & ThisType) => T1" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "offPropChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: ObjectOrObjectEntries<{ [P in keyof T2]?: (this: T2, oldValue: T2[P], newValue: T2[P], changes: any, element: T2) => void; }>) => T1" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "offAttributeChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: { [x: string]: (this: T2, oldValue: string, newValue: string, element: T2) => void; }) => T1" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "onPropChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: ObjectOrObjectEntries<{ [P in keyof T2]?: (this: T2, oldValue: T2[P], newValue: T2[P], changes: any, element: T2) => void; }>) => T1" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "onAttributeChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: { [x: string]: (this: T2, oldValue: string, newValue: string, element: T2) => void; }) => T1" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } } ], "slots": [ { "name": "", "description": "" } ], "cssParts": [], "events": [], "demos": [], "superclass": { "module": "components/Box.js", "name": "default" }, "mixins": [ { "module": "mixins/ShapeMixin.js", "name": "default" }, { "module": "mixins/DelegatesFocusMixin.js", "name": "default" }, { "module": "mixins/HyperlinkMixin.js", "name": "default" } ], "description": "Input chips allow users to enter or edit information as a chip (tag-like).\n@see https://m3.material.io/components/chips/specs" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "default", "module": "components/InputChip.js" } }, { "kind": "custom-element-definition", "name": "mdw-input-chip", "declaration": { "name": "default", "module": "components/InputChip.js" } } ] }, { "kind": "javascript-module", "path": "components/Label.js", "declarations": [ { "kind": "class", "name": "Label", "tagName": "mdw-label", "customElement": true, "attributes": [ { "name": "color", "fieldName": "color", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "ink", "fieldName": "ink", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "type-style", "fieldName": "typeStyle", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "block", "fieldName": "block", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "inline", "fieldName": "inline", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "row", "fieldName": "row", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "x", "fieldName": "x", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "y", "fieldName": "y", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "gap", "fieldName": "gap", "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "padding", "fieldName": "padding", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "text-padding", "fieldName": "textPadding", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/TypographyMixin.js" } }, { "name": "text-padding-top", "fieldName": "textPaddingTop", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/TypographyMixin.js" } }, { "name": "text-leading", "fieldName": "textLeading", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/TypographyMixin.js" } }, { "name": "text-padding-bottom", "fieldName": "textPaddingBottom", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/TypographyMixin.js" } } ], "members": [ { "name": "delegatesFocus", "kind": "field", "description": "When true, the element delegates focus to an internal focus target.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/DelegatesFocusMixin.js#L15" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "textPadding", "kind": "field", "description": "General vertical padding for text content (css length)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/TypographyMixin.js#L24" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/TypographyMixin.js" } }, { "name": "textPaddingTop", "kind": "field", "description": "Padding-top override for text content (css length)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/TypographyMixin.js#L26" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/TypographyMixin.js" } }, { "name": "textLeading", "kind": "field", "description": "Line-leading (extra top spacing) for text (css length or 'sp' units)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/TypographyMixin.js#L28" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/TypographyMixin.js" } }, { "name": "textPaddingBottom", "kind": "field", "description": "Padding-bottom override for text content (css length)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/TypographyMixin.js#L30" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/TypographyMixin.js" } }, { "name": "block", "kind": "field", "description": "Set `display: block` on the host (boolean)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js#L9" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "inline", "kind": "field", "description": "Use inline flex layout: `display: inline-flex` (boolean)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js#L11" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "row", "kind": "field", "description": "Switch main axis to horizontal: `flex-direction: row` (boolean)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js#L13" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "x", "kind": "field", "description": "Main-axis alignment / justification.\nAllowed: 'start'|'center'|'end'|'between'|'around'|'stretch'|'baseline'.\nDefault: 'start'.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js#L19" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "y", "kind": "field", "description": "Cross-axis alignment / alignment of items.\nSame allowed values as `x`. Default: 'start'.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js#L29" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "gap", "kind": "field", "description": "Gap between children. Accepts preset numeric strings (e.g. '8') mapped to px, or floats.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js#L36" }, "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "padding", "kind": "field", "description": "Padding preset or numeric value (e.g. 'pane', '8', '16').", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js#L38" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "color", "kind": "field", "description": "Palette or surface token used to select background/ink tokens.\nExamples: 'primary', 'background', 'surface-container-low'.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L52" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "ink", "kind": "field", "description": "Explicit ink override token (e.g. 'outline', 'on-primary', 'inverse-on-surface', 'inherit').\nMaps to `--mdw-ink`.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L57" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "typeStyle", "kind": "field", "description": "Typographic style shortcut that maps to type scale variables\n(e.g. 'headline-large', 'body-medium').", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L62" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "prototype", "kind": "field", "static": true, "type": { "text": "CustomElement" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "compose", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L145" }, "type": { "text": "(parts: CompositionPart[]) => Composition" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "#refsProxy", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1145" }, "type": { "text": "Record" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "#refsCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1148" }, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "#refsCompositionCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1151" }, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "#composition", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1154" }, "type": { "text": "Composition" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "#patching", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1156" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "#pendingPatchRenders", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1159" }, "type": { "text": "[string, any, CustomElement][]" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "#propAttributeCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1162" }, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "#callbackArguments", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1165" }, "type": { "text": "CallbackArguments" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "elementInternals", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1172" }, "type": { "text": "ElementInternals" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "render", "kind": "field", "description": "Updates nodes based on data\nExpects data in JSON Merge Patch format", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1185" }, "type": { "text": "RenderDraw" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "propChangedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1213" }, "type": { "text": "(this: T, name: K, oldValue: K extends keyof T ? T[K] : unknown, newValue: K extends keyof T ? T[K] : unknown, changes?: K extends keyof T ? T[K] extends object ? Partial : T[K] : unknown) => void" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "attributeChangedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1234" }, "type": { "text": "(name: string, oldValue: string, newValue: string) => void" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "#template", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1284" }, "type": { "text": "DocumentFragment" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "#onObserverPropertyChanged", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1294" }, "type": { "text": "(name: string, oldValue: any, newValue: any, changes: any) => void" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "static", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1330" }, "type": { "text": "typeof CustomElement" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "patch", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1333" }, "type": { "text": "(patch: any) => void" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "refs", "kind": "field", "description": "Proxy object that returns shadow DOM elements by tag.\nIf called before interpolation (eg: on composed), returns from template", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1404" }, "type": { "text": "Record" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "attributeCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1391" }, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "callbackArguments", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1400" }, "type": { "text": "CallbackArguments | { composition: Composition; refs: Record; html: any; inline: (fn: (data: Partial) => any) => string; template: DocumentFragment; element: T; }" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "composition", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1403" }, "type": { "text": "Composition" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "connectedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1435" }, "type": { "text": "() => void" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "disconnectedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1441" }, "type": { "text": "() => void" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "elementName", "kind": "field", "static": true, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "observedAttributes", "kind": "field", "static": true, "type": { "text": "Iterable" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "interpolatesTemplate", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "supportsElementInternals", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "supportsElementInternalsRole", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "defined", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "registrations", "kind": "field", "static": true, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "expressions", "kind": "method", "static": true, "description": "Expressions are idempotent functions that are selectively called whenever\na render is requested.\nExpressions are constructed exactly as methods though differ in expected\narguments. The first argument should be destructured to ensure each used\nproperty is accessed at least once in order to inspect used properties.\n\nThe Composition API will inspect this function with a proxy for `this` to\ncatalog what observables are used by the expression. This allows the\nComposition API to build a cache as well as selective invoke the expression\nonly when needed.\n\nWhen used with in element templates, the element itself will be passed as\nits first argument.\n````js\n Button\n .prop('filled', 'boolean')\n .prop('outlined', 'boolean')\n .expresssions({\n _isFilledOrOutlined({filled, outlined}) {\n return (filled || outlined)\n },\n })\n .html`
`;\n````\n\nWhen used with external data source, that data source\nwill be passed to the expression with all properties being `null` at first\ninspection.\n````js\n const externalData = {first: 'John', last: 'Doe'};\n ContactCard\n .expresssions({\n _fullName({first, last}) {\n return [first, last].filter(Boolean).join(' ');\n },\n })\n myButton.render(externalData);\n````\n\nExpressions may be support argumentless calls by using default\nparameters with `this`.\n````js\n Button\n .expresssions({\n isFilledOrOutlined({filled, outlined} = this) {\n return (filled || outlined)\n },\n });\n myButton.isFilledorOutlined();\n````", "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends { [K in keyof any]: K extends `_${any}` ? ((data: INSTANCE, state?: Record) => string | boolean | null) : ((data?: INSTANCE, state?: Record) => string | boolean | null); } & ThisType>(this: CLASS, expressions: PROPS & ThisType) => CLASS & Class<{ [K in keyof PROPS]: K extends `_${any}` ? never : () => ReturnType; }, ARGS>" } }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "methods", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "overrides", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends Partial>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "props", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "idl", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "append", "kind": "field", "static": true, "description": "Append parts to composition", "type": { "text": "(this: T, ...parts: CompositionPart[]) => T" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "recompose", "kind": "field", "static": true, "description": "After composition, invokes callback.\nMay be called multiple times.", "type": { "text": ", T3 extends CompositionCallback[\"composed\"]>(this: T1, callback: T3) => T1" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "css", "kind": "field", "static": true, "description": "Appends styles to composition", "type": { "text": "(this: T1, array: T2, ...rest: T2 extends string ? any : T2 extends TemplateStringsArray ? any[] : (HTMLStyleElement | CSSStyleSheet)[]) => T1" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "autoRegister", "kind": "field", "static": true, "description": "Registers class with customElements. If class is registered before then,\ndoes nothing.", "type": { "text": "(this: T, elementName: string) => T" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "html", "kind": "field", "static": true, "description": "Appends DocumentFragment to composition", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1405" }, "type": { "text": "(this: T, string: TemplateStringsArray, ...substitutions: (string | Element | ((this: InstanceType, data: InstanceType, injections?: any) => any))[]) => T" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "extend", "kind": "field", "static": true, "description": "Extends base class into a new class.\nUse to avoid mutating base class.", "type": { "text": " T2>(this: T1, customExtender?: T3) => T3 extends null ? T1 : T2" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "setStatic", "kind": "field", "static": true, "description": "Assigns static values to class", "type": { "text": " any) | string | number | boolean | any[] | object); }>(this: T1, source: T2 & ThisType) => T1 & T2" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "readonly", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "set", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "mixin", "kind": "field", "static": true, "description": "Returns result of calling mixin with current class", "type": { "text": " any, RETURN extends ReturnType, SUBCLASS extends ClassOf>(this: BASE, mixin: FN) => SUBCLASS & BASE" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "register", "kind": "field", "static": true, "description": "Registers class with window.customElements synchronously", "type": { "text": "(this: T, elementName?: string, force?: boolean) => T" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "propList", "kind": "field", "static": true, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "attrList", "kind": "field", "static": true, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "propChangedCallbacks", "kind": "field", "static": true, "type": { "text": "Map any)[]>" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "attributeChangedCallbacks", "kind": "field", "static": true, "type": { "text": "Map any)[]>" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "prop", "kind": "field", "static": true, "description": "Creates observable property on instances (via prototype)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1007" }, "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "setPrototype", "kind": "field", "static": true, "description": "Creates observable property on instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any)>(this: CLASS, name: KEY, options: OPTIONS) => OPTIONS extends (...args2: any[]) => infer R ? R : OPTIONS extends ObserverPropertyType ? ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? unknown extends R ? object : R : OPTIONS extends { type: ObserverPropertyType; } ? ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? unknown extends R ? string : R : never" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "define", "kind": "field", "static": true, "description": "Define properties on instances via Object.defineProperties().\nAutomatically sets property non-enumerable if name begins with `_`.\nFunctions will be remapped as getters", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends { [P in keyof any]: { enumerable?: boolean; configurable?: boolean; writable?: boolean; value?: any; get?: ((this: INSTANCE) => any); set?: (this: INSTANCE, value: any) => void; } | ((this: INSTANCE, ...args: any[]) => any); }, VALUE extends { [KEY in keyof PROPS]: PROPS[KEY] extends (...args2: any[]) => infer R ? R : PROPS[KEY] extends TypedPropertyDescriptor ? R : never; }>(this: CLASS, props: PROPS & ThisType) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "undefine", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROP extends string, PROPS extends INSTANCE & Record>(this: CLASS, name: PROP) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "observe", "kind": "field", "static": true, "description": "Creates observable properties on instances", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends IDLParameter, VALUE extends { [KEY in keyof PROPS]: PROPS[KEY] extends (...args2: any[]) => infer R ? R : PROPS[KEY] extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : PROPS[KEY] extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : PROPS[KEY] extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : PROPS[KEY] extends ObserverOptions ? (unknown extends R ? string : R) : never; }>(this: CLASS, props: PROPS) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "defineStatic", "kind": "field", "static": true, "type": { "text": ">(this: T1, props: T2) => T1 & ParsedProps" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "events", "kind": "field", "static": true, "type": { "text": "(this: T, listeners?: CompositionEventListenerObject>, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "childEvents", "kind": "field", "static": true, "type": { "text": "(this: T, listenerMap: { [x: string]: CompositionEventListenerObject>; }, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "rootEvents", "kind": "field", "static": true, "type": { "text": "(this: T, listeners?: CompositionEventListenerObject>, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "on", "kind": "field", "static": true, "type": { "text": ", T3 extends CompositionCallback, T4 extends keyof T3>(this: T1, name: T3 | T4, callbacks?: T3[T4] & ThisType) => T1" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "off", "kind": "field", "static": true, "type": { "text": ", T3 extends CompositionCallback, T4 extends keyof T3>(this: T1, name: T3 | T4, callbacks?: T3[T4] & ThisType) => T1" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "offPropChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: ObjectOrObjectEntries<{ [P in keyof T2]?: (this: T2, oldValue: T2[P], newValue: T2[P], changes: any, element: T2) => void; }>) => T1" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "offAttributeChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: { [x: string]: (this: T2, oldValue: string, newValue: string, element: T2) => void; }) => T1" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "onPropChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: ObjectOrObjectEntries<{ [P in keyof T2]?: (this: T2, oldValue: T2[P], newValue: T2[P], changes: any, element: T2) => void; }>) => T1" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "onAttributeChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: { [x: string]: (this: T2, oldValue: string, newValue: string, element: T2) => void; }) => T1" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } } ], "slots": [ { "name": "", "description": "" } ], "cssParts": [], "events": [], "demos": [], "superclass": { "module": "components/Box.js", "name": "default" }, "mixins": [ { "module": "mixins/TypographyMixin.js", "name": "default" } ], "description": "Material Design Type scale: Label.\n@see https://m3.material.io/styles/typography/type-scale-tokens" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "default", "module": "components/Label.js" } }, { "kind": "custom-element-definition", "name": "mdw-label", "declaration": { "name": "default", "module": "components/Label.js" } } ] }, { "kind": "javascript-module", "path": "components/List.js", "declarations": [ { "kind": "class", "name": "List", "tagName": "mdw-list", "customElement": true, "attributes": [ { "name": "ink", "fieldName": "ink", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "type-style", "fieldName": "typeStyle", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "block", "fieldName": "block", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "inline", "fieldName": "inline", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "row", "fieldName": "row", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "x", "fieldName": "x", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "y", "fieldName": "y", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "gap", "fieldName": "gap", "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "padding", "fieldName": "padding", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "density", "fieldName": "density", "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "mixins/DensityMixin.js" } }, { "name": "color", "fieldName": "color", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } } ], "members": [ { "name": "density", "kind": "field", "description": "Density level affecting spacing and compactness. Integer from -4 (dense) to 4 (spacious).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/DensityMixin.js#L9" }, "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "mixins/DensityMixin.js" } }, { "name": "block", "kind": "field", "description": "Set `display: block` on the host (boolean)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js#L9" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "inline", "kind": "field", "description": "Use inline flex layout: `display: inline-flex` (boolean)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js#L11" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "row", "kind": "field", "description": "Switch main axis to horizontal: `flex-direction: row` (boolean)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js#L13" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "x", "kind": "field", "description": "Main-axis alignment / justification.\nAllowed: 'start'|'center'|'end'|'between'|'around'|'stretch'|'baseline'.\nDefault: 'start'.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js#L19" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "y", "kind": "field", "description": "Cross-axis alignment / alignment of items.\nSame allowed values as `x`. Default: 'start'.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js#L29" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "gap", "kind": "field", "description": "Gap between children. Accepts preset numeric strings (e.g. '8') mapped to px, or floats.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js#L36" }, "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "padding", "kind": "field", "description": "Padding preset or numeric value (e.g. 'pane', '8', '16').", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js#L38" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "color", "kind": "field", "description": "Palette or surface token used to select background/ink tokens.\nExamples: 'primary', 'background', 'surface-container-low'.\nVisual color token for list surfaces. Default is `surface` to match\nMaterial surface theming.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/List.js#L24" }, "type": { "text": "string & { empty: string; }" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "ink", "kind": "field", "description": "Explicit ink override token (e.g. 'outline', 'on-primary', 'inverse-on-surface', 'inherit').\nMaps to `--mdw-ink`.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L57" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "typeStyle", "kind": "field", "description": "Typographic style shortcut that maps to type scale variables\n(e.g. 'headline-large', 'body-medium').", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L62" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "prototype", "kind": "field", "static": true, "type": { "text": "CustomElement" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "readAriaProperty", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/AriaReflectorMixin.js#L28" }, "return": { "type": { "text": "(name: \"shadowRoot\" | \"ariaActiveDescendantElement\" | \"ariaAtomic\" | \"ariaAutoComplete\" | \"ariaBrailleLabel\" | \"ariaBrailleRoleDescription\" | \"ariaBusy\" | \"ariaChecked\" | \"ariaColCount\" | \"ariaColIndex\" | \"ariaColIndexText\" | \"ariaColSpan\" | \"ariaControlsElements\" | \"ariaCurrent\" | \"ariaDescribedByElements\" | \"ariaDescription\" | \"ariaDetailsElements\" | \"ariaDisabled\" | \"ariaErrorMessageElements\" | \"ariaExpanded\" | \"ariaFlowToElements\" | \"ariaHasPopup\" | \"ariaHidden\" | \"ariaInvalid\" | \"ariaKeyShortcuts\" | \"ariaLabel\" | \"ariaLabelledByElements\" | \"ariaLevel\" | \"ariaLive\" | \"ariaModal\" | \"ariaMultiLine\" | \"ariaMultiSelectable\" | \"ariaOrientation\" | \"ariaOwnsElements\" | \"ariaPlaceholder\" | \"ariaPosInSet\" | \"ariaPressed\" | \"ariaReadOnly\" | \"ariaRelevant\" | \"ariaRequired\" | \"ariaRoleDescription\" | \"ariaRowCount\" | \"ariaRowIndex\" | \"ariaRowIndexText\" | \"ariaRowSpan\" | \"ariaSelected\" | \"ariaSetSize\" | \"ariaSort\" | \"ariaValueMax\" | \"ariaValueMin\" | \"ariaValueNow\" | \"ariaValueText\" | \"role\") => string | Element | ShadowRoot | readonly Element[]" } }, "inheritedFrom": { "name": "default", "module": "mixins/AriaReflectorMixin.js" } }, { "name": "updateAriaProperty", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/AriaReflectorMixin.js#L47" }, "return": { "type": { "text": ">(name: K, value: ARIAMixin[K]) => void" } }, "inheritedFrom": { "name": "default", "module": "mixins/AriaReflectorMixin.js" } }, { "name": "compose", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L145" }, "type": { "text": "(parts: CompositionPart[]) => Composition" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "#refsProxy", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1145" }, "type": { "text": "Record" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "#refsCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1148" }, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "#refsCompositionCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1151" }, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "#composition", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1154" }, "type": { "text": "Composition" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "#patching", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1156" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "#pendingPatchRenders", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1159" }, "type": { "text": "[string, any, CustomElement][]" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "#propAttributeCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1162" }, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "#callbackArguments", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1165" }, "type": { "text": "CallbackArguments" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "elementInternals", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1172" }, "type": { "text": "ElementInternals" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "render", "kind": "field", "description": "Updates nodes based on data\nExpects data in JSON Merge Patch format", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1185" }, "type": { "text": "RenderDraw" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "propChangedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1213" }, "type": { "text": "(this: T, name: K, oldValue: K extends keyof T ? T[K] : unknown, newValue: K extends keyof T ? T[K] : unknown, changes?: K extends keyof T ? T[K] extends object ? Partial : T[K] : unknown) => void" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "attributeChangedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1234" }, "type": { "text": "(name: string, oldValue: string, newValue: string) => void" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "#template", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1284" }, "type": { "text": "DocumentFragment" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "#onObserverPropertyChanged", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1294" }, "type": { "text": "(name: string, oldValue: any, newValue: any, changes: any) => void" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "static", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1330" }, "type": { "text": "typeof CustomElement" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "patch", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1333" }, "type": { "text": "(patch: any) => void" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "refs", "kind": "field", "description": "Proxy object that returns shadow DOM elements by tag.\nIf called before interpolation (eg: on composed), returns from template", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1404" }, "type": { "text": "Record" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "attributeCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1391" }, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "callbackArguments", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1400" }, "type": { "text": "CallbackArguments | { composition: Composition; refs: Record; html: any; inline: (fn: (data: Partial) => any) => string; template: DocumentFragment; element: T; }" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "composition", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1403" }, "type": { "text": "Composition" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "connectedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1435" }, "type": { "text": "() => void" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "disconnectedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1441" }, "type": { "text": "() => void" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "delegatesFocus", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1175" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "elementName", "kind": "field", "static": true, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "observedAttributes", "kind": "field", "static": true, "type": { "text": "Iterable" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "interpolatesTemplate", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "supportsElementInternals", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "supportsElementInternalsRole", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "defined", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "registrations", "kind": "field", "static": true, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "expressions", "kind": "method", "static": true, "description": "Expressions are idempotent functions that are selectively called whenever\na render is requested.\nExpressions are constructed exactly as methods though differ in expected\narguments. The first argument should be destructured to ensure each used\nproperty is accessed at least once in order to inspect used properties.\n\nThe Composition API will inspect this function with a proxy for `this` to\ncatalog what observables are used by the expression. This allows the\nComposition API to build a cache as well as selective invoke the expression\nonly when needed.\n\nWhen used with in element templates, the element itself will be passed as\nits first argument.\n````js\n Button\n .prop('filled', 'boolean')\n .prop('outlined', 'boolean')\n .expresssions({\n _isFilledOrOutlined({filled, outlined}) {\n return (filled || outlined)\n },\n })\n .html`
`;\n````\n\nWhen used with external data source, that data source\nwill be passed to the expression with all properties being `null` at first\ninspection.\n````js\n const externalData = {first: 'John', last: 'Doe'};\n ContactCard\n .expresssions({\n _fullName({first, last}) {\n return [first, last].filter(Boolean).join(' ');\n },\n })\n myButton.render(externalData);\n````\n\nExpressions may be support argumentless calls by using default\nparameters with `this`.\n````js\n Button\n .expresssions({\n isFilledOrOutlined({filled, outlined} = this) {\n return (filled || outlined)\n },\n });\n myButton.isFilledorOutlined();\n````", "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends { [K in keyof any]: K extends `_${any}` ? ((data: INSTANCE, state?: Record) => string | boolean | null) : ((data?: INSTANCE, state?: Record) => string | boolean | null); } & ThisType>(this: CLASS, expressions: PROPS & ThisType) => CLASS & Class<{ [K in keyof PROPS]: K extends `_${any}` ? never : () => ReturnType; }, ARGS>" } }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "methods", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "overrides", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends Partial>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "props", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "idl", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "append", "kind": "field", "static": true, "description": "Append parts to composition", "type": { "text": "(this: T, ...parts: CompositionPart[]) => T" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "recompose", "kind": "field", "static": true, "description": "After composition, invokes callback.\nMay be called multiple times.", "type": { "text": ", T3 extends CompositionCallback[\"composed\"]>(this: T1, callback: T3) => T1" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "css", "kind": "field", "static": true, "description": "Appends styles to composition", "type": { "text": "(this: T1, array: T2, ...rest: T2 extends string ? any : T2 extends TemplateStringsArray ? any[] : (HTMLStyleElement | CSSStyleSheet)[]) => T1" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "autoRegister", "kind": "field", "static": true, "description": "Registers class with customElements. If class is registered before then,\ndoes nothing.", "type": { "text": "(this: T, elementName: string) => T" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "html", "kind": "field", "static": true, "description": "Appends DocumentFragment to composition", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1405" }, "type": { "text": "(this: T, string: TemplateStringsArray, ...substitutions: (string | Element | ((this: InstanceType, data: InstanceType, injections?: any) => any))[]) => T" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "extend", "kind": "field", "static": true, "description": "Extends base class into a new class.\nUse to avoid mutating base class.", "type": { "text": " T2>(this: T1, customExtender?: T3) => T3 extends null ? T1 : T2" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "setStatic", "kind": "field", "static": true, "description": "Assigns static values to class", "type": { "text": " any) | string | number | boolean | any[] | object); }>(this: T1, source: T2 & ThisType) => T1 & T2" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "readonly", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "set", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "mixin", "kind": "field", "static": true, "description": "Returns result of calling mixin with current class", "type": { "text": " any, RETURN extends ReturnType, SUBCLASS extends ClassOf>(this: BASE, mixin: FN) => SUBCLASS & BASE" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "register", "kind": "field", "static": true, "description": "Registers class with window.customElements synchronously", "type": { "text": "(this: T, elementName?: string, force?: boolean) => T" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "propList", "kind": "field", "static": true, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "attrList", "kind": "field", "static": true, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "propChangedCallbacks", "kind": "field", "static": true, "type": { "text": "Map any)[]>" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "attributeChangedCallbacks", "kind": "field", "static": true, "type": { "text": "Map any)[]>" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "prop", "kind": "field", "static": true, "description": "Creates observable property on instances (via prototype)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1007" }, "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "setPrototype", "kind": "field", "static": true, "description": "Creates observable property on instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any)>(this: CLASS, name: KEY, options: OPTIONS) => OPTIONS extends (...args2: any[]) => infer R ? R : OPTIONS extends ObserverPropertyType ? ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? unknown extends R ? object : R : OPTIONS extends { type: ObserverPropertyType; } ? ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? unknown extends R ? string : R : never" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "define", "kind": "field", "static": true, "description": "Define properties on instances via Object.defineProperties().\nAutomatically sets property non-enumerable if name begins with `_`.\nFunctions will be remapped as getters", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends { [P in keyof any]: { enumerable?: boolean; configurable?: boolean; writable?: boolean; value?: any; get?: ((this: INSTANCE) => any); set?: (this: INSTANCE, value: any) => void; } | ((this: INSTANCE, ...args: any[]) => any); }, VALUE extends { [KEY in keyof PROPS]: PROPS[KEY] extends (...args2: any[]) => infer R ? R : PROPS[KEY] extends TypedPropertyDescriptor ? R : never; }>(this: CLASS, props: PROPS & ThisType) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "undefine", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROP extends string, PROPS extends INSTANCE & Record>(this: CLASS, name: PROP) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "observe", "kind": "field", "static": true, "description": "Creates observable properties on instances", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends IDLParameter, VALUE extends { [KEY in keyof PROPS]: PROPS[KEY] extends (...args2: any[]) => infer R ? R : PROPS[KEY] extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : PROPS[KEY] extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : PROPS[KEY] extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : PROPS[KEY] extends ObserverOptions ? (unknown extends R ? string : R) : never; }>(this: CLASS, props: PROPS) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "defineStatic", "kind": "field", "static": true, "type": { "text": ">(this: T1, props: T2) => T1 & ParsedProps" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "events", "kind": "field", "static": true, "type": { "text": "(this: T, listeners?: CompositionEventListenerObject>, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "childEvents", "kind": "field", "static": true, "type": { "text": "(this: T, listenerMap: { [x: string]: CompositionEventListenerObject>; }, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "rootEvents", "kind": "field", "static": true, "type": { "text": "(this: T, listeners?: CompositionEventListenerObject>, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "on", "kind": "field", "static": true, "type": { "text": ", T3 extends CompositionCallback, T4 extends keyof T3>(this: T1, name: T3 | T4, callbacks?: T3[T4] & ThisType) => T1" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "off", "kind": "field", "static": true, "type": { "text": ", T3 extends CompositionCallback, T4 extends keyof T3>(this: T1, name: T3 | T4, callbacks?: T3[T4] & ThisType) => T1" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "offPropChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: ObjectOrObjectEntries<{ [P in keyof T2]?: (this: T2, oldValue: T2[P], newValue: T2[P], changes: any, element: T2) => void; }>) => T1" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "offAttributeChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: { [x: string]: (this: T2, oldValue: string, newValue: string, element: T2) => void; }) => T1" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "onPropChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: ObjectOrObjectEntries<{ [P in keyof T2]?: (this: T2, oldValue: T2[P], newValue: T2[P], changes: any, element: T2) => void; }>) => T1" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "onAttributeChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: { [x: string]: (this: T2, oldValue: string, newValue: string, element: T2) => void; }) => T1" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } } ], "slots": [ { "name": "", "description": "" } ], "cssParts": [], "events": [], "demos": [ { "url": "demo/components/list.html" } ], "superclass": { "module": "components/Box.js", "name": "default" }, "mixins": [ { "module": "mixins/DensityMixin.js", "name": "default" }, { "module": "mixins/AriaReflectorMixin.js", "name": "default" } ], "description": "@typedef {'compact'} DeprecatedHTMLMenuElementProperties" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "default", "module": "components/List.js" } }, { "kind": "custom-element-definition", "name": "mdw-list", "declaration": { "name": "default", "module": "components/List.js" } } ] }, { "kind": "javascript-module", "path": "components/ListItem.js", "declarations": [ { "kind": "class", "name": "ListItem", "tagName": "mdw-list-item", "customElement": true, "attributes": [ { "name": "color", "fieldName": "color", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "ink", "fieldName": "ink", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "type-style", "fieldName": "typeStyle", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "disabled", "fieldName": "disabled", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "focused", "fieldName": "focused", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "hovered", "fieldName": "hovered", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "pressed", "fieldName": "pressed", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "href", "fieldName": "href", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/HyperlinkMixin.js" } }, { "name": "target", "fieldName": "target", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/HyperlinkMixin.js" } }, { "name": "download", "fieldName": "download", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/HyperlinkMixin.js" } }, { "name": "ping", "fieldName": "ping", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/HyperlinkMixin.js" } }, { "name": "rel", "fieldName": "rel", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/HyperlinkMixin.js" } }, { "name": "hreflang", "fieldName": "hreflang", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/HyperlinkMixin.js" } }, { "name": "referrerpolicy", "fieldName": "referrerPolicy", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/HyperlinkMixin.js" } }, { "name": "leading", "description": "Leading slot content or shorthand string.", "fieldName": "leading", "type": { "text": "string" } }, { "name": "avatar", "description": "Avatar label or shorthand content for a leading avatar.", "fieldName": "avatar", "type": { "text": "string" } }, { "name": "avatar-color", "description": "Color token used for the avatar container (default: primary-container).", "fieldName": "avatarColor", "type": { "text": "string" } }, { "name": "avatar-src", "description": "Image source for the avatar.", "fieldName": "avatarSrc", "type": { "text": "string" } }, { "name": "src", "description": "Image source URL for a leading image in the list item.", "fieldName": "src", "type": { "text": "string" } }, { "name": "alt", "description": "Alt text for the leading image.", "fieldName": "alt", "type": { "text": "string" } }, { "name": "icon", "description": "Icon name for a leading icon.", "fieldName": "icon", "type": { "text": "string" } }, { "name": "icon-ink", "description": "Ink/color token used for the leading icon.", "fieldName": "iconInk", "type": { "text": "string" } }, { "name": "icon-src", "description": "External image/SVG source for the leading icon.", "fieldName": "iconSrc", "type": { "text": "string" } }, { "name": "icon-variation", "description": "Icon variation (e.g., 'filled').", "fieldName": "iconVariation", "type": { "text": "string" } }, { "name": "checkbox", "description": "Checkbox shorthand name or placement class for a selectable leading checkbox.", "fieldName": "checkbox", "type": { "text": "string" } }, { "name": "radio", "description": "Radio shorthand name or placement class for a selectable leading radio.", "fieldName": "radio", "type": { "text": "string" } }, { "name": "selection-color", "description": "Selection color token used when item is selected (default: primary).", "fieldName": "selectionColor", "type": { "text": "string" } }, { "name": "selected", "description": "Selection state for the item.", "fieldName": "selected", "type": { "text": "boolean" } }, { "name": "supporting", "fieldName": "supporting", "type": { "text": "string" } }, { "name": "trailing", "description": "Trailing text slot or shorthand.", "fieldName": "trailing", "type": { "text": "string" } }, { "name": "trailing-icon", "description": "Trailing icon name.", "fieldName": "trailingIcon", "type": { "text": "string" } }, { "name": "trailing-icon-ink", "description": "Ink/color token for the trailing icon.", "fieldName": "trailingIconInk", "type": { "text": "string" } }, { "name": "trailing-icon-src", "description": "External image/SVG source for the trailing icon.", "fieldName": "trailingIconSrc", "type": { "text": "string" } }, { "name": "divider", "description": "Divider style identifier (e.g., 'inset').", "fieldName": "divider", "type": { "text": "string" } }, { "name": "video", "description": "If true, indicates the list item contains video content and adjusts layout.", "fieldName": "video", "type": { "text": "boolean" } }, { "name": "lines", "description": "Number of text lines the item should reserve for content (integer).", "fieldName": "lines", "type": { "text": "number" } }, { "name": "state-layer", "type": { "text": "boolean" }, "description": "Show the visual state layer element when true", "fieldName": "stateLayer", "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } } ], "members": [ { "name": "href", "kind": "field", "description": "The URL that the hyperlink points to.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L34" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/HyperlinkMixin.js" } }, { "name": "target", "kind": "field", "description": "The browsing context in which to open the linked resource (e.g. '_blank').", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L36" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/HyperlinkMixin.js" } }, { "name": "download", "kind": "field", "description": "Suggested filename for download.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L38" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/HyperlinkMixin.js" } }, { "name": "ping", "kind": "field", "description": "URLs to be pinged when the link is followed.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L40" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/HyperlinkMixin.js" } }, { "name": "rel", "kind": "field", "description": "Link relationship tokens (e.g. 'noopener', 'noreferrer').", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L42" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/HyperlinkMixin.js" } }, { "name": "hreflang", "kind": "field", "description": "Language of the linked resource.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L44" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/HyperlinkMixin.js" } }, { "name": "referrerPolicy", "kind": "field", "description": "Referrer policy for the link (serialized to 'referrerpolicy' attribute).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L46" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/HyperlinkMixin.js" } }, { "name": "origin", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L49" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/HyperlinkMixin.js" } }, { "name": "protocol", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L50" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/HyperlinkMixin.js" } }, { "name": "username", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L51" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/HyperlinkMixin.js" } }, { "name": "password", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L52" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/HyperlinkMixin.js" } }, { "name": "host", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L53" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/HyperlinkMixin.js" } }, { "name": "hostname", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L54" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/HyperlinkMixin.js" } }, { "name": "port", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L55" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/HyperlinkMixin.js" } }, { "name": "pathname", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L56" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/HyperlinkMixin.js" } }, { "name": "search", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L57" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/HyperlinkMixin.js" } }, { "name": "hash", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L58" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/HyperlinkMixin.js" } }, { "name": "disabled", "kind": "field", "description": "Whether the element is disabled (affects interactive states)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L14" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "focused", "kind": "field", "description": "Force focus state (independent of document)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L16" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "hovered", "kind": "field", "description": "Force hover state (independent of interaction)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L18" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "pressed", "kind": "field", "description": "Force pressed state (independent of interaction)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L20" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "stateLayer", "kind": "field", "description": "Show the visual state layer element when true\nWhen true, draw the Material state layer for interactive feedback.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/ListItem.js#L33" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "disabledState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/ListItem.js#L107" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "hoveredState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L38" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "focusedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L39" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "pressedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L40" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "touchedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L41" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "pointedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L44" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "stateTargetElement", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L50" }, "type": { "text": "HTMLElement" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "color", "kind": "field", "description": "Palette or surface token used to select background/ink tokens.\nExamples: 'primary', 'background', 'surface-container-low'.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L52" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "ink", "kind": "field", "description": "Explicit ink override token (e.g. 'outline', 'on-primary', 'inverse-on-surface', 'inherit').\nMaps to `--mdw-ink`.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L57" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "typeStyle", "kind": "field", "description": "Typographic style shortcut that maps to type scale variables\n(e.g. 'headline-large', 'body-medium').", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L62" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "leading", "kind": "field", "description": "Leading slot content or shorthand string.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/ListItem.js#L37" }, "type": { "text": "string" } }, { "name": "avatar", "kind": "field", "description": "Avatar label or shorthand content for a leading avatar.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/ListItem.js#L40" }, "type": { "text": "string" } }, { "name": "avatarColor", "kind": "field", "description": "Color token used for the avatar container (default: primary-container).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/ListItem.js#L43" }, "type": { "text": "string" } }, { "name": "avatarSrc", "kind": "field", "description": "Image source for the avatar.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/ListItem.js#L46" }, "type": { "text": "string" } }, { "name": "src", "kind": "field", "description": "Image source URL for a leading image in the list item.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/ListItem.js#L49" }, "type": { "text": "string" } }, { "name": "alt", "kind": "field", "description": "Alt text for the leading image.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/ListItem.js#L52" }, "type": { "text": "string" } }, { "name": "icon", "kind": "field", "description": "Icon name for a leading icon.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/ListItem.js#L55" }, "type": { "text": "string" } }, { "name": "iconInk", "kind": "field", "description": "Ink/color token used for the leading icon.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/ListItem.js#L58" }, "type": { "text": "string" } }, { "name": "iconSrc", "kind": "field", "description": "External image/SVG source for the leading icon.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/ListItem.js#L61" }, "type": { "text": "string" } }, { "name": "iconVariation", "kind": "field", "description": "Icon variation (e.g., 'filled').", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/ListItem.js#L64" }, "type": { "text": "string" } }, { "name": "checkbox", "kind": "field", "description": "Checkbox shorthand name or placement class for a selectable leading checkbox.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/ListItem.js#L67" }, "type": { "text": "string" } }, { "name": "radio", "kind": "field", "description": "Radio shorthand name or placement class for a selectable leading radio.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/ListItem.js#L70" }, "type": { "text": "string" } }, { "name": "selectionColor", "kind": "field", "description": "Selection color token used when item is selected (default: primary).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/ListItem.js#L73" }, "type": { "text": "string" } }, { "name": "selected", "kind": "field", "description": "Selection state for the item.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/ListItem.js#L76" }, "type": { "text": "boolean" } }, { "name": "supporting", "kind": "field", "description": "Supporting text (secondary line) for the list item.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/ListItem.js#L400" }, "type": { "text": "string" } }, { "name": "trailing", "kind": "field", "description": "Trailing text slot or shorthand.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/ListItem.js#L82" }, "type": { "text": "string" } }, { "name": "trailingIcon", "kind": "field", "description": "Trailing icon name.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/ListItem.js#L85" }, "type": { "text": "string" } }, { "name": "trailingIconInk", "kind": "field", "description": "Ink/color token for the trailing icon.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/ListItem.js#L88" }, "type": { "text": "string" } }, { "name": "trailingIconSrc", "kind": "field", "description": "External image/SVG source for the trailing icon.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/ListItem.js#L91" }, "type": { "text": "string" } }, { "name": "divider", "kind": "field", "description": "Divider style identifier (e.g., 'inset').", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/ListItem.js#L94" }, "type": { "text": "string" } }, { "name": "video", "kind": "field", "description": "If true, indicates the list item contains video content and adjusts layout.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/ListItem.js#L97" }, "type": { "text": "boolean" } }, { "name": "lines", "kind": "field", "description": "Number of text lines the item should reserve for content (integer).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/ListItem.js#L100" }, "type": { "text": "number" } }, { "name": "isInteractive", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/ListItem.js#L113" }, "return": { "type": { "text": "() => boolean" } } }, { "name": "hasSupporting", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/ListItem.js#L116" }, "return": { "type": { "text": "() => boolean" } } }, { "name": "checkboxClass", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/ListItem.js#L119" }, "return": { "type": { "text": "() => string" } } }, { "name": "radioClass", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/ListItem.js#L122" }, "return": { "type": { "text": "() => string" } } }, { "name": "computedIconVariation", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/ListItem.js#L125" }, "return": { "type": { "text": "() => string" } } }, { "name": "prototype", "kind": "field", "static": true, "type": { "text": "CustomElement" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "addRipple", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/RippleMixin.js#L37" }, "return": { "type": { "text": "(x?: number, y?: number, hold?: boolean) => CustomElement & { hadRippleHeld: boolean; hadRippleReleased: boolean; rippleStarted: boolean; } & { rippleState: string; keepAlive: boolean; _positionX: number; _positionY: number; _radius: number; holdRipple: boolean; } & { _positionStyle: ElementStylerOptions | { styles: { minHeight: string; minWidth: string; boxShadow: string; top: string; left: string; }; }; } & { updatePosition(x?: number, y?: number, size?: number): void; handleRippleComplete(): void; }" } }, "inheritedFrom": { "name": "default", "module": "mixins/RippleMixin.js" } }, { "name": "readAriaProperty", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/AriaReflectorMixin.js#L28" }, "return": { "type": { "text": "(name: \"shadowRoot\" | \"ariaActiveDescendantElement\" | \"ariaAtomic\" | \"ariaAutoComplete\" | \"ariaBrailleLabel\" | \"ariaBrailleRoleDescription\" | \"ariaBusy\" | \"ariaChecked\" | \"ariaColCount\" | \"ariaColIndex\" | \"ariaColIndexText\" | \"ariaColSpan\" | \"ariaControlsElements\" | \"ariaCurrent\" | \"ariaDescribedByElements\" | \"ariaDescription\" | \"ariaDetailsElements\" | \"ariaDisabled\" | \"ariaErrorMessageElements\" | \"ariaExpanded\" | \"ariaFlowToElements\" | \"ariaHasPopup\" | \"ariaHidden\" | \"ariaInvalid\" | \"ariaKeyShortcuts\" | \"ariaLabel\" | \"ariaLabelledByElements\" | \"ariaLevel\" | \"ariaLive\" | \"ariaModal\" | \"ariaMultiLine\" | \"ariaMultiSelectable\" | \"ariaOrientation\" | \"ariaOwnsElements\" | \"ariaPlaceholder\" | \"ariaPosInSet\" | \"ariaPressed\" | \"ariaReadOnly\" | \"ariaRelevant\" | \"ariaRequired\" | \"ariaRoleDescription\" | \"ariaRowCount\" | \"ariaRowIndex\" | \"ariaRowIndexText\" | \"ariaRowSpan\" | \"ariaSelected\" | \"ariaSetSize\" | \"ariaSort\" | \"ariaValueMax\" | \"ariaValueMin\" | \"ariaValueNow\" | \"ariaValueText\" | \"role\") => string | Element | ShadowRoot | readonly Element[]" } }, "inheritedFrom": { "name": "default", "module": "mixins/AriaReflectorMixin.js" } }, { "name": "updateAriaProperty", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/AriaReflectorMixin.js#L47" }, "return": { "type": { "text": ">(name: K, value: ARIAMixin[K]) => void" } }, "inheritedFrom": { "name": "default", "module": "mixins/AriaReflectorMixin.js" } }, { "name": "compose", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L145" }, "type": { "text": "(parts: CompositionPart[]) => Composition" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#refsProxy", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1145" }, "type": { "text": "Record" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#refsCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1148" }, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#refsCompositionCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1151" }, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#composition", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1154" }, "type": { "text": "Composition" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#patching", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1156" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#pendingPatchRenders", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1159" }, "type": { "text": "[string, any, CustomElement][]" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#propAttributeCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1162" }, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#callbackArguments", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1165" }, "type": { "text": "CallbackArguments" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "elementInternals", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1172" }, "type": { "text": "ElementInternals" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "render", "kind": "field", "description": "Updates nodes based on data\nExpects data in JSON Merge Patch format", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1185" }, "type": { "text": "RenderDraw" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "propChangedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1213" }, "type": { "text": "(this: T, name: K, oldValue: K extends keyof T ? T[K] : unknown, newValue: K extends keyof T ? T[K] : unknown, changes?: K extends keyof T ? T[K] extends object ? Partial : T[K] : unknown) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attributeChangedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1234" }, "type": { "text": "(name: string, oldValue: string, newValue: string) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#template", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1284" }, "type": { "text": "DocumentFragment" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#onObserverPropertyChanged", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1294" }, "type": { "text": "(name: string, oldValue: any, newValue: any, changes: any) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "static", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1330" }, "type": { "text": "typeof CustomElement" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "patch", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1333" }, "type": { "text": "(patch: any) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "refs", "kind": "field", "description": "Proxy object that returns shadow DOM elements by tag.\nIf called before interpolation (eg: on composed), returns from template", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1404" }, "type": { "text": "Record" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attributeCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1391" }, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "callbackArguments", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1400" }, "type": { "text": "CallbackArguments | { composition: Composition; refs: Record; html: any; inline: (fn: (data: Partial) => any) => string; template: DocumentFragment; element: T; }" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "composition", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1403" }, "type": { "text": "Composition" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "connectedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1435" }, "type": { "text": "() => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "disconnectedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1441" }, "type": { "text": "() => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "delegatesFocus", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1175" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "elementName", "kind": "field", "static": true, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "observedAttributes", "kind": "field", "static": true, "type": { "text": "Iterable" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "interpolatesTemplate", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "supportsElementInternals", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "supportsElementInternalsRole", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "defined", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "registrations", "kind": "field", "static": true, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "expressions", "kind": "method", "static": true, "description": "Expressions are idempotent functions that are selectively called whenever\na render is requested.\nExpressions are constructed exactly as methods though differ in expected\narguments. The first argument should be destructured to ensure each used\nproperty is accessed at least once in order to inspect used properties.\n\nThe Composition API will inspect this function with a proxy for `this` to\ncatalog what observables are used by the expression. This allows the\nComposition API to build a cache as well as selective invoke the expression\nonly when needed.\n\nWhen used with in element templates, the element itself will be passed as\nits first argument.\n````js\n Button\n .prop('filled', 'boolean')\n .prop('outlined', 'boolean')\n .expresssions({\n _isFilledOrOutlined({filled, outlined}) {\n return (filled || outlined)\n },\n })\n .html`
`;\n````\n\nWhen used with external data source, that data source\nwill be passed to the expression with all properties being `null` at first\ninspection.\n````js\n const externalData = {first: 'John', last: 'Doe'};\n ContactCard\n .expresssions({\n _fullName({first, last}) {\n return [first, last].filter(Boolean).join(' ');\n },\n })\n myButton.render(externalData);\n````\n\nExpressions may be support argumentless calls by using default\nparameters with `this`.\n````js\n Button\n .expresssions({\n isFilledOrOutlined({filled, outlined} = this) {\n return (filled || outlined)\n },\n });\n myButton.isFilledorOutlined();\n````", "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends { [K in keyof any]: K extends `_${any}` ? ((data: INSTANCE, state?: Record) => string | boolean | null) : ((data?: INSTANCE, state?: Record) => string | boolean | null); } & ThisType>(this: CLASS, expressions: PROPS & ThisType) => CLASS & Class<{ [K in keyof PROPS]: K extends `_${any}` ? never : () => ReturnType; }, ARGS>" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "methods", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "overrides", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends Partial>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "props", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "idl", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "append", "kind": "field", "static": true, "description": "Append parts to composition", "type": { "text": "(this: T, ...parts: CompositionPart[]) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "recompose", "kind": "field", "static": true, "description": "After composition, invokes callback.\nMay be called multiple times.", "type": { "text": ", T3 extends CompositionCallback[\"composed\"]>(this: T1, callback: T3) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "css", "kind": "field", "static": true, "description": "Appends styles to composition", "type": { "text": "(this: T1, array: T2, ...rest: T2 extends string ? any : T2 extends TemplateStringsArray ? any[] : (HTMLStyleElement | CSSStyleSheet)[]) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "autoRegister", "kind": "field", "static": true, "description": "Registers class with customElements. If class is registered before then,\ndoes nothing.", "type": { "text": "(this: T, elementName: string) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "html", "kind": "field", "static": true, "description": "Appends DocumentFragment to composition", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1405" }, "type": { "text": "(this: T, string: TemplateStringsArray, ...substitutions: (string | Element | ((this: InstanceType, data: InstanceType, injections?: any) => any))[]) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "extend", "kind": "field", "static": true, "description": "Extends base class into a new class.\nUse to avoid mutating base class.", "type": { "text": " T2>(this: T1, customExtender?: T3) => T3 extends null ? T1 : T2" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "setStatic", "kind": "field", "static": true, "description": "Assigns static values to class", "type": { "text": " any) | string | number | boolean | any[] | object); }>(this: T1, source: T2 & ThisType) => T1 & T2" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "readonly", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "set", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "mixin", "kind": "field", "static": true, "description": "Returns result of calling mixin with current class", "type": { "text": " any, RETURN extends ReturnType, SUBCLASS extends ClassOf>(this: BASE, mixin: FN) => SUBCLASS & BASE" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "register", "kind": "field", "static": true, "description": "Registers class with window.customElements synchronously", "type": { "text": "(this: T, elementName?: string, force?: boolean) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "propList", "kind": "field", "static": true, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attrList", "kind": "field", "static": true, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "propChangedCallbacks", "kind": "field", "static": true, "type": { "text": "Map any)[]>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attributeChangedCallbacks", "kind": "field", "static": true, "type": { "text": "Map any)[]>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "prop", "kind": "field", "static": true, "description": "Creates observable property on instances (via prototype)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1007" }, "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "setPrototype", "kind": "field", "static": true, "description": "Creates observable property on instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any)>(this: CLASS, name: KEY, options: OPTIONS) => OPTIONS extends (...args2: any[]) => infer R ? R : OPTIONS extends ObserverPropertyType ? ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? unknown extends R ? object : R : OPTIONS extends { type: ObserverPropertyType; } ? ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? unknown extends R ? string : R : never" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "define", "kind": "field", "static": true, "description": "Define properties on instances via Object.defineProperties().\nAutomatically sets property non-enumerable if name begins with `_`.\nFunctions will be remapped as getters", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends { [P in keyof any]: { enumerable?: boolean; configurable?: boolean; writable?: boolean; value?: any; get?: ((this: INSTANCE) => any); set?: (this: INSTANCE, value: any) => void; } | ((this: INSTANCE, ...args: any[]) => any); }, VALUE extends { [KEY in keyof PROPS]: PROPS[KEY] extends (...args2: any[]) => infer R ? R : PROPS[KEY] extends TypedPropertyDescriptor ? R : never; }>(this: CLASS, props: PROPS & ThisType) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "undefine", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROP extends string, PROPS extends INSTANCE & Record>(this: CLASS, name: PROP) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "observe", "kind": "field", "static": true, "description": "Creates observable properties on instances", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends IDLParameter, VALUE extends { [KEY in keyof PROPS]: PROPS[KEY] extends (...args2: any[]) => infer R ? R : PROPS[KEY] extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : PROPS[KEY] extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : PROPS[KEY] extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : PROPS[KEY] extends ObserverOptions ? (unknown extends R ? string : R) : never; }>(this: CLASS, props: PROPS) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "defineStatic", "kind": "field", "static": true, "type": { "text": ">(this: T1, props: T2) => T1 & ParsedProps" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "events", "kind": "field", "static": true, "type": { "text": "(this: T, listeners?: CompositionEventListenerObject>, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "childEvents", "kind": "field", "static": true, "type": { "text": "(this: T, listenerMap: { [x: string]: CompositionEventListenerObject>; }, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "rootEvents", "kind": "field", "static": true, "type": { "text": "(this: T, listeners?: CompositionEventListenerObject>, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "on", "kind": "field", "static": true, "type": { "text": ", T3 extends CompositionCallback, T4 extends keyof T3>(this: T1, name: T3 | T4, callbacks?: T3[T4] & ThisType) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "off", "kind": "field", "static": true, "type": { "text": ", T3 extends CompositionCallback, T4 extends keyof T3>(this: T1, name: T3 | T4, callbacks?: T3[T4] & ThisType) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "offPropChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: ObjectOrObjectEntries<{ [P in keyof T2]?: (this: T2, oldValue: T2[P], newValue: T2[P], changes: any, element: T2) => void; }>) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "offAttributeChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: { [x: string]: (this: T2, oldValue: string, newValue: string, element: T2) => void; }) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "onPropChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: ObjectOrObjectEntries<{ [P in keyof T2]?: (this: T2, oldValue: T2[P], newValue: T2[P], changes: any, element: T2) => void; }>) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "onAttributeChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: { [x: string]: (this: T2, oldValue: string, newValue: string, element: T2) => void; }) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } } ], "slots": [ { "name": "leading", "description": "{leading}" }, { "name": "", "description": "" }, { "name": "supporting", "description": "{supporting}" }, { "name": "trailing", "description": "{trailing}" } ], "cssParts": [], "events": [], "demos": [], "superclass": { "module": "core/CustomElement.js", "name": "default" }, "mixins": [ { "module": "mixins/ThemableMixin.js", "name": "default" }, { "module": "mixins/StateMixin.js", "name": "default" }, { "module": "mixins/RippleMixin.js", "name": "default" }, { "module": "mixins/AriaReflectorMixin.js", "name": "default" }, { "module": "mixins/HyperlinkMixin.js", "name": "default" } ], "description": "List item representing a single row in a list; supports leading/trailing\ncontent, selection, and accessibility features.\n@see https://m3.material.io/components/lists/specs" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "default", "module": "components/ListItem.js" } }, { "kind": "custom-element-definition", "name": "mdw-list-item", "declaration": { "name": "default", "module": "components/ListItem.js" } } ] }, { "kind": "javascript-module", "path": "components/ListOption.js", "declarations": [ { "kind": "class", "name": "ListOption", "tagName": "mdw-list-option", "customElement": true, "attributes": [ { "name": "color", "fieldName": "color", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "ink", "fieldName": "ink", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "type-style", "fieldName": "typeStyle", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "disabled", "fieldName": "disabled", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "focused", "fieldName": "focused", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "hovered", "fieldName": "hovered", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "pressed", "fieldName": "pressed", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "href", "fieldName": "href", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "target", "fieldName": "target", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "download", "fieldName": "download", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "ping", "fieldName": "ping", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "rel", "fieldName": "rel", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "hreflang", "fieldName": "hreflang", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "referrerpolicy", "fieldName": "referrerPolicy", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "leading", "fieldName": "leading", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "avatar", "fieldName": "avatar", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "avatar-color", "fieldName": "avatarColor", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "avatar-src", "fieldName": "avatarSrc", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "src", "fieldName": "src", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "alt", "fieldName": "alt", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "icon", "fieldName": "icon", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "icon-ink", "fieldName": "iconInk", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "icon-src", "fieldName": "iconSrc", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "icon-variation", "fieldName": "iconVariation", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "checkbox", "fieldName": "checkbox", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "radio", "fieldName": "radio", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "selection-color", "fieldName": "selectionColor", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "selected", "description": "Initial/default selection state (reflected to `selected` attribute).\nUse `selected` property to control runtime selection.", "fieldName": "defaultSelected", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "supporting", "fieldName": "supporting", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "trailing", "fieldName": "trailing", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "trailing-icon", "fieldName": "trailingIcon", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "trailing-icon-ink", "fieldName": "trailingIconInk", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "trailing-icon-src", "fieldName": "trailingIconSrc", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "divider", "fieldName": "divider", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "video", "fieldName": "video", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "lines", "fieldName": "lines", "type": { "text": "integer" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "label", "description": "Explicit label for accessibility. Reflected to attribute `label`.\nFalls back to `textContent` when not provided.", "fieldName": "_label", "type": { "text": "string" } }, { "name": "text", "description": "Explicit text content for the option. Reflected to attribute `text`.", "fieldName": "_text", "type": { "text": "string" } }, { "name": "value", "description": "Underlying option value (reflected to `value` attribute). Defaults to\nthe option's text content when not provided.", "fieldName": "_value", "type": { "text": "string" } }, { "name": "state-layer", "type": { "text": "boolean" }, "description": "Show the visual state layer element when true", "fieldName": "stateLayer", "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } } ], "members": [ { "name": "delegatesFocus", "kind": "field", "description": "When true, the element delegates focus to an internal focus target.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/DelegatesFocusMixin.js#L15" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "href", "kind": "field", "description": "The URL that the hyperlink points to.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L34" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "target", "kind": "field", "description": "The browsing context in which to open the linked resource (e.g. '_blank').", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L36" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "download", "kind": "field", "description": "Suggested filename for download.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L38" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "ping", "kind": "field", "description": "URLs to be pinged when the link is followed.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L40" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "rel", "kind": "field", "description": "Link relationship tokens (e.g. 'noopener', 'noreferrer').", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L42" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "hreflang", "kind": "field", "description": "Language of the linked resource.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L44" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "referrerPolicy", "kind": "field", "description": "Referrer policy for the link (serialized to 'referrerpolicy' attribute).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L46" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "origin", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L49" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "protocol", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L50" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "username", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L51" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "password", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L52" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "host", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L53" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "hostname", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L54" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "port", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L55" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "pathname", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L56" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "search", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L57" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "hash", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L58" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "readAriaProperty", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/AriaReflectorMixin.js#L28" }, "type": { "text": "(name: \"shadowRoot\" | \"ariaActiveDescendantElement\" | \"ariaAtomic\" | \"ariaAutoComplete\" | \"ariaBrailleLabel\" | \"ariaBrailleRoleDescription\" | \"ariaBusy\" | \"ariaChecked\" | \"ariaColCount\" | \"ariaColIndex\" | \"ariaColIndexText\" | \"ariaColSpan\" | \"ariaControlsElements\" | \"ariaCurrent\" | \"ariaDescribedByElements\" | \"ariaDescription\" | \"ariaDetailsElements\" | \"ariaDisabled\" | \"ariaErrorMessageElements\" | \"ariaExpanded\" | \"ariaFlowToElements\" | \"ariaHasPopup\" | \"ariaHidden\" | \"ariaInvalid\" | \"ariaKeyShortcuts\" | \"ariaLabel\" | \"ariaLabelledByElements\" | \"ariaLevel\" | \"ariaLive\" | \"ariaModal\" | \"ariaMultiLine\" | \"ariaMultiSelectable\" | \"ariaOrientation\" | \"ariaOwnsElements\" | \"ariaPlaceholder\" | \"ariaPosInSet\" | \"ariaPressed\" | \"ariaReadOnly\" | \"ariaRelevant\" | \"ariaRequired\" | \"ariaRoleDescription\" | \"ariaRowCount\" | \"ariaRowIndex\" | \"ariaRowIndexText\" | \"ariaRowSpan\" | \"ariaSelected\" | \"ariaSetSize\" | \"ariaSort\" | \"ariaValueMax\" | \"ariaValueMin\" | \"ariaValueNow\" | \"ariaValueText\" | \"role\") => string | Element | ShadowRoot | readonly Element[]" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "updateAriaProperty", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/AriaReflectorMixin.js#L47" }, "type": { "text": ">(name: K, value: ARIAMixin[K]) => void" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "disabled", "kind": "field", "description": "Whether the element is disabled (affects interactive states)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L14" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "focused", "kind": "field", "description": "Force focus state (independent of document)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L16" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "hovered", "kind": "field", "description": "Force hover state (independent of interaction)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L18" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "pressed", "kind": "field", "description": "Force pressed state (independent of interaction)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L20" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "disabledState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/ListOption.js#L78" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "hoveredState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L38" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "focusedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L39" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "pressedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L40" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "touchedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L41" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "pointedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L44" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "stateTargetElement", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L50" }, "type": { "text": "HTMLElement" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "addRipple", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/RippleMixin.js#L37" }, "type": { "text": "(x?: number, y?: number, hold?: boolean) => CustomElement & { hadRippleHeld: boolean; hadRippleReleased: boolean; rippleStarted: boolean; } & { rippleState: string; keepAlive: boolean; _positionX: number; _positionY: number; _radius: number; holdRipple: boolean; } & { _positionStyle: ElementStylerOptions | { styles: { minHeight: string; minWidth: string; boxShadow: string; top: string; left: string; }; }; } & { updatePosition(x?: number, y?: number, size?: number): void; handleRippleComplete(): void; }" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "color", "kind": "field", "description": "Palette or surface token used to select background/ink tokens.\nExamples: 'primary', 'background', 'surface-container-low'.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L52" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "ink", "kind": "field", "description": "Explicit ink override token (e.g. 'outline', 'on-primary', 'inverse-on-surface', 'inherit').\nMaps to `--mdw-ink`.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L57" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "typeStyle", "kind": "field", "description": "Typographic style shortcut that maps to type scale variables\n(e.g. 'headline-large', 'body-medium').", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L62" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "selected", "kind": "field", "description": "Selection state for the item.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/ListOption.js#L65" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "isInteractive", "kind": "field", "description": "Whether this option behaves as an interactive selectable item.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/ListOption.js#L30" }, "type": { "text": "(() => boolean) & boolean" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "computedIconVariation", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/ListOption.js#L142" }, "type": { "text": "(() => string) & (() => string)" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "defaultSelected", "kind": "field", "description": "Initial/default selection state (reflected to `selected` attribute).\nUse `selected` property to control runtime selection.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/ListOption.js#L50" }, "type": { "text": "boolean" } }, { "name": "index", "kind": "field", "description": "Numeric index of the option inside the parent listbox.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/ListOption.js#L85" }, "type": { "text": "number" } }, { "name": "form", "kind": "field", "description": "Associated form owner (if any) for form-associated behavior.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/ListOption.js#L88" }, "type": { "text": "HTMLFormElement" } }, { "name": "text", "kind": "field", "description": "Text content for the option; setting updates the internal `_text` field.\nIf not provided, the getter falls back to element textContent.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/ListOption.js#L94" }, "type": { "text": "string" } }, { "name": "label", "kind": "field", "description": "Accessible label for the option. Falls back to `text` or the element\ncontent when not explicitly set.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/ListOption.js#L107" }, "type": { "text": "string" } }, { "name": "value", "kind": "field", "description": "Option `value` used when the option is selected in a form. Defaults to\nthe option's text when not explicitly defined.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/ListOption.js#L119" }, "type": { "text": "string" } }, { "name": "formDisabledCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/ListOption.js#L127" }, "type": { "text": "(formDisabled: boolean) => void" } }, { "name": "anchorAriaLabelledBy", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/ListOption.js#L136" }, "type": { "text": "() => string" } }, { "name": "anchorAriaDescribedBy", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/ListOption.js#L139" }, "type": { "text": "() => string" } }, { "name": "prototype", "kind": "field", "static": true, "type": { "text": "CustomElement" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "stateLayer", "kind": "field", "description": "Show the visual state layer element when true\nWhen true, draw the Material state layer for interactive feedback.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/ListItem.js#L33" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "leading", "kind": "field", "description": "Leading slot content or shorthand string.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/ListItem.js#L37" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "avatar", "kind": "field", "description": "Avatar label or shorthand content for a leading avatar.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/ListItem.js#L40" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "avatarColor", "kind": "field", "description": "Color token used for the avatar container (default: primary-container).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/ListItem.js#L43" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "avatarSrc", "kind": "field", "description": "Image source for the avatar.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/ListItem.js#L46" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "src", "kind": "field", "description": "Image source URL for a leading image in the list item.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/ListItem.js#L49" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "alt", "kind": "field", "description": "Alt text for the leading image.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/ListItem.js#L52" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "icon", "kind": "field", "description": "Icon name for a leading icon.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/ListItem.js#L55" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "iconInk", "kind": "field", "description": "Ink/color token used for the leading icon.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/ListItem.js#L58" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "iconSrc", "kind": "field", "description": "External image/SVG source for the leading icon.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/ListItem.js#L61" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "iconVariation", "kind": "field", "description": "Icon variation (e.g., 'filled').", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/ListItem.js#L64" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "checkbox", "kind": "field", "description": "Checkbox shorthand name or placement class for a selectable leading checkbox.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/ListItem.js#L67" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "radio", "kind": "field", "description": "Radio shorthand name or placement class for a selectable leading radio.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/ListItem.js#L70" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "selectionColor", "kind": "field", "description": "Selection color token used when item is selected (default: primary).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/ListItem.js#L73" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "supporting", "kind": "field", "description": "Supporting text (secondary line) for the list item.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/ListItem.js#L400" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "trailing", "kind": "field", "description": "Trailing text slot or shorthand.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/ListItem.js#L82" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "trailingIcon", "kind": "field", "description": "Trailing icon name.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/ListItem.js#L85" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "trailingIconInk", "kind": "field", "description": "Ink/color token for the trailing icon.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/ListItem.js#L88" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "trailingIconSrc", "kind": "field", "description": "External image/SVG source for the trailing icon.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/ListItem.js#L91" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "divider", "kind": "field", "description": "Divider style identifier (e.g., 'inset').", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/ListItem.js#L94" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "video", "kind": "field", "description": "If true, indicates the list item contains video content and adjusts layout.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/ListItem.js#L97" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "lines", "kind": "field", "description": "Number of text lines the item should reserve for content (integer).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/ListItem.js#L100" }, "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "hasSupporting", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/ListItem.js#L116" }, "return": { "type": { "text": "() => boolean" } }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "checkboxClass", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/ListItem.js#L119" }, "return": { "type": { "text": "() => string" } }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "radioClass", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/ListItem.js#L122" }, "return": { "type": { "text": "() => string" } }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "compose", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L145" }, "type": { "text": "(parts: CompositionPart[]) => Composition" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "#refsProxy", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1145" }, "type": { "text": "Record" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "#refsCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1148" }, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "#refsCompositionCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1151" }, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "#composition", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1154" }, "type": { "text": "Composition" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "#patching", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1156" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "#pendingPatchRenders", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1159" }, "type": { "text": "[string, any, CustomElement][]" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "#propAttributeCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1162" }, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "#callbackArguments", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1165" }, "type": { "text": "CallbackArguments" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "elementInternals", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1172" }, "type": { "text": "ElementInternals" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "render", "kind": "field", "description": "Updates nodes based on data\nExpects data in JSON Merge Patch format", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1185" }, "type": { "text": "RenderDraw" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "propChangedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1213" }, "type": { "text": "(this: T, name: K, oldValue: K extends keyof T ? T[K] : unknown, newValue: K extends keyof T ? T[K] : unknown, changes?: K extends keyof T ? T[K] extends object ? Partial : T[K] : unknown) => void" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "attributeChangedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1234" }, "type": { "text": "(name: string, oldValue: string, newValue: string) => void" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "#template", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1284" }, "type": { "text": "DocumentFragment" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "#onObserverPropertyChanged", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1294" }, "type": { "text": "(name: string, oldValue: any, newValue: any, changes: any) => void" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "static", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1330" }, "type": { "text": "typeof CustomElement" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "patch", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1333" }, "type": { "text": "(patch: any) => void" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "refs", "kind": "field", "description": "Proxy object that returns shadow DOM elements by tag.\nIf called before interpolation (eg: on composed), returns from template", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1404" }, "type": { "text": "Record" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "attributeCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1391" }, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "callbackArguments", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1400" }, "type": { "text": "CallbackArguments | { composition: Composition; refs: Record; html: any; inline: (fn: (data: Partial) => any) => string; template: DocumentFragment; element: T; }" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "composition", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1403" }, "type": { "text": "Composition" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "connectedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1435" }, "type": { "text": "() => void" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "disconnectedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1441" }, "type": { "text": "() => void" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "elementName", "kind": "field", "static": true, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "observedAttributes", "kind": "field", "static": true, "type": { "text": "Iterable" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "interpolatesTemplate", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "supportsElementInternals", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "supportsElementInternalsRole", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "defined", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "registrations", "kind": "field", "static": true, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "expressions", "kind": "method", "static": true, "description": "Expressions are idempotent functions that are selectively called whenever\na render is requested.\nExpressions are constructed exactly as methods though differ in expected\narguments. The first argument should be destructured to ensure each used\nproperty is accessed at least once in order to inspect used properties.\n\nThe Composition API will inspect this function with a proxy for `this` to\ncatalog what observables are used by the expression. This allows the\nComposition API to build a cache as well as selective invoke the expression\nonly when needed.\n\nWhen used with in element templates, the element itself will be passed as\nits first argument.\n````js\n Button\n .prop('filled', 'boolean')\n .prop('outlined', 'boolean')\n .expresssions({\n _isFilledOrOutlined({filled, outlined}) {\n return (filled || outlined)\n },\n })\n .html`
`;\n````\n\nWhen used with external data source, that data source\nwill be passed to the expression with all properties being `null` at first\ninspection.\n````js\n const externalData = {first: 'John', last: 'Doe'};\n ContactCard\n .expresssions({\n _fullName({first, last}) {\n return [first, last].filter(Boolean).join(' ');\n },\n })\n myButton.render(externalData);\n````\n\nExpressions may be support argumentless calls by using default\nparameters with `this`.\n````js\n Button\n .expresssions({\n isFilledOrOutlined({filled, outlined} = this) {\n return (filled || outlined)\n },\n });\n myButton.isFilledorOutlined();\n````", "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends { [K in keyof any]: K extends `_${any}` ? ((data: INSTANCE, state?: Record) => string | boolean | null) : ((data?: INSTANCE, state?: Record) => string | boolean | null); } & ThisType>(this: CLASS, expressions: PROPS & ThisType) => CLASS & Class<{ [K in keyof PROPS]: K extends `_${any}` ? never : () => ReturnType; }, ARGS>" } }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "methods", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "overrides", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends Partial>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "props", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "idl", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "append", "kind": "field", "static": true, "description": "Append parts to composition", "type": { "text": "(this: T, ...parts: CompositionPart[]) => T" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "recompose", "kind": "field", "static": true, "description": "After composition, invokes callback.\nMay be called multiple times.", "type": { "text": ", T3 extends CompositionCallback[\"composed\"]>(this: T1, callback: T3) => T1" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "css", "kind": "field", "static": true, "description": "Appends styles to composition", "type": { "text": "(this: T1, array: T2, ...rest: T2 extends string ? any : T2 extends TemplateStringsArray ? any[] : (HTMLStyleElement | CSSStyleSheet)[]) => T1" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "autoRegister", "kind": "field", "static": true, "description": "Registers class with customElements. If class is registered before then,\ndoes nothing.", "type": { "text": "(this: T, elementName: string) => T" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "html", "kind": "field", "static": true, "description": "Appends DocumentFragment to composition", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1405" }, "type": { "text": "(this: T, string: TemplateStringsArray, ...substitutions: (string | Element | ((this: InstanceType, data: InstanceType, injections?: any) => any))[]) => T" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "extend", "kind": "field", "static": true, "description": "Extends base class into a new class.\nUse to avoid mutating base class.", "type": { "text": " T2>(this: T1, customExtender?: T3) => T3 extends null ? T1 : T2" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "setStatic", "kind": "field", "static": true, "description": "Assigns static values to class", "type": { "text": " any) | string | number | boolean | any[] | object); }>(this: T1, source: T2 & ThisType) => T1 & T2" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "readonly", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "set", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "mixin", "kind": "field", "static": true, "description": "Returns result of calling mixin with current class", "type": { "text": " any, RETURN extends ReturnType, SUBCLASS extends ClassOf>(this: BASE, mixin: FN) => SUBCLASS & BASE" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "register", "kind": "field", "static": true, "description": "Registers class with window.customElements synchronously", "type": { "text": "(this: T, elementName?: string, force?: boolean) => T" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "propList", "kind": "field", "static": true, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "attrList", "kind": "field", "static": true, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "propChangedCallbacks", "kind": "field", "static": true, "type": { "text": "Map any)[]>" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "attributeChangedCallbacks", "kind": "field", "static": true, "type": { "text": "Map any)[]>" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "prop", "kind": "field", "static": true, "description": "Creates observable property on instances (via prototype)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1007" }, "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "setPrototype", "kind": "field", "static": true, "description": "Creates observable property on instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any)>(this: CLASS, name: KEY, options: OPTIONS) => OPTIONS extends (...args2: any[]) => infer R ? R : OPTIONS extends ObserverPropertyType ? ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? unknown extends R ? object : R : OPTIONS extends { type: ObserverPropertyType; } ? ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? unknown extends R ? string : R : never" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "define", "kind": "field", "static": true, "description": "Define properties on instances via Object.defineProperties().\nAutomatically sets property non-enumerable if name begins with `_`.\nFunctions will be remapped as getters", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends { [P in keyof any]: { enumerable?: boolean; configurable?: boolean; writable?: boolean; value?: any; get?: ((this: INSTANCE) => any); set?: (this: INSTANCE, value: any) => void; } | ((this: INSTANCE, ...args: any[]) => any); }, VALUE extends { [KEY in keyof PROPS]: PROPS[KEY] extends (...args2: any[]) => infer R ? R : PROPS[KEY] extends TypedPropertyDescriptor ? R : never; }>(this: CLASS, props: PROPS & ThisType) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "undefine", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROP extends string, PROPS extends INSTANCE & Record>(this: CLASS, name: PROP) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "observe", "kind": "field", "static": true, "description": "Creates observable properties on instances", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends IDLParameter, VALUE extends { [KEY in keyof PROPS]: PROPS[KEY] extends (...args2: any[]) => infer R ? R : PROPS[KEY] extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : PROPS[KEY] extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : PROPS[KEY] extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : PROPS[KEY] extends ObserverOptions ? (unknown extends R ? string : R) : never; }>(this: CLASS, props: PROPS) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "defineStatic", "kind": "field", "static": true, "type": { "text": ">(this: T1, props: T2) => T1 & ParsedProps" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "events", "kind": "field", "static": true, "type": { "text": "(this: T, listeners?: CompositionEventListenerObject>, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "childEvents", "kind": "field", "static": true, "type": { "text": "(this: T, listenerMap: { [x: string]: CompositionEventListenerObject>; }, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "rootEvents", "kind": "field", "static": true, "type": { "text": "(this: T, listeners?: CompositionEventListenerObject>, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "on", "kind": "field", "static": true, "type": { "text": ", T3 extends CompositionCallback, T4 extends keyof T3>(this: T1, name: T3 | T4, callbacks?: T3[T4] & ThisType) => T1" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "off", "kind": "field", "static": true, "type": { "text": ", T3 extends CompositionCallback, T4 extends keyof T3>(this: T1, name: T3 | T4, callbacks?: T3[T4] & ThisType) => T1" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "offPropChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: ObjectOrObjectEntries<{ [P in keyof T2]?: (this: T2, oldValue: T2[P], newValue: T2[P], changes: any, element: T2) => void; }>) => T1" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "offAttributeChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: { [x: string]: (this: T2, oldValue: string, newValue: string, element: T2) => void; }) => T1" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "onPropChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: ObjectOrObjectEntries<{ [P in keyof T2]?: (this: T2, oldValue: T2[P], newValue: T2[P], changes: any, element: T2) => void; }>) => T1" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } }, { "name": "onAttributeChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: { [x: string]: (this: T2, oldValue: string, newValue: string, element: T2) => void; }) => T1" }, "inheritedFrom": { "name": "default", "module": "components/ListItem.js" } } ], "slots": [ { "name": "leading", "description": "{leading}" }, { "name": "", "description": "" }, { "name": "supporting", "description": "{supporting}" }, { "name": "trailing", "description": "{trailing}" } ], "cssParts": [], "events": [], "demos": [], "superclass": { "module": "components/ListItem.js", "name": "default" }, "mixins": [ { "module": "mixins/DelegatesFocusMixin.js", "name": "default" } ], "description": "List options represent selectable choices within a `mdw-listbox` or list.\n@see https://m3.material.io/components/lists/specs" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "default", "module": "components/ListOption.js" } }, { "kind": "custom-element-definition", "name": "mdw-list-option", "declaration": { "name": "default", "module": "components/ListOption.js" } } ] }, { "kind": "javascript-module", "path": "components/Listbox.js", "declarations": [ { "kind": "class", "name": "Listbox", "tagName": "mdw-listbox", "customElement": true, "attributes": [ { "name": "ink", "fieldName": "ink", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/List.js" } }, { "name": "type-style", "fieldName": "typeStyle", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/List.js" } }, { "name": "block", "fieldName": "block", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/List.js" } }, { "name": "inline", "fieldName": "inline", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/List.js" } }, { "name": "row", "fieldName": "row", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/List.js" } }, { "name": "x", "fieldName": "x", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/List.js" } }, { "name": "y", "fieldName": "y", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/List.js" } }, { "name": "gap", "fieldName": "gap", "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "components/List.js" } }, { "name": "padding", "fieldName": "padding", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/List.js" } }, { "name": "density", "fieldName": "density", "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "components/List.js" } }, { "name": "disabled", "fieldName": "disabled", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "focused", "fieldName": "focused", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "hovered", "fieldName": "hovered", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "pressed", "fieldName": "pressed", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "state-layer", "fieldName": "stateLayer", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "aria-controls", "fieldName": "ariaControls", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/FormAssociatedMixin.js" } }, { "name": "autocomplete", "fieldName": "autocomplete", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/FormAssociatedMixin.js" } }, { "name": "name", "fieldName": "name", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/FormAssociatedMixin.js" } }, { "name": "readonly", "fieldName": "readOnly", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/FormAssociatedMixin.js" } }, { "name": "formnovalidate", "fieldName": "formNoValidate", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/FormAssociatedMixin.js" } }, { "name": "checked", "fieldName": "defaultChecked", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/FormAssociatedMixin.js" } }, { "name": "required", "fieldName": "required", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/FormAssociatedMixin.js" } }, { "name": "value", "fieldName": "_defaultValue", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/FormAssociatedMixin.js" } }, { "name": "kbd-nav", "fieldName": "kbdNav", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/KeyboardNavMixin.js" } }, { "name": "multiple", "description": "When true, multiple options may be selected (select-multiple semantics).", "fieldName": "multiple", "type": { "text": "boolean" } }, { "name": "size", "description": "Visible size (number of rows) for the listbox; 0 means auto.", "fieldName": "size", "type": { "text": "number" } }, { "name": "type", "type": { "text": "string" }, "fieldName": "type", "inheritedFrom": { "name": "default", "module": "mixins/FormAssociatedMixin.js" } }, { "name": "color", "fieldName": "color", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/List.js" } } ], "members": [ { "name": "delegatesFocus", "kind": "field", "description": "When true, the element delegates focus to an internal focus target.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/DelegatesFocusMixin.js#L15" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/List.js" } }, { "name": "kbdNav", "kind": "field", "description": "Enable keyboard roving navigation when present (set to 'true').", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/KeyboardNavMixin.js#L23" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/KeyboardNavMixin.js" } }, { "name": "kbdNavQuery", "kind": "field", "description": "Query used to find roving tab index children\nQuery selector used by keyboard navigation mixin to find focusable options.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Listbox.js#L81" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/KeyboardNavMixin.js" } }, { "name": "kbdNavFocusableWhenDisabled", "kind": "field", "description": "Flag whether disabled elements participating in roving tab index\nshould be focusable.\nAllow keyboard navigation to focus disabled options in some patterns.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Listbox.js#L84" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/KeyboardNavMixin.js" } }, { "name": "ariaOrientationDefault", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/KeyboardNavMixin.js#L41" }, "type": { "text": "\"horizontal\" | \"vertical\"" }, "inheritedFrom": { "name": "default", "module": "mixins/KeyboardNavMixin.js" } }, { "name": "kbdNavChildren", "kind": "field", "description": "List of roving tab index participating children", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/KeyboardNavMixin.js#L48" }, "type": { "text": "NodeListOf" }, "inheritedFrom": { "name": "default", "module": "mixins/KeyboardNavMixin.js" } }, { "name": "disabled", "kind": "field", "description": "Whether the element is disabled (affects interactive states)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L14" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "focused", "kind": "field", "description": "Force focus state (independent of document)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L16" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "hovered", "kind": "field", "description": "Force hover state (independent of interaction)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L18" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "pressed", "kind": "field", "description": "Force pressed state (independent of interaction)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L20" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "stateLayer", "kind": "field", "description": "Show the visual state layer element when true", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L34" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "disabledState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L171" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "hoveredState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L38" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "focusedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L39" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "pressedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L40" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "touchedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L41" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "pointedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L44" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "stateTargetElement", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L50" }, "type": { "text": "HTMLElement" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "ariaControls", "kind": "field", "description": "ARIA 'controls' attribute (string).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L32" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/FormAssociatedMixin.js" } }, { "name": "autocomplete", "kind": "field", "description": "Autocomplete token for the associated control (string).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L34" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/FormAssociatedMixin.js" } }, { "name": "name", "kind": "field", "description": "Name attribute for the control used in forms.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L36" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/FormAssociatedMixin.js" } }, { "name": "readOnly", "kind": "field", "description": "Read-only state reflected to control via 'readonly' attribute.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L38" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/FormAssociatedMixin.js" } }, { "name": "formNoValidate", "kind": "field", "description": "When true, form validation is skipped for this control (formnovalidate).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L40" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/FormAssociatedMixin.js" } }, { "name": "defaultChecked", "kind": "field", "description": "Default checked state for checkable controls (checkbox/radio).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L42" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/FormAssociatedMixin.js" } }, { "name": "required", "kind": "field", "description": "Whether the control is required for form submission.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L47" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/FormAssociatedMixin.js" } }, { "name": "type", "kind": "field", "description": "Control type token (e.g. 'text','checkbox','radio','file').\nReturns the control type string compatible with `input`/`select` semantics.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Listbox.js#L26" }, "type": { "text": "\"select-multiple\" | \"select-one\"" }, "inheritedFrom": { "name": "default", "module": "mixins/FormAssociatedMixin.js" } }, { "name": "erroredState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L65" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/FormAssociatedMixin.js" } }, { "name": "defaultValue", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L66" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/FormAssociatedMixin.js" } }, { "name": "value", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Listbox.js#L107" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/FormAssociatedMixin.js" } }, { "name": "checked", "kind": "field", "description": "Part of FormAssociatedMixin for simplicity.\nEnumerability doesn't guarantee checked state will be passed or used.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L145" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/FormAssociatedMixin.js" } }, { "name": "form", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L160" }, "type": { "text": "HTMLFormElement" }, "inheritedFrom": { "name": "default", "module": "mixins/FormAssociatedMixin.js" } }, { "name": "validity", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L161" }, "type": { "text": "ValidityState" }, "inheritedFrom": { "name": "default", "module": "mixins/FormAssociatedMixin.js" } }, { "name": "validationMessage", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L162" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/FormAssociatedMixin.js" } }, { "name": "willValidate", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L163" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/FormAssociatedMixin.js" } }, { "name": "labels", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L168" }, "type": { "text": "NodeList" }, "inheritedFrom": { "name": "default", "module": "mixins/FormAssociatedMixin.js" } }, { "name": "density", "kind": "field", "description": "Density level affecting spacing and compactness. Integer from -4 (dense) to 4 (spacious).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/DensityMixin.js#L9" }, "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "components/List.js" } }, { "name": "block", "kind": "field", "description": "Set `display: block` on the host (boolean)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js#L9" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/List.js" } }, { "name": "inline", "kind": "field", "description": "Use inline flex layout: `display: inline-flex` (boolean)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js#L11" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/List.js" } }, { "name": "row", "kind": "field", "description": "Switch main axis to horizontal: `flex-direction: row` (boolean)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js#L13" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/List.js" } }, { "name": "x", "kind": "field", "description": "Main-axis alignment / justification.\nAllowed: 'start'|'center'|'end'|'between'|'around'|'stretch'|'baseline'.\nDefault: 'start'.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js#L19" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/List.js" } }, { "name": "y", "kind": "field", "description": "Cross-axis alignment / alignment of items.\nSame allowed values as `x`. Default: 'start'.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js#L29" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/List.js" } }, { "name": "gap", "kind": "field", "description": "Gap between children. Accepts preset numeric strings (e.g. '8') mapped to px, or floats.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js#L36" }, "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "components/List.js" } }, { "name": "padding", "kind": "field", "description": "Padding preset or numeric value (e.g. 'pane', '8', '16').", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js#L38" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/List.js" } }, { "name": "ink", "kind": "field", "description": "Explicit ink override token (e.g. 'outline', 'on-primary', 'inverse-on-surface', 'inherit').\nMaps to `--mdw-ink`.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L57" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/List.js" } }, { "name": "typeStyle", "kind": "field", "description": "Typographic style shortcut that maps to type scale variables\n(e.g. 'headline-large', 'body-medium').", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L62" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/List.js" } }, { "name": "multiple", "kind": "field", "description": "When true, multiple options may be selected (select-multiple semantics).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Listbox.js#L23" }, "type": { "text": "boolean" } }, { "name": "size", "kind": "field", "description": "Visible size (number of rows) for the listbox; 0 means auto.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Listbox.js#L26" }, "type": { "text": "number" } }, { "name": "options", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Listbox.js#L49" }, "type": { "text": "HTMLCollectionOf; } & { readAriaProperty(name: \"shadowRoot\" | \"ariaActiveDescendantElement\" | \"ariaAtomic\" | \"ariaAutoComplete\" | \"ariaBrailleLabel\" | \"ariaBrailleRoleDescription\" | \"ariaBusy\" | \"ariaChecked\" | \"ariaColCount\" | \"ariaColIndex\" | \"ariaColIndexText\" | \"ariaColSpan\" | \"ariaControlsElements\" | \"ariaCurrent\" | \"ariaDescribedByElements\" | \"ariaDescription\" | \"ariaDetailsElements\" | \"ariaDisabled\" | \"ariaErrorMessageElements\" | \"ariaExpanded\" | \"ariaFlowToElements\" | \"ariaHasPopup\" | \"ariaHidden\" | \"ariaInvalid\" | \"ariaKeyShortcuts\" | \"ariaLabel\" | \"ariaLabelledByElements\" | \"ariaLevel\" | \"ariaLive\" | \"ariaModal\" | \"ariaMultiLine\" | \"ariaMultiSelectable\" | \"ariaOrientation\" | \"ariaOwnsElements\" | \"ariaPlaceholder\" | \"ariaPosInSet\" | \"ariaPressed\" | \"ariaReadOnly\" | \"ariaRelevant\" | \"ariaRequired\" | \"ariaRoleDescription\" | \"ariaRowCount\" | \"ariaRowIndex\" | \"ariaRowIndexText\" | \"ariaRowSpan\" | \"ariaSelected\" | \"ariaSetSize\" | \"ariaSort\" | \"ariaValueMax\" | \"ariaValueMin\" | \"ariaValueNow\" | \"ariaValueText\" | \"role\"): string | Element | ShadowRoot | readonly Element[]; updateAriaProperty>(name: K, value: ARIAMixin[K]): void; } & { disabled: boolean; focused: boolean; hovered: boolean; pressed: boolean; _lastInteraction: \"mouse\" | \"touch\" | \"key\" | \"pen\"; _hovered: boolean; _focused: boolean; _focusedSynthetic: boolean; _keyPressed: boolean; _keyReleased: boolean; _pointerPressed: boolean; stateLayer: boolean; } & { disabledState: boolean; hoveredState: boolean; focusedState: boolean; pressedState: boolean; touchedState: boolean; pointedState: boolean; } & { stateTargetElement: HTMLElement; } & { _lastRippleWeakRef: WeakRef; _rippleAdded: boolean; } & { _lastRipple: CustomElement & { hadRippleHeld: boolean; hadRippleReleased: boolean; rippleStarted: boolean; } & { rippleState: string; keepAlive: boolean; _positionX: number; _positionY: number; _radius: number; holdRipple: boolean; } & { _positionStyle: ElementStylerOptions | { styles: { minHeight: string; minWidth: string; boxShadow: string; top: string; left: string; }; }; } & { updatePosition(x?: number, y?: number, size?: number): void; handleRippleComplete(): void; }; } & { addRipple(x?: number, y?: number, hold?: boolean): CustomElement & { hadRippleHeld: boolean; hadRippleReleased: boolean; rippleStarted: boolean; } & { rippleState: string; keepAlive: boolean; _positionX: number; _positionY: number; _radius: number; holdRipple: boolean; } & { _positionStyle: ElementStylerOptions | { styles: { minHeight: string; minWidth: string; boxShadow: string; top: string; left: string; }; }; } & { updatePosition(x?: number, y?: number, size?: number): void; handleRippleComplete(): void; }; } & { color: string; ink: string; typeStyle: string; } & { _ariaRole: string; stateLayer: boolean; } & { leading: string; avatar: string; avatarColor: string; avatarSrc: string; src: string; alt: string; icon: string; iconInk: string; iconSrc: string; iconVariation: string; checkbox: string; radio: string; selectionColor: string; selected: boolean; supporting: string; trailing: string; trailingIcon: string; trailingIconInk: string; trailingIconSrc: string; divider: string; video: boolean; lines: number; _supportingSlotted: boolean; } & { disabledState: boolean; } & { isInteractive: () => boolean; hasSupporting: () => boolean; checkboxClass: () => string; radioClass: () => string; computedIconVariation: () => string; } & { _ariaRole: string; _index: number; _selectedDirty: boolean; isInteractive: boolean; } & { _label: string; _text: string; defaultSelected: boolean; _selected: boolean; _value: string; _formDisabled: boolean; } & { selected: boolean; disabledState: boolean; } & { index: number; form: HTMLFormElement; text: string; label: string; value: string; } & { formDisabledCallback(formDisabled: boolean): void; focus(options?: FocusOptions): void; } & { anchorAriaLabelledBy: () => string; anchorAriaDescribedBy: () => string; computedIconVariation: () => string; }> & HTMLOptionsCollection" } }, { "name": "selectedOptions", "kind": "field", "description": "Returns a live HTMLCollection of selected `mdw-list-option` elements.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Listbox.js#L68" }, "type": { "text": "HTMLCollectionOf; } & { readAriaProperty(name: \"shadowRoot\" | \"ariaActiveDescendantElement\" | \"ariaAtomic\" | \"ariaAutoComplete\" | \"ariaBrailleLabel\" | \"ariaBrailleRoleDescription\" | \"ariaBusy\" | \"ariaChecked\" | \"ariaColCount\" | \"ariaColIndex\" | \"ariaColIndexText\" | \"ariaColSpan\" | \"ariaControlsElements\" | \"ariaCurrent\" | \"ariaDescribedByElements\" | \"ariaDescription\" | \"ariaDetailsElements\" | \"ariaDisabled\" | \"ariaErrorMessageElements\" | \"ariaExpanded\" | \"ariaFlowToElements\" | \"ariaHasPopup\" | \"ariaHidden\" | \"ariaInvalid\" | \"ariaKeyShortcuts\" | \"ariaLabel\" | \"ariaLabelledByElements\" | \"ariaLevel\" | \"ariaLive\" | \"ariaModal\" | \"ariaMultiLine\" | \"ariaMultiSelectable\" | \"ariaOrientation\" | \"ariaOwnsElements\" | \"ariaPlaceholder\" | \"ariaPosInSet\" | \"ariaPressed\" | \"ariaReadOnly\" | \"ariaRelevant\" | \"ariaRequired\" | \"ariaRoleDescription\" | \"ariaRowCount\" | \"ariaRowIndex\" | \"ariaRowIndexText\" | \"ariaRowSpan\" | \"ariaSelected\" | \"ariaSetSize\" | \"ariaSort\" | \"ariaValueMax\" | \"ariaValueMin\" | \"ariaValueNow\" | \"ariaValueText\" | \"role\"): string | Element | ShadowRoot | readonly Element[]; updateAriaProperty>(name: K, value: ARIAMixin[K]): void; } & { disabled: boolean; focused: boolean; hovered: boolean; pressed: boolean; _lastInteraction: \"mouse\" | \"touch\" | \"key\" | \"pen\"; _hovered: boolean; _focused: boolean; _focusedSynthetic: boolean; _keyPressed: boolean; _keyReleased: boolean; _pointerPressed: boolean; stateLayer: boolean; } & { disabledState: boolean; hoveredState: boolean; focusedState: boolean; pressedState: boolean; touchedState: boolean; pointedState: boolean; } & { stateTargetElement: HTMLElement; } & { _lastRippleWeakRef: WeakRef; _rippleAdded: boolean; } & { _lastRipple: CustomElement & { hadRippleHeld: boolean; hadRippleReleased: boolean; rippleStarted: boolean; } & { rippleState: string; keepAlive: boolean; _positionX: number; _positionY: number; _radius: number; holdRipple: boolean; } & { _positionStyle: ElementStylerOptions | { styles: { minHeight: string; minWidth: string; boxShadow: string; top: string; left: string; }; }; } & { updatePosition(x?: number, y?: number, size?: number): void; handleRippleComplete(): void; }; } & { addRipple(x?: number, y?: number, hold?: boolean): CustomElement & { hadRippleHeld: boolean; hadRippleReleased: boolean; rippleStarted: boolean; } & { rippleState: string; keepAlive: boolean; _positionX: number; _positionY: number; _radius: number; holdRipple: boolean; } & { _positionStyle: ElementStylerOptions | { styles: { minHeight: string; minWidth: string; boxShadow: string; top: string; left: string; }; }; } & { updatePosition(x?: number, y?: number, size?: number): void; handleRippleComplete(): void; }; } & { color: string; ink: string; typeStyle: string; } & { _ariaRole: string; stateLayer: boolean; } & { leading: string; avatar: string; avatarColor: string; avatarSrc: string; src: string; alt: string; icon: string; iconInk: string; iconSrc: string; iconVariation: string; checkbox: string; radio: string; selectionColor: string; selected: boolean; supporting: string; trailing: string; trailingIcon: string; trailingIconInk: string; trailingIconSrc: string; divider: string; video: boolean; lines: number; _supportingSlotted: boolean; } & { disabledState: boolean; } & { isInteractive: () => boolean; hasSupporting: () => boolean; checkboxClass: () => string; radioClass: () => string; computedIconVariation: () => string; } & { _ariaRole: string; _index: number; _selectedDirty: boolean; isInteractive: boolean; } & { _label: string; _text: string; defaultSelected: boolean; _selected: boolean; _value: string; _formDisabled: boolean; } & { selected: boolean; disabledState: boolean; } & { index: number; form: HTMLFormElement; text: string; label: string; value: string; } & { formDisabledCallback(formDisabled: boolean): void; focus(options?: FocusOptions): void; } & { anchorAriaLabelledBy: () => string; anchorAriaDescribedBy: () => string; computedIconVariation: () => string; }>" } }, { "name": "length", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Listbox.js#L87" }, "type": { "text": "number" } }, { "name": "selectedIndex", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Listbox.js#L89" }, "type": { "text": "number" } }, { "name": "add", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Listbox.js#L125" }, "type": { "text": "(element: HTMLOptionElement | HTMLOptGroupElement, before?: number | HTMLElement) => void" } }, { "name": "item", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Listbox.js#L165" }, "return": { "type": { "text": "(index: number) => CustomElement & { delegatesFocus: boolean; } & { href: string; target: string; download: string; ping: string; rel: string; hreflang: string; referrerPolicy: string; } & { origin: string; protocol: string; username: string; password: string; host: string; hostname: string; port: string; pathname: string; search: string; hash: string; } & object & { _ariaRole: string; } & { _onConnectAriaValues: Map<\"ariaAtomic\" | \"ariaAutoComplete\" | \"ariaBrailleLabel\" | \"ariaBrailleRoleDescription\" | \"ariaBusy\" | \"ariaChecked\" | \"ariaColCount\" | \"ariaColIndex\" | \"ariaColIndexText\" | \"ariaColSpan\" | \"ariaCurrent\" | \"ariaDescription\" | \"ariaDisabled\" | \"ariaExpanded\" | \"ariaHasPopup\" | \"ariaHidden\" | \"ariaInvalid\" | \"ariaKeyShortcuts\" | \"ariaLabel\" | \"ariaLevel\" | \"ariaLive\" | \"ariaModal\" | \"ariaMultiLine\" | \"ariaMultiSelectable\" | \"ariaOrientation\" | \"ariaPlaceholder\" | \"ariaPosInSet\" | \"ariaPressed\" | \"ariaReadOnly\" | \"ariaRelevant\" | \"ariaRequired\" | \"ariaRoleDescription\" | \"ariaRowCount\" | \"ariaRowIndex\" | \"ariaRowIndexText\" | \"ariaRowSpan\" | \"ariaSelected\" | \"ariaSetSize\" | \"ariaSort\" | \"ariaValueMax\" | \"ariaValueMin\" | \"ariaValueNow\" | \"ariaValueText\" | \"role\", string>; } & { readAriaProperty(name: \"shadowRoot\" | \"ariaActiveDescendantElement\" | \"ariaAtomic\" | \"ariaAutoComplete\" | \"ariaBrailleLabel\" | \"ariaBrailleRoleDescription\" | \"ariaBusy\" | \"ariaChecked\" | \"ariaColCount\" | \"ariaColIndex\" | \"ariaColIndexText\" | \"ariaColSpan\" | \"ariaControlsElements\" | \"ariaCurrent\" | \"ariaDescribedByElements\" | \"ariaDescription\" | \"ariaDetailsElements\" | \"ariaDisabled\" | \"ariaErrorMessageElements\" | \"ariaExpanded\" | \"ariaFlowToElements\" | \"ariaHasPopup\" | \"ariaHidden\" | \"ariaInvalid\" | \"ariaKeyShortcuts\" | \"ariaLabel\" | \"ariaLabelledByElements\" | \"ariaLevel\" | \"ariaLive\" | \"ariaModal\" | \"ariaMultiLine\" | \"ariaMultiSelectable\" | \"ariaOrientation\" | \"ariaOwnsElements\" | \"ariaPlaceholder\" | \"ariaPosInSet\" | \"ariaPressed\" | \"ariaReadOnly\" | \"ariaRelevant\" | \"ariaRequired\" | \"ariaRoleDescription\" | \"ariaRowCount\" | \"ariaRowIndex\" | \"ariaRowIndexText\" | \"ariaRowSpan\" | \"ariaSelected\" | \"ariaSetSize\" | \"ariaSort\" | \"ariaValueMax\" | \"ariaValueMin\" | \"ariaValueNow\" | \"ariaValueText\" | \"role\"): string | Element | ShadowRoot | readonly Element[]; updateAriaProperty>(name: K, value: ARIAMixin[K]): void; } & { disabled: boolean; focused: boolean; hovered: boolean; pressed: boolean; _lastInteraction: \"mouse\" | \"touch\" | \"key\" | \"pen\"; _hovered: boolean; _focused: boolean; _focusedSynthetic: boolean; _keyPressed: boolean; _keyReleased: boolean; _pointerPressed: boolean; stateLayer: boolean; } & { disabledState: boolean; hoveredState: boolean; focusedState: boolean; pressedState: boolean; touchedState: boolean; pointedState: boolean; } & { stateTargetElement: HTMLElement; } & { _lastRippleWeakRef: WeakRef; _rippleAdded: boolean; } & { _lastRipple: CustomElement & { hadRippleHeld: boolean; hadRippleReleased: boolean; rippleStarted: boolean; } & { rippleState: string; keepAlive: boolean; _positionX: number; _positionY: number; _radius: number; holdRipple: boolean; } & { _positionStyle: ElementStylerOptions | { styles: { minHeight: string; minWidth: string; boxShadow: string; top: string; left: string; }; }; } & { updatePosition(x?: number, y?: number, size?: number): void; handleRippleComplete(): void; }; } & { addRipple(x?: number, y?: number, hold?: boolean): CustomElement & { hadRippleHeld: boolean; hadRippleReleased: boolean; rippleStarted: boolean; } & { rippleState: string; keepAlive: boolean; _positionX: number; _positionY: number; _radius: number; holdRipple: boolean; } & { _positionStyle: ElementStylerOptions | { styles: { minHeight: string; minWidth: string; boxShadow: string; top: string; left: string; }; }; } & { updatePosition(x?: number, y?: number, size?: number): void; handleRippleComplete(): void; }; } & { color: string; ink: string; typeStyle: string; } & { _ariaRole: string; stateLayer: boolean; } & { leading: string; avatar: string; avatarColor: string; avatarSrc: string; src: string; alt: string; icon: string; iconInk: string; iconSrc: string; iconVariation: string; checkbox: string; radio: string; selectionColor: string; selected: boolean; supporting: string; trailing: string; trailingIcon: string; trailingIconInk: string; trailingIconSrc: string; divider: string; video: boolean; lines: number; _supportingSlotted: boolean; } & { disabledState: boolean; } & { isInteractive: () => boolean; hasSupporting: () => boolean; checkboxClass: () => string; radioClass: () => string; computedIconVariation: () => string; } & { _ariaRole: string; _index: number; _selectedDirty: boolean; isInteractive: boolean; } & { _label: string; _text: string; defaultSelected: boolean; _selected: boolean; _value: string; _formDisabled: boolean; } & { selected: boolean; disabledState: boolean; } & { index: number; form: HTMLFormElement; text: string; label: string; value: string; } & { formDisabledCallback(formDisabled: boolean): void; focus(options?: FocusOptions): void; } & { anchorAriaLabelledBy: () => string; anchorAriaDescribedBy: () => string; computedIconVariation: () => string; }" } } }, { "name": "namedItem", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Listbox.js#L170" }, "return": { "type": { "text": "(name: string) => CustomElement & { delegatesFocus: boolean; } & { href: string; target: string; download: string; ping: string; rel: string; hreflang: string; referrerPolicy: string; } & { origin: string; protocol: string; username: string; password: string; host: string; hostname: string; port: string; pathname: string; search: string; hash: string; } & object & { _ariaRole: string; } & { _onConnectAriaValues: Map<\"ariaAtomic\" | \"ariaAutoComplete\" | \"ariaBrailleLabel\" | \"ariaBrailleRoleDescription\" | \"ariaBusy\" | \"ariaChecked\" | \"ariaColCount\" | \"ariaColIndex\" | \"ariaColIndexText\" | \"ariaColSpan\" | \"ariaCurrent\" | \"ariaDescription\" | \"ariaDisabled\" | \"ariaExpanded\" | \"ariaHasPopup\" | \"ariaHidden\" | \"ariaInvalid\" | \"ariaKeyShortcuts\" | \"ariaLabel\" | \"ariaLevel\" | \"ariaLive\" | \"ariaModal\" | \"ariaMultiLine\" | \"ariaMultiSelectable\" | \"ariaOrientation\" | \"ariaPlaceholder\" | \"ariaPosInSet\" | \"ariaPressed\" | \"ariaReadOnly\" | \"ariaRelevant\" | \"ariaRequired\" | \"ariaRoleDescription\" | \"ariaRowCount\" | \"ariaRowIndex\" | \"ariaRowIndexText\" | \"ariaRowSpan\" | \"ariaSelected\" | \"ariaSetSize\" | \"ariaSort\" | \"ariaValueMax\" | \"ariaValueMin\" | \"ariaValueNow\" | \"ariaValueText\" | \"role\", string>; } & { readAriaProperty(name: \"shadowRoot\" | \"ariaActiveDescendantElement\" | \"ariaAtomic\" | \"ariaAutoComplete\" | \"ariaBrailleLabel\" | \"ariaBrailleRoleDescription\" | \"ariaBusy\" | \"ariaChecked\" | \"ariaColCount\" | \"ariaColIndex\" | \"ariaColIndexText\" | \"ariaColSpan\" | \"ariaControlsElements\" | \"ariaCurrent\" | \"ariaDescribedByElements\" | \"ariaDescription\" | \"ariaDetailsElements\" | \"ariaDisabled\" | \"ariaErrorMessageElements\" | \"ariaExpanded\" | \"ariaFlowToElements\" | \"ariaHasPopup\" | \"ariaHidden\" | \"ariaInvalid\" | \"ariaKeyShortcuts\" | \"ariaLabel\" | \"ariaLabelledByElements\" | \"ariaLevel\" | \"ariaLive\" | \"ariaModal\" | \"ariaMultiLine\" | \"ariaMultiSelectable\" | \"ariaOrientation\" | \"ariaOwnsElements\" | \"ariaPlaceholder\" | \"ariaPosInSet\" | \"ariaPressed\" | \"ariaReadOnly\" | \"ariaRelevant\" | \"ariaRequired\" | \"ariaRoleDescription\" | \"ariaRowCount\" | \"ariaRowIndex\" | \"ariaRowIndexText\" | \"ariaRowSpan\" | \"ariaSelected\" | \"ariaSetSize\" | \"ariaSort\" | \"ariaValueMax\" | \"ariaValueMin\" | \"ariaValueNow\" | \"ariaValueText\" | \"role\"): string | Element | ShadowRoot | readonly Element[]; updateAriaProperty>(name: K, value: ARIAMixin[K]): void; } & { disabled: boolean; focused: boolean; hovered: boolean; pressed: boolean; _lastInteraction: \"mouse\" | \"touch\" | \"key\" | \"pen\"; _hovered: boolean; _focused: boolean; _focusedSynthetic: boolean; _keyPressed: boolean; _keyReleased: boolean; _pointerPressed: boolean; stateLayer: boolean; } & { disabledState: boolean; hoveredState: boolean; focusedState: boolean; pressedState: boolean; touchedState: boolean; pointedState: boolean; } & { stateTargetElement: HTMLElement; } & { _lastRippleWeakRef: WeakRef; _rippleAdded: boolean; } & { _lastRipple: CustomElement & { hadRippleHeld: boolean; hadRippleReleased: boolean; rippleStarted: boolean; } & { rippleState: string; keepAlive: boolean; _positionX: number; _positionY: number; _radius: number; holdRipple: boolean; } & { _positionStyle: ElementStylerOptions | { styles: { minHeight: string; minWidth: string; boxShadow: string; top: string; left: string; }; }; } & { updatePosition(x?: number, y?: number, size?: number): void; handleRippleComplete(): void; }; } & { addRipple(x?: number, y?: number, hold?: boolean): CustomElement & { hadRippleHeld: boolean; hadRippleReleased: boolean; rippleStarted: boolean; } & { rippleState: string; keepAlive: boolean; _positionX: number; _positionY: number; _radius: number; holdRipple: boolean; } & { _positionStyle: ElementStylerOptions | { styles: { minHeight: string; minWidth: string; boxShadow: string; top: string; left: string; }; }; } & { updatePosition(x?: number, y?: number, size?: number): void; handleRippleComplete(): void; }; } & { color: string; ink: string; typeStyle: string; } & { _ariaRole: string; stateLayer: boolean; } & { leading: string; avatar: string; avatarColor: string; avatarSrc: string; src: string; alt: string; icon: string; iconInk: string; iconSrc: string; iconVariation: string; checkbox: string; radio: string; selectionColor: string; selected: boolean; supporting: string; trailing: string; trailingIcon: string; trailingIconInk: string; trailingIconSrc: string; divider: string; video: boolean; lines: number; _supportingSlotted: boolean; } & { disabledState: boolean; } & { isInteractive: () => boolean; hasSupporting: () => boolean; checkboxClass: () => string; radioClass: () => string; computedIconVariation: () => string; } & { _ariaRole: string; _index: number; _selectedDirty: boolean; isInteractive: boolean; } & { _label: string; _text: string; defaultSelected: boolean; _selected: boolean; _value: string; _formDisabled: boolean; } & { selected: boolean; disabledState: boolean; } & { index: number; form: HTMLFormElement; text: string; label: string; value: string; } & { formDisabledCallback(formDisabled: boolean): void; focus(options?: FocusOptions): void; } & { anchorAriaLabelledBy: () => string; anchorAriaDescribedBy: () => string; computedIconVariation: () => string; }" } } }, { "name": "onListboxClick", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Listbox.js#L179" }, "return": { "type": { "text": "(event: Event) => void" } } }, { "name": "prototype", "kind": "field", "static": true, "type": { "text": "CustomElement" }, "inheritedFrom": { "name": "default", "module": "components/List.js" } }, { "name": "checkValidity", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L177" }, "return": { "type": { "text": "() => boolean" } }, "inheritedFrom": { "name": "default", "module": "mixins/FormAssociatedMixin.js" } }, { "name": "reportValidity", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L179" }, "return": { "type": { "text": "() => boolean" } }, "inheritedFrom": { "name": "default", "module": "mixins/FormAssociatedMixin.js" } }, { "name": "setCustomValidity", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L185" }, "return": { "type": { "text": "(error: string) => void" } }, "inheritedFrom": { "name": "default", "module": "mixins/FormAssociatedMixin.js" } }, { "name": "refreshFormAssociation", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L203" }, "return": { "type": { "text": "() => void" } }, "inheritedFrom": { "name": "default", "module": "mixins/FormAssociatedMixin.js" } }, { "name": "formIPCEvent", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L234" }, "return": { "type": { "text": "(event: CustomEvent<[string, string]>) => void" } }, "inheritedFrom": { "name": "default", "module": "mixins/FormAssociatedMixin.js" } }, { "name": "focusCurrentOrFirst", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/KeyboardNavMixin.js#L57" }, "return": { "type": { "text": "() => HTMLElement" } }, "inheritedFrom": { "name": "default", "module": "mixins/KeyboardNavMixin.js" } }, { "name": "focusNext", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/KeyboardNavMixin.js#L78" }, "return": { "type": { "text": "(current?: HTMLElement, loop?: boolean, reverse?: boolean) => HTMLElement" } }, "inheritedFrom": { "name": "default", "module": "mixins/KeyboardNavMixin.js" } }, { "name": "focusPrevious", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/KeyboardNavMixin.js#L133" }, "return": { "type": { "text": "(current?: HTMLElement, loop?: boolean) => HTMLElement" } }, "inheritedFrom": { "name": "default", "module": "mixins/KeyboardNavMixin.js" } }, { "name": "refreshTabIndexes", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/KeyboardNavMixin.js#L156" }, "return": { "type": { "text": "() => void" } }, "inheritedFrom": { "name": "default", "module": "mixins/KeyboardNavMixin.js" } }, { "name": "color", "kind": "field", "description": "Palette or surface token used to select background/ink tokens.\nExamples: 'primary', 'background', 'surface-container-low'.\nVisual color token for list surfaces. Default is `surface` to match\nMaterial surface theming.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/List.js#L24" }, "type": { "text": "string & { empty: string; }" }, "inheritedFrom": { "name": "default", "module": "components/List.js" } }, { "name": "readAriaProperty", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/AriaReflectorMixin.js#L28" }, "return": { "type": { "text": "(name: \"shadowRoot\" | \"ariaActiveDescendantElement\" | \"ariaAtomic\" | \"ariaAutoComplete\" | \"ariaBrailleLabel\" | \"ariaBrailleRoleDescription\" | \"ariaBusy\" | \"ariaChecked\" | \"ariaColCount\" | \"ariaColIndex\" | \"ariaColIndexText\" | \"ariaColSpan\" | \"ariaControlsElements\" | \"ariaCurrent\" | \"ariaDescribedByElements\" | \"ariaDescription\" | \"ariaDetailsElements\" | \"ariaDisabled\" | \"ariaErrorMessageElements\" | \"ariaExpanded\" | \"ariaFlowToElements\" | \"ariaHasPopup\" | \"ariaHidden\" | \"ariaInvalid\" | \"ariaKeyShortcuts\" | \"ariaLabel\" | \"ariaLabelledByElements\" | \"ariaLevel\" | \"ariaLive\" | \"ariaModal\" | \"ariaMultiLine\" | \"ariaMultiSelectable\" | \"ariaOrientation\" | \"ariaOwnsElements\" | \"ariaPlaceholder\" | \"ariaPosInSet\" | \"ariaPressed\" | \"ariaReadOnly\" | \"ariaRelevant\" | \"ariaRequired\" | \"ariaRoleDescription\" | \"ariaRowCount\" | \"ariaRowIndex\" | \"ariaRowIndexText\" | \"ariaRowSpan\" | \"ariaSelected\" | \"ariaSetSize\" | \"ariaSort\" | \"ariaValueMax\" | \"ariaValueMin\" | \"ariaValueNow\" | \"ariaValueText\" | \"role\") => string | Element | ShadowRoot | readonly Element[]" } }, "inheritedFrom": { "name": "default", "module": "components/List.js" } }, { "name": "updateAriaProperty", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/AriaReflectorMixin.js#L47" }, "return": { "type": { "text": ">(name: K, value: ARIAMixin[K]) => void" } }, "inheritedFrom": { "name": "default", "module": "components/List.js" } }, { "name": "compose", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L145" }, "type": { "text": "(parts: CompositionPart[]) => Composition" }, "inheritedFrom": { "name": "default", "module": "components/List.js" } }, { "name": "#refsProxy", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1145" }, "type": { "text": "Record" }, "inheritedFrom": { "name": "default", "module": "components/List.js" } }, { "name": "#refsCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1148" }, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "components/List.js" } }, { "name": "#refsCompositionCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1151" }, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "components/List.js" } }, { "name": "#composition", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1154" }, "type": { "text": "Composition" }, "inheritedFrom": { "name": "default", "module": "components/List.js" } }, { "name": "#patching", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1156" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/List.js" } }, { "name": "#pendingPatchRenders", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1159" }, "type": { "text": "[string, any, CustomElement][]" }, "inheritedFrom": { "name": "default", "module": "components/List.js" } }, { "name": "#propAttributeCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1162" }, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "components/List.js" } }, { "name": "#callbackArguments", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1165" }, "type": { "text": "CallbackArguments" }, "inheritedFrom": { "name": "default", "module": "components/List.js" } }, { "name": "elementInternals", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1172" }, "type": { "text": "ElementInternals" }, "inheritedFrom": { "name": "default", "module": "components/List.js" } }, { "name": "render", "kind": "field", "description": "Updates nodes based on data\nExpects data in JSON Merge Patch format", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1185" }, "type": { "text": "RenderDraw" }, "inheritedFrom": { "name": "default", "module": "components/List.js" } }, { "name": "propChangedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1213" }, "type": { "text": "(this: T, name: K, oldValue: K extends keyof T ? T[K] : unknown, newValue: K extends keyof T ? T[K] : unknown, changes?: K extends keyof T ? T[K] extends object ? Partial : T[K] : unknown) => void" }, "inheritedFrom": { "name": "default", "module": "components/List.js" } }, { "name": "attributeChangedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1234" }, "type": { "text": "(name: string, oldValue: string, newValue: string) => void" }, "inheritedFrom": { "name": "default", "module": "components/List.js" } }, { "name": "#template", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1284" }, "type": { "text": "DocumentFragment" }, "inheritedFrom": { "name": "default", "module": "components/List.js" } }, { "name": "#onObserverPropertyChanged", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1294" }, "type": { "text": "(name: string, oldValue: any, newValue: any, changes: any) => void" }, "inheritedFrom": { "name": "default", "module": "components/List.js" } }, { "name": "static", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1330" }, "type": { "text": "typeof CustomElement" }, "inheritedFrom": { "name": "default", "module": "components/List.js" } }, { "name": "patch", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1333" }, "type": { "text": "(patch: any) => void" }, "inheritedFrom": { "name": "default", "module": "components/List.js" } }, { "name": "refs", "kind": "field", "description": "Proxy object that returns shadow DOM elements by tag.\nIf called before interpolation (eg: on composed), returns from template", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1404" }, "type": { "text": "Record" }, "inheritedFrom": { "name": "default", "module": "components/List.js" } }, { "name": "attributeCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1391" }, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "components/List.js" } }, { "name": "callbackArguments", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1400" }, "type": { "text": "CallbackArguments | { composition: Composition; refs: Record; html: any; inline: (fn: (data: Partial) => any) => string; template: DocumentFragment; element: T; }" }, "inheritedFrom": { "name": "default", "module": "components/List.js" } }, { "name": "composition", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1403" }, "type": { "text": "Composition" }, "inheritedFrom": { "name": "default", "module": "components/List.js" } }, { "name": "connectedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1435" }, "type": { "text": "() => void" }, "inheritedFrom": { "name": "default", "module": "components/List.js" } }, { "name": "disconnectedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1441" }, "type": { "text": "() => void" }, "inheritedFrom": { "name": "default", "module": "components/List.js" } }, { "name": "elementName", "kind": "field", "static": true, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/List.js" } }, { "name": "observedAttributes", "kind": "field", "static": true, "type": { "text": "Iterable" }, "inheritedFrom": { "name": "default", "module": "components/List.js" } }, { "name": "interpolatesTemplate", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/List.js" } }, { "name": "supportsElementInternals", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/List.js" } }, { "name": "supportsElementInternalsRole", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/List.js" } }, { "name": "defined", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/List.js" } }, { "name": "registrations", "kind": "field", "static": true, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "components/List.js" } }, { "name": "expressions", "kind": "method", "static": true, "description": "Expressions are idempotent functions that are selectively called whenever\na render is requested.\nExpressions are constructed exactly as methods though differ in expected\narguments. The first argument should be destructured to ensure each used\nproperty is accessed at least once in order to inspect used properties.\n\nThe Composition API will inspect this function with a proxy for `this` to\ncatalog what observables are used by the expression. This allows the\nComposition API to build a cache as well as selective invoke the expression\nonly when needed.\n\nWhen used with in element templates, the element itself will be passed as\nits first argument.\n````js\n Button\n .prop('filled', 'boolean')\n .prop('outlined', 'boolean')\n .expresssions({\n _isFilledOrOutlined({filled, outlined}) {\n return (filled || outlined)\n },\n })\n .html`
`;\n````\n\nWhen used with external data source, that data source\nwill be passed to the expression with all properties being `null` at first\ninspection.\n````js\n const externalData = {first: 'John', last: 'Doe'};\n ContactCard\n .expresssions({\n _fullName({first, last}) {\n return [first, last].filter(Boolean).join(' ');\n },\n })\n myButton.render(externalData);\n````\n\nExpressions may be support argumentless calls by using default\nparameters with `this`.\n````js\n Button\n .expresssions({\n isFilledOrOutlined({filled, outlined} = this) {\n return (filled || outlined)\n },\n });\n myButton.isFilledorOutlined();\n````", "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends { [K in keyof any]: K extends `_${any}` ? ((data: INSTANCE, state?: Record) => string | boolean | null) : ((data?: INSTANCE, state?: Record) => string | boolean | null); } & ThisType>(this: CLASS, expressions: PROPS & ThisType) => CLASS & Class<{ [K in keyof PROPS]: K extends `_${any}` ? never : () => ReturnType; }, ARGS>" } }, "inheritedFrom": { "name": "default", "module": "components/List.js" } }, { "name": "methods", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "components/List.js" } }, { "name": "overrides", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends Partial>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "components/List.js" } }, { "name": "props", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "components/List.js" } }, { "name": "idl", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "components/List.js" } }, { "name": "append", "kind": "field", "static": true, "description": "Append parts to composition", "type": { "text": "(this: T, ...parts: CompositionPart[]) => T" }, "inheritedFrom": { "name": "default", "module": "components/List.js" } }, { "name": "recompose", "kind": "field", "static": true, "description": "After composition, invokes callback.\nMay be called multiple times.", "type": { "text": ", T3 extends CompositionCallback[\"composed\"]>(this: T1, callback: T3) => T1" }, "inheritedFrom": { "name": "default", "module": "components/List.js" } }, { "name": "css", "kind": "field", "static": true, "description": "Appends styles to composition", "type": { "text": "(this: T1, array: T2, ...rest: T2 extends string ? any : T2 extends TemplateStringsArray ? any[] : (HTMLStyleElement | CSSStyleSheet)[]) => T1" }, "inheritedFrom": { "name": "default", "module": "components/List.js" } }, { "name": "autoRegister", "kind": "field", "static": true, "description": "Registers class with customElements. If class is registered before then,\ndoes nothing.", "type": { "text": "(this: T, elementName: string) => T" }, "inheritedFrom": { "name": "default", "module": "components/List.js" } }, { "name": "html", "kind": "field", "static": true, "description": "Appends DocumentFragment to composition", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1405" }, "type": { "text": "(this: T, string: TemplateStringsArray, ...substitutions: (string | Element | ((this: InstanceType, data: InstanceType, injections?: any) => any))[]) => T" }, "inheritedFrom": { "name": "default", "module": "components/List.js" } }, { "name": "extend", "kind": "field", "static": true, "description": "Extends base class into a new class.\nUse to avoid mutating base class.", "type": { "text": " T2>(this: T1, customExtender?: T3) => T3 extends null ? T1 : T2" }, "inheritedFrom": { "name": "default", "module": "components/List.js" } }, { "name": "setStatic", "kind": "field", "static": true, "description": "Assigns static values to class", "type": { "text": " any) | string | number | boolean | any[] | object); }>(this: T1, source: T2 & ThisType) => T1 & T2" }, "inheritedFrom": { "name": "default", "module": "components/List.js" } }, { "name": "readonly", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "components/List.js" } }, { "name": "set", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "components/List.js" } }, { "name": "mixin", "kind": "field", "static": true, "description": "Returns result of calling mixin with current class", "type": { "text": " any, RETURN extends ReturnType, SUBCLASS extends ClassOf>(this: BASE, mixin: FN) => SUBCLASS & BASE" }, "inheritedFrom": { "name": "default", "module": "components/List.js" } }, { "name": "register", "kind": "field", "static": true, "description": "Registers class with window.customElements synchronously", "type": { "text": "(this: T, elementName?: string, force?: boolean) => T" }, "inheritedFrom": { "name": "default", "module": "components/List.js" } }, { "name": "propList", "kind": "field", "static": true, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "components/List.js" } }, { "name": "attrList", "kind": "field", "static": true, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "components/List.js" } }, { "name": "propChangedCallbacks", "kind": "field", "static": true, "type": { "text": "Map any)[]>" }, "inheritedFrom": { "name": "default", "module": "components/List.js" } }, { "name": "attributeChangedCallbacks", "kind": "field", "static": true, "type": { "text": "Map any)[]>" }, "inheritedFrom": { "name": "default", "module": "components/List.js" } }, { "name": "prop", "kind": "field", "static": true, "description": "Creates observable property on instances (via prototype)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1007" }, "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "components/List.js" } }, { "name": "setPrototype", "kind": "field", "static": true, "description": "Creates observable property on instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any)>(this: CLASS, name: KEY, options: OPTIONS) => OPTIONS extends (...args2: any[]) => infer R ? R : OPTIONS extends ObserverPropertyType ? ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? unknown extends R ? object : R : OPTIONS extends { type: ObserverPropertyType; } ? ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? unknown extends R ? string : R : never" }, "inheritedFrom": { "name": "default", "module": "components/List.js" } }, { "name": "define", "kind": "field", "static": true, "description": "Define properties on instances via Object.defineProperties().\nAutomatically sets property non-enumerable if name begins with `_`.\nFunctions will be remapped as getters", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends { [P in keyof any]: { enumerable?: boolean; configurable?: boolean; writable?: boolean; value?: any; get?: ((this: INSTANCE) => any); set?: (this: INSTANCE, value: any) => void; } | ((this: INSTANCE, ...args: any[]) => any); }, VALUE extends { [KEY in keyof PROPS]: PROPS[KEY] extends (...args2: any[]) => infer R ? R : PROPS[KEY] extends TypedPropertyDescriptor ? R : never; }>(this: CLASS, props: PROPS & ThisType) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "components/List.js" } }, { "name": "undefine", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROP extends string, PROPS extends INSTANCE & Record>(this: CLASS, name: PROP) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "components/List.js" } }, { "name": "observe", "kind": "field", "static": true, "description": "Creates observable properties on instances", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends IDLParameter, VALUE extends { [KEY in keyof PROPS]: PROPS[KEY] extends (...args2: any[]) => infer R ? R : PROPS[KEY] extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : PROPS[KEY] extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : PROPS[KEY] extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : PROPS[KEY] extends ObserverOptions ? (unknown extends R ? string : R) : never; }>(this: CLASS, props: PROPS) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "components/List.js" } }, { "name": "defineStatic", "kind": "field", "static": true, "type": { "text": ">(this: T1, props: T2) => T1 & ParsedProps" }, "inheritedFrom": { "name": "default", "module": "components/List.js" } }, { "name": "events", "kind": "field", "static": true, "type": { "text": "(this: T, listeners?: CompositionEventListenerObject>, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "components/List.js" } }, { "name": "childEvents", "kind": "field", "static": true, "type": { "text": "(this: T, listenerMap: { [x: string]: CompositionEventListenerObject>; }, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "components/List.js" } }, { "name": "rootEvents", "kind": "field", "static": true, "type": { "text": "(this: T, listeners?: CompositionEventListenerObject>, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "components/List.js" } }, { "name": "on", "kind": "field", "static": true, "type": { "text": ", T3 extends CompositionCallback, T4 extends keyof T3>(this: T1, name: T3 | T4, callbacks?: T3[T4] & ThisType) => T1" }, "inheritedFrom": { "name": "default", "module": "components/List.js" } }, { "name": "off", "kind": "field", "static": true, "type": { "text": ", T3 extends CompositionCallback, T4 extends keyof T3>(this: T1, name: T3 | T4, callbacks?: T3[T4] & ThisType) => T1" }, "inheritedFrom": { "name": "default", "module": "components/List.js" } }, { "name": "offPropChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: ObjectOrObjectEntries<{ [P in keyof T2]?: (this: T2, oldValue: T2[P], newValue: T2[P], changes: any, element: T2) => void; }>) => T1" }, "inheritedFrom": { "name": "default", "module": "components/List.js" } }, { "name": "offAttributeChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: { [x: string]: (this: T2, oldValue: string, newValue: string, element: T2) => void; }) => T1" }, "inheritedFrom": { "name": "default", "module": "components/List.js" } }, { "name": "onPropChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: ObjectOrObjectEntries<{ [P in keyof T2]?: (this: T2, oldValue: T2[P], newValue: T2[P], changes: any, element: T2) => void; }>) => T1" }, "inheritedFrom": { "name": "default", "module": "components/List.js" } }, { "name": "onAttributeChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: { [x: string]: (this: T2, oldValue: string, newValue: string, element: T2) => void; }) => T1" }, "inheritedFrom": { "name": "default", "module": "components/List.js" } } ], "slots": [ { "name": "", "description": "" } ], "cssParts": [], "events": [ { "name": "listbox-click", "type": { "text": "Event" } } ], "demos": [ { "url": "demo/components/listbox.html" } ], "superclass": { "module": "components/List.js", "name": "default" }, "mixins": [ { "module": "mixins/StateMixin.js", "name": "default" }, { "module": "mixins/FormAssociatedMixin.js", "name": "default" }, { "module": "mixins/KeyboardNavMixin.js", "name": "default" }, { "module": "mixins/DelegatesFocusMixin.js", "name": "default" } ], "description": "Listbox: a selectable list of options, used for autocompletes and selects.\nimplements {HTMLSelectElement}\n@see https://m3.material.io/components/lists/specs" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "default", "module": "components/Listbox.js" } }, { "kind": "custom-element-definition", "name": "mdw-listbox", "declaration": { "name": "default", "module": "components/Listbox.js" } } ] }, { "kind": "javascript-module", "path": "components/Menu.js", "declarations": [ { "kind": "class", "name": "Menu", "tagName": "mdw-menu", "customElement": true, "attributes": [ { "name": "color", "fieldName": "color", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "ink", "fieldName": "ink", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "type-style", "fieldName": "typeStyle", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "shape-top", "fieldName": "shapeTop", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shape-bottom", "fieldName": "shapeBottom", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shape-start", "fieldName": "shapeStart", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shape-end", "fieldName": "shapeEnd", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shape-style", "fieldName": "shapeStyle", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "outlined", "fieldName": "outlined", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "open", "fieldName": "open", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/PopupMixin.js" } }, { "name": "modal", "fieldName": "modal", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/PopupMixin.js" } }, { "name": "native", "fieldName": "native", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/PopupMixin.js" } }, { "name": "scrollable", "fieldName": "scrollable", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/PopupMixin.js" } }, { "name": "match-source-width", "fieldName": "matchSourceWidth", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/PopupMixin.js" } }, { "name": "popup-margin", "fieldName": "popupMargin", "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "mixins/PopupMixin.js" } }, { "name": "density", "fieldName": "density", "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "mixins/DensityMixin.js" } }, { "name": "kbd-nav", "fieldName": "kbdNav", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/KeyboardNavMixin.js" } }, { "name": "flow", "type": { "text": "string" }, "fieldName": "flow", "inheritedFrom": { "name": "default", "module": "mixins/PopupMixin.js" } } ], "members": [ { "name": "delegatesFocus", "kind": "field", "description": "When true, the element delegates focus to an internal focus target.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/DelegatesFocusMixin.js#L15" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "kbdNav", "kind": "field", "description": "Enable keyboard roving navigation when present (set to 'true').", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/KeyboardNavMixin.js#L23" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/KeyboardNavMixin.js" } }, { "name": "kbdNavQuery", "kind": "field", "description": "Query used to find roving tab index children", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/KeyboardNavMixin.js#L32" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/KeyboardNavMixin.js" } }, { "name": "kbdNavFocusableWhenDisabled", "kind": "field", "description": "Flag whether disabled elements participating in roving tab index\nshould be focusable.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/KeyboardNavMixin.js#L39" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/KeyboardNavMixin.js" } }, { "name": "ariaOrientationDefault", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/KeyboardNavMixin.js#L41" }, "type": { "text": "\"horizontal\" | \"vertical\"" }, "inheritedFrom": { "name": "default", "module": "mixins/KeyboardNavMixin.js" } }, { "name": "kbdNavChildren", "kind": "field", "description": "List of roving tab index participating children", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Menu.js#L44" }, "type": { "text": "NodeListOf & Element[]" }, "inheritedFrom": { "name": "default", "module": "mixins/KeyboardNavMixin.js" } }, { "name": "density", "kind": "field", "description": "Density level affecting spacing and compactness. Integer from -4 (dense) to 4 (spacious).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/DensityMixin.js#L9" }, "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "mixins/DensityMixin.js" } }, { "name": "open", "kind": "field", "description": "Whether the popup is currently open", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/PopupMixin.js#L84" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/PopupMixin.js" } }, { "name": "modal", "kind": "field", "description": "When true the popup behaves as a blocking modal", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/PopupMixin.js#L86" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/PopupMixin.js" } }, { "name": "native", "kind": "field", "description": "Use the native HTMLDialogElement when available", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/PopupMixin.js#L88" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/PopupMixin.js" } }, { "name": "scrollable", "kind": "field", "description": "Allow internal content to scroll when true", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/PopupMixin.js#L90" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/PopupMixin.js" } }, { "name": "matchSourceWidth", "kind": "field", "description": "When true, match the popup width to the source element", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/PopupMixin.js#L92" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/PopupMixin.js" } }, { "name": "flow", "kind": "field", "description": "Placement strategy for the popup ('corner').", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Menu.js#L25" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/PopupMixin.js" } }, { "name": "popupMargin", "kind": "field", "description": "Margin between popup and viewport/anchor (px)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/PopupMixin.js#L101" }, "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "mixins/PopupMixin.js" } }, { "name": "useHistory", "kind": "field", "description": "Whether to push/pop history entries when opening the popup", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/PopupMixin.js#L105" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/PopupMixin.js" } }, { "name": "returnValue", "kind": "field", "description": "Optional return value for dialog-like popups", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/PopupMixin.js#L107" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/PopupMixin.js" } }, { "name": "disabled", "kind": "field", "description": "Whether the element is disabled (affects interactive states)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L14" }, "type": { "text": "boolean" } }, { "name": "focused", "kind": "field", "description": "Force focus state (independent of document)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L16" }, "type": { "text": "boolean" } }, { "name": "hovered", "kind": "field", "description": "Force hover state (independent of interaction)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L18" }, "type": { "text": "boolean" } }, { "name": "pressed", "kind": "field", "description": "Force pressed state (independent of interaction)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L20" }, "type": { "text": "boolean" } }, { "name": "stateLayer", "kind": "field", "description": "Show the visual state layer element when true", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L34" }, "type": { "text": "boolean" } }, { "name": "disabledState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L37" }, "type": { "text": "boolean" } }, { "name": "hoveredState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L38" }, "type": { "text": "boolean" } }, { "name": "focusedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L39" }, "type": { "text": "boolean" } }, { "name": "pressedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L40" }, "type": { "text": "boolean" } }, { "name": "touchedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L41" }, "type": { "text": "boolean" } }, { "name": "pointedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L44" }, "type": { "text": "boolean" } }, { "name": "stateTargetElement", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L50" }, "type": { "text": "HTMLElement" } }, { "name": "color", "kind": "field", "description": "Palette or surface token used to select background/ink tokens.\nExamples: 'primary', 'background', 'surface-container-low'.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L52" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "ink", "kind": "field", "description": "Explicit ink override token (e.g. 'outline', 'on-primary', 'inverse-on-surface', 'inherit').\nMaps to `--mdw-ink`.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L57" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "typeStyle", "kind": "field", "description": "Typographic style shortcut that maps to type scale variables\n(e.g. 'headline-large', 'body-medium').", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L62" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "shapeTop", "kind": "field", "description": "Show top cut/shape on the element", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L9" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shapeBottom", "kind": "field", "description": "Show bottom cut/shape on the element", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L11" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shapeStart", "kind": "field", "description": "Show start-side cut/shape (logical start)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L13" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shapeEnd", "kind": "field", "description": "Show end-side cut/shape (logical end)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L15" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shapeStyle", "kind": "field", "description": "Predefined shape size/style name (none|extra-small|small|medium|large|extra-large|full|inherit)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L17" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "outlined", "kind": "field", "description": "When true, an outline is rendered around the element", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L19" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "cascader", "kind": "field", "description": "Element that cascaded this submenu (if present).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Menu.js#L55" }, "type": { "text": "HTMLElement" } }, { "name": "submenu", "kind": "field", "description": "Currently opened submenu element (if any).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Menu.js#L67" }, "type": { "text": "HTMLElement" } }, { "name": "cascade", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Menu.js#L122" }, "return": { "type": { "text": "(cascader: HTMLElement) => void" } } }, { "name": "prototype", "kind": "field", "static": true, "type": { "text": "CustomElement" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "updatePopupPosition", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/PopupMixin.js#L138" }, "return": { "type": { "text": "(anchor?: Element | DOMRectLike) => void" } }, "inheritedFrom": { "name": "default", "module": "mixins/PopupMixin.js" } }, { "name": "onSlotChange", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/PopupMixin.js#L290" }, "return": { "type": { "text": "({ currentTarget }: Event & { currentTarget: HTMLSlotElement; }) => void" } }, "inheritedFrom": { "name": "default", "module": "mixins/PopupMixin.js" } }, { "name": "showPopup", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/PopupMixin.js#L303" }, "return": { "type": { "text": "(source?: HTMLElement | Event | PointerEvent | MouseEvent, focus?: boolean, flow?: string) => boolean" } }, "inheritedFrom": { "name": "default", "module": "mixins/PopupMixin.js" } }, { "name": "showModal", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/PopupMixin.js#L389" }, "return": { "type": { "text": "(source?: HTMLElement | Event | PointerEvent | MouseEvent, focus?: boolean, flow?: string) => boolean" } }, "inheritedFrom": { "name": "default", "module": "mixins/PopupMixin.js" } }, { "name": "show", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/PopupMixin.js#L404" }, "return": { "type": { "text": "(source?: HTMLElement | Event | PointerEvent | MouseEvent, focus?: boolean, flow?: string) => boolean" } }, "inheritedFrom": { "name": "default", "module": "mixins/PopupMixin.js" } }, { "name": "close", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/PopupMixin.js#L417" }, "return": { "type": { "text": "(returnValue?: any, returnFocus?: boolean) => boolean" } }, "inheritedFrom": { "name": "default", "module": "mixins/PopupMixin.js" } }, { "name": "focusCurrentOrFirst", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/KeyboardNavMixin.js#L57" }, "return": { "type": { "text": "() => HTMLElement" } }, "inheritedFrom": { "name": "default", "module": "mixins/KeyboardNavMixin.js" } }, { "name": "focusNext", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/KeyboardNavMixin.js#L78" }, "return": { "type": { "text": "(current?: HTMLElement, loop?: boolean, reverse?: boolean) => HTMLElement" } }, "inheritedFrom": { "name": "default", "module": "mixins/KeyboardNavMixin.js" } }, { "name": "focusPrevious", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/KeyboardNavMixin.js#L133" }, "return": { "type": { "text": "(current?: HTMLElement, loop?: boolean) => HTMLElement" } }, "inheritedFrom": { "name": "default", "module": "mixins/KeyboardNavMixin.js" } }, { "name": "refreshTabIndexes", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/KeyboardNavMixin.js#L156" }, "return": { "type": { "text": "() => void" } }, "inheritedFrom": { "name": "default", "module": "mixins/KeyboardNavMixin.js" } }, { "name": "compose", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L145" }, "type": { "text": "(parts: CompositionPart[]) => Composition" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#refsProxy", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1145" }, "type": { "text": "Record" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#refsCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1148" }, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#refsCompositionCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1151" }, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#composition", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1154" }, "type": { "text": "Composition" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#patching", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1156" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#pendingPatchRenders", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1159" }, "type": { "text": "[string, any, CustomElement][]" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#propAttributeCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1162" }, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#callbackArguments", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1165" }, "type": { "text": "CallbackArguments" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "elementInternals", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1172" }, "type": { "text": "ElementInternals" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "render", "kind": "field", "description": "Updates nodes based on data\nExpects data in JSON Merge Patch format", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1185" }, "type": { "text": "RenderDraw" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "propChangedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1213" }, "type": { "text": "(this: T, name: K, oldValue: K extends keyof T ? T[K] : unknown, newValue: K extends keyof T ? T[K] : unknown, changes?: K extends keyof T ? T[K] extends object ? Partial : T[K] : unknown) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attributeChangedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1234" }, "type": { "text": "(name: string, oldValue: string, newValue: string) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#template", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1284" }, "type": { "text": "DocumentFragment" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#onObserverPropertyChanged", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1294" }, "type": { "text": "(name: string, oldValue: any, newValue: any, changes: any) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "static", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1330" }, "type": { "text": "typeof CustomElement" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "patch", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1333" }, "type": { "text": "(patch: any) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "refs", "kind": "field", "description": "Proxy object that returns shadow DOM elements by tag.\nIf called before interpolation (eg: on composed), returns from template", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1404" }, "type": { "text": "Record" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attributeCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1391" }, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "callbackArguments", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1400" }, "type": { "text": "CallbackArguments | { composition: Composition; refs: Record; html: any; inline: (fn: (data: Partial) => any) => string; template: DocumentFragment; element: T; }" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "composition", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1403" }, "type": { "text": "Composition" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "connectedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1435" }, "type": { "text": "() => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "disconnectedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1441" }, "type": { "text": "() => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "elementName", "kind": "field", "static": true, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "observedAttributes", "kind": "field", "static": true, "type": { "text": "Iterable" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "interpolatesTemplate", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "supportsElementInternals", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "supportsElementInternalsRole", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "defined", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "registrations", "kind": "field", "static": true, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "expressions", "kind": "method", "static": true, "description": "Expressions are idempotent functions that are selectively called whenever\na render is requested.\nExpressions are constructed exactly as methods though differ in expected\narguments. The first argument should be destructured to ensure each used\nproperty is accessed at least once in order to inspect used properties.\n\nThe Composition API will inspect this function with a proxy for `this` to\ncatalog what observables are used by the expression. This allows the\nComposition API to build a cache as well as selective invoke the expression\nonly when needed.\n\nWhen used with in element templates, the element itself will be passed as\nits first argument.\n````js\n Button\n .prop('filled', 'boolean')\n .prop('outlined', 'boolean')\n .expresssions({\n _isFilledOrOutlined({filled, outlined}) {\n return (filled || outlined)\n },\n })\n .html`
`;\n````\n\nWhen used with external data source, that data source\nwill be passed to the expression with all properties being `null` at first\ninspection.\n````js\n const externalData = {first: 'John', last: 'Doe'};\n ContactCard\n .expresssions({\n _fullName({first, last}) {\n return [first, last].filter(Boolean).join(' ');\n },\n })\n myButton.render(externalData);\n````\n\nExpressions may be support argumentless calls by using default\nparameters with `this`.\n````js\n Button\n .expresssions({\n isFilledOrOutlined({filled, outlined} = this) {\n return (filled || outlined)\n },\n });\n myButton.isFilledorOutlined();\n````", "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends { [K in keyof any]: K extends `_${any}` ? ((data: INSTANCE, state?: Record) => string | boolean | null) : ((data?: INSTANCE, state?: Record) => string | boolean | null); } & ThisType>(this: CLASS, expressions: PROPS & ThisType) => CLASS & Class<{ [K in keyof PROPS]: K extends `_${any}` ? never : () => ReturnType; }, ARGS>" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "methods", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "overrides", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends Partial>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "props", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "idl", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "append", "kind": "field", "static": true, "description": "Append parts to composition", "type": { "text": "(this: T, ...parts: CompositionPart[]) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "recompose", "kind": "field", "static": true, "description": "After composition, invokes callback.\nMay be called multiple times.", "type": { "text": ", T3 extends CompositionCallback[\"composed\"]>(this: T1, callback: T3) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "css", "kind": "field", "static": true, "description": "Appends styles to composition", "type": { "text": "(this: T1, array: T2, ...rest: T2 extends string ? any : T2 extends TemplateStringsArray ? any[] : (HTMLStyleElement | CSSStyleSheet)[]) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "autoRegister", "kind": "field", "static": true, "description": "Registers class with customElements. If class is registered before then,\ndoes nothing.", "type": { "text": "(this: T, elementName: string) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "html", "kind": "field", "static": true, "description": "Appends DocumentFragment to composition", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1405" }, "type": { "text": "(this: T, string: TemplateStringsArray, ...substitutions: (string | Element | ((this: InstanceType, data: InstanceType, injections?: any) => any))[]) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "extend", "kind": "field", "static": true, "description": "Extends base class into a new class.\nUse to avoid mutating base class.", "type": { "text": " T2>(this: T1, customExtender?: T3) => T3 extends null ? T1 : T2" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "setStatic", "kind": "field", "static": true, "description": "Assigns static values to class", "type": { "text": " any) | string | number | boolean | any[] | object); }>(this: T1, source: T2 & ThisType) => T1 & T2" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "readonly", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "set", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "mixin", "kind": "field", "static": true, "description": "Returns result of calling mixin with current class", "type": { "text": " any, RETURN extends ReturnType, SUBCLASS extends ClassOf>(this: BASE, mixin: FN) => SUBCLASS & BASE" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "register", "kind": "field", "static": true, "description": "Registers class with window.customElements synchronously", "type": { "text": "(this: T, elementName?: string, force?: boolean) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "propList", "kind": "field", "static": true, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attrList", "kind": "field", "static": true, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "propChangedCallbacks", "kind": "field", "static": true, "type": { "text": "Map any)[]>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attributeChangedCallbacks", "kind": "field", "static": true, "type": { "text": "Map any)[]>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "prop", "kind": "field", "static": true, "description": "Creates observable property on instances (via prototype)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1007" }, "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "setPrototype", "kind": "field", "static": true, "description": "Creates observable property on instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any)>(this: CLASS, name: KEY, options: OPTIONS) => OPTIONS extends (...args2: any[]) => infer R ? R : OPTIONS extends ObserverPropertyType ? ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? unknown extends R ? object : R : OPTIONS extends { type: ObserverPropertyType; } ? ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? unknown extends R ? string : R : never" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "define", "kind": "field", "static": true, "description": "Define properties on instances via Object.defineProperties().\nAutomatically sets property non-enumerable if name begins with `_`.\nFunctions will be remapped as getters", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends { [P in keyof any]: { enumerable?: boolean; configurable?: boolean; writable?: boolean; value?: any; get?: ((this: INSTANCE) => any); set?: (this: INSTANCE, value: any) => void; } | ((this: INSTANCE, ...args: any[]) => any); }, VALUE extends { [KEY in keyof PROPS]: PROPS[KEY] extends (...args2: any[]) => infer R ? R : PROPS[KEY] extends TypedPropertyDescriptor ? R : never; }>(this: CLASS, props: PROPS & ThisType) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "undefine", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROP extends string, PROPS extends INSTANCE & Record>(this: CLASS, name: PROP) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "observe", "kind": "field", "static": true, "description": "Creates observable properties on instances", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends IDLParameter, VALUE extends { [KEY in keyof PROPS]: PROPS[KEY] extends (...args2: any[]) => infer R ? R : PROPS[KEY] extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : PROPS[KEY] extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : PROPS[KEY] extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : PROPS[KEY] extends ObserverOptions ? (unknown extends R ? string : R) : never; }>(this: CLASS, props: PROPS) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "defineStatic", "kind": "field", "static": true, "type": { "text": ">(this: T1, props: T2) => T1 & ParsedProps" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "events", "kind": "field", "static": true, "type": { "text": "(this: T, listeners?: CompositionEventListenerObject>, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "childEvents", "kind": "field", "static": true, "type": { "text": "(this: T, listenerMap: { [x: string]: CompositionEventListenerObject>; }, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "rootEvents", "kind": "field", "static": true, "type": { "text": "(this: T, listeners?: CompositionEventListenerObject>, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "on", "kind": "field", "static": true, "type": { "text": ", T3 extends CompositionCallback, T4 extends keyof T3>(this: T1, name: T3 | T4, callbacks?: T3[T4] & ThisType) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "off", "kind": "field", "static": true, "type": { "text": ", T3 extends CompositionCallback, T4 extends keyof T3>(this: T1, name: T3 | T4, callbacks?: T3[T4] & ThisType) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "offPropChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: ObjectOrObjectEntries<{ [P in keyof T2]?: (this: T2, oldValue: T2[P], newValue: T2[P], changes: any, element: T2) => void; }>) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "offAttributeChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: { [x: string]: (this: T2, oldValue: string, newValue: string, element: T2) => void; }) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "onPropChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: ObjectOrObjectEntries<{ [P in keyof T2]?: (this: T2, oldValue: T2[P], newValue: T2[P], changes: any, element: T2) => void; }>) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "onAttributeChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: { [x: string]: (this: T2, oldValue: string, newValue: string, element: T2) => void; }) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } } ], "slots": [ { "name": "", "description": "" } ], "cssParts": [], "events": [], "demos": [ { "url": "demo/components/menus.html" } ], "superclass": { "module": "core/CustomElement.js", "name": "default" }, "mixins": [ { "module": "mixins/ThemableMixin.js", "name": "default" }, { "module": "mixins/ElevationMixin.js", "name": "default" }, { "module": "mixins/ShapeMixin.js", "name": "default" }, { "module": "mixins/PopupMixin.js", "name": "default" }, { "module": "mixins/DensityMixin.js", "name": "default" }, { "module": "mixins/KeyboardNavMixin.js", "name": "default" } ], "description": "Menus provide a list of choices or actions in a temporary surface.\n@see https://m3.material.io/components/menus/specs\n@see https://www.w3.org/TR/wai-aria-practices/#menu" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "default", "module": "components/Menu.js" } }, { "kind": "custom-element-definition", "name": "mdw-menu", "declaration": { "name": "default", "module": "components/Menu.js" } } ] }, { "kind": "javascript-module", "path": "components/MenuItem.js", "declarations": [ { "kind": "class", "name": "MenuItem", "tagName": "mdw-menu-item", "customElement": true, "attributes": [ { "name": "color", "fieldName": "color", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "ink", "fieldName": "ink", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "type-style", "fieldName": "typeStyle", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "disabled", "fieldName": "disabled", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "focused", "fieldName": "focused", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "hovered", "fieldName": "hovered", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "pressed", "fieldName": "pressed", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "href", "fieldName": "href", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "target", "fieldName": "target", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "download", "fieldName": "download", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "ping", "fieldName": "ping", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "rel", "fieldName": "rel", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "hreflang", "fieldName": "hreflang", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "referrerpolicy", "fieldName": "referrerPolicy", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "leading", "fieldName": "leading", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "avatar", "fieldName": "avatar", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "avatar-color", "fieldName": "avatarColor", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "avatar-src", "fieldName": "avatarSrc", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "src", "fieldName": "src", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "alt", "fieldName": "alt", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "icon", "fieldName": "icon", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "icon-ink", "fieldName": "iconInk", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "icon-src", "fieldName": "iconSrc", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "icon-variation", "fieldName": "iconVariation", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "checkbox", "fieldName": "checkbox", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "radio", "fieldName": "radio", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "selection-color", "fieldName": "selectionColor", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "selected", "fieldName": "defaultSelected", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "supporting", "fieldName": "supporting", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "trailing", "fieldName": "trailing", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "trailing-icon", "fieldName": "trailingIcon", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "trailing-icon-ink", "fieldName": "trailingIconInk", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "trailing-icon-src", "fieldName": "trailingIconSrc", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "divider", "fieldName": "divider", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "video", "fieldName": "video", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "lines", "fieldName": "lines", "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "label", "fieldName": "_label", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "text", "fieldName": "_text", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "value", "description": "Backing field for the menu item's value attribute. Can be `null` to\nindicate no explicit value; reflected to the `value` attribute.", "fieldName": "_defaultValue", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/FormAssociatedMixin.js" } }, { "name": "aria-controls", "fieldName": "ariaControls", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/FormAssociatedMixin.js" } }, { "name": "autocomplete", "fieldName": "autocomplete", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/FormAssociatedMixin.js" } }, { "name": "name", "fieldName": "name", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/FormAssociatedMixin.js" } }, { "name": "readonly", "fieldName": "readOnly", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/FormAssociatedMixin.js" } }, { "name": "formnovalidate", "fieldName": "formNoValidate", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/FormAssociatedMixin.js" } }, { "name": "checked", "fieldName": "defaultChecked", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/FormAssociatedMixin.js" } }, { "name": "required", "fieldName": "required", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/FormAssociatedMixin.js" } }, { "name": "cascades", "description": "ID of the submenu to open when this item cascades.", "fieldName": "cascades", "type": { "text": "string" } }, { "name": "type", "type": { "text": "string" }, "fieldName": "type", "inheritedFrom": { "name": "default", "module": "mixins/FormAssociatedMixin.js" } }, { "name": "state-layer", "type": { "text": "boolean" }, "description": "Show the visual state layer element when true", "fieldName": "stateLayer", "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } } ], "members": [ { "name": "delegatesFocus", "kind": "field", "description": "When true, the element delegates focus to an internal focus target.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/DelegatesFocusMixin.js#L15" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "disabled", "kind": "field", "description": "Whether the element is disabled (affects interactive states)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L14" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "focused", "kind": "field", "description": "Force focus state (independent of document)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L16" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "hovered", "kind": "field", "description": "Force hover state (independent of interaction)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L18" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "pressed", "kind": "field", "description": "Force pressed state (independent of interaction)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L20" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "stateLayer", "kind": "field", "description": "Show the visual state layer element when true\nWhen true, draw the Material state layer for interactive feedback.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/ListItem.js#L33" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "hoveredState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L38" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "focusedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L39" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "pressedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L40" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "touchedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L41" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "pointedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L44" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "stateTargetElement", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L50" }, "type": { "text": "HTMLElement" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "ariaControls", "kind": "field", "description": "ARIA 'controls' attribute (string).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L32" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/FormAssociatedMixin.js" } }, { "name": "autocomplete", "kind": "field", "description": "Autocomplete token for the associated control (string).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L34" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/FormAssociatedMixin.js" } }, { "name": "name", "kind": "field", "description": "Name attribute for the control used in forms.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L36" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/FormAssociatedMixin.js" } }, { "name": "readOnly", "kind": "field", "description": "Read-only state reflected to control via 'readonly' attribute.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L38" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/FormAssociatedMixin.js" } }, { "name": "formNoValidate", "kind": "field", "description": "When true, form validation is skipped for this control (formnovalidate).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L40" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/FormAssociatedMixin.js" } }, { "name": "defaultChecked", "kind": "field", "description": "Default checked state for checkable controls (checkbox/radio).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L42" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/FormAssociatedMixin.js" } }, { "name": "required", "kind": "field", "description": "Whether the control is required for form submission.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L47" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/FormAssociatedMixin.js" } }, { "name": "type", "kind": "field", "description": "Control type token (e.g. 'text','checkbox','radio','file').", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/MenuItem.js#L28" }, "type": { "text": "\"checkbox\" | \"radio\"" }, "inheritedFrom": { "name": "default", "module": "mixins/FormAssociatedMixin.js" } }, { "name": "erroredState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L65" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/FormAssociatedMixin.js" } }, { "name": "defaultValue", "kind": "field", "description": "Non-null string representation of the default value used for form\nassociation. Getter never returns null; setter writes to `_defaultValue`.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/MenuItem.js#L54" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/FormAssociatedMixin.js" } }, { "name": "value", "kind": "field", "description": "Option `value` used when the option is selected in a form. Defaults to\nthe option's text when not explicitly defined.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/MenuItem.js#L64" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/FormAssociatedMixin.js" } }, { "name": "checked", "kind": "field", "description": "Part of FormAssociatedMixin for simplicity.\nEnumerability doesn't guarantee checked state will be passed or used.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L145" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/FormAssociatedMixin.js" } }, { "name": "validity", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L161" }, "type": { "text": "ValidityState" }, "inheritedFrom": { "name": "default", "module": "mixins/FormAssociatedMixin.js" } }, { "name": "validationMessage", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L162" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/FormAssociatedMixin.js" } }, { "name": "willValidate", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L163" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/FormAssociatedMixin.js" } }, { "name": "labels", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L168" }, "type": { "text": "NodeList" }, "inheritedFrom": { "name": "default", "module": "mixins/FormAssociatedMixin.js" } }, { "name": "href", "kind": "field", "description": "The URL that the hyperlink points to.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L34" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "target", "kind": "field", "description": "The browsing context in which to open the linked resource (e.g. '_blank').", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L36" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "download", "kind": "field", "description": "Suggested filename for download.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L38" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "ping", "kind": "field", "description": "URLs to be pinged when the link is followed.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L40" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "rel", "kind": "field", "description": "Link relationship tokens (e.g. 'noopener', 'noreferrer').", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L42" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "hreflang", "kind": "field", "description": "Language of the linked resource.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L44" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "referrerPolicy", "kind": "field", "description": "Referrer policy for the link (serialized to 'referrerpolicy' attribute).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L46" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "origin", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L49" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "protocol", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L50" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "username", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L51" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "password", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L52" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "host", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L53" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "hostname", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L54" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "port", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L55" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "pathname", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L56" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "search", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L57" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "hash", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L58" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "readAriaProperty", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/AriaReflectorMixin.js#L28" }, "type": { "text": "(name: \"shadowRoot\" | \"ariaActiveDescendantElement\" | \"ariaAtomic\" | \"ariaAutoComplete\" | \"ariaBrailleLabel\" | \"ariaBrailleRoleDescription\" | \"ariaBusy\" | \"ariaChecked\" | \"ariaColCount\" | \"ariaColIndex\" | \"ariaColIndexText\" | \"ariaColSpan\" | \"ariaControlsElements\" | \"ariaCurrent\" | \"ariaDescribedByElements\" | \"ariaDescription\" | \"ariaDetailsElements\" | \"ariaDisabled\" | \"ariaErrorMessageElements\" | \"ariaExpanded\" | \"ariaFlowToElements\" | \"ariaHasPopup\" | \"ariaHidden\" | \"ariaInvalid\" | \"ariaKeyShortcuts\" | \"ariaLabel\" | \"ariaLabelledByElements\" | \"ariaLevel\" | \"ariaLive\" | \"ariaModal\" | \"ariaMultiLine\" | \"ariaMultiSelectable\" | \"ariaOrientation\" | \"ariaOwnsElements\" | \"ariaPlaceholder\" | \"ariaPosInSet\" | \"ariaPressed\" | \"ariaReadOnly\" | \"ariaRelevant\" | \"ariaRequired\" | \"ariaRoleDescription\" | \"ariaRowCount\" | \"ariaRowIndex\" | \"ariaRowIndexText\" | \"ariaRowSpan\" | \"ariaSelected\" | \"ariaSetSize\" | \"ariaSort\" | \"ariaValueMax\" | \"ariaValueMin\" | \"ariaValueNow\" | \"ariaValueText\" | \"role\") => string | Element | ShadowRoot | readonly Element[]" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "updateAriaProperty", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/AriaReflectorMixin.js#L47" }, "type": { "text": ">(name: K, value: ARIAMixin[K]) => void" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "addRipple", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/RippleMixin.js#L37" }, "type": { "text": "(x?: number, y?: number, hold?: boolean) => CustomElement & { hadRippleHeld: boolean; hadRippleReleased: boolean; rippleStarted: boolean; } & { rippleState: string; keepAlive: boolean; _positionX: number; _positionY: number; _radius: number; holdRipple: boolean; } & { _positionStyle: ElementStylerOptions | { styles: { minHeight: string; minWidth: string; boxShadow: string; top: string; left: string; }; }; } & { updatePosition(x?: number, y?: number, size?: number): void; handleRippleComplete(): void; }" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "color", "kind": "field", "description": "Palette or surface token used to select background/ink tokens.\nExamples: 'primary', 'background', 'surface-container-low'.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L52" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "ink", "kind": "field", "description": "Explicit ink override token (e.g. 'outline', 'on-primary', 'inverse-on-surface', 'inherit').\nMaps to `--mdw-ink`.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L57" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "typeStyle", "kind": "field", "description": "Typographic style shortcut that maps to type scale variables\n(e.g. 'headline-large', 'body-medium').", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L62" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "leading", "kind": "field", "description": "Leading slot content or shorthand string.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/ListItem.js#L37" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "avatar", "kind": "field", "description": "Avatar label or shorthand content for a leading avatar.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/ListItem.js#L40" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "avatarColor", "kind": "field", "description": "Color token used for the avatar container (default: primary-container).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/ListItem.js#L43" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "avatarSrc", "kind": "field", "description": "Image source for the avatar.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/ListItem.js#L46" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "src", "kind": "field", "description": "Image source URL for a leading image in the list item.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/ListItem.js#L49" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "alt", "kind": "field", "description": "Alt text for the leading image.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/ListItem.js#L52" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "icon", "kind": "field", "description": "Icon name for a leading icon.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/ListItem.js#L55" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "iconInk", "kind": "field", "description": "Ink/color token used for the leading icon.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/ListItem.js#L58" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "iconSrc", "kind": "field", "description": "External image/SVG source for the leading icon.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/ListItem.js#L61" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "iconVariation", "kind": "field", "description": "Icon variation (e.g., 'filled').", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/ListItem.js#L64" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "checkbox", "kind": "field", "description": "Checkbox shorthand name or placement class for a selectable leading checkbox.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/ListItem.js#L67" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "radio", "kind": "field", "description": "Radio shorthand name or placement class for a selectable leading radio.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/ListItem.js#L70" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "selectionColor", "kind": "field", "description": "Selection color token used when item is selected (default: primary).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/ListItem.js#L73" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "supporting", "kind": "field", "description": "Supporting text (secondary line) for the list item.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/ListItem.js#L79" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "trailing", "kind": "field", "description": "Trailing text slot or shorthand.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/ListItem.js#L82" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "trailingIcon", "kind": "field", "description": "Trailing icon name.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/ListItem.js#L85" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "trailingIconInk", "kind": "field", "description": "Ink/color token for the trailing icon.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/ListItem.js#L88" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "trailingIconSrc", "kind": "field", "description": "External image/SVG source for the trailing icon.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/ListItem.js#L91" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "divider", "kind": "field", "description": "Divider style identifier (e.g., 'inset').", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/ListItem.js#L94" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "video", "kind": "field", "description": "If true, indicates the list item contains video content and adjusts layout.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/ListItem.js#L97" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "lines", "kind": "field", "description": "Number of text lines the item should reserve for content (integer).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/ListItem.js#L100" }, "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "hasSupporting", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/ListItem.js#L116" }, "type": { "text": "() => boolean" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "checkboxClass", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/ListItem.js#L119" }, "type": { "text": "() => string" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "radioClass", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/ListItem.js#L122" }, "type": { "text": "() => string" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "CASCADE_TIMEOUT", "kind": "field", "description": "Milliseconds to delay before opening a cascaded submenu.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/MenuItem.js#L22" }, "type": { "text": "number" } }, { "name": "cascades", "kind": "field", "description": "ID of the submenu to open when this item cascades.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/MenuItem.js#L36" }, "type": { "text": "string" } }, { "name": "computeTrailingIcon", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/MenuItem.js#L95" }, "return": { "type": { "text": "() => string" } } }, { "name": "unscheduleCascade", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/MenuItem.js#L101" }, "return": { "type": { "text": "() => void" } } }, { "name": "scheduleCascade", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/MenuItem.js#L105" }, "return": { "type": { "text": "() => void" } } }, { "name": "cascade", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/MenuItem.js#L109" }, "return": { "type": { "text": "() => void" } } }, { "name": "prototype", "kind": "field", "static": true, "type": { "text": "CustomElement" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "form", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L160" }, "type": { "text": "HTMLFormElement" }, "inheritedFrom": { "name": "default", "module": "mixins/FormAssociatedMixin.js" } }, { "name": "checkValidity", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L177" }, "return": { "type": { "text": "() => boolean" } }, "inheritedFrom": { "name": "default", "module": "mixins/FormAssociatedMixin.js" } }, { "name": "reportValidity", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L179" }, "return": { "type": { "text": "() => boolean" } }, "inheritedFrom": { "name": "default", "module": "mixins/FormAssociatedMixin.js" } }, { "name": "setCustomValidity", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L185" }, "return": { "type": { "text": "(error: string) => void" } }, "inheritedFrom": { "name": "default", "module": "mixins/FormAssociatedMixin.js" } }, { "name": "refreshFormAssociation", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L203" }, "return": { "type": { "text": "() => void" } }, "inheritedFrom": { "name": "default", "module": "mixins/FormAssociatedMixin.js" } }, { "name": "formIPCEvent", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L234" }, "return": { "type": { "text": "(event: CustomEvent<[string, string]>) => void" } }, "inheritedFrom": { "name": "default", "module": "mixins/FormAssociatedMixin.js" } }, { "name": "disabledState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/ListOption.js#L78" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "selected", "kind": "field", "description": "Selection state for the item.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/ListOption.js#L65" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "isInteractive", "kind": "field", "description": "Whether this option behaves as an interactive selectable item.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/ListOption.js#L30" }, "type": { "text": "(() => boolean) & boolean" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "computedIconVariation", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/ListOption.js#L142" }, "type": { "text": "(() => string) & (() => string)" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "defaultSelected", "kind": "field", "description": "Initial/default selection state (reflected to `selected` attribute).\nUse `selected` property to control runtime selection.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/ListOption.js#L50" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "index", "kind": "field", "description": "Numeric index of the option inside the parent listbox.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/ListOption.js#L85" }, "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "text", "kind": "field", "description": "Text content for the option; setting updates the internal `_text` field.\nIf not provided, the getter falls back to element textContent.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/ListOption.js#L94" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "label", "kind": "field", "description": "Accessible label for the option. Falls back to `text` or the element\ncontent when not explicitly set.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/ListOption.js#L107" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "formDisabledCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/ListOption.js#L127" }, "type": { "text": "(formDisabled: boolean) => void" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "anchorAriaLabelledBy", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/ListOption.js#L136" }, "type": { "text": "() => string" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "anchorAriaDescribedBy", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/ListOption.js#L139" }, "type": { "text": "() => string" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "compose", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L145" }, "type": { "text": "(parts: CompositionPart[]) => Composition" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "#refsProxy", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1145" }, "type": { "text": "Record" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "#refsCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1148" }, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "#refsCompositionCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1151" }, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "#composition", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1154" }, "type": { "text": "Composition" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "#patching", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1156" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "#pendingPatchRenders", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1159" }, "type": { "text": "[string, any, CustomElement][]" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "#propAttributeCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1162" }, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "#callbackArguments", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1165" }, "type": { "text": "CallbackArguments" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "elementInternals", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1172" }, "type": { "text": "ElementInternals" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "render", "kind": "field", "description": "Updates nodes based on data\nExpects data in JSON Merge Patch format", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1185" }, "type": { "text": "RenderDraw" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "propChangedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1213" }, "type": { "text": "(this: T, name: K, oldValue: K extends keyof T ? T[K] : unknown, newValue: K extends keyof T ? T[K] : unknown, changes?: K extends keyof T ? T[K] extends object ? Partial : T[K] : unknown) => void" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "attributeChangedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1234" }, "type": { "text": "(name: string, oldValue: string, newValue: string) => void" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "#template", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1284" }, "type": { "text": "DocumentFragment" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "#onObserverPropertyChanged", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1294" }, "type": { "text": "(name: string, oldValue: any, newValue: any, changes: any) => void" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "static", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1330" }, "type": { "text": "typeof CustomElement" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "patch", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1333" }, "type": { "text": "(patch: any) => void" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "refs", "kind": "field", "description": "Proxy object that returns shadow DOM elements by tag.\nIf called before interpolation (eg: on composed), returns from template", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1404" }, "type": { "text": "Record" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "attributeCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1391" }, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "callbackArguments", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1400" }, "type": { "text": "CallbackArguments | { composition: Composition; refs: Record; html: any; inline: (fn: (data: Partial) => any) => string; template: DocumentFragment; element: T; }" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "composition", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1403" }, "type": { "text": "Composition" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "connectedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1435" }, "type": { "text": "() => void" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "disconnectedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1441" }, "type": { "text": "() => void" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "elementName", "kind": "field", "static": true, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "observedAttributes", "kind": "field", "static": true, "type": { "text": "Iterable" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "interpolatesTemplate", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "supportsElementInternals", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "supportsElementInternalsRole", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "defined", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "registrations", "kind": "field", "static": true, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "expressions", "kind": "method", "static": true, "description": "Expressions are idempotent functions that are selectively called whenever\na render is requested.\nExpressions are constructed exactly as methods though differ in expected\narguments. The first argument should be destructured to ensure each used\nproperty is accessed at least once in order to inspect used properties.\n\nThe Composition API will inspect this function with a proxy for `this` to\ncatalog what observables are used by the expression. This allows the\nComposition API to build a cache as well as selective invoke the expression\nonly when needed.\n\nWhen used with in element templates, the element itself will be passed as\nits first argument.\n````js\n Button\n .prop('filled', 'boolean')\n .prop('outlined', 'boolean')\n .expresssions({\n _isFilledOrOutlined({filled, outlined}) {\n return (filled || outlined)\n },\n })\n .html`
`;\n````\n\nWhen used with external data source, that data source\nwill be passed to the expression with all properties being `null` at first\ninspection.\n````js\n const externalData = {first: 'John', last: 'Doe'};\n ContactCard\n .expresssions({\n _fullName({first, last}) {\n return [first, last].filter(Boolean).join(' ');\n },\n })\n myButton.render(externalData);\n````\n\nExpressions may be support argumentless calls by using default\nparameters with `this`.\n````js\n Button\n .expresssions({\n isFilledOrOutlined({filled, outlined} = this) {\n return (filled || outlined)\n },\n });\n myButton.isFilledorOutlined();\n````", "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends { [K in keyof any]: K extends `_${any}` ? ((data: INSTANCE, state?: Record) => string | boolean | null) : ((data?: INSTANCE, state?: Record) => string | boolean | null); } & ThisType>(this: CLASS, expressions: PROPS & ThisType) => CLASS & Class<{ [K in keyof PROPS]: K extends `_${any}` ? never : () => ReturnType; }, ARGS>" } }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "methods", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "overrides", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends Partial>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "props", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "idl", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "append", "kind": "field", "static": true, "description": "Append parts to composition", "type": { "text": "(this: T, ...parts: CompositionPart[]) => T" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "recompose", "kind": "field", "static": true, "description": "After composition, invokes callback.\nMay be called multiple times.", "type": { "text": ", T3 extends CompositionCallback[\"composed\"]>(this: T1, callback: T3) => T1" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "css", "kind": "field", "static": true, "description": "Appends styles to composition", "type": { "text": "(this: T1, array: T2, ...rest: T2 extends string ? any : T2 extends TemplateStringsArray ? any[] : (HTMLStyleElement | CSSStyleSheet)[]) => T1" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "autoRegister", "kind": "field", "static": true, "description": "Registers class with customElements. If class is registered before then,\ndoes nothing.", "type": { "text": "(this: T, elementName: string) => T" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "html", "kind": "field", "static": true, "description": "Appends DocumentFragment to composition", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1405" }, "type": { "text": "(this: T, string: TemplateStringsArray, ...substitutions: (string | Element | ((this: InstanceType, data: InstanceType, injections?: any) => any))[]) => T" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "extend", "kind": "field", "static": true, "description": "Extends base class into a new class.\nUse to avoid mutating base class.", "type": { "text": " T2>(this: T1, customExtender?: T3) => T3 extends null ? T1 : T2" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "setStatic", "kind": "field", "static": true, "description": "Assigns static values to class", "type": { "text": " any) | string | number | boolean | any[] | object); }>(this: T1, source: T2 & ThisType) => T1 & T2" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "readonly", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "set", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "mixin", "kind": "field", "static": true, "description": "Returns result of calling mixin with current class", "type": { "text": " any, RETURN extends ReturnType, SUBCLASS extends ClassOf>(this: BASE, mixin: FN) => SUBCLASS & BASE" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "register", "kind": "field", "static": true, "description": "Registers class with window.customElements synchronously", "type": { "text": "(this: T, elementName?: string, force?: boolean) => T" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "propList", "kind": "field", "static": true, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "attrList", "kind": "field", "static": true, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "propChangedCallbacks", "kind": "field", "static": true, "type": { "text": "Map any)[]>" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "attributeChangedCallbacks", "kind": "field", "static": true, "type": { "text": "Map any)[]>" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "prop", "kind": "field", "static": true, "description": "Creates observable property on instances (via prototype)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1007" }, "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "setPrototype", "kind": "field", "static": true, "description": "Creates observable property on instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any)>(this: CLASS, name: KEY, options: OPTIONS) => OPTIONS extends (...args2: any[]) => infer R ? R : OPTIONS extends ObserverPropertyType ? ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? unknown extends R ? object : R : OPTIONS extends { type: ObserverPropertyType; } ? ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? unknown extends R ? string : R : never" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "define", "kind": "field", "static": true, "description": "Define properties on instances via Object.defineProperties().\nAutomatically sets property non-enumerable if name begins with `_`.\nFunctions will be remapped as getters", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends { [P in keyof any]: { enumerable?: boolean; configurable?: boolean; writable?: boolean; value?: any; get?: ((this: INSTANCE) => any); set?: (this: INSTANCE, value: any) => void; } | ((this: INSTANCE, ...args: any[]) => any); }, VALUE extends { [KEY in keyof PROPS]: PROPS[KEY] extends (...args2: any[]) => infer R ? R : PROPS[KEY] extends TypedPropertyDescriptor ? R : never; }>(this: CLASS, props: PROPS & ThisType) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "undefine", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROP extends string, PROPS extends INSTANCE & Record>(this: CLASS, name: PROP) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "observe", "kind": "field", "static": true, "description": "Creates observable properties on instances", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends IDLParameter, VALUE extends { [KEY in keyof PROPS]: PROPS[KEY] extends (...args2: any[]) => infer R ? R : PROPS[KEY] extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : PROPS[KEY] extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : PROPS[KEY] extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : PROPS[KEY] extends ObserverOptions ? (unknown extends R ? string : R) : never; }>(this: CLASS, props: PROPS) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "defineStatic", "kind": "field", "static": true, "type": { "text": ">(this: T1, props: T2) => T1 & ParsedProps" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "events", "kind": "field", "static": true, "type": { "text": "(this: T, listeners?: CompositionEventListenerObject>, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "childEvents", "kind": "field", "static": true, "type": { "text": "(this: T, listenerMap: { [x: string]: CompositionEventListenerObject>; }, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "rootEvents", "kind": "field", "static": true, "type": { "text": "(this: T, listeners?: CompositionEventListenerObject>, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "on", "kind": "field", "static": true, "type": { "text": ", T3 extends CompositionCallback, T4 extends keyof T3>(this: T1, name: T3 | T4, callbacks?: T3[T4] & ThisType) => T1" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "off", "kind": "field", "static": true, "type": { "text": ", T3 extends CompositionCallback, T4 extends keyof T3>(this: T1, name: T3 | T4, callbacks?: T3[T4] & ThisType) => T1" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "offPropChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: ObjectOrObjectEntries<{ [P in keyof T2]?: (this: T2, oldValue: T2[P], newValue: T2[P], changes: any, element: T2) => void; }>) => T1" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "offAttributeChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: { [x: string]: (this: T2, oldValue: string, newValue: string, element: T2) => void; }) => T1" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "onPropChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: ObjectOrObjectEntries<{ [P in keyof T2]?: (this: T2, oldValue: T2[P], newValue: T2[P], changes: any, element: T2) => void; }>) => T1" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } }, { "name": "onAttributeChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: { [x: string]: (this: T2, oldValue: string, newValue: string, element: T2) => void; }) => T1" }, "inheritedFrom": { "name": "default", "module": "components/ListOption.js" } } ], "slots": [ { "name": "leading", "description": "{leading}" }, { "name": "", "description": "" }, { "name": "supporting", "description": "{supporting}" }, { "name": "trailing", "description": "{trailing}" } ], "cssParts": [], "events": [], "demos": [], "superclass": { "module": "components/ListOption.js", "name": "default" }, "mixins": [ { "module": "mixins/FormAssociatedMixin.js", "name": "default" } ], "description": "Menu items represent selectable options within a menu. They can trigger\nactions, toggle state, or open nested submenus.\n@see https://m3.material.io/components/menus/specs" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "default", "module": "components/MenuItem.js" } }, { "kind": "custom-element-definition", "name": "mdw-menu-item", "declaration": { "name": "default", "module": "components/MenuItem.js" } } ] }, { "kind": "javascript-module", "path": "components/NavBar.js", "declarations": [ { "kind": "class", "name": "NavBar", "tagName": "mdw-nav-bar", "customElement": true, "attributes": [ { "name": "ink", "fieldName": "ink", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "type-style", "fieldName": "typeStyle", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "open", "description": "When true, the navigation bar is expanded and visible on small viewports.", "fieldName": "open", "type": { "text": "boolean" } }, { "name": "auto-close", "description": "Pixel threshold for auto-closing the nav bar based on viewport width.\nA value of `-1` disables auto-close. Default: 728.", "fieldName": "autoClose", "type": { "text": "number" } }, { "name": "color", "type": { "text": "string" }, "description": "Palette or surface token used to select background/ink tokens.\nExamples: 'primary', 'background', 'surface-container-low'.", "fieldName": "color", "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } } ], "members": [ { "name": "delegatesFocus", "kind": "field", "description": "When true, the element delegates focus to an internal focus target.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/DelegatesFocusMixin.js#L15" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "color", "kind": "field", "description": "Palette or surface token used to select background/ink tokens.\nExamples: 'primary', 'background', 'surface-container-low'.\nColor token used for the nav surface (defaults to `surface-container`).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/NavBar.js#L30" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "ink", "kind": "field", "description": "Explicit ink override token (e.g. 'outline', 'on-primary', 'inverse-on-surface', 'inherit').\nMaps to `--mdw-ink`.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L57" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "typeStyle", "kind": "field", "description": "Typographic style shortcut that maps to type scale variables\n(e.g. 'headline-large', 'body-medium').", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L62" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "open", "kind": "field", "description": "When true, the navigation bar is expanded and visible on small viewports.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/NavBar.js#L17" }, "type": { "text": "boolean" } }, { "name": "autoClose", "kind": "field", "description": "Pixel threshold for auto-closing the nav bar based on viewport width.\nA value of `-1` disables auto-close. Default: 728.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/NavBar.js#L23" }, "type": { "text": "number" } }, { "name": "onWindowResize", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/NavBar.js#L72" }, "return": { "type": { "text": "() => void" } } }, { "name": "prototype", "kind": "field", "static": true, "type": { "text": "CustomElement" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "compose", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L145" }, "type": { "text": "(parts: CompositionPart[]) => Composition" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#refsProxy", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1145" }, "type": { "text": "Record" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#refsCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1148" }, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#refsCompositionCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1151" }, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#composition", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1154" }, "type": { "text": "Composition" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#patching", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1156" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#pendingPatchRenders", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1159" }, "type": { "text": "[string, any, CustomElement][]" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#propAttributeCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1162" }, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#callbackArguments", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1165" }, "type": { "text": "CallbackArguments" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "elementInternals", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1172" }, "type": { "text": "ElementInternals" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "render", "kind": "field", "description": "Updates nodes based on data\nExpects data in JSON Merge Patch format", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1185" }, "type": { "text": "RenderDraw" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "propChangedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1213" }, "type": { "text": "(this: T, name: K, oldValue: K extends keyof T ? T[K] : unknown, newValue: K extends keyof T ? T[K] : unknown, changes?: K extends keyof T ? T[K] extends object ? Partial : T[K] : unknown) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attributeChangedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1234" }, "type": { "text": "(name: string, oldValue: string, newValue: string) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#template", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1284" }, "type": { "text": "DocumentFragment" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#onObserverPropertyChanged", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1294" }, "type": { "text": "(name: string, oldValue: any, newValue: any, changes: any) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "static", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1330" }, "type": { "text": "typeof CustomElement" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "patch", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1333" }, "type": { "text": "(patch: any) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "refs", "kind": "field", "description": "Proxy object that returns shadow DOM elements by tag.\nIf called before interpolation (eg: on composed), returns from template", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1404" }, "type": { "text": "Record" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attributeCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1391" }, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "callbackArguments", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1400" }, "type": { "text": "CallbackArguments | { composition: Composition; refs: Record; html: any; inline: (fn: (data: Partial) => any) => string; template: DocumentFragment; element: T; }" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "composition", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1403" }, "type": { "text": "Composition" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "connectedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1435" }, "type": { "text": "() => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "disconnectedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1441" }, "type": { "text": "() => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "elementName", "kind": "field", "static": true, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "observedAttributes", "kind": "field", "static": true, "type": { "text": "Iterable" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "interpolatesTemplate", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "supportsElementInternals", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "supportsElementInternalsRole", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "defined", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "registrations", "kind": "field", "static": true, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "expressions", "kind": "method", "static": true, "description": "Expressions are idempotent functions that are selectively called whenever\na render is requested.\nExpressions are constructed exactly as methods though differ in expected\narguments. The first argument should be destructured to ensure each used\nproperty is accessed at least once in order to inspect used properties.\n\nThe Composition API will inspect this function with a proxy for `this` to\ncatalog what observables are used by the expression. This allows the\nComposition API to build a cache as well as selective invoke the expression\nonly when needed.\n\nWhen used with in element templates, the element itself will be passed as\nits first argument.\n````js\n Button\n .prop('filled', 'boolean')\n .prop('outlined', 'boolean')\n .expresssions({\n _isFilledOrOutlined({filled, outlined}) {\n return (filled || outlined)\n },\n })\n .html`
`;\n````\n\nWhen used with external data source, that data source\nwill be passed to the expression with all properties being `null` at first\ninspection.\n````js\n const externalData = {first: 'John', last: 'Doe'};\n ContactCard\n .expresssions({\n _fullName({first, last}) {\n return [first, last].filter(Boolean).join(' ');\n },\n })\n myButton.render(externalData);\n````\n\nExpressions may be support argumentless calls by using default\nparameters with `this`.\n````js\n Button\n .expresssions({\n isFilledOrOutlined({filled, outlined} = this) {\n return (filled || outlined)\n },\n });\n myButton.isFilledorOutlined();\n````", "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends { [K in keyof any]: K extends `_${any}` ? ((data: INSTANCE, state?: Record) => string | boolean | null) : ((data?: INSTANCE, state?: Record) => string | boolean | null); } & ThisType>(this: CLASS, expressions: PROPS & ThisType) => CLASS & Class<{ [K in keyof PROPS]: K extends `_${any}` ? never : () => ReturnType; }, ARGS>" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "methods", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "overrides", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends Partial>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "props", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "idl", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "append", "kind": "field", "static": true, "description": "Append parts to composition", "type": { "text": "(this: T, ...parts: CompositionPart[]) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "recompose", "kind": "field", "static": true, "description": "After composition, invokes callback.\nMay be called multiple times.", "type": { "text": ", T3 extends CompositionCallback[\"composed\"]>(this: T1, callback: T3) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "css", "kind": "field", "static": true, "description": "Appends styles to composition", "type": { "text": "(this: T1, array: T2, ...rest: T2 extends string ? any : T2 extends TemplateStringsArray ? any[] : (HTMLStyleElement | CSSStyleSheet)[]) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "autoRegister", "kind": "field", "static": true, "description": "Registers class with customElements. If class is registered before then,\ndoes nothing.", "type": { "text": "(this: T, elementName: string) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "html", "kind": "field", "static": true, "description": "Appends DocumentFragment to composition", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1405" }, "type": { "text": "(this: T, string: TemplateStringsArray, ...substitutions: (string | Element | ((this: InstanceType, data: InstanceType, injections?: any) => any))[]) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "extend", "kind": "field", "static": true, "description": "Extends base class into a new class.\nUse to avoid mutating base class.", "type": { "text": " T2>(this: T1, customExtender?: T3) => T3 extends null ? T1 : T2" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "setStatic", "kind": "field", "static": true, "description": "Assigns static values to class", "type": { "text": " any) | string | number | boolean | any[] | object); }>(this: T1, source: T2 & ThisType) => T1 & T2" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "readonly", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "set", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "mixin", "kind": "field", "static": true, "description": "Returns result of calling mixin with current class", "type": { "text": " any, RETURN extends ReturnType, SUBCLASS extends ClassOf>(this: BASE, mixin: FN) => SUBCLASS & BASE" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "register", "kind": "field", "static": true, "description": "Registers class with window.customElements synchronously", "type": { "text": "(this: T, elementName?: string, force?: boolean) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "propList", "kind": "field", "static": true, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attrList", "kind": "field", "static": true, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "propChangedCallbacks", "kind": "field", "static": true, "type": { "text": "Map any)[]>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attributeChangedCallbacks", "kind": "field", "static": true, "type": { "text": "Map any)[]>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "prop", "kind": "field", "static": true, "description": "Creates observable property on instances (via prototype)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1007" }, "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "setPrototype", "kind": "field", "static": true, "description": "Creates observable property on instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any)>(this: CLASS, name: KEY, options: OPTIONS) => OPTIONS extends (...args2: any[]) => infer R ? R : OPTIONS extends ObserverPropertyType ? ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? unknown extends R ? object : R : OPTIONS extends { type: ObserverPropertyType; } ? ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? unknown extends R ? string : R : never" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "define", "kind": "field", "static": true, "description": "Define properties on instances via Object.defineProperties().\nAutomatically sets property non-enumerable if name begins with `_`.\nFunctions will be remapped as getters", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends { [P in keyof any]: { enumerable?: boolean; configurable?: boolean; writable?: boolean; value?: any; get?: ((this: INSTANCE) => any); set?: (this: INSTANCE, value: any) => void; } | ((this: INSTANCE, ...args: any[]) => any); }, VALUE extends { [KEY in keyof PROPS]: PROPS[KEY] extends (...args2: any[]) => infer R ? R : PROPS[KEY] extends TypedPropertyDescriptor ? R : never; }>(this: CLASS, props: PROPS & ThisType) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "undefine", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROP extends string, PROPS extends INSTANCE & Record>(this: CLASS, name: PROP) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "observe", "kind": "field", "static": true, "description": "Creates observable properties on instances", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends IDLParameter, VALUE extends { [KEY in keyof PROPS]: PROPS[KEY] extends (...args2: any[]) => infer R ? R : PROPS[KEY] extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : PROPS[KEY] extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : PROPS[KEY] extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : PROPS[KEY] extends ObserverOptions ? (unknown extends R ? string : R) : never; }>(this: CLASS, props: PROPS) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "defineStatic", "kind": "field", "static": true, "type": { "text": ">(this: T1, props: T2) => T1 & ParsedProps" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "events", "kind": "field", "static": true, "type": { "text": "(this: T, listeners?: CompositionEventListenerObject>, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "childEvents", "kind": "field", "static": true, "type": { "text": "(this: T, listenerMap: { [x: string]: CompositionEventListenerObject>; }, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "rootEvents", "kind": "field", "static": true, "type": { "text": "(this: T, listeners?: CompositionEventListenerObject>, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "on", "kind": "field", "static": true, "type": { "text": ", T3 extends CompositionCallback, T4 extends keyof T3>(this: T1, name: T3 | T4, callbacks?: T3[T4] & ThisType) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "off", "kind": "field", "static": true, "type": { "text": ", T3 extends CompositionCallback, T4 extends keyof T3>(this: T1, name: T3 | T4, callbacks?: T3[T4] & ThisType) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "offPropChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: ObjectOrObjectEntries<{ [P in keyof T2]?: (this: T2, oldValue: T2[P], newValue: T2[P], changes: any, element: T2) => void; }>) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "offAttributeChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: { [x: string]: (this: T2, oldValue: string, newValue: string, element: T2) => void; }) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "onPropChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: ObjectOrObjectEntries<{ [P in keyof T2]?: (this: T2, oldValue: T2[P], newValue: T2[P], changes: any, element: T2) => void; }>) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "onAttributeChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: { [x: string]: (this: T2, oldValue: string, newValue: string, element: T2) => void; }) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } } ], "slots": [ { "name": "", "description": "" } ], "cssParts": [], "events": [ { "name": "window-resize", "type": { "text": "Event" } } ], "demos": [ { "url": "demo/components/navbar.html" } ], "superclass": { "module": "core/CustomElement.js", "name": "default" }, "mixins": [ { "module": "mixins/DelegatesFocusMixin.js", "name": "default" }, { "module": "mixins/ThemableMixin.js", "name": "default" } ], "description": "Navigation bars let people switch between UI views on smaller devices\n@see https://m3.material.io/components/navigation-bar/specs" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "default", "module": "components/NavBar.js" } }, { "kind": "custom-element-definition", "name": "mdw-nav-bar", "declaration": { "name": "default", "module": "components/NavBar.js" } } ] }, { "kind": "javascript-module", "path": "components/NavBarItem.js", "declarations": [ { "kind": "class", "name": "NavBarItem", "tagName": "mdw-nav-bar-item", "customElement": true, "attributes": [ { "name": "color", "fieldName": "color", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "ink", "fieldName": "ink", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "type-style", "fieldName": "typeStyle", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "disabled", "fieldName": "disabled", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "focused", "fieldName": "focused", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "hovered", "fieldName": "hovered", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "pressed", "fieldName": "pressed", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "href", "fieldName": "href", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "target", "fieldName": "target", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "download", "fieldName": "download", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "ping", "fieldName": "ping", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "rel", "fieldName": "rel", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "hreflang", "fieldName": "hreflang", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "referrerpolicy", "fieldName": "referrerPolicy", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "show-label", "fieldName": "showLabel", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "active", "fieldName": "active", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "icon", "fieldName": "icon", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "src", "fieldName": "src", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "badge", "fieldName": "badge", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "aria-label", "fieldName": "ariaLabel", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "state-layer", "type": { "text": "boolean" }, "description": "Show the visual state layer element when true", "fieldName": "stateLayer", "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } } ], "members": [ { "name": "delegatesFocus", "kind": "field", "description": "When true, the element delegates focus to an internal focus target.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/DelegatesFocusMixin.js#L15" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "href", "kind": "field", "description": "The URL that the hyperlink points to.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L34" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "target", "kind": "field", "description": "The browsing context in which to open the linked resource (e.g. '_blank').", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L36" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "download", "kind": "field", "description": "Suggested filename for download.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L38" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "ping", "kind": "field", "description": "URLs to be pinged when the link is followed.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L40" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "rel", "kind": "field", "description": "Link relationship tokens (e.g. 'noopener', 'noreferrer').", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L42" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "hreflang", "kind": "field", "description": "Language of the linked resource.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L44" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "referrerPolicy", "kind": "field", "description": "Referrer policy for the link (serialized to 'referrerpolicy' attribute).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L46" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "origin", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L49" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "protocol", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L50" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "username", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L51" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "password", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L52" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "host", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L53" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "hostname", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L54" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "port", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L55" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "pathname", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L56" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "search", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L57" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "hash", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L58" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "disabled", "kind": "field", "description": "Whether the element is disabled (affects interactive states)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L14" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "focused", "kind": "field", "description": "Force focus state (independent of document)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L16" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "hovered", "kind": "field", "description": "Force hover state (independent of interaction)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L18" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "pressed", "kind": "field", "description": "Force pressed state (independent of interaction)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L20" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "disabledState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L37" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "hoveredState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L38" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "focusedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L39" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "pressedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L40" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "touchedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L41" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "pointedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L44" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "stateTargetElement", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L50" }, "type": { "text": "HTMLElement" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "addRipple", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/RippleMixin.js#L37" }, "type": { "text": "(x?: number, y?: number, hold?: boolean) => CustomElement & { hadRippleHeld: boolean; hadRippleReleased: boolean; rippleStarted: boolean; } & { rippleState: string; keepAlive: boolean; _positionX: number; _positionY: number; _radius: number; holdRipple: boolean; } & { _positionStyle: ElementStylerOptions | { styles: { minHeight: string; minWidth: string; boxShadow: string; top: string; left: string; }; }; } & { updatePosition(x?: number, y?: number, size?: number): void; handleRippleComplete(): void; }" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "color", "kind": "field", "description": "Palette or surface token used to select background/ink tokens.\nExamples: 'primary', 'background', 'surface-container-low'.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L52" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "ink", "kind": "field", "description": "Explicit ink override token (e.g. 'outline', 'on-primary', 'inverse-on-surface', 'inherit').\nMaps to `--mdw-ink`.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L57" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "typeStyle", "kind": "field", "description": "Typographic style shortcut that maps to type scale variables\n(e.g. 'headline-large', 'body-medium').", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L62" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "prototype", "kind": "field", "static": true, "type": { "text": "CustomElement" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "stateLayer", "kind": "field", "description": "Show the visual state layer element when true", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/NavItem.js#L31" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "showLabel", "kind": "field", "description": "Whether the label slot is visible. When true the label is shown.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/NavItem.js#L35" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "active", "kind": "field", "description": "Whether the item is active/selected; affects styling and aria-current.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/NavItem.js#L37" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "icon", "kind": "field", "description": "Name of the icon to display (e.g. 'home'); ignored when `src` is provided.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/NavItem.js#L39" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "src", "kind": "field", "description": "URL of an icon image; takes precedence over `icon` when present.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/NavItem.js#L41" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "badge", "kind": "field", "description": "Badge content to display on the item (e.g. notification count).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/NavItem.js#L43" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "iconVariation", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/NavItem.js#L62" }, "type": { "text": "() => string" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } } ], "slots": [ { "name": "", "description": "" } ], "cssParts": [ { "name": "badge" } ], "events": [], "demos": [], "superclass": { "module": "components/NavItem.js", "name": "default" }, "mixins": [], "description": "A navigation bar item represents a destination within a navigation bar,\nproviding an icon and optional label to help users move between app sections.\n@see https://m3.material.io/components/navigation-bar/specs" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "default", "module": "components/NavBarItem.js" } }, { "kind": "custom-element-definition", "name": "mdw-nav-bar-item", "declaration": { "name": "default", "module": "components/NavBarItem.js" } } ] }, { "kind": "javascript-module", "path": "components/NavDrawer.js", "declarations": [ { "kind": "class", "name": "NavDrawer", "tagName": "mdw-nav-drawer", "customElement": true, "attributes": [ { "name": "color", "fieldName": "color", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/SideSheet.js" } }, { "name": "ink", "fieldName": "ink", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/SideSheet.js" } }, { "name": "type-style", "fieldName": "typeStyle", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/SideSheet.js" } }, { "name": "block", "fieldName": "block", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/SideSheet.js" } }, { "name": "inline", "fieldName": "inline", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/SideSheet.js" } }, { "name": "row", "fieldName": "row", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/SideSheet.js" } }, { "name": "x", "fieldName": "x", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/SideSheet.js" } }, { "name": "y", "fieldName": "y", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/SideSheet.js" } }, { "name": "gap", "fieldName": "gap", "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "components/SideSheet.js" } }, { "name": "padding", "fieldName": "padding", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/SideSheet.js" } }, { "name": "shape-top", "fieldName": "shapeTop", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/SideSheet.js" } }, { "name": "shape-bottom", "fieldName": "shapeBottom", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/SideSheet.js" } }, { "name": "shape-start", "fieldName": "shapeStart", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/SideSheet.js" } }, { "name": "shape-end", "description": "When true, apply drawer shape at the end edge (RTL-aware).", "fieldName": "shapeEnd", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/SideSheet.js" } }, { "name": "shape-style", "fieldName": "shapeStyle", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/SideSheet.js" } }, { "name": "outlined", "fieldName": "outlined", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/SideSheet.js" } }, { "name": "fixed", "fieldName": "fixed", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/SideSheet.js" } }, { "name": "open", "fieldName": "open", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/SideSheet.js" } }, { "name": "inline-end", "fieldName": "inlineEnd", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/SideSheet.js" } }, { "name": "ontoggle", "fieldName": "ontoggle", "type": { "text": "function" }, "inheritedFrom": { "name": "default", "module": "components/SideSheet.js" } }, { "name": "onclose", "fieldName": "onclose", "type": { "text": "function" }, "inheritedFrom": { "name": "default", "module": "components/SideSheet.js" } }, { "name": "auto-open", "description": "Viewport width in pixels at or above which the drawer auto-opens.\nUse `-1` to disable auto-open. Default: 1248.", "fieldName": "autoOpen", "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "components/SideSheet.js" } }, { "name": "auto-close", "fieldName": "autoClose", "type": { "text": "float" }, "inheritedFrom": { "name": "default", "module": "components/SideSheet.js" } }, { "name": "fixed-breakpoint", "description": "Fixed layout breakpoint in pixels for permanent/dismissible drawer modes.\nDefault: 1248.", "fieldName": "fixedBreakpoint", "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "components/SideSheet.js" } }, { "name": "fixed-color", "fieldName": "fixedColor", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/SideSheet.js" } } ], "members": [ { "name": "delegatesFocus", "kind": "field", "description": "When true, the element delegates focus to an internal focus target.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/DelegatesFocusMixin.js#L15" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/SideSheet.js" } }, { "name": "observeResize", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ResizeObserverMixin.js#L26" }, "type": { "text": "() => void" }, "inheritedFrom": { "name": "default", "module": "components/SideSheet.js" } }, { "name": "unobserveResize", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ResizeObserverMixin.js#L31" }, "type": { "text": "() => void" }, "inheritedFrom": { "name": "default", "module": "components/SideSheet.js" } }, { "name": "readAriaProperty", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/AriaReflectorMixin.js#L28" }, "type": { "text": "(name: \"shadowRoot\" | \"ariaActiveDescendantElement\" | \"ariaAtomic\" | \"ariaAutoComplete\" | \"ariaBrailleLabel\" | \"ariaBrailleRoleDescription\" | \"ariaBusy\" | \"ariaChecked\" | \"ariaColCount\" | \"ariaColIndex\" | \"ariaColIndexText\" | \"ariaColSpan\" | \"ariaControlsElements\" | \"ariaCurrent\" | \"ariaDescribedByElements\" | \"ariaDescription\" | \"ariaDetailsElements\" | \"ariaDisabled\" | \"ariaErrorMessageElements\" | \"ariaExpanded\" | \"ariaFlowToElements\" | \"ariaHasPopup\" | \"ariaHidden\" | \"ariaInvalid\" | \"ariaKeyShortcuts\" | \"ariaLabel\" | \"ariaLabelledByElements\" | \"ariaLevel\" | \"ariaLive\" | \"ariaModal\" | \"ariaMultiLine\" | \"ariaMultiSelectable\" | \"ariaOrientation\" | \"ariaOwnsElements\" | \"ariaPlaceholder\" | \"ariaPosInSet\" | \"ariaPressed\" | \"ariaReadOnly\" | \"ariaRelevant\" | \"ariaRequired\" | \"ariaRoleDescription\" | \"ariaRowCount\" | \"ariaRowIndex\" | \"ariaRowIndexText\" | \"ariaRowSpan\" | \"ariaSelected\" | \"ariaSetSize\" | \"ariaSort\" | \"ariaValueMax\" | \"ariaValueMin\" | \"ariaValueNow\" | \"ariaValueText\" | \"role\") => string | Element | ShadowRoot | readonly Element[]" }, "inheritedFrom": { "name": "default", "module": "components/SideSheet.js" } }, { "name": "updateAriaProperty", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/AriaReflectorMixin.js#L47" }, "type": { "text": ">(name: K, value: ARIAMixin[K]) => void" }, "inheritedFrom": { "name": "default", "module": "components/SideSheet.js" } }, { "name": "disabled", "kind": "field", "description": "Whether the element is disabled (affects interactive states)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L14" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/SideSheet.js" } }, { "name": "focused", "kind": "field", "description": "Force focus state (independent of document)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L16" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/SideSheet.js" } }, { "name": "hovered", "kind": "field", "description": "Force hover state (independent of interaction)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L18" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/SideSheet.js" } }, { "name": "pressed", "kind": "field", "description": "Force pressed state (independent of interaction)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L20" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/SideSheet.js" } }, { "name": "stateLayer", "kind": "field", "description": "Show the visual state layer element when true", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L34" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/SideSheet.js" } }, { "name": "disabledState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L37" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/SideSheet.js" } }, { "name": "hoveredState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L38" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/SideSheet.js" } }, { "name": "focusedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L39" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/SideSheet.js" } }, { "name": "pressedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L40" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/SideSheet.js" } }, { "name": "touchedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L41" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/SideSheet.js" } }, { "name": "pointedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L44" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/SideSheet.js" } }, { "name": "stateTargetElement", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L50" }, "type": { "text": "HTMLElement" }, "inheritedFrom": { "name": "default", "module": "components/SideSheet.js" } }, { "name": "ink", "kind": "field", "description": "Explicit ink override token (e.g. 'outline', 'on-primary', 'inverse-on-surface', 'inherit').\nMaps to `--mdw-ink`.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L57" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/SideSheet.js" } }, { "name": "typeStyle", "kind": "field", "description": "Typographic style shortcut that maps to type scale variables\n(e.g. 'headline-large', 'body-medium').", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L62" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/SideSheet.js" } }, { "name": "shapeTop", "kind": "field", "description": "Show top cut/shape on the element", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L9" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/SideSheet.js" } }, { "name": "shapeBottom", "kind": "field", "description": "Show bottom cut/shape on the element", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L11" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/SideSheet.js" } }, { "name": "shapeStart", "kind": "field", "description": "Show start-side cut/shape (logical start)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L13" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/SideSheet.js" } }, { "name": "shapeEnd", "kind": "field", "description": "Show end-side cut/shape (logical end)\nWhen true, apply drawer shape at the end edge (RTL-aware).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/NavDrawer.js#L13" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/SideSheet.js" } }, { "name": "shapeStyle", "kind": "field", "description": "Predefined shape size/style name (none|extra-small|small|medium|large|extra-large|full|inherit)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L17" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/SideSheet.js" } }, { "name": "outlined", "kind": "field", "description": "When true, an outline is rendered around the element", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L19" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/SideSheet.js" } }, { "name": "block", "kind": "field", "description": "Set `display: block` on the host (boolean)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js#L9" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/SideSheet.js" } }, { "name": "inline", "kind": "field", "description": "Use inline flex layout: `display: inline-flex` (boolean)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js#L11" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/SideSheet.js" } }, { "name": "row", "kind": "field", "description": "Switch main axis to horizontal: `flex-direction: row` (boolean)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js#L13" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/SideSheet.js" } }, { "name": "x", "kind": "field", "description": "Main-axis alignment / justification.\nAllowed: 'start'|'center'|'end'|'between'|'around'|'stretch'|'baseline'.\nDefault: 'start'.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js#L19" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/SideSheet.js" } }, { "name": "y", "kind": "field", "description": "Cross-axis alignment / alignment of items.\nSame allowed values as `x`. Default: 'start'.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js#L29" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/SideSheet.js" } }, { "name": "gap", "kind": "field", "description": "Gap between children. Accepts preset numeric strings (e.g. '8') mapped to px, or floats.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js#L36" }, "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "components/SideSheet.js" } }, { "name": "padding", "kind": "field", "description": "Padding preset or numeric value (e.g. 'pane', '8', '16').", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js#L38" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/SideSheet.js" } }, { "name": "autoOpen", "kind": "field", "description": "Optional auto-open minimum viewport inline-size (px); -1 disables.\nViewport width in pixels at or above which the drawer auto-opens.\nUse `-1` to disable auto-open. Default: 1248.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/NavDrawer.js#L22" }, "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "components/SideSheet.js" } }, { "name": "fixedBreakpoint", "kind": "field", "description": "Inline-size breakpoint (px) at which the sheet becomes `fixed`.\nFixed layout breakpoint in pixels for permanent/dismissible drawer modes.\nDefault: 1248.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/NavDrawer.js#L31" }, "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "components/SideSheet.js" } }, { "name": "prototype", "kind": "field", "static": true, "type": { "text": "CustomElement" }, "inheritedFrom": { "name": "default", "module": "components/SideSheet.js" } }, { "name": "color", "kind": "field", "description": "Palette or surface token used to select background/ink tokens.\nExamples: 'primary', 'background', 'surface-container-low'.\nThe theme color token used for the sheet background.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/SideSheet.js#L96" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/SideSheet.js" } }, { "name": "fixed", "kind": "field", "description": "When true the side sheet is fixed (non-modal/static), occupying layout space.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/SideSheet.js#L47" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/SideSheet.js" } }, { "name": "open", "kind": "field", "description": "Whether the sheet is currently open (visible).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/SideSheet.js#L49" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/SideSheet.js" } }, { "name": "inlineEnd", "kind": "field", "description": "When true, position the sheet at the inline end edge.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/SideSheet.js#L51" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/SideSheet.js" } }, { "name": "autoClose", "kind": "field", "description": "Optional auto-close maximum viewport inline-size (px); -1 disables.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/SideSheet.js#L84" }, "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "components/SideSheet.js" } }, { "name": "fixedColor", "kind": "field", "description": "Optional fixed-mode color token applied when sheet is fixed.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/SideSheet.js#L98" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/SideSheet.js" } }, { "name": "hostStyles", "kind": "field", "description": "Computed animation/style object applied to the host for open/close.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/SideSheet.js#L115" }, "type": { "text": "ElementStylerOptions | { styles: { marginLeft: string | number; marginRight: string | number; transform: string; }; timing: { duration: number; easing: string; }; }" }, "inheritedFrom": { "name": "default", "module": "components/SideSheet.js" } }, { "name": "checkForScrim", "kind": "method", "description": "Ensure a scrim is present when the sheet is modal (open && !fixed).\nWhen `animate` is true, keep the scrim around to run its fade-out.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/SideSheet.js#L142" }, "return": { "type": { "text": "(animate?: boolean) => void" } }, "inheritedFrom": { "name": "default", "module": "components/SideSheet.js" } }, { "name": "checkDragFinished", "kind": "method", "description": "Evaluate drag state and decide whether to close or snap open.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/SideSheet.js#L166" }, "return": { "type": { "text": "() => void" } }, "inheritedFrom": { "name": "default", "module": "components/SideSheet.js" } }, { "name": "onWindowResize", "kind": "method", "description": "Recompute `fixed`/`open` state based on the window width and breakpoints.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/SideSheet.js#L185" }, "return": { "type": { "text": "() => void" } }, "inheritedFrom": { "name": "default", "module": "components/SideSheet.js" } }, { "name": "onResizeObserved", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ResizeObserverMixin.js#L23" }, "return": { "type": { "text": "(entry: ResizeObserverEntry) => void" } }, "inheritedFrom": { "name": "default", "module": "components/SideSheet.js" } } ], "slots": [ { "name": "", "description": "" } ], "cssParts": [], "events": [], "demos": [ { "url": "demo/components/navdrawer.html" } ], "superclass": { "module": "components/SideSheet.js", "name": "default" }, "mixins": [], "description": "Navigation drawers provide access to destinations and app-level navigation\nin a side panel. They can be modal, dismissible, or permanent depending on\nviewport and application needs.\n@see https://m3.material.io/components/navigation-drawer/specs" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "default", "module": "components/NavDrawer.js" } }, { "kind": "custom-element-definition", "name": "mdw-nav-drawer", "declaration": { "name": "default", "module": "components/NavDrawer.js" } } ] }, { "kind": "javascript-module", "path": "components/NavDrawerItem.js", "declarations": [ { "kind": "class", "name": "NavDrawerItem", "tagName": "mdw-nav-drawer-item", "customElement": true, "attributes": [ { "name": "color", "fieldName": "color", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "ink", "fieldName": "ink", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "type-style", "fieldName": "typeStyle", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "disabled", "fieldName": "disabled", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "focused", "fieldName": "focused", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "hovered", "fieldName": "hovered", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "pressed", "fieldName": "pressed", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "href", "fieldName": "href", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "target", "fieldName": "target", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "download", "fieldName": "download", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "ping", "fieldName": "ping", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "rel", "fieldName": "rel", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "hreflang", "fieldName": "hreflang", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "referrerpolicy", "fieldName": "referrerPolicy", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "show-label", "fieldName": "showLabel", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "active", "fieldName": "active", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "icon", "fieldName": "icon", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "src", "fieldName": "src", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "badge", "fieldName": "badge", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "aria-label", "fieldName": "ariaLabel", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "state-layer", "type": { "text": "boolean" }, "description": "Show the visual state layer element when true", "fieldName": "stateLayer", "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } } ], "members": [ { "name": "delegatesFocus", "kind": "field", "description": "When true, the element delegates focus to an internal focus target.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/DelegatesFocusMixin.js#L15" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "href", "kind": "field", "description": "The URL that the hyperlink points to.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L34" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "target", "kind": "field", "description": "The browsing context in which to open the linked resource (e.g. '_blank').", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L36" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "download", "kind": "field", "description": "Suggested filename for download.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L38" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "ping", "kind": "field", "description": "URLs to be pinged when the link is followed.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L40" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "rel", "kind": "field", "description": "Link relationship tokens (e.g. 'noopener', 'noreferrer').", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L42" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "hreflang", "kind": "field", "description": "Language of the linked resource.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L44" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "referrerPolicy", "kind": "field", "description": "Referrer policy for the link (serialized to 'referrerpolicy' attribute).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L46" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "origin", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L49" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "protocol", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L50" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "username", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L51" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "password", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L52" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "host", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L53" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "hostname", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L54" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "port", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L55" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "pathname", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L56" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "search", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L57" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "hash", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L58" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "disabled", "kind": "field", "description": "Whether the element is disabled (affects interactive states)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L14" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "focused", "kind": "field", "description": "Force focus state (independent of document)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L16" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "hovered", "kind": "field", "description": "Force hover state (independent of interaction)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L18" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "pressed", "kind": "field", "description": "Force pressed state (independent of interaction)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L20" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "disabledState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L37" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "hoveredState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L38" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "focusedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L39" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "pressedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L40" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "touchedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L41" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "pointedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L44" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "stateTargetElement", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L50" }, "type": { "text": "HTMLElement" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "addRipple", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/RippleMixin.js#L37" }, "type": { "text": "(x?: number, y?: number, hold?: boolean) => CustomElement & { hadRippleHeld: boolean; hadRippleReleased: boolean; rippleStarted: boolean; } & { rippleState: string; keepAlive: boolean; _positionX: number; _positionY: number; _radius: number; holdRipple: boolean; } & { _positionStyle: ElementStylerOptions | { styles: { minHeight: string; minWidth: string; boxShadow: string; top: string; left: string; }; }; } & { updatePosition(x?: number, y?: number, size?: number): void; handleRippleComplete(): void; }" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "color", "kind": "field", "description": "Palette or surface token used to select background/ink tokens.\nExamples: 'primary', 'background', 'surface-container-low'.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L52" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "ink", "kind": "field", "description": "Explicit ink override token (e.g. 'outline', 'on-primary', 'inverse-on-surface', 'inherit').\nMaps to `--mdw-ink`.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L57" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "typeStyle", "kind": "field", "description": "Typographic style shortcut that maps to type scale variables\n(e.g. 'headline-large', 'body-medium').", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L62" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "prototype", "kind": "field", "static": true, "type": { "text": "CustomElement" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "stateLayer", "kind": "field", "description": "Show the visual state layer element when true", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/NavItem.js#L31" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "showLabel", "kind": "field", "description": "Whether the label slot is visible. When true the label is shown.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/NavItem.js#L35" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "active", "kind": "field", "description": "Whether the item is active/selected; affects styling and aria-current.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/NavItem.js#L37" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "icon", "kind": "field", "description": "Name of the icon to display (e.g. 'home'); ignored when `src` is provided.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/NavItem.js#L39" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "src", "kind": "field", "description": "URL of an icon image; takes precedence over `icon` when present.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/NavItem.js#L41" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "badge", "kind": "field", "description": "Badge content to display on the item (e.g. notification count).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/NavItem.js#L43" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "iconVariation", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/NavItem.js#L62" }, "type": { "text": "() => string" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } } ], "slots": [ { "name": "", "description": "" } ], "cssParts": [], "events": [], "demos": [], "superclass": { "module": "components/NavItem.js", "name": "default" }, "mixins": [], "description": "A navigation drawer item represents a destination inside a navigation drawer,\nshowing an icon, label, and optional badge to help users navigate app sections.\n@see https://m3.material.io/components/navigation-drawer/specs" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "default", "module": "components/NavDrawerItem.js" } }, { "kind": "custom-element-definition", "name": "mdw-nav-drawer-item", "declaration": { "name": "default", "module": "components/NavDrawerItem.js" } } ] }, { "kind": "javascript-module", "path": "components/NavItem.js", "declarations": [ { "kind": "class", "name": "NavItem", "tagName": "mdw-nav-item", "customElement": true, "attributes": [ { "name": "color", "fieldName": "color", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "ink", "fieldName": "ink", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "type-style", "fieldName": "typeStyle", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "disabled", "fieldName": "disabled", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "focused", "fieldName": "focused", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "hovered", "fieldName": "hovered", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "pressed", "fieldName": "pressed", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "href", "fieldName": "href", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/HyperlinkMixin.js" } }, { "name": "target", "fieldName": "target", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/HyperlinkMixin.js" } }, { "name": "download", "fieldName": "download", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/HyperlinkMixin.js" } }, { "name": "ping", "fieldName": "ping", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/HyperlinkMixin.js" } }, { "name": "rel", "fieldName": "rel", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/HyperlinkMixin.js" } }, { "name": "hreflang", "fieldName": "hreflang", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/HyperlinkMixin.js" } }, { "name": "referrerpolicy", "fieldName": "referrerPolicy", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/HyperlinkMixin.js" } }, { "name": "show-label", "description": "Whether the label slot is visible. When true the label is shown.", "fieldName": "showLabel", "type": { "text": "string" } }, { "name": "active", "description": "Whether the item is active/selected; affects styling and aria-current.", "fieldName": "active", "type": { "text": "boolean" } }, { "name": "icon", "description": "Name of the icon to display (e.g. 'home'); ignored when `src` is provided.", "fieldName": "icon", "type": { "text": "string" } }, { "name": "src", "description": "URL of an icon image; takes precedence over `icon` when present.", "fieldName": "src", "type": { "text": "string" } }, { "name": "badge", "description": "Badge content to display on the item (e.g. notification count).", "fieldName": "badge", "type": { "text": "string" } }, { "name": "aria-label", "description": "Accessible label for the anchor; when present it is used instead of the slot text.", "fieldName": "ariaLabel", "type": { "text": "string" } }, { "name": "state-layer", "type": { "text": "boolean" }, "description": "Show the visual state layer element when true", "fieldName": "stateLayer", "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } } ], "members": [ { "name": "delegatesFocus", "kind": "field", "description": "When true, the element delegates focus to an internal focus target.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/DelegatesFocusMixin.js#L15" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "href", "kind": "field", "description": "The URL that the hyperlink points to.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L34" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/HyperlinkMixin.js" } }, { "name": "target", "kind": "field", "description": "The browsing context in which to open the linked resource (e.g. '_blank').", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L36" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/HyperlinkMixin.js" } }, { "name": "download", "kind": "field", "description": "Suggested filename for download.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L38" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/HyperlinkMixin.js" } }, { "name": "ping", "kind": "field", "description": "URLs to be pinged when the link is followed.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L40" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/HyperlinkMixin.js" } }, { "name": "rel", "kind": "field", "description": "Link relationship tokens (e.g. 'noopener', 'noreferrer').", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L42" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/HyperlinkMixin.js" } }, { "name": "hreflang", "kind": "field", "description": "Language of the linked resource.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L44" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/HyperlinkMixin.js" } }, { "name": "referrerPolicy", "kind": "field", "description": "Referrer policy for the link (serialized to 'referrerpolicy' attribute).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L46" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/HyperlinkMixin.js" } }, { "name": "origin", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L49" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/HyperlinkMixin.js" } }, { "name": "protocol", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L50" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/HyperlinkMixin.js" } }, { "name": "username", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L51" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/HyperlinkMixin.js" } }, { "name": "password", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L52" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/HyperlinkMixin.js" } }, { "name": "host", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L53" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/HyperlinkMixin.js" } }, { "name": "hostname", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L54" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/HyperlinkMixin.js" } }, { "name": "port", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L55" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/HyperlinkMixin.js" } }, { "name": "pathname", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L56" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/HyperlinkMixin.js" } }, { "name": "search", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L57" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/HyperlinkMixin.js" } }, { "name": "hash", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L58" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/HyperlinkMixin.js" } }, { "name": "disabled", "kind": "field", "description": "Whether the element is disabled (affects interactive states)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L14" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "focused", "kind": "field", "description": "Force focus state (independent of document)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L16" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "hovered", "kind": "field", "description": "Force hover state (independent of interaction)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L18" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "pressed", "kind": "field", "description": "Force pressed state (independent of interaction)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L20" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "stateLayer", "kind": "field", "description": "Show the visual state layer element when true", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/NavItem.js#L31" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "disabledState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L37" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "hoveredState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L38" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "focusedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L39" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "pressedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L40" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "touchedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L41" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "pointedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L44" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "stateTargetElement", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L50" }, "type": { "text": "HTMLElement" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "addRipple", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/RippleMixin.js#L37" }, "type": { "text": "(x?: number, y?: number, hold?: boolean) => CustomElement & { hadRippleHeld: boolean; hadRippleReleased: boolean; rippleStarted: boolean; } & { rippleState: string; keepAlive: boolean; _positionX: number; _positionY: number; _radius: number; holdRipple: boolean; } & { _positionStyle: ElementStylerOptions | { styles: { minHeight: string; minWidth: string; boxShadow: string; top: string; left: string; }; }; } & { updatePosition(x?: number, y?: number, size?: number): void; handleRippleComplete(): void; }" }, "inheritedFrom": { "name": "default", "module": "mixins/RippleMixin.js" } }, { "name": "color", "kind": "field", "description": "Palette or surface token used to select background/ink tokens.\nExamples: 'primary', 'background', 'surface-container-low'.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L52" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "ink", "kind": "field", "description": "Explicit ink override token (e.g. 'outline', 'on-primary', 'inverse-on-surface', 'inherit').\nMaps to `--mdw-ink`.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L57" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "typeStyle", "kind": "field", "description": "Typographic style shortcut that maps to type scale variables\n(e.g. 'headline-large', 'body-medium').", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L62" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "showLabel", "kind": "field", "description": "Whether the label slot is visible. When true the label is shown.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/NavItem.js#L35" }, "type": { "text": "string" } }, { "name": "active", "kind": "field", "description": "Whether the item is active/selected; affects styling and aria-current.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/NavItem.js#L37" }, "type": { "text": "boolean" } }, { "name": "icon", "kind": "field", "description": "Name of the icon to display (e.g. 'home'); ignored when `src` is provided.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/NavItem.js#L39" }, "type": { "text": "string" } }, { "name": "src", "kind": "field", "description": "URL of an icon image; takes precedence over `icon` when present.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/NavItem.js#L41" }, "type": { "text": "string" } }, { "name": "badge", "kind": "field", "description": "Badge content to display on the item (e.g. notification count).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/NavItem.js#L43" }, "type": { "text": "string" } }, { "name": "iconVariation", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/NavItem.js#L62" }, "type": { "text": "() => string" } }, { "name": "prototype", "kind": "field", "static": true, "type": { "text": "CustomElement" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "compose", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L145" }, "type": { "text": "(parts: CompositionPart[]) => Composition" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#refsProxy", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1145" }, "type": { "text": "Record" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#refsCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1148" }, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#refsCompositionCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1151" }, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#composition", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1154" }, "type": { "text": "Composition" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#patching", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1156" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#pendingPatchRenders", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1159" }, "type": { "text": "[string, any, CustomElement][]" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#propAttributeCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1162" }, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#callbackArguments", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1165" }, "type": { "text": "CallbackArguments" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "elementInternals", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1172" }, "type": { "text": "ElementInternals" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "render", "kind": "field", "description": "Updates nodes based on data\nExpects data in JSON Merge Patch format", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1185" }, "type": { "text": "RenderDraw" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "propChangedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1213" }, "type": { "text": "(this: T, name: K, oldValue: K extends keyof T ? T[K] : unknown, newValue: K extends keyof T ? T[K] : unknown, changes?: K extends keyof T ? T[K] extends object ? Partial : T[K] : unknown) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attributeChangedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1234" }, "type": { "text": "(name: string, oldValue: string, newValue: string) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#template", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1284" }, "type": { "text": "DocumentFragment" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#onObserverPropertyChanged", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1294" }, "type": { "text": "(name: string, oldValue: any, newValue: any, changes: any) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "static", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1330" }, "type": { "text": "typeof CustomElement" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "patch", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1333" }, "type": { "text": "(patch: any) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "refs", "kind": "field", "description": "Proxy object that returns shadow DOM elements by tag.\nIf called before interpolation (eg: on composed), returns from template", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1404" }, "type": { "text": "Record" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attributeCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1391" }, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "callbackArguments", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1400" }, "type": { "text": "CallbackArguments | { composition: Composition; refs: Record; html: any; inline: (fn: (data: Partial) => any) => string; template: DocumentFragment; element: T; }" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "composition", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1403" }, "type": { "text": "Composition" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "connectedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1435" }, "type": { "text": "() => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "disconnectedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1441" }, "type": { "text": "() => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "elementName", "kind": "field", "static": true, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "observedAttributes", "kind": "field", "static": true, "type": { "text": "Iterable" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "interpolatesTemplate", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "supportsElementInternals", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "supportsElementInternalsRole", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "defined", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "registrations", "kind": "field", "static": true, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "expressions", "kind": "method", "static": true, "description": "Expressions are idempotent functions that are selectively called whenever\na render is requested.\nExpressions are constructed exactly as methods though differ in expected\narguments. The first argument should be destructured to ensure each used\nproperty is accessed at least once in order to inspect used properties.\n\nThe Composition API will inspect this function with a proxy for `this` to\ncatalog what observables are used by the expression. This allows the\nComposition API to build a cache as well as selective invoke the expression\nonly when needed.\n\nWhen used with in element templates, the element itself will be passed as\nits first argument.\n````js\n Button\n .prop('filled', 'boolean')\n .prop('outlined', 'boolean')\n .expresssions({\n _isFilledOrOutlined({filled, outlined}) {\n return (filled || outlined)\n },\n })\n .html`
`;\n````\n\nWhen used with external data source, that data source\nwill be passed to the expression with all properties being `null` at first\ninspection.\n````js\n const externalData = {first: 'John', last: 'Doe'};\n ContactCard\n .expresssions({\n _fullName({first, last}) {\n return [first, last].filter(Boolean).join(' ');\n },\n })\n myButton.render(externalData);\n````\n\nExpressions may be support argumentless calls by using default\nparameters with `this`.\n````js\n Button\n .expresssions({\n isFilledOrOutlined({filled, outlined} = this) {\n return (filled || outlined)\n },\n });\n myButton.isFilledorOutlined();\n````", "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends { [K in keyof any]: K extends `_${any}` ? ((data: INSTANCE, state?: Record) => string | boolean | null) : ((data?: INSTANCE, state?: Record) => string | boolean | null); } & ThisType>(this: CLASS, expressions: PROPS & ThisType) => CLASS & Class<{ [K in keyof PROPS]: K extends `_${any}` ? never : () => ReturnType; }, ARGS>" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "methods", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "overrides", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends Partial>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "props", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "idl", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "append", "kind": "field", "static": true, "description": "Append parts to composition", "type": { "text": "(this: T, ...parts: CompositionPart[]) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "recompose", "kind": "field", "static": true, "description": "After composition, invokes callback.\nMay be called multiple times.", "type": { "text": ", T3 extends CompositionCallback[\"composed\"]>(this: T1, callback: T3) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "css", "kind": "field", "static": true, "description": "Appends styles to composition", "type": { "text": "(this: T1, array: T2, ...rest: T2 extends string ? any : T2 extends TemplateStringsArray ? any[] : (HTMLStyleElement | CSSStyleSheet)[]) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "autoRegister", "kind": "field", "static": true, "description": "Registers class with customElements. If class is registered before then,\ndoes nothing.", "type": { "text": "(this: T, elementName: string) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "html", "kind": "field", "static": true, "description": "Appends DocumentFragment to composition", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1405" }, "type": { "text": "(this: T, string: TemplateStringsArray, ...substitutions: (string | Element | ((this: InstanceType, data: InstanceType, injections?: any) => any))[]) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "extend", "kind": "field", "static": true, "description": "Extends base class into a new class.\nUse to avoid mutating base class.", "type": { "text": " T2>(this: T1, customExtender?: T3) => T3 extends null ? T1 : T2" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "setStatic", "kind": "field", "static": true, "description": "Assigns static values to class", "type": { "text": " any) | string | number | boolean | any[] | object); }>(this: T1, source: T2 & ThisType) => T1 & T2" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "readonly", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "set", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "mixin", "kind": "field", "static": true, "description": "Returns result of calling mixin with current class", "type": { "text": " any, RETURN extends ReturnType, SUBCLASS extends ClassOf>(this: BASE, mixin: FN) => SUBCLASS & BASE" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "register", "kind": "field", "static": true, "description": "Registers class with window.customElements synchronously", "type": { "text": "(this: T, elementName?: string, force?: boolean) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "propList", "kind": "field", "static": true, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attrList", "kind": "field", "static": true, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "propChangedCallbacks", "kind": "field", "static": true, "type": { "text": "Map any)[]>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attributeChangedCallbacks", "kind": "field", "static": true, "type": { "text": "Map any)[]>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "prop", "kind": "field", "static": true, "description": "Creates observable property on instances (via prototype)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1007" }, "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "setPrototype", "kind": "field", "static": true, "description": "Creates observable property on instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any)>(this: CLASS, name: KEY, options: OPTIONS) => OPTIONS extends (...args2: any[]) => infer R ? R : OPTIONS extends ObserverPropertyType ? ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? unknown extends R ? object : R : OPTIONS extends { type: ObserverPropertyType; } ? ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? unknown extends R ? string : R : never" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "define", "kind": "field", "static": true, "description": "Define properties on instances via Object.defineProperties().\nAutomatically sets property non-enumerable if name begins with `_`.\nFunctions will be remapped as getters", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends { [P in keyof any]: { enumerable?: boolean; configurable?: boolean; writable?: boolean; value?: any; get?: ((this: INSTANCE) => any); set?: (this: INSTANCE, value: any) => void; } | ((this: INSTANCE, ...args: any[]) => any); }, VALUE extends { [KEY in keyof PROPS]: PROPS[KEY] extends (...args2: any[]) => infer R ? R : PROPS[KEY] extends TypedPropertyDescriptor ? R : never; }>(this: CLASS, props: PROPS & ThisType) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "undefine", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROP extends string, PROPS extends INSTANCE & Record>(this: CLASS, name: PROP) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "observe", "kind": "field", "static": true, "description": "Creates observable properties on instances", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends IDLParameter, VALUE extends { [KEY in keyof PROPS]: PROPS[KEY] extends (...args2: any[]) => infer R ? R : PROPS[KEY] extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : PROPS[KEY] extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : PROPS[KEY] extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : PROPS[KEY] extends ObserverOptions ? (unknown extends R ? string : R) : never; }>(this: CLASS, props: PROPS) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "defineStatic", "kind": "field", "static": true, "type": { "text": ">(this: T1, props: T2) => T1 & ParsedProps" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "events", "kind": "field", "static": true, "type": { "text": "(this: T, listeners?: CompositionEventListenerObject>, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "childEvents", "kind": "field", "static": true, "type": { "text": "(this: T, listenerMap: { [x: string]: CompositionEventListenerObject>; }, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "rootEvents", "kind": "field", "static": true, "type": { "text": "(this: T, listeners?: CompositionEventListenerObject>, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "on", "kind": "field", "static": true, "type": { "text": ", T3 extends CompositionCallback, T4 extends keyof T3>(this: T1, name: T3 | T4, callbacks?: T3[T4] & ThisType) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "off", "kind": "field", "static": true, "type": { "text": ", T3 extends CompositionCallback, T4 extends keyof T3>(this: T1, name: T3 | T4, callbacks?: T3[T4] & ThisType) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "offPropChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: ObjectOrObjectEntries<{ [P in keyof T2]?: (this: T2, oldValue: T2[P], newValue: T2[P], changes: any, element: T2) => void; }>) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "offAttributeChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: { [x: string]: (this: T2, oldValue: string, newValue: string, element: T2) => void; }) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "onPropChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: ObjectOrObjectEntries<{ [P in keyof T2]?: (this: T2, oldValue: T2[P], newValue: T2[P], changes: any, element: T2) => void; }>) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "onAttributeChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: { [x: string]: (this: T2, oldValue: string, newValue: string, element: T2) => void; }) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } } ], "slots": [ { "name": "", "description": "" } ], "cssParts": [ { "name": "badge" } ], "events": [], "demos": [], "superclass": { "module": "core/CustomElement.js", "name": "default" }, "mixins": [ { "module": "mixins/ThemableMixin.js", "name": "default" }, { "module": "mixins/StateMixin.js", "name": "default" }, { "module": "mixins/RippleMixin.js", "name": "default" }, { "module": "mixins/HyperlinkMixin.js", "name": "default" }, { "module": "mixins/DelegatesFocusMixin.js", "name": "default" } ], "description": "@typedef {'charset'|'coords'|'name'|'shape'} DeprecatedHTMLAnchorElementProperties" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "default", "module": "components/NavItem.js" } }, { "kind": "custom-element-definition", "name": "mdw-nav-item", "declaration": { "name": "default", "module": "components/NavItem.js" } } ] }, { "kind": "javascript-module", "path": "components/NavRail.js", "declarations": [ { "kind": "class", "name": "NavRail", "tagName": "mdw-nav-rail", "customElement": true, "attributes": [ { "name": "color", "fieldName": "color", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/SideSheet.js" } }, { "name": "ink", "fieldName": "ink", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/SideSheet.js" } }, { "name": "type-style", "fieldName": "typeStyle", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/SideSheet.js" } }, { "name": "block", "fieldName": "block", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/SideSheet.js" } }, { "name": "inline", "fieldName": "inline", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/SideSheet.js" } }, { "name": "row", "fieldName": "row", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/SideSheet.js" } }, { "name": "x", "fieldName": "x", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/SideSheet.js" } }, { "name": "y", "fieldName": "y", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/SideSheet.js" } }, { "name": "gap", "fieldName": "gap", "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "components/SideSheet.js" } }, { "name": "padding", "fieldName": "padding", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/SideSheet.js" } }, { "name": "shape-top", "fieldName": "shapeTop", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/SideSheet.js" } }, { "name": "shape-bottom", "fieldName": "shapeBottom", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/SideSheet.js" } }, { "name": "shape-start", "fieldName": "shapeStart", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/SideSheet.js" } }, { "name": "shape-end", "fieldName": "shapeEnd", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/SideSheet.js" } }, { "name": "shape-style", "fieldName": "shapeStyle", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/SideSheet.js" } }, { "name": "outlined", "fieldName": "outlined", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/SideSheet.js" } }, { "name": "fixed", "fieldName": "fixed", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/SideSheet.js" } }, { "name": "open", "fieldName": "open", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/SideSheet.js" } }, { "name": "inline-end", "fieldName": "inlineEnd", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/SideSheet.js" } }, { "name": "ontoggle", "fieldName": "ontoggle", "type": { "text": "function" }, "inheritedFrom": { "name": "default", "module": "components/SideSheet.js" } }, { "name": "onclose", "fieldName": "onclose", "type": { "text": "function" }, "inheritedFrom": { "name": "default", "module": "components/SideSheet.js" } }, { "name": "auto-open", "description": "Viewport width (pixels) threshold at or above which the rail will auto-open.", "fieldName": "autoOpen", "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "components/SideSheet.js" } }, { "name": "auto-close", "description": "Viewport width (pixels) threshold at or below which the rail will auto-close.", "fieldName": "autoClose", "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "components/SideSheet.js" } }, { "name": "fixed-breakpoint", "description": "Viewport width (pixels) at which the rail becomes fixed (non-collapsible).", "fieldName": "fixedBreakpoint", "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "components/SideSheet.js" } }, { "name": "fixed-color", "fieldName": "fixedColor", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/SideSheet.js" } }, { "name": "align", "description": "Horizontal alignment for rail content: 'start', 'center', or 'end'.", "fieldName": "align", "type": { "text": "string" } } ], "members": [ { "name": "delegatesFocus", "kind": "field", "description": "When true, the element delegates focus to an internal focus target.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/DelegatesFocusMixin.js#L15" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/SideSheet.js" } }, { "name": "observeResize", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ResizeObserverMixin.js#L26" }, "type": { "text": "() => void" }, "inheritedFrom": { "name": "default", "module": "components/SideSheet.js" } }, { "name": "unobserveResize", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ResizeObserverMixin.js#L31" }, "type": { "text": "() => void" }, "inheritedFrom": { "name": "default", "module": "components/SideSheet.js" } }, { "name": "readAriaProperty", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/AriaReflectorMixin.js#L28" }, "type": { "text": "(name: \"shadowRoot\" | \"ariaActiveDescendantElement\" | \"ariaAtomic\" | \"ariaAutoComplete\" | \"ariaBrailleLabel\" | \"ariaBrailleRoleDescription\" | \"ariaBusy\" | \"ariaChecked\" | \"ariaColCount\" | \"ariaColIndex\" | \"ariaColIndexText\" | \"ariaColSpan\" | \"ariaControlsElements\" | \"ariaCurrent\" | \"ariaDescribedByElements\" | \"ariaDescription\" | \"ariaDetailsElements\" | \"ariaDisabled\" | \"ariaErrorMessageElements\" | \"ariaExpanded\" | \"ariaFlowToElements\" | \"ariaHasPopup\" | \"ariaHidden\" | \"ariaInvalid\" | \"ariaKeyShortcuts\" | \"ariaLabel\" | \"ariaLabelledByElements\" | \"ariaLevel\" | \"ariaLive\" | \"ariaModal\" | \"ariaMultiLine\" | \"ariaMultiSelectable\" | \"ariaOrientation\" | \"ariaOwnsElements\" | \"ariaPlaceholder\" | \"ariaPosInSet\" | \"ariaPressed\" | \"ariaReadOnly\" | \"ariaRelevant\" | \"ariaRequired\" | \"ariaRoleDescription\" | \"ariaRowCount\" | \"ariaRowIndex\" | \"ariaRowIndexText\" | \"ariaRowSpan\" | \"ariaSelected\" | \"ariaSetSize\" | \"ariaSort\" | \"ariaValueMax\" | \"ariaValueMin\" | \"ariaValueNow\" | \"ariaValueText\" | \"role\") => string | Element | ShadowRoot | readonly Element[]" }, "inheritedFrom": { "name": "default", "module": "components/SideSheet.js" } }, { "name": "updateAriaProperty", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/AriaReflectorMixin.js#L47" }, "type": { "text": ">(name: K, value: ARIAMixin[K]) => void" }, "inheritedFrom": { "name": "default", "module": "components/SideSheet.js" } }, { "name": "disabled", "kind": "field", "description": "Whether the element is disabled (affects interactive states)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L14" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/SideSheet.js" } }, { "name": "focused", "kind": "field", "description": "Force focus state (independent of document)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L16" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/SideSheet.js" } }, { "name": "hovered", "kind": "field", "description": "Force hover state (independent of interaction)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L18" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/SideSheet.js" } }, { "name": "pressed", "kind": "field", "description": "Force pressed state (independent of interaction)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L20" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/SideSheet.js" } }, { "name": "stateLayer", "kind": "field", "description": "Show the visual state layer element when true", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L34" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/SideSheet.js" } }, { "name": "disabledState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L37" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/SideSheet.js" } }, { "name": "hoveredState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L38" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/SideSheet.js" } }, { "name": "focusedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L39" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/SideSheet.js" } }, { "name": "pressedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L40" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/SideSheet.js" } }, { "name": "touchedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L41" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/SideSheet.js" } }, { "name": "pointedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L44" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/SideSheet.js" } }, { "name": "stateTargetElement", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L50" }, "type": { "text": "HTMLElement" }, "inheritedFrom": { "name": "default", "module": "components/SideSheet.js" } }, { "name": "ink", "kind": "field", "description": "Explicit ink override token (e.g. 'outline', 'on-primary', 'inverse-on-surface', 'inherit').\nMaps to `--mdw-ink`.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L57" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/SideSheet.js" } }, { "name": "typeStyle", "kind": "field", "description": "Typographic style shortcut that maps to type scale variables\n(e.g. 'headline-large', 'body-medium').", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L62" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/SideSheet.js" } }, { "name": "shapeTop", "kind": "field", "description": "Show top cut/shape on the element", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L9" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/SideSheet.js" } }, { "name": "shapeBottom", "kind": "field", "description": "Show bottom cut/shape on the element", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L11" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/SideSheet.js" } }, { "name": "shapeStart", "kind": "field", "description": "Show start-side cut/shape (logical start)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L13" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/SideSheet.js" } }, { "name": "shapeEnd", "kind": "field", "description": "Show end-side cut/shape (logical end)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L15" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/SideSheet.js" } }, { "name": "shapeStyle", "kind": "field", "description": "Predefined shape size/style name (none|extra-small|small|medium|large|extra-large|full|inherit)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L17" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/SideSheet.js" } }, { "name": "outlined", "kind": "field", "description": "When true, an outline is rendered around the element", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L19" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/SideSheet.js" } }, { "name": "block", "kind": "field", "description": "Set `display: block` on the host (boolean)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js#L9" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/SideSheet.js" } }, { "name": "inline", "kind": "field", "description": "Use inline flex layout: `display: inline-flex` (boolean)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js#L11" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/SideSheet.js" } }, { "name": "row", "kind": "field", "description": "Switch main axis to horizontal: `flex-direction: row` (boolean)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js#L13" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/SideSheet.js" } }, { "name": "x", "kind": "field", "description": "Main-axis alignment / justification.\nAllowed: 'start'|'center'|'end'|'between'|'around'|'stretch'|'baseline'.\nDefault: 'start'.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js#L19" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/SideSheet.js" } }, { "name": "y", "kind": "field", "description": "Cross-axis alignment / alignment of items.\nSame allowed values as `x`. Default: 'start'.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js#L29" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/SideSheet.js" } }, { "name": "gap", "kind": "field", "description": "Gap between children. Accepts preset numeric strings (e.g. '8') mapped to px, or floats.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js#L36" }, "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "components/SideSheet.js" } }, { "name": "padding", "kind": "field", "description": "Padding preset or numeric value (e.g. 'pane', '8', '16').", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js#L38" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/SideSheet.js" } }, { "name": "autoOpen", "kind": "field", "description": "Optional auto-open minimum viewport inline-size (px); -1 disables.\nViewport width (pixels) threshold at or above which the rail will auto-open.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/NavRail.js#L14" }, "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "components/SideSheet.js" } }, { "name": "autoClose", "kind": "field", "description": "Optional auto-close maximum viewport inline-size (px); -1 disables.\nViewport width (pixels) threshold at or below which the rail will auto-close.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/NavRail.js#L19" }, "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "components/SideSheet.js" } }, { "name": "fixedBreakpoint", "kind": "field", "description": "Inline-size breakpoint (px) at which the sheet becomes `fixed`.\nViewport width (pixels) at which the rail becomes fixed (non-collapsible).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/NavRail.js#L24" }, "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "components/SideSheet.js" } }, { "name": "align", "kind": "field", "description": "Horizontal alignment for rail content: 'start', 'center', or 'end'.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/NavRail.js#L12" }, "type": { "text": "\"start\" | \"center\" | \"end\"" } }, { "name": "prototype", "kind": "field", "static": true, "type": { "text": "CustomElement" }, "inheritedFrom": { "name": "default", "module": "components/SideSheet.js" } }, { "name": "color", "kind": "field", "description": "Palette or surface token used to select background/ink tokens.\nExamples: 'primary', 'background', 'surface-container-low'.\nThe theme color token used for the sheet background.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/SideSheet.js#L96" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/SideSheet.js" } }, { "name": "fixed", "kind": "field", "description": "When true the side sheet is fixed (non-modal/static), occupying layout space.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/SideSheet.js#L47" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/SideSheet.js" } }, { "name": "open", "kind": "field", "description": "Whether the sheet is currently open (visible).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/SideSheet.js#L49" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/SideSheet.js" } }, { "name": "inlineEnd", "kind": "field", "description": "When true, position the sheet at the inline end edge.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/SideSheet.js#L51" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/SideSheet.js" } }, { "name": "fixedColor", "kind": "field", "description": "Optional fixed-mode color token applied when sheet is fixed.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/SideSheet.js#L98" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/SideSheet.js" } }, { "name": "hostStyles", "kind": "field", "description": "Computed animation/style object applied to the host for open/close.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/SideSheet.js#L115" }, "type": { "text": "ElementStylerOptions | { styles: { marginLeft: string | number; marginRight: string | number; transform: string; }; timing: { duration: number; easing: string; }; }" }, "inheritedFrom": { "name": "default", "module": "components/SideSheet.js" } }, { "name": "checkForScrim", "kind": "method", "description": "Ensure a scrim is present when the sheet is modal (open && !fixed).\nWhen `animate` is true, keep the scrim around to run its fade-out.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/SideSheet.js#L142" }, "return": { "type": { "text": "(animate?: boolean) => void" } }, "inheritedFrom": { "name": "default", "module": "components/SideSheet.js" } }, { "name": "checkDragFinished", "kind": "method", "description": "Evaluate drag state and decide whether to close or snap open.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/SideSheet.js#L166" }, "return": { "type": { "text": "() => void" } }, "inheritedFrom": { "name": "default", "module": "components/SideSheet.js" } }, { "name": "onWindowResize", "kind": "method", "description": "Recompute `fixed`/`open` state based on the window width and breakpoints.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/SideSheet.js#L185" }, "return": { "type": { "text": "() => void" } }, "inheritedFrom": { "name": "default", "module": "components/SideSheet.js" } }, { "name": "onResizeObserved", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ResizeObserverMixin.js#L23" }, "return": { "type": { "text": "(entry: ResizeObserverEntry) => void" } }, "inheritedFrom": { "name": "default", "module": "components/SideSheet.js" } } ], "slots": [ { "name": "start", "description": "" }, { "name": "", "description": "" } ], "cssParts": [], "events": [], "demos": [ { "url": "demo/components/navrail.html" } ], "superclass": { "module": "components/SideSheet.js", "name": "default" }, "mixins": [], "description": "Navigation rails provide access to app destinations and destinations-level\nnavigation in a vertical rail, suited for larger screens and desktop layouts.\n@see https://m3.material.io/components/navigation-rail/specs" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "default", "module": "components/NavRail.js" } }, { "kind": "custom-element-definition", "name": "mdw-nav-rail", "declaration": { "name": "default", "module": "components/NavRail.js" } } ] }, { "kind": "javascript-module", "path": "components/NavRailItem.js", "declarations": [ { "kind": "class", "name": "NavRailItem", "tagName": "mdw-nav-rail-item", "customElement": true, "attributes": [ { "name": "color", "fieldName": "color", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "ink", "fieldName": "ink", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "type-style", "fieldName": "typeStyle", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "disabled", "fieldName": "disabled", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "focused", "fieldName": "focused", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "hovered", "fieldName": "hovered", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "pressed", "fieldName": "pressed", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "href", "fieldName": "href", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "target", "fieldName": "target", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "download", "fieldName": "download", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "ping", "fieldName": "ping", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "rel", "fieldName": "rel", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "hreflang", "fieldName": "hreflang", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "referrerpolicy", "fieldName": "referrerPolicy", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "show-label", "fieldName": "showLabel", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "active", "fieldName": "active", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "icon", "fieldName": "icon", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "src", "fieldName": "src", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "badge", "fieldName": "badge", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "aria-label", "fieldName": "ariaLabel", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "state-layer", "type": { "text": "boolean" }, "description": "Show the visual state layer element when true", "fieldName": "stateLayer", "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } } ], "members": [ { "name": "delegatesFocus", "kind": "field", "description": "When true, the element delegates focus to an internal focus target.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/DelegatesFocusMixin.js#L15" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "href", "kind": "field", "description": "The URL that the hyperlink points to.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L34" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "target", "kind": "field", "description": "The browsing context in which to open the linked resource (e.g. '_blank').", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L36" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "download", "kind": "field", "description": "Suggested filename for download.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L38" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "ping", "kind": "field", "description": "URLs to be pinged when the link is followed.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L40" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "rel", "kind": "field", "description": "Link relationship tokens (e.g. 'noopener', 'noreferrer').", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L42" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "hreflang", "kind": "field", "description": "Language of the linked resource.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L44" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "referrerPolicy", "kind": "field", "description": "Referrer policy for the link (serialized to 'referrerpolicy' attribute).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L46" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "origin", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L49" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "protocol", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L50" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "username", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L51" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "password", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L52" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "host", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L53" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "hostname", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L54" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "port", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L55" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "pathname", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L56" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "search", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L57" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "hash", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L58" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "disabled", "kind": "field", "description": "Whether the element is disabled (affects interactive states)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L14" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "focused", "kind": "field", "description": "Force focus state (independent of document)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L16" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "hovered", "kind": "field", "description": "Force hover state (independent of interaction)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L18" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "pressed", "kind": "field", "description": "Force pressed state (independent of interaction)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L20" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "disabledState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L37" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "hoveredState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L38" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "focusedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L39" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "pressedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L40" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "touchedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L41" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "pointedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L44" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "stateTargetElement", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L50" }, "type": { "text": "HTMLElement" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "addRipple", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/RippleMixin.js#L37" }, "type": { "text": "(x?: number, y?: number, hold?: boolean) => CustomElement & { hadRippleHeld: boolean; hadRippleReleased: boolean; rippleStarted: boolean; } & { rippleState: string; keepAlive: boolean; _positionX: number; _positionY: number; _radius: number; holdRipple: boolean; } & { _positionStyle: ElementStylerOptions | { styles: { minHeight: string; minWidth: string; boxShadow: string; top: string; left: string; }; }; } & { updatePosition(x?: number, y?: number, size?: number): void; handleRippleComplete(): void; }" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "color", "kind": "field", "description": "Palette or surface token used to select background/ink tokens.\nExamples: 'primary', 'background', 'surface-container-low'.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L52" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "ink", "kind": "field", "description": "Explicit ink override token (e.g. 'outline', 'on-primary', 'inverse-on-surface', 'inherit').\nMaps to `--mdw-ink`.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L57" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "typeStyle", "kind": "field", "description": "Typographic style shortcut that maps to type scale variables\n(e.g. 'headline-large', 'body-medium').", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L62" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "prototype", "kind": "field", "static": true, "type": { "text": "CustomElement" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "stateLayer", "kind": "field", "description": "Show the visual state layer element when true", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/NavItem.js#L31" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "showLabel", "kind": "field", "description": "Whether the label slot is visible. When true the label is shown.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/NavItem.js#L35" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "active", "kind": "field", "description": "Whether the item is active/selected; affects styling and aria-current.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/NavItem.js#L37" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "icon", "kind": "field", "description": "Name of the icon to display (e.g. 'home'); ignored when `src` is provided.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/NavItem.js#L39" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "src", "kind": "field", "description": "URL of an icon image; takes precedence over `icon` when present.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/NavItem.js#L41" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "badge", "kind": "field", "description": "Badge content to display on the item (e.g. notification count).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/NavItem.js#L43" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "iconVariation", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/NavItem.js#L62" }, "type": { "text": "() => string" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "compose", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L145" }, "type": { "text": "(parts: CompositionPart[]) => Composition" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "#refsProxy", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1145" }, "type": { "text": "Record" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "#refsCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1148" }, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "#refsCompositionCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1151" }, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "#composition", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1154" }, "type": { "text": "Composition" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "#patching", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1156" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "#pendingPatchRenders", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1159" }, "type": { "text": "[string, any, CustomElement][]" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "#propAttributeCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1162" }, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "#callbackArguments", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1165" }, "type": { "text": "CallbackArguments" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "elementInternals", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1172" }, "type": { "text": "ElementInternals" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "render", "kind": "field", "description": "Updates nodes based on data\nExpects data in JSON Merge Patch format", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1185" }, "type": { "text": "RenderDraw" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "propChangedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1213" }, "type": { "text": "(this: T, name: K, oldValue: K extends keyof T ? T[K] : unknown, newValue: K extends keyof T ? T[K] : unknown, changes?: K extends keyof T ? T[K] extends object ? Partial : T[K] : unknown) => void" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "attributeChangedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1234" }, "type": { "text": "(name: string, oldValue: string, newValue: string) => void" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "#template", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1284" }, "type": { "text": "DocumentFragment" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "#onObserverPropertyChanged", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1294" }, "type": { "text": "(name: string, oldValue: any, newValue: any, changes: any) => void" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "static", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1330" }, "type": { "text": "typeof CustomElement" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "patch", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1333" }, "type": { "text": "(patch: any) => void" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "refs", "kind": "field", "description": "Proxy object that returns shadow DOM elements by tag.\nIf called before interpolation (eg: on composed), returns from template", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1404" }, "type": { "text": "Record" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "attributeCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1391" }, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "callbackArguments", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1400" }, "type": { "text": "CallbackArguments | { composition: Composition; refs: Record; html: any; inline: (fn: (data: Partial) => any) => string; template: DocumentFragment; element: T; }" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "composition", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1403" }, "type": { "text": "Composition" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "connectedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1435" }, "type": { "text": "() => void" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "disconnectedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1441" }, "type": { "text": "() => void" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "elementName", "kind": "field", "static": true, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "observedAttributes", "kind": "field", "static": true, "type": { "text": "Iterable" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "interpolatesTemplate", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "supportsElementInternals", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "supportsElementInternalsRole", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "defined", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "registrations", "kind": "field", "static": true, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "expressions", "kind": "method", "static": true, "description": "Expressions are idempotent functions that are selectively called whenever\na render is requested.\nExpressions are constructed exactly as methods though differ in expected\narguments. The first argument should be destructured to ensure each used\nproperty is accessed at least once in order to inspect used properties.\n\nThe Composition API will inspect this function with a proxy for `this` to\ncatalog what observables are used by the expression. This allows the\nComposition API to build a cache as well as selective invoke the expression\nonly when needed.\n\nWhen used with in element templates, the element itself will be passed as\nits first argument.\n````js\n Button\n .prop('filled', 'boolean')\n .prop('outlined', 'boolean')\n .expresssions({\n _isFilledOrOutlined({filled, outlined}) {\n return (filled || outlined)\n },\n })\n .html`
`;\n````\n\nWhen used with external data source, that data source\nwill be passed to the expression with all properties being `null` at first\ninspection.\n````js\n const externalData = {first: 'John', last: 'Doe'};\n ContactCard\n .expresssions({\n _fullName({first, last}) {\n return [first, last].filter(Boolean).join(' ');\n },\n })\n myButton.render(externalData);\n````\n\nExpressions may be support argumentless calls by using default\nparameters with `this`.\n````js\n Button\n .expresssions({\n isFilledOrOutlined({filled, outlined} = this) {\n return (filled || outlined)\n },\n });\n myButton.isFilledorOutlined();\n````", "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends { [K in keyof any]: K extends `_${any}` ? ((data: INSTANCE, state?: Record) => string | boolean | null) : ((data?: INSTANCE, state?: Record) => string | boolean | null); } & ThisType>(this: CLASS, expressions: PROPS & ThisType) => CLASS & Class<{ [K in keyof PROPS]: K extends `_${any}` ? never : () => ReturnType; }, ARGS>" } }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "methods", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "overrides", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends Partial>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "props", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "idl", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "append", "kind": "field", "static": true, "description": "Append parts to composition", "type": { "text": "(this: T, ...parts: CompositionPart[]) => T" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "recompose", "kind": "field", "static": true, "description": "After composition, invokes callback.\nMay be called multiple times.", "type": { "text": ", T3 extends CompositionCallback[\"composed\"]>(this: T1, callback: T3) => T1" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "css", "kind": "field", "static": true, "description": "Appends styles to composition", "type": { "text": "(this: T1, array: T2, ...rest: T2 extends string ? any : T2 extends TemplateStringsArray ? any[] : (HTMLStyleElement | CSSStyleSheet)[]) => T1" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "autoRegister", "kind": "field", "static": true, "description": "Registers class with customElements. If class is registered before then,\ndoes nothing.", "type": { "text": "(this: T, elementName: string) => T" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "html", "kind": "field", "static": true, "description": "Appends DocumentFragment to composition", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1405" }, "type": { "text": "(this: T, string: TemplateStringsArray, ...substitutions: (string | Element | ((this: InstanceType, data: InstanceType, injections?: any) => any))[]) => T" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "extend", "kind": "field", "static": true, "description": "Extends base class into a new class.\nUse to avoid mutating base class.", "type": { "text": " T2>(this: T1, customExtender?: T3) => T3 extends null ? T1 : T2" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "setStatic", "kind": "field", "static": true, "description": "Assigns static values to class", "type": { "text": " any) | string | number | boolean | any[] | object); }>(this: T1, source: T2 & ThisType) => T1 & T2" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "readonly", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "set", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "mixin", "kind": "field", "static": true, "description": "Returns result of calling mixin with current class", "type": { "text": " any, RETURN extends ReturnType, SUBCLASS extends ClassOf>(this: BASE, mixin: FN) => SUBCLASS & BASE" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "register", "kind": "field", "static": true, "description": "Registers class with window.customElements synchronously", "type": { "text": "(this: T, elementName?: string, force?: boolean) => T" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "propList", "kind": "field", "static": true, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "attrList", "kind": "field", "static": true, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "propChangedCallbacks", "kind": "field", "static": true, "type": { "text": "Map any)[]>" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "attributeChangedCallbacks", "kind": "field", "static": true, "type": { "text": "Map any)[]>" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "prop", "kind": "field", "static": true, "description": "Creates observable property on instances (via prototype)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1007" }, "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "setPrototype", "kind": "field", "static": true, "description": "Creates observable property on instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any)>(this: CLASS, name: KEY, options: OPTIONS) => OPTIONS extends (...args2: any[]) => infer R ? R : OPTIONS extends ObserverPropertyType ? ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? unknown extends R ? object : R : OPTIONS extends { type: ObserverPropertyType; } ? ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? unknown extends R ? string : R : never" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "define", "kind": "field", "static": true, "description": "Define properties on instances via Object.defineProperties().\nAutomatically sets property non-enumerable if name begins with `_`.\nFunctions will be remapped as getters", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends { [P in keyof any]: { enumerable?: boolean; configurable?: boolean; writable?: boolean; value?: any; get?: ((this: INSTANCE) => any); set?: (this: INSTANCE, value: any) => void; } | ((this: INSTANCE, ...args: any[]) => any); }, VALUE extends { [KEY in keyof PROPS]: PROPS[KEY] extends (...args2: any[]) => infer R ? R : PROPS[KEY] extends TypedPropertyDescriptor ? R : never; }>(this: CLASS, props: PROPS & ThisType) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "undefine", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROP extends string, PROPS extends INSTANCE & Record>(this: CLASS, name: PROP) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "observe", "kind": "field", "static": true, "description": "Creates observable properties on instances", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends IDLParameter, VALUE extends { [KEY in keyof PROPS]: PROPS[KEY] extends (...args2: any[]) => infer R ? R : PROPS[KEY] extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : PROPS[KEY] extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : PROPS[KEY] extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : PROPS[KEY] extends ObserverOptions ? (unknown extends R ? string : R) : never; }>(this: CLASS, props: PROPS) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "defineStatic", "kind": "field", "static": true, "type": { "text": ">(this: T1, props: T2) => T1 & ParsedProps" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "events", "kind": "field", "static": true, "type": { "text": "(this: T, listeners?: CompositionEventListenerObject>, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "childEvents", "kind": "field", "static": true, "type": { "text": "(this: T, listenerMap: { [x: string]: CompositionEventListenerObject>; }, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "rootEvents", "kind": "field", "static": true, "type": { "text": "(this: T, listeners?: CompositionEventListenerObject>, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "on", "kind": "field", "static": true, "type": { "text": ", T3 extends CompositionCallback, T4 extends keyof T3>(this: T1, name: T3 | T4, callbacks?: T3[T4] & ThisType) => T1" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "off", "kind": "field", "static": true, "type": { "text": ", T3 extends CompositionCallback, T4 extends keyof T3>(this: T1, name: T3 | T4, callbacks?: T3[T4] & ThisType) => T1" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "offPropChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: ObjectOrObjectEntries<{ [P in keyof T2]?: (this: T2, oldValue: T2[P], newValue: T2[P], changes: any, element: T2) => void; }>) => T1" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "offAttributeChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: { [x: string]: (this: T2, oldValue: string, newValue: string, element: T2) => void; }) => T1" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "onPropChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: ObjectOrObjectEntries<{ [P in keyof T2]?: (this: T2, oldValue: T2[P], newValue: T2[P], changes: any, element: T2) => void; }>) => T1" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } }, { "name": "onAttributeChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: { [x: string]: (this: T2, oldValue: string, newValue: string, element: T2) => void; }) => T1" }, "inheritedFrom": { "name": "default", "module": "components/NavItem.js" } } ], "slots": [ { "name": "", "description": "" } ], "cssParts": [ { "name": "badge" } ], "events": [], "demos": [], "superclass": { "module": "components/NavItem.js", "name": "default" }, "mixins": [], "description": "A navigation rail item represents a destination within a navigation rail,\nshowing an icon and optional label for vertical navigation on larger screens.\n@see https://m3.material.io/components/navigation-rail/specs" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "default", "module": "components/NavRailItem.js" } }, { "kind": "custom-element-definition", "name": "mdw-nav-rail-item", "declaration": { "name": "default", "module": "components/NavRailItem.js" } } ] }, { "kind": "javascript-module", "path": "components/Page.js", "declarations": [ { "kind": "class", "name": "Page", "tagName": "mdw-page", "customElement": true, "attributes": [ { "name": "pane-one", "description": "Layout behavior for the first pane: 'fixed' keeps a fixed width, 'flexible' grows.", "fieldName": "paneOne", "type": { "text": "string" } }, { "name": "pane-two", "description": "Layout behavior for the second pane; null disables the second pane.", "fieldName": "paneTwo", "type": { "text": "string" } }, { "name": "pane-two-active", "description": "Whether the second pane is currently active/visible.", "fieldName": "paneTwoActive", "type": { "text": "boolean" } }, { "name": "pane-two-breakpoint", "description": "Inline-size breakpoint (px) at which the second pane becomes visible.", "fieldName": "paneTwoBreakpoint", "type": { "text": "number" } } ], "members": [ { "name": "delegatesFocus", "kind": "field", "description": "When true, the element delegates focus to an internal focus target.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/DelegatesFocusMixin.js#L15" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "paneOne", "kind": "field", "description": "Layout behavior for the first pane: 'fixed' keeps a fixed width, 'flexible' grows.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Page.js#L19" }, "type": { "text": "\"fixed\" | \"flexible\"" } }, { "name": "paneTwo", "kind": "field", "description": "Layout behavior for the second pane; null disables the second pane.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Page.js#L23" }, "type": { "text": "\"fixed\" | \"flexible\"" } }, { "name": "paneTwoActive", "kind": "field", "description": "Whether the second pane is currently active/visible.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Page.js#L27" }, "type": { "text": "boolean" } }, { "name": "paneTwoBreakpoint", "kind": "field", "description": "Inline-size breakpoint (px) at which the second pane becomes visible.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Page.js#L29" }, "type": { "text": "number" } }, { "name": "prototype", "kind": "field", "static": true, "type": { "text": "CustomElement" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "onResizeObserved", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ResizeObserverMixin.js#L23" }, "return": { "type": { "text": "(entry: ResizeObserverEntry) => void" } }, "inheritedFrom": { "name": "default", "module": "mixins/ResizeObserverMixin.js" } }, { "name": "observeResize", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ResizeObserverMixin.js#L26" }, "return": { "type": { "text": "() => void" } }, "inheritedFrom": { "name": "default", "module": "mixins/ResizeObserverMixin.js" } }, { "name": "unobserveResize", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ResizeObserverMixin.js#L31" }, "return": { "type": { "text": "() => void" } }, "inheritedFrom": { "name": "default", "module": "mixins/ResizeObserverMixin.js" } }, { "name": "compose", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L145" }, "type": { "text": "(parts: CompositionPart[]) => Composition" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#refsProxy", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1145" }, "type": { "text": "Record" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#refsCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1148" }, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#refsCompositionCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1151" }, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#composition", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1154" }, "type": { "text": "Composition" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#patching", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1156" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#pendingPatchRenders", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1159" }, "type": { "text": "[string, any, CustomElement][]" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#propAttributeCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1162" }, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#callbackArguments", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1165" }, "type": { "text": "CallbackArguments" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "elementInternals", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1172" }, "type": { "text": "ElementInternals" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "render", "kind": "field", "description": "Updates nodes based on data\nExpects data in JSON Merge Patch format", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1185" }, "type": { "text": "RenderDraw" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "propChangedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1213" }, "type": { "text": "(this: T, name: K, oldValue: K extends keyof T ? T[K] : unknown, newValue: K extends keyof T ? T[K] : unknown, changes?: K extends keyof T ? T[K] extends object ? Partial : T[K] : unknown) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attributeChangedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1234" }, "type": { "text": "(name: string, oldValue: string, newValue: string) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#template", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1284" }, "type": { "text": "DocumentFragment" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#onObserverPropertyChanged", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1294" }, "type": { "text": "(name: string, oldValue: any, newValue: any, changes: any) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "static", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1330" }, "type": { "text": "typeof CustomElement" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "patch", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1333" }, "type": { "text": "(patch: any) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "refs", "kind": "field", "description": "Proxy object that returns shadow DOM elements by tag.\nIf called before interpolation (eg: on composed), returns from template", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1404" }, "type": { "text": "Record" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attributeCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1391" }, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "callbackArguments", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1400" }, "type": { "text": "CallbackArguments | { composition: Composition; refs: Record; html: any; inline: (fn: (data: Partial) => any) => string; template: DocumentFragment; element: T; }" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "composition", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1403" }, "type": { "text": "Composition" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "connectedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1435" }, "type": { "text": "() => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "disconnectedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1441" }, "type": { "text": "() => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "elementName", "kind": "field", "static": true, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "observedAttributes", "kind": "field", "static": true, "type": { "text": "Iterable" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "interpolatesTemplate", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "supportsElementInternals", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "supportsElementInternalsRole", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "defined", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "registrations", "kind": "field", "static": true, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "expressions", "kind": "method", "static": true, "description": "Expressions are idempotent functions that are selectively called whenever\na render is requested.\nExpressions are constructed exactly as methods though differ in expected\narguments. The first argument should be destructured to ensure each used\nproperty is accessed at least once in order to inspect used properties.\n\nThe Composition API will inspect this function with a proxy for `this` to\ncatalog what observables are used by the expression. This allows the\nComposition API to build a cache as well as selective invoke the expression\nonly when needed.\n\nWhen used with in element templates, the element itself will be passed as\nits first argument.\n````js\n Button\n .prop('filled', 'boolean')\n .prop('outlined', 'boolean')\n .expresssions({\n _isFilledOrOutlined({filled, outlined}) {\n return (filled || outlined)\n },\n })\n .html`
`;\n````\n\nWhen used with external data source, that data source\nwill be passed to the expression with all properties being `null` at first\ninspection.\n````js\n const externalData = {first: 'John', last: 'Doe'};\n ContactCard\n .expresssions({\n _fullName({first, last}) {\n return [first, last].filter(Boolean).join(' ');\n },\n })\n myButton.render(externalData);\n````\n\nExpressions may be support argumentless calls by using default\nparameters with `this`.\n````js\n Button\n .expresssions({\n isFilledOrOutlined({filled, outlined} = this) {\n return (filled || outlined)\n },\n });\n myButton.isFilledorOutlined();\n````", "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends { [K in keyof any]: K extends `_${any}` ? ((data: INSTANCE, state?: Record) => string | boolean | null) : ((data?: INSTANCE, state?: Record) => string | boolean | null); } & ThisType>(this: CLASS, expressions: PROPS & ThisType) => CLASS & Class<{ [K in keyof PROPS]: K extends `_${any}` ? never : () => ReturnType; }, ARGS>" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "methods", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "overrides", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends Partial>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "props", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "idl", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "append", "kind": "field", "static": true, "description": "Append parts to composition", "type": { "text": "(this: T, ...parts: CompositionPart[]) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "recompose", "kind": "field", "static": true, "description": "After composition, invokes callback.\nMay be called multiple times.", "type": { "text": ", T3 extends CompositionCallback[\"composed\"]>(this: T1, callback: T3) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "css", "kind": "field", "static": true, "description": "Appends styles to composition", "type": { "text": "(this: T1, array: T2, ...rest: T2 extends string ? any : T2 extends TemplateStringsArray ? any[] : (HTMLStyleElement | CSSStyleSheet)[]) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "autoRegister", "kind": "field", "static": true, "description": "Registers class with customElements. If class is registered before then,\ndoes nothing.", "type": { "text": "(this: T, elementName: string) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "html", "kind": "field", "static": true, "description": "Appends DocumentFragment to composition", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1405" }, "type": { "text": "(this: T, string: TemplateStringsArray, ...substitutions: (string | Element | ((this: InstanceType, data: InstanceType, injections?: any) => any))[]) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "extend", "kind": "field", "static": true, "description": "Extends base class into a new class.\nUse to avoid mutating base class.", "type": { "text": " T2>(this: T1, customExtender?: T3) => T3 extends null ? T1 : T2" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "setStatic", "kind": "field", "static": true, "description": "Assigns static values to class", "type": { "text": " any) | string | number | boolean | any[] | object); }>(this: T1, source: T2 & ThisType) => T1 & T2" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "readonly", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "set", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "mixin", "kind": "field", "static": true, "description": "Returns result of calling mixin with current class", "type": { "text": " any, RETURN extends ReturnType, SUBCLASS extends ClassOf>(this: BASE, mixin: FN) => SUBCLASS & BASE" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "register", "kind": "field", "static": true, "description": "Registers class with window.customElements synchronously", "type": { "text": "(this: T, elementName?: string, force?: boolean) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "propList", "kind": "field", "static": true, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attrList", "kind": "field", "static": true, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "propChangedCallbacks", "kind": "field", "static": true, "type": { "text": "Map any)[]>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attributeChangedCallbacks", "kind": "field", "static": true, "type": { "text": "Map any)[]>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "prop", "kind": "field", "static": true, "description": "Creates observable property on instances (via prototype)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1007" }, "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "setPrototype", "kind": "field", "static": true, "description": "Creates observable property on instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any)>(this: CLASS, name: KEY, options: OPTIONS) => OPTIONS extends (...args2: any[]) => infer R ? R : OPTIONS extends ObserverPropertyType ? ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? unknown extends R ? object : R : OPTIONS extends { type: ObserverPropertyType; } ? ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? unknown extends R ? string : R : never" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "define", "kind": "field", "static": true, "description": "Define properties on instances via Object.defineProperties().\nAutomatically sets property non-enumerable if name begins with `_`.\nFunctions will be remapped as getters", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends { [P in keyof any]: { enumerable?: boolean; configurable?: boolean; writable?: boolean; value?: any; get?: ((this: INSTANCE) => any); set?: (this: INSTANCE, value: any) => void; } | ((this: INSTANCE, ...args: any[]) => any); }, VALUE extends { [KEY in keyof PROPS]: PROPS[KEY] extends (...args2: any[]) => infer R ? R : PROPS[KEY] extends TypedPropertyDescriptor ? R : never; }>(this: CLASS, props: PROPS & ThisType) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "undefine", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROP extends string, PROPS extends INSTANCE & Record>(this: CLASS, name: PROP) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "observe", "kind": "field", "static": true, "description": "Creates observable properties on instances", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends IDLParameter, VALUE extends { [KEY in keyof PROPS]: PROPS[KEY] extends (...args2: any[]) => infer R ? R : PROPS[KEY] extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : PROPS[KEY] extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : PROPS[KEY] extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : PROPS[KEY] extends ObserverOptions ? (unknown extends R ? string : R) : never; }>(this: CLASS, props: PROPS) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "defineStatic", "kind": "field", "static": true, "type": { "text": ">(this: T1, props: T2) => T1 & ParsedProps" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "events", "kind": "field", "static": true, "type": { "text": "(this: T, listeners?: CompositionEventListenerObject>, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "childEvents", "kind": "field", "static": true, "type": { "text": "(this: T, listenerMap: { [x: string]: CompositionEventListenerObject>; }, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "rootEvents", "kind": "field", "static": true, "type": { "text": "(this: T, listeners?: CompositionEventListenerObject>, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "on", "kind": "field", "static": true, "type": { "text": ", T3 extends CompositionCallback, T4 extends keyof T3>(this: T1, name: T3 | T4, callbacks?: T3[T4] & ThisType) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "off", "kind": "field", "static": true, "type": { "text": ", T3 extends CompositionCallback, T4 extends keyof T3>(this: T1, name: T3 | T4, callbacks?: T3[T4] & ThisType) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "offPropChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: ObjectOrObjectEntries<{ [P in keyof T2]?: (this: T2, oldValue: T2[P], newValue: T2[P], changes: any, element: T2) => void; }>) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "offAttributeChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: { [x: string]: (this: T2, oldValue: string, newValue: string, element: T2) => void; }) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "onPropChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: ObjectOrObjectEntries<{ [P in keyof T2]?: (this: T2, oldValue: T2[P], newValue: T2[P], changes: any, element: T2) => void; }>) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "onAttributeChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: { [x: string]: (this: T2, oldValue: string, newValue: string, element: T2) => void; }) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } } ], "slots": [ { "name": "", "description": "" }, { "name": "two", "description": "" } ], "cssParts": [], "events": [], "demos": [], "superclass": { "module": "core/CustomElement.js", "name": "default" }, "mixins": [ { "module": "mixins/DelegatesFocusMixin.js", "name": "default" }, { "module": "mixins/ResizeObserverMixin.js", "name": "default" } ], "description": "Page is a top-level layout container that manages single or multi-pane\napplication layouts, adapting to viewport size to show one or two panes.\n@see https://m3.material.io/foundations/layout/applying-layout/window-size-classes" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "default", "module": "components/Page.js" } }, { "kind": "custom-element-definition", "name": "mdw-page", "declaration": { "name": "default", "module": "components/Page.js" } } ] }, { "kind": "javascript-module", "path": "components/Pane.js", "declarations": [ { "kind": "class", "name": "Pane", "tagName": "mdw-pane", "customElement": true, "attributes": [ { "name": "color", "fieldName": "color", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "ink", "fieldName": "ink", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "type-style", "fieldName": "typeStyle", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "block", "fieldName": "block", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "inline", "fieldName": "inline", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "row", "fieldName": "row", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "x", "fieldName": "x", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "y", "fieldName": "y", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "gap", "fieldName": "gap", "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "padding", "fieldName": "padding", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "shape-top", "fieldName": "shapeTop", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shape-bottom", "fieldName": "shapeBottom", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shape-start", "fieldName": "shapeStart", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shape-end", "fieldName": "shapeEnd", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shape-style", "fieldName": "shapeStyle", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "outlined", "fieldName": "outlined", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } } ], "members": [ { "name": "disabled", "kind": "field", "description": "Whether the element is disabled (affects interactive states)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L14" }, "type": { "text": "boolean" } }, { "name": "focused", "kind": "field", "description": "Force focus state (independent of document)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L16" }, "type": { "text": "boolean" } }, { "name": "hovered", "kind": "field", "description": "Force hover state (independent of interaction)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L18" }, "type": { "text": "boolean" } }, { "name": "pressed", "kind": "field", "description": "Force pressed state (independent of interaction)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L20" }, "type": { "text": "boolean" } }, { "name": "stateLayer", "kind": "field", "description": "Show the visual state layer element when true", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L34" }, "type": { "text": "boolean" } }, { "name": "disabledState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L37" }, "type": { "text": "boolean" } }, { "name": "hoveredState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L38" }, "type": { "text": "boolean" } }, { "name": "focusedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L39" }, "type": { "text": "boolean" } }, { "name": "pressedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L40" }, "type": { "text": "boolean" } }, { "name": "touchedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L41" }, "type": { "text": "boolean" } }, { "name": "pointedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L44" }, "type": { "text": "boolean" } }, { "name": "stateTargetElement", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L50" }, "type": { "text": "HTMLElement" } }, { "name": "color", "kind": "field", "description": "Palette or surface token used to select background/ink tokens.\nExamples: 'primary', 'background', 'surface-container-low'.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L52" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "ink", "kind": "field", "description": "Explicit ink override token (e.g. 'outline', 'on-primary', 'inverse-on-surface', 'inherit').\nMaps to `--mdw-ink`.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L57" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "typeStyle", "kind": "field", "description": "Typographic style shortcut that maps to type scale variables\n(e.g. 'headline-large', 'body-medium').", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L62" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "shapeTop", "kind": "field", "description": "Show top cut/shape on the element", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L9" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shapeBottom", "kind": "field", "description": "Show bottom cut/shape on the element", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L11" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shapeStart", "kind": "field", "description": "Show start-side cut/shape (logical start)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L13" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shapeEnd", "kind": "field", "description": "Show end-side cut/shape (logical end)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L15" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shapeStyle", "kind": "field", "description": "Predefined shape size/style name (none|extra-small|small|medium|large|extra-large|full|inherit)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L17" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "outlined", "kind": "field", "description": "When true, an outline is rendered around the element", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L19" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "block", "kind": "field", "description": "Set `display: block` on the host (boolean)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js#L9" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "inline", "kind": "field", "description": "Use inline flex layout: `display: inline-flex` (boolean)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js#L11" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "row", "kind": "field", "description": "Switch main axis to horizontal: `flex-direction: row` (boolean)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js#L13" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "x", "kind": "field", "description": "Main-axis alignment / justification.\nAllowed: 'start'|'center'|'end'|'between'|'around'|'stretch'|'baseline'.\nDefault: 'start'.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js#L19" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "y", "kind": "field", "description": "Cross-axis alignment / alignment of items.\nSame allowed values as `x`. Default: 'start'.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js#L29" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "gap", "kind": "field", "description": "Gap between children. Accepts preset numeric strings (e.g. '8') mapped to px, or floats.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js#L36" }, "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "padding", "kind": "field", "description": "Padding preset or numeric value (e.g. 'pane', '8', '16').", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js#L38" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "prototype", "kind": "field", "static": true, "type": { "text": "CustomElement" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "compose", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L145" }, "type": { "text": "(parts: CompositionPart[]) => Composition" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "#refsProxy", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1145" }, "type": { "text": "Record" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "#refsCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1148" }, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "#refsCompositionCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1151" }, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "#composition", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1154" }, "type": { "text": "Composition" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "#patching", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1156" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "#pendingPatchRenders", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1159" }, "type": { "text": "[string, any, CustomElement][]" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "#propAttributeCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1162" }, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "#callbackArguments", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1165" }, "type": { "text": "CallbackArguments" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "elementInternals", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1172" }, "type": { "text": "ElementInternals" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "render", "kind": "field", "description": "Updates nodes based on data\nExpects data in JSON Merge Patch format", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1185" }, "type": { "text": "RenderDraw" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "propChangedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1213" }, "type": { "text": "(this: T, name: K, oldValue: K extends keyof T ? T[K] : unknown, newValue: K extends keyof T ? T[K] : unknown, changes?: K extends keyof T ? T[K] extends object ? Partial : T[K] : unknown) => void" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "attributeChangedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1234" }, "type": { "text": "(name: string, oldValue: string, newValue: string) => void" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "#template", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1284" }, "type": { "text": "DocumentFragment" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "#onObserverPropertyChanged", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1294" }, "type": { "text": "(name: string, oldValue: any, newValue: any, changes: any) => void" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "static", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1330" }, "type": { "text": "typeof CustomElement" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "patch", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1333" }, "type": { "text": "(patch: any) => void" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "refs", "kind": "field", "description": "Proxy object that returns shadow DOM elements by tag.\nIf called before interpolation (eg: on composed), returns from template", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1404" }, "type": { "text": "Record" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "attributeCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1391" }, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "callbackArguments", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1400" }, "type": { "text": "CallbackArguments | { composition: Composition; refs: Record; html: any; inline: (fn: (data: Partial) => any) => string; template: DocumentFragment; element: T; }" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "composition", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1403" }, "type": { "text": "Composition" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "connectedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1435" }, "type": { "text": "() => void" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "disconnectedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1441" }, "type": { "text": "() => void" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "delegatesFocus", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1175" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "elementName", "kind": "field", "static": true, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "observedAttributes", "kind": "field", "static": true, "type": { "text": "Iterable" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "interpolatesTemplate", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "supportsElementInternals", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "supportsElementInternalsRole", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "defined", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "registrations", "kind": "field", "static": true, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "expressions", "kind": "method", "static": true, "description": "Expressions are idempotent functions that are selectively called whenever\na render is requested.\nExpressions are constructed exactly as methods though differ in expected\narguments. The first argument should be destructured to ensure each used\nproperty is accessed at least once in order to inspect used properties.\n\nThe Composition API will inspect this function with a proxy for `this` to\ncatalog what observables are used by the expression. This allows the\nComposition API to build a cache as well as selective invoke the expression\nonly when needed.\n\nWhen used with in element templates, the element itself will be passed as\nits first argument.\n````js\n Button\n .prop('filled', 'boolean')\n .prop('outlined', 'boolean')\n .expresssions({\n _isFilledOrOutlined({filled, outlined}) {\n return (filled || outlined)\n },\n })\n .html`
`;\n````\n\nWhen used with external data source, that data source\nwill be passed to the expression with all properties being `null` at first\ninspection.\n````js\n const externalData = {first: 'John', last: 'Doe'};\n ContactCard\n .expresssions({\n _fullName({first, last}) {\n return [first, last].filter(Boolean).join(' ');\n },\n })\n myButton.render(externalData);\n````\n\nExpressions may be support argumentless calls by using default\nparameters with `this`.\n````js\n Button\n .expresssions({\n isFilledOrOutlined({filled, outlined} = this) {\n return (filled || outlined)\n },\n });\n myButton.isFilledorOutlined();\n````", "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends { [K in keyof any]: K extends `_${any}` ? ((data: INSTANCE, state?: Record) => string | boolean | null) : ((data?: INSTANCE, state?: Record) => string | boolean | null); } & ThisType>(this: CLASS, expressions: PROPS & ThisType) => CLASS & Class<{ [K in keyof PROPS]: K extends `_${any}` ? never : () => ReturnType; }, ARGS>" } }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "methods", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "overrides", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends Partial>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "props", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "idl", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "append", "kind": "field", "static": true, "description": "Append parts to composition", "type": { "text": "(this: T, ...parts: CompositionPart[]) => T" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "recompose", "kind": "field", "static": true, "description": "After composition, invokes callback.\nMay be called multiple times.", "type": { "text": ", T3 extends CompositionCallback[\"composed\"]>(this: T1, callback: T3) => T1" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "css", "kind": "field", "static": true, "description": "Appends styles to composition", "type": { "text": "(this: T1, array: T2, ...rest: T2 extends string ? any : T2 extends TemplateStringsArray ? any[] : (HTMLStyleElement | CSSStyleSheet)[]) => T1" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "autoRegister", "kind": "field", "static": true, "description": "Registers class with customElements. If class is registered before then,\ndoes nothing.", "type": { "text": "(this: T, elementName: string) => T" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "html", "kind": "field", "static": true, "description": "Appends DocumentFragment to composition", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1405" }, "type": { "text": "(this: T, string: TemplateStringsArray, ...substitutions: (string | Element | ((this: InstanceType, data: InstanceType, injections?: any) => any))[]) => T" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "extend", "kind": "field", "static": true, "description": "Extends base class into a new class.\nUse to avoid mutating base class.", "type": { "text": " T2>(this: T1, customExtender?: T3) => T3 extends null ? T1 : T2" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "setStatic", "kind": "field", "static": true, "description": "Assigns static values to class", "type": { "text": " any) | string | number | boolean | any[] | object); }>(this: T1, source: T2 & ThisType) => T1 & T2" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "readonly", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "set", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "mixin", "kind": "field", "static": true, "description": "Returns result of calling mixin with current class", "type": { "text": " any, RETURN extends ReturnType, SUBCLASS extends ClassOf>(this: BASE, mixin: FN) => SUBCLASS & BASE" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "register", "kind": "field", "static": true, "description": "Registers class with window.customElements synchronously", "type": { "text": "(this: T, elementName?: string, force?: boolean) => T" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "propList", "kind": "field", "static": true, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "attrList", "kind": "field", "static": true, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "propChangedCallbacks", "kind": "field", "static": true, "type": { "text": "Map any)[]>" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "attributeChangedCallbacks", "kind": "field", "static": true, "type": { "text": "Map any)[]>" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "prop", "kind": "field", "static": true, "description": "Creates observable property on instances (via prototype)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1007" }, "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "setPrototype", "kind": "field", "static": true, "description": "Creates observable property on instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any)>(this: CLASS, name: KEY, options: OPTIONS) => OPTIONS extends (...args2: any[]) => infer R ? R : OPTIONS extends ObserverPropertyType ? ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? unknown extends R ? object : R : OPTIONS extends { type: ObserverPropertyType; } ? ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? unknown extends R ? string : R : never" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "define", "kind": "field", "static": true, "description": "Define properties on instances via Object.defineProperties().\nAutomatically sets property non-enumerable if name begins with `_`.\nFunctions will be remapped as getters", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends { [P in keyof any]: { enumerable?: boolean; configurable?: boolean; writable?: boolean; value?: any; get?: ((this: INSTANCE) => any); set?: (this: INSTANCE, value: any) => void; } | ((this: INSTANCE, ...args: any[]) => any); }, VALUE extends { [KEY in keyof PROPS]: PROPS[KEY] extends (...args2: any[]) => infer R ? R : PROPS[KEY] extends TypedPropertyDescriptor ? R : never; }>(this: CLASS, props: PROPS & ThisType) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "undefine", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROP extends string, PROPS extends INSTANCE & Record>(this: CLASS, name: PROP) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "observe", "kind": "field", "static": true, "description": "Creates observable properties on instances", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends IDLParameter, VALUE extends { [KEY in keyof PROPS]: PROPS[KEY] extends (...args2: any[]) => infer R ? R : PROPS[KEY] extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : PROPS[KEY] extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : PROPS[KEY] extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : PROPS[KEY] extends ObserverOptions ? (unknown extends R ? string : R) : never; }>(this: CLASS, props: PROPS) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "defineStatic", "kind": "field", "static": true, "type": { "text": ">(this: T1, props: T2) => T1 & ParsedProps" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "events", "kind": "field", "static": true, "type": { "text": "(this: T, listeners?: CompositionEventListenerObject>, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "childEvents", "kind": "field", "static": true, "type": { "text": "(this: T, listenerMap: { [x: string]: CompositionEventListenerObject>; }, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "rootEvents", "kind": "field", "static": true, "type": { "text": "(this: T, listeners?: CompositionEventListenerObject>, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "on", "kind": "field", "static": true, "type": { "text": ", T3 extends CompositionCallback, T4 extends keyof T3>(this: T1, name: T3 | T4, callbacks?: T3[T4] & ThisType) => T1" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "off", "kind": "field", "static": true, "type": { "text": ", T3 extends CompositionCallback, T4 extends keyof T3>(this: T1, name: T3 | T4, callbacks?: T3[T4] & ThisType) => T1" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "offPropChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: ObjectOrObjectEntries<{ [P in keyof T2]?: (this: T2, oldValue: T2[P], newValue: T2[P], changes: any, element: T2) => void; }>) => T1" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "offAttributeChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: { [x: string]: (this: T2, oldValue: string, newValue: string, element: T2) => void; }) => T1" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "onPropChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: ObjectOrObjectEntries<{ [P in keyof T2]?: (this: T2, oldValue: T2[P], newValue: T2[P], changes: any, element: T2) => void; }>) => T1" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "onAttributeChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: { [x: string]: (this: T2, oldValue: string, newValue: string, element: T2) => void; }) => T1" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } } ], "slots": [ { "name": "", "description": "" } ], "cssParts": [], "events": [], "demos": [], "superclass": { "module": "components/Box.js", "name": "default" }, "mixins": [ { "module": "mixins/ShapeMixin.js", "name": "default" } ], "description": "Pane is a layout surface used within `mdw-page` to provide shaped,\npadded content columns for app content. It is intended to be placed\nas a child of `mdw-page` to create consistent, shaped panes with the\nsame padding and background surface used across the layout system.\n@see https://m3.material.io/foundations/layout/applying-layout/window-size-classes" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "default", "module": "components/Pane.js" } }, { "kind": "custom-element-definition", "name": "mdw-pane", "declaration": { "name": "default", "module": "components/Pane.js" } } ] }, { "kind": "javascript-module", "path": "components/Popup.js", "declarations": [ { "kind": "class", "name": "Popup", "tagName": "mdw-popup", "customElement": true, "attributes": [ { "name": "color", "fieldName": "color", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "ink", "fieldName": "ink", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "type-style", "fieldName": "typeStyle", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "shape-top", "fieldName": "shapeTop", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shape-bottom", "fieldName": "shapeBottom", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shape-start", "fieldName": "shapeStart", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shape-end", "fieldName": "shapeEnd", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shape-style", "fieldName": "shapeStyle", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "outlined", "fieldName": "outlined", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "open", "fieldName": "open", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/PopupMixin.js" } }, { "name": "modal", "fieldName": "modal", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/PopupMixin.js" } }, { "name": "native", "fieldName": "native", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/PopupMixin.js" } }, { "name": "scrollable", "fieldName": "scrollable", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/PopupMixin.js" } }, { "name": "match-source-width", "fieldName": "matchSourceWidth", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/PopupMixin.js" } }, { "name": "flow", "fieldName": "flow", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/PopupMixin.js" } }, { "name": "popup-margin", "fieldName": "popupMargin", "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "mixins/PopupMixin.js" } }, { "name": "elevation", "description": "Elevation level (0–5) controlling the drop-shadow depth of the popup.", "fieldName": "elevation", "type": { "text": "number" } } ], "members": [ { "name": "delegatesFocus", "kind": "field", "description": "When true, the element delegates focus to an internal focus target.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/DelegatesFocusMixin.js#L15" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "open", "kind": "field", "description": "Whether the popup is currently open", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/PopupMixin.js#L84" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/PopupMixin.js" } }, { "name": "modal", "kind": "field", "description": "When true the popup behaves as a blocking modal", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/PopupMixin.js#L86" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/PopupMixin.js" } }, { "name": "native", "kind": "field", "description": "Use the native HTMLDialogElement when available", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/PopupMixin.js#L88" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/PopupMixin.js" } }, { "name": "scrollable", "kind": "field", "description": "Allow internal content to scroll when true", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/PopupMixin.js#L90" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/PopupMixin.js" } }, { "name": "matchSourceWidth", "kind": "field", "description": "When true, match the popup width to the source element", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/PopupMixin.js#L92" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/PopupMixin.js" } }, { "name": "flow", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/PopupMixin.js#L95" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/PopupMixin.js" } }, { "name": "popupMargin", "kind": "field", "description": "Margin between popup and viewport/anchor (px)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/PopupMixin.js#L101" }, "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "mixins/PopupMixin.js" } }, { "name": "useHistory", "kind": "field", "description": "Whether to push/pop history entries when opening the popup", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/PopupMixin.js#L105" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/PopupMixin.js" } }, { "name": "returnValue", "kind": "field", "description": "Optional return value for dialog-like popups", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/PopupMixin.js#L107" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/PopupMixin.js" } }, { "name": "disabled", "kind": "field", "description": "Whether the element is disabled (affects interactive states)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L14" }, "type": { "text": "boolean" } }, { "name": "focused", "kind": "field", "description": "Force focus state (independent of document)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L16" }, "type": { "text": "boolean" } }, { "name": "hovered", "kind": "field", "description": "Force hover state (independent of interaction)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L18" }, "type": { "text": "boolean" } }, { "name": "pressed", "kind": "field", "description": "Force pressed state (independent of interaction)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L20" }, "type": { "text": "boolean" } }, { "name": "stateLayer", "kind": "field", "description": "Show the visual state layer element when true", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L34" }, "type": { "text": "boolean" } }, { "name": "disabledState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L37" }, "type": { "text": "boolean" } }, { "name": "hoveredState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L38" }, "type": { "text": "boolean" } }, { "name": "focusedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L39" }, "type": { "text": "boolean" } }, { "name": "pressedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L40" }, "type": { "text": "boolean" } }, { "name": "touchedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L41" }, "type": { "text": "boolean" } }, { "name": "pointedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L44" }, "type": { "text": "boolean" } }, { "name": "stateTargetElement", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L50" }, "type": { "text": "HTMLElement" } }, { "name": "color", "kind": "field", "description": "Palette or surface token used to select background/ink tokens.\nExamples: 'primary', 'background', 'surface-container-low'.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L52" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "ink", "kind": "field", "description": "Explicit ink override token (e.g. 'outline', 'on-primary', 'inverse-on-surface', 'inherit').\nMaps to `--mdw-ink`.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L57" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "typeStyle", "kind": "field", "description": "Typographic style shortcut that maps to type scale variables\n(e.g. 'headline-large', 'body-medium').", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L62" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "shapeTop", "kind": "field", "description": "Show top cut/shape on the element", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L9" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shapeBottom", "kind": "field", "description": "Show bottom cut/shape on the element", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L11" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shapeStart", "kind": "field", "description": "Show start-side cut/shape (logical start)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L13" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shapeEnd", "kind": "field", "description": "Show end-side cut/shape (logical end)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L15" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shapeStyle", "kind": "field", "description": "Predefined shape size/style name (none|extra-small|small|medium|large|extra-large|full|inherit)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L17" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "outlined", "kind": "field", "description": "When true, an outline is rendered around the element", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L19" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "elevation", "kind": "field", "description": "Elevation level (0–5) controlling the drop-shadow depth of the popup.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Popup.js#L20" }, "type": { "text": "number" } }, { "name": "prototype", "kind": "field", "static": true, "type": { "text": "CustomElement" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "updatePopupPosition", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/PopupMixin.js#L138" }, "return": { "type": { "text": "(anchor?: Element | DOMRectLike) => void" } }, "inheritedFrom": { "name": "default", "module": "mixins/PopupMixin.js" } }, { "name": "onSlotChange", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/PopupMixin.js#L290" }, "return": { "type": { "text": "({ currentTarget }: Event & { currentTarget: HTMLSlotElement; }) => void" } }, "inheritedFrom": { "name": "default", "module": "mixins/PopupMixin.js" } }, { "name": "showPopup", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/PopupMixin.js#L303" }, "return": { "type": { "text": "(source?: HTMLElement | Event | PointerEvent | MouseEvent, focus?: boolean, flow?: string) => boolean" } }, "inheritedFrom": { "name": "default", "module": "mixins/PopupMixin.js" } }, { "name": "showModal", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/PopupMixin.js#L389" }, "return": { "type": { "text": "(source?: HTMLElement | Event | PointerEvent | MouseEvent, focus?: boolean, flow?: string) => boolean" } }, "inheritedFrom": { "name": "default", "module": "mixins/PopupMixin.js" } }, { "name": "show", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/PopupMixin.js#L404" }, "return": { "type": { "text": "(source?: HTMLElement | Event | PointerEvent | MouseEvent, focus?: boolean, flow?: string) => boolean" } }, "inheritedFrom": { "name": "default", "module": "mixins/PopupMixin.js" } }, { "name": "close", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/PopupMixin.js#L417" }, "return": { "type": { "text": "(returnValue?: any, returnFocus?: boolean) => boolean" } }, "inheritedFrom": { "name": "default", "module": "mixins/PopupMixin.js" } }, { "name": "compose", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L145" }, "type": { "text": "(parts: CompositionPart[]) => Composition" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#refsProxy", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1145" }, "type": { "text": "Record" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#refsCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1148" }, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#refsCompositionCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1151" }, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#composition", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1154" }, "type": { "text": "Composition" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#patching", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1156" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#pendingPatchRenders", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1159" }, "type": { "text": "[string, any, CustomElement][]" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#propAttributeCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1162" }, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#callbackArguments", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1165" }, "type": { "text": "CallbackArguments" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "elementInternals", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1172" }, "type": { "text": "ElementInternals" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "render", "kind": "field", "description": "Updates nodes based on data\nExpects data in JSON Merge Patch format", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1185" }, "type": { "text": "RenderDraw" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "propChangedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1213" }, "type": { "text": "(this: T, name: K, oldValue: K extends keyof T ? T[K] : unknown, newValue: K extends keyof T ? T[K] : unknown, changes?: K extends keyof T ? T[K] extends object ? Partial : T[K] : unknown) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attributeChangedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1234" }, "type": { "text": "(name: string, oldValue: string, newValue: string) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#template", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1284" }, "type": { "text": "DocumentFragment" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#onObserverPropertyChanged", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1294" }, "type": { "text": "(name: string, oldValue: any, newValue: any, changes: any) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "static", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1330" }, "type": { "text": "typeof CustomElement" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "patch", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1333" }, "type": { "text": "(patch: any) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "refs", "kind": "field", "description": "Proxy object that returns shadow DOM elements by tag.\nIf called before interpolation (eg: on composed), returns from template", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1404" }, "type": { "text": "Record" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attributeCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1391" }, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "callbackArguments", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1400" }, "type": { "text": "CallbackArguments | { composition: Composition; refs: Record; html: any; inline: (fn: (data: Partial) => any) => string; template: DocumentFragment; element: T; }" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "composition", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1403" }, "type": { "text": "Composition" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "connectedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1435" }, "type": { "text": "() => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "disconnectedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1441" }, "type": { "text": "() => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "elementName", "kind": "field", "static": true, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "observedAttributes", "kind": "field", "static": true, "type": { "text": "Iterable" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "interpolatesTemplate", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "supportsElementInternals", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "supportsElementInternalsRole", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "defined", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "registrations", "kind": "field", "static": true, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "expressions", "kind": "method", "static": true, "description": "Expressions are idempotent functions that are selectively called whenever\na render is requested.\nExpressions are constructed exactly as methods though differ in expected\narguments. The first argument should be destructured to ensure each used\nproperty is accessed at least once in order to inspect used properties.\n\nThe Composition API will inspect this function with a proxy for `this` to\ncatalog what observables are used by the expression. This allows the\nComposition API to build a cache as well as selective invoke the expression\nonly when needed.\n\nWhen used with in element templates, the element itself will be passed as\nits first argument.\n````js\n Button\n .prop('filled', 'boolean')\n .prop('outlined', 'boolean')\n .expresssions({\n _isFilledOrOutlined({filled, outlined}) {\n return (filled || outlined)\n },\n })\n .html`
`;\n````\n\nWhen used with external data source, that data source\nwill be passed to the expression with all properties being `null` at first\ninspection.\n````js\n const externalData = {first: 'John', last: 'Doe'};\n ContactCard\n .expresssions({\n _fullName({first, last}) {\n return [first, last].filter(Boolean).join(' ');\n },\n })\n myButton.render(externalData);\n````\n\nExpressions may be support argumentless calls by using default\nparameters with `this`.\n````js\n Button\n .expresssions({\n isFilledOrOutlined({filled, outlined} = this) {\n return (filled || outlined)\n },\n });\n myButton.isFilledorOutlined();\n````", "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends { [K in keyof any]: K extends `_${any}` ? ((data: INSTANCE, state?: Record) => string | boolean | null) : ((data?: INSTANCE, state?: Record) => string | boolean | null); } & ThisType>(this: CLASS, expressions: PROPS & ThisType) => CLASS & Class<{ [K in keyof PROPS]: K extends `_${any}` ? never : () => ReturnType; }, ARGS>" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "methods", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "overrides", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends Partial>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "props", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "idl", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "append", "kind": "field", "static": true, "description": "Append parts to composition", "type": { "text": "(this: T, ...parts: CompositionPart[]) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "recompose", "kind": "field", "static": true, "description": "After composition, invokes callback.\nMay be called multiple times.", "type": { "text": ", T3 extends CompositionCallback[\"composed\"]>(this: T1, callback: T3) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "css", "kind": "field", "static": true, "description": "Appends styles to composition", "type": { "text": "(this: T1, array: T2, ...rest: T2 extends string ? any : T2 extends TemplateStringsArray ? any[] : (HTMLStyleElement | CSSStyleSheet)[]) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "autoRegister", "kind": "field", "static": true, "description": "Registers class with customElements. If class is registered before then,\ndoes nothing.", "type": { "text": "(this: T, elementName: string) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "html", "kind": "field", "static": true, "description": "Appends DocumentFragment to composition", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1405" }, "type": { "text": "(this: T, string: TemplateStringsArray, ...substitutions: (string | Element | ((this: InstanceType, data: InstanceType, injections?: any) => any))[]) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "extend", "kind": "field", "static": true, "description": "Extends base class into a new class.\nUse to avoid mutating base class.", "type": { "text": " T2>(this: T1, customExtender?: T3) => T3 extends null ? T1 : T2" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "setStatic", "kind": "field", "static": true, "description": "Assigns static values to class", "type": { "text": " any) | string | number | boolean | any[] | object); }>(this: T1, source: T2 & ThisType) => T1 & T2" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "readonly", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "set", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "mixin", "kind": "field", "static": true, "description": "Returns result of calling mixin with current class", "type": { "text": " any, RETURN extends ReturnType, SUBCLASS extends ClassOf>(this: BASE, mixin: FN) => SUBCLASS & BASE" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "register", "kind": "field", "static": true, "description": "Registers class with window.customElements synchronously", "type": { "text": "(this: T, elementName?: string, force?: boolean) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "propList", "kind": "field", "static": true, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attrList", "kind": "field", "static": true, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "propChangedCallbacks", "kind": "field", "static": true, "type": { "text": "Map any)[]>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attributeChangedCallbacks", "kind": "field", "static": true, "type": { "text": "Map any)[]>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "prop", "kind": "field", "static": true, "description": "Creates observable property on instances (via prototype)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1007" }, "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "setPrototype", "kind": "field", "static": true, "description": "Creates observable property on instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any)>(this: CLASS, name: KEY, options: OPTIONS) => OPTIONS extends (...args2: any[]) => infer R ? R : OPTIONS extends ObserverPropertyType ? ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? unknown extends R ? object : R : OPTIONS extends { type: ObserverPropertyType; } ? ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? unknown extends R ? string : R : never" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "define", "kind": "field", "static": true, "description": "Define properties on instances via Object.defineProperties().\nAutomatically sets property non-enumerable if name begins with `_`.\nFunctions will be remapped as getters", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends { [P in keyof any]: { enumerable?: boolean; configurable?: boolean; writable?: boolean; value?: any; get?: ((this: INSTANCE) => any); set?: (this: INSTANCE, value: any) => void; } | ((this: INSTANCE, ...args: any[]) => any); }, VALUE extends { [KEY in keyof PROPS]: PROPS[KEY] extends (...args2: any[]) => infer R ? R : PROPS[KEY] extends TypedPropertyDescriptor ? R : never; }>(this: CLASS, props: PROPS & ThisType) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "undefine", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROP extends string, PROPS extends INSTANCE & Record>(this: CLASS, name: PROP) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "observe", "kind": "field", "static": true, "description": "Creates observable properties on instances", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends IDLParameter, VALUE extends { [KEY in keyof PROPS]: PROPS[KEY] extends (...args2: any[]) => infer R ? R : PROPS[KEY] extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : PROPS[KEY] extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : PROPS[KEY] extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : PROPS[KEY] extends ObserverOptions ? (unknown extends R ? string : R) : never; }>(this: CLASS, props: PROPS) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "defineStatic", "kind": "field", "static": true, "type": { "text": ">(this: T1, props: T2) => T1 & ParsedProps" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "events", "kind": "field", "static": true, "type": { "text": "(this: T, listeners?: CompositionEventListenerObject>, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "childEvents", "kind": "field", "static": true, "type": { "text": "(this: T, listenerMap: { [x: string]: CompositionEventListenerObject>; }, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "rootEvents", "kind": "field", "static": true, "type": { "text": "(this: T, listeners?: CompositionEventListenerObject>, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "on", "kind": "field", "static": true, "type": { "text": ", T3 extends CompositionCallback, T4 extends keyof T3>(this: T1, name: T3 | T4, callbacks?: T3[T4] & ThisType) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "off", "kind": "field", "static": true, "type": { "text": ", T3 extends CompositionCallback, T4 extends keyof T3>(this: T1, name: T3 | T4, callbacks?: T3[T4] & ThisType) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "offPropChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: ObjectOrObjectEntries<{ [P in keyof T2]?: (this: T2, oldValue: T2[P], newValue: T2[P], changes: any, element: T2) => void; }>) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "offAttributeChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: { [x: string]: (this: T2, oldValue: string, newValue: string, element: T2) => void; }) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "onPropChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: ObjectOrObjectEntries<{ [P in keyof T2]?: (this: T2, oldValue: T2[P], newValue: T2[P], changes: any, element: T2) => void; }>) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "onAttributeChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: { [x: string]: (this: T2, oldValue: string, newValue: string, element: T2) => void; }) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } } ], "slots": [ { "name": "", "description": "" } ], "cssParts": [], "events": [], "demos": [], "superclass": { "module": "core/CustomElement.js", "name": "default" }, "mixins": [ { "module": "mixins/ThemableMixin.js", "name": "default" }, { "module": "mixins/ElevationMixin.js", "name": "default" }, { "module": "mixins/ShapeMixin.js", "name": "default" }, { "module": "mixins/PopupMixin.js", "name": "default" } ], "description": "Popup displays transient content such as menus or popovers and provides\nelevation, shape, and theming control for floating surfaces.\n@see https://m3.material.io/styles/elevation/overview" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "default", "module": "components/Popup.js" } }, { "kind": "custom-element-definition", "name": "mdw-popup", "declaration": { "name": "default", "module": "components/Popup.js" } } ] }, { "kind": "javascript-module", "path": "components/Progress.js", "declarations": [ { "kind": "class", "name": "Progress", "tagName": "mdw-progress", "customElement": true, "attributes": [ { "name": "color", "fieldName": "color", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "ink", "fieldName": "ink", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "type-style", "fieldName": "typeStyle", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "circle", "description": "Render the circular variant when true; otherwise render a linear bar.", "fieldName": "circle", "type": { "text": "boolean" } }, { "name": "value", "description": "Current progress value. When present the indicator is determinate.", "fieldName": "value", "type": { "text": "number" } }, { "name": "max", "description": "Maximum progress value (defaults to 100 when not set).", "fieldName": "max", "type": { "text": "number" } }, { "name": "auto-hide", "description": "When true, the progress will auto-hide when complete.", "fieldName": "autoHide", "type": { "text": "boolean" } } ], "members": [ { "name": "color", "kind": "field", "description": "Palette or surface token used to select background/ink tokens.\nExamples: 'primary', 'background', 'surface-container-low'.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L52" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "ink", "kind": "field", "description": "Explicit ink override token (e.g. 'outline', 'on-primary', 'inverse-on-surface', 'inherit').\nMaps to `--mdw-ink`.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L57" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "typeStyle", "kind": "field", "description": "Typographic style shortcut that maps to type scale variables\n(e.g. 'headline-large', 'body-medium').", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L62" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "circle", "kind": "field", "description": "Render the circular variant when true; otherwise render a linear bar.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Progress.js#L15" }, "type": { "text": "boolean" } }, { "name": "value", "kind": "field", "description": "Current progress value. When present the indicator is determinate.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Progress.js#L17" }, "type": { "text": "number" } }, { "name": "max", "kind": "field", "description": "Maximum progress value (defaults to 100 when not set).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Progress.js#L19" }, "type": { "text": "number" } }, { "name": "autoHide", "kind": "field", "description": "When true, the progress will auto-hide when complete.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Progress.js#L21" }, "type": { "text": "boolean" } }, { "name": "position", "kind": "field", "description": "Proxy to the internal `` element's `position` property.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Progress.js#L52" }, "type": { "text": "number" } }, { "name": "labels", "kind": "field", "description": "Proxy to the internal `` element's `labels` collection.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Progress.js#L56" }, "type": { "text": "NodeListOf" } }, { "name": "isDeterminate", "kind": "method", "description": "True when `value` is provided, indicating a determinate progress state.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Progress.js#L46" }, "return": { "type": { "text": "() => boolean" } } }, { "name": "prototype", "kind": "field", "static": true, "type": { "text": "CustomElement" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "compose", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L145" }, "type": { "text": "(parts: CompositionPart[]) => Composition" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#refsProxy", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1145" }, "type": { "text": "Record" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#refsCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1148" }, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#refsCompositionCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1151" }, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#composition", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1154" }, "type": { "text": "Composition" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#patching", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1156" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#pendingPatchRenders", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1159" }, "type": { "text": "[string, any, CustomElement][]" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#propAttributeCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1162" }, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#callbackArguments", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1165" }, "type": { "text": "CallbackArguments" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "elementInternals", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1172" }, "type": { "text": "ElementInternals" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "render", "kind": "field", "description": "Updates nodes based on data\nExpects data in JSON Merge Patch format", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1185" }, "type": { "text": "RenderDraw" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "propChangedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1213" }, "type": { "text": "(this: T, name: K, oldValue: K extends keyof T ? T[K] : unknown, newValue: K extends keyof T ? T[K] : unknown, changes?: K extends keyof T ? T[K] extends object ? Partial : T[K] : unknown) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attributeChangedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1234" }, "type": { "text": "(name: string, oldValue: string, newValue: string) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#template", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1284" }, "type": { "text": "DocumentFragment" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#onObserverPropertyChanged", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1294" }, "type": { "text": "(name: string, oldValue: any, newValue: any, changes: any) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "static", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1330" }, "type": { "text": "typeof CustomElement" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "patch", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1333" }, "type": { "text": "(patch: any) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "refs", "kind": "field", "description": "Proxy object that returns shadow DOM elements by tag.\nIf called before interpolation (eg: on composed), returns from template", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1404" }, "type": { "text": "Record" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attributeCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1391" }, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "callbackArguments", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1400" }, "type": { "text": "CallbackArguments | { composition: Composition; refs: Record; html: any; inline: (fn: (data: Partial) => any) => string; template: DocumentFragment; element: T; }" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "composition", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1403" }, "type": { "text": "Composition" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "connectedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1435" }, "type": { "text": "() => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "disconnectedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1441" }, "type": { "text": "() => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "delegatesFocus", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1175" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "elementName", "kind": "field", "static": true, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "observedAttributes", "kind": "field", "static": true, "type": { "text": "Iterable" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "interpolatesTemplate", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "supportsElementInternals", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "supportsElementInternalsRole", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "defined", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "registrations", "kind": "field", "static": true, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "expressions", "kind": "method", "static": true, "description": "Expressions are idempotent functions that are selectively called whenever\na render is requested.\nExpressions are constructed exactly as methods though differ in expected\narguments. The first argument should be destructured to ensure each used\nproperty is accessed at least once in order to inspect used properties.\n\nThe Composition API will inspect this function with a proxy for `this` to\ncatalog what observables are used by the expression. This allows the\nComposition API to build a cache as well as selective invoke the expression\nonly when needed.\n\nWhen used with in element templates, the element itself will be passed as\nits first argument.\n````js\n Button\n .prop('filled', 'boolean')\n .prop('outlined', 'boolean')\n .expresssions({\n _isFilledOrOutlined({filled, outlined}) {\n return (filled || outlined)\n },\n })\n .html`
`;\n````\n\nWhen used with external data source, that data source\nwill be passed to the expression with all properties being `null` at first\ninspection.\n````js\n const externalData = {first: 'John', last: 'Doe'};\n ContactCard\n .expresssions({\n _fullName({first, last}) {\n return [first, last].filter(Boolean).join(' ');\n },\n })\n myButton.render(externalData);\n````\n\nExpressions may be support argumentless calls by using default\nparameters with `this`.\n````js\n Button\n .expresssions({\n isFilledOrOutlined({filled, outlined} = this) {\n return (filled || outlined)\n },\n });\n myButton.isFilledorOutlined();\n````", "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends { [K in keyof any]: K extends `_${any}` ? ((data: INSTANCE, state?: Record) => string | boolean | null) : ((data?: INSTANCE, state?: Record) => string | boolean | null); } & ThisType>(this: CLASS, expressions: PROPS & ThisType) => CLASS & Class<{ [K in keyof PROPS]: K extends `_${any}` ? never : () => ReturnType; }, ARGS>" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "methods", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "overrides", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends Partial>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "props", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "idl", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "append", "kind": "field", "static": true, "description": "Append parts to composition", "type": { "text": "(this: T, ...parts: CompositionPart[]) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "recompose", "kind": "field", "static": true, "description": "After composition, invokes callback.\nMay be called multiple times.", "type": { "text": ", T3 extends CompositionCallback[\"composed\"]>(this: T1, callback: T3) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "css", "kind": "field", "static": true, "description": "Appends styles to composition", "type": { "text": "(this: T1, array: T2, ...rest: T2 extends string ? any : T2 extends TemplateStringsArray ? any[] : (HTMLStyleElement | CSSStyleSheet)[]) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "autoRegister", "kind": "field", "static": true, "description": "Registers class with customElements. If class is registered before then,\ndoes nothing.", "type": { "text": "(this: T, elementName: string) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "html", "kind": "field", "static": true, "description": "Appends DocumentFragment to composition", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1405" }, "type": { "text": "(this: T, string: TemplateStringsArray, ...substitutions: (string | Element | ((this: InstanceType, data: InstanceType, injections?: any) => any))[]) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "extend", "kind": "field", "static": true, "description": "Extends base class into a new class.\nUse to avoid mutating base class.", "type": { "text": " T2>(this: T1, customExtender?: T3) => T3 extends null ? T1 : T2" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "setStatic", "kind": "field", "static": true, "description": "Assigns static values to class", "type": { "text": " any) | string | number | boolean | any[] | object); }>(this: T1, source: T2 & ThisType) => T1 & T2" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "readonly", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "set", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "mixin", "kind": "field", "static": true, "description": "Returns result of calling mixin with current class", "type": { "text": " any, RETURN extends ReturnType, SUBCLASS extends ClassOf>(this: BASE, mixin: FN) => SUBCLASS & BASE" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "register", "kind": "field", "static": true, "description": "Registers class with window.customElements synchronously", "type": { "text": "(this: T, elementName?: string, force?: boolean) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "propList", "kind": "field", "static": true, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attrList", "kind": "field", "static": true, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "propChangedCallbacks", "kind": "field", "static": true, "type": { "text": "Map any)[]>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attributeChangedCallbacks", "kind": "field", "static": true, "type": { "text": "Map any)[]>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "prop", "kind": "field", "static": true, "description": "Creates observable property on instances (via prototype)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1007" }, "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "setPrototype", "kind": "field", "static": true, "description": "Creates observable property on instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any)>(this: CLASS, name: KEY, options: OPTIONS) => OPTIONS extends (...args2: any[]) => infer R ? R : OPTIONS extends ObserverPropertyType ? ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? unknown extends R ? object : R : OPTIONS extends { type: ObserverPropertyType; } ? ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? unknown extends R ? string : R : never" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "define", "kind": "field", "static": true, "description": "Define properties on instances via Object.defineProperties().\nAutomatically sets property non-enumerable if name begins with `_`.\nFunctions will be remapped as getters", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends { [P in keyof any]: { enumerable?: boolean; configurable?: boolean; writable?: boolean; value?: any; get?: ((this: INSTANCE) => any); set?: (this: INSTANCE, value: any) => void; } | ((this: INSTANCE, ...args: any[]) => any); }, VALUE extends { [KEY in keyof PROPS]: PROPS[KEY] extends (...args2: any[]) => infer R ? R : PROPS[KEY] extends TypedPropertyDescriptor ? R : never; }>(this: CLASS, props: PROPS & ThisType) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "undefine", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROP extends string, PROPS extends INSTANCE & Record>(this: CLASS, name: PROP) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "observe", "kind": "field", "static": true, "description": "Creates observable properties on instances", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends IDLParameter, VALUE extends { [KEY in keyof PROPS]: PROPS[KEY] extends (...args2: any[]) => infer R ? R : PROPS[KEY] extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : PROPS[KEY] extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : PROPS[KEY] extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : PROPS[KEY] extends ObserverOptions ? (unknown extends R ? string : R) : never; }>(this: CLASS, props: PROPS) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "defineStatic", "kind": "field", "static": true, "type": { "text": ">(this: T1, props: T2) => T1 & ParsedProps" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "events", "kind": "field", "static": true, "type": { "text": "(this: T, listeners?: CompositionEventListenerObject>, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "childEvents", "kind": "field", "static": true, "type": { "text": "(this: T, listenerMap: { [x: string]: CompositionEventListenerObject>; }, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "rootEvents", "kind": "field", "static": true, "type": { "text": "(this: T, listeners?: CompositionEventListenerObject>, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "on", "kind": "field", "static": true, "type": { "text": ", T3 extends CompositionCallback, T4 extends keyof T3>(this: T1, name: T3 | T4, callbacks?: T3[T4] & ThisType) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "off", "kind": "field", "static": true, "type": { "text": ", T3 extends CompositionCallback, T4 extends keyof T3>(this: T1, name: T3 | T4, callbacks?: T3[T4] & ThisType) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "offPropChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: ObjectOrObjectEntries<{ [P in keyof T2]?: (this: T2, oldValue: T2[P], newValue: T2[P], changes: any, element: T2) => void; }>) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "offAttributeChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: { [x: string]: (this: T2, oldValue: string, newValue: string, element: T2) => void; }) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "onPropChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: ObjectOrObjectEntries<{ [P in keyof T2]?: (this: T2, oldValue: T2[P], newValue: T2[P], changes: any, element: T2) => void; }>) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "onAttributeChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: { [x: string]: (this: T2, oldValue: string, newValue: string, element: T2) => void; }) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } } ], "slots": [], "cssParts": [], "events": [], "demos": [ { "url": "demo/components/progress.html" } ], "superclass": { "module": "core/CustomElement.js", "name": "default" }, "mixins": [ { "module": "mixins/ThemableMixin.js", "name": "default" } ], "description": "Progress indicators display the progress of an operation as a determinate\nbar or an indeterminate animation.\n@see https://m3.material.io/components/progress-indicators/specs\n@see https://html.spec.whatwg.org/multipage/form-elements.html#the-progress-element" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "default", "module": "components/Progress.js" } }, { "kind": "custom-element-definition", "name": "mdw-progress", "declaration": { "name": "default", "module": "components/Progress.js" } } ] }, { "kind": "javascript-module", "path": "components/Radio.js", "declarations": [ { "kind": "class", "name": "Radio", "tagName": "mdw-radio", "customElement": true, "attributes": [ { "name": "color", "fieldName": "color", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "ink", "fieldName": "ink", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "type-style", "fieldName": "typeStyle", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "disabled", "fieldName": "disabled", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "focused", "fieldName": "focused", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "hovered", "fieldName": "hovered", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "pressed", "fieldName": "pressed", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "aria-controls", "fieldName": "ariaControls", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "autocomplete", "fieldName": "autocomplete", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "name", "fieldName": "name", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "readonly", "fieldName": "readOnly", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "formnovalidate", "fieldName": "formNoValidate", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "checked", "fieldName": "defaultChecked", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "required", "fieldName": "required", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "value", "fieldName": "_defaultValue", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "aria-label", "fieldName": "ariaLabel", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "accept", "fieldName": "accept", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "alt", "fieldName": "alt", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "dirname", "fieldName": "dirName", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "formenctype", "fieldName": "formEnctype", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "formmethod", "fieldName": "formMethod", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "formtarget", "fieldName": "formTarget", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "max", "fieldName": "max", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "maxlength", "fieldName": "maxLength", "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "min", "fieldName": "min", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "minlength", "fieldName": "minLength", "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "multiple", "fieldName": "multiple", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "pattern", "fieldName": "pattern", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "placeholder", "fieldName": "placeholder", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "size", "fieldName": "size", "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "src", "fieldName": "src", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "step", "fieldName": "step", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "indeterminate", "fieldName": "indeterminate", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "state-layer", "type": { "text": "boolean" }, "description": "Show the visual state layer element when true", "fieldName": "stateLayer", "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "type", "type": { "text": "string" }, "fieldName": "type", "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } } ], "members": [ { "name": "delegatesFocus", "kind": "field", "description": "When true, the element delegates focus to an internal focus target.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/DelegatesFocusMixin.js#L15" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "disabled", "kind": "field", "description": "Whether the element is disabled (affects interactive states)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L14" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "focused", "kind": "field", "description": "Force focus state (independent of document)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L16" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "hovered", "kind": "field", "description": "Force hover state (independent of interaction)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L18" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "pressed", "kind": "field", "description": "Force pressed state (independent of interaction)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L20" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "stateLayer", "kind": "field", "description": "Show the visual state layer element when true\nForces Material state-layer overlay for pressed/hover states.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Radio.js#L25" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "disabledState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L171" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "hoveredState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L38" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "focusedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L39" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "pressedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L40" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "touchedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L41" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "pointedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L44" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "stateTargetElement", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ControlMixin.js#L66" }, "type": { "text": "HTMLElement" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "ariaControls", "kind": "field", "description": "ARIA 'controls' attribute (string).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L32" }, "type": { "text": "string" } }, { "name": "autocomplete", "kind": "field", "description": "Autocomplete token for the associated control (string).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L34" }, "type": { "text": "string" } }, { "name": "name", "kind": "field", "description": "Name attribute for the control used in forms.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L36" }, "type": { "text": "string" } }, { "name": "readOnly", "kind": "field", "description": "Read-only state reflected to control via 'readonly' attribute.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L38" }, "type": { "text": "boolean" } }, { "name": "formNoValidate", "kind": "field", "description": "When true, form validation is skipped for this control (formnovalidate).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L40" }, "type": { "text": "boolean" } }, { "name": "defaultChecked", "kind": "field", "description": "Default checked state for checkable controls (checkbox/radio).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L42" }, "type": { "text": "boolean" } }, { "name": "required", "kind": "field", "description": "Whether the control is required for form submission.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L47" }, "type": { "text": "boolean" } }, { "name": "type", "kind": "field", "description": "Control type token (e.g. 'text','checkbox','radio','file').\nNative control `type` used for the underlying input; always 'radio'.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Radio.js#L23" }, "type": { "text": "string" } }, { "name": "erroredState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L65" }, "type": { "text": "boolean" } }, { "name": "defaultValue", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L66" }, "type": { "text": "string" } }, { "name": "value", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L108" }, "type": { "text": "string" } }, { "name": "checked", "kind": "field", "description": "Part of FormAssociatedMixin for simplicity.\nEnumerability doesn't guarantee checked state will be passed or used.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L145" }, "type": { "text": "boolean" } }, { "name": "form", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L160" }, "type": { "text": "HTMLFormElement" } }, { "name": "validity", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L161" }, "type": { "text": "ValidityState" } }, { "name": "validationMessage", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L162" }, "type": { "text": "string" } }, { "name": "willValidate", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L163" }, "type": { "text": "boolean" } }, { "name": "labels", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L168" }, "type": { "text": "NodeList" } }, { "name": "focusableOnDisabled", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ControlMixin.js#L30" }, "type": { "text": "boolean" } }, { "name": "controlTagName", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L102" }, "type": { "text": "string" } }, { "name": "controlVoidElement", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ControlMixin.js#L32" }, "type": { "text": "boolean" } }, { "name": "accept", "kind": "field", "description": "Accepted file types for file input (e.g. '.png,.jpg').", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L41" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "alt", "kind": "field", "description": "Alternate text for images (for `type='image'`).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L43" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "dirName", "kind": "field", "description": "Directionality for form submission name (dirname attribute).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L45" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "formEnctype", "kind": "field", "description": "Form encoding type (formenctype).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L49" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "formMethod", "kind": "field", "description": "Form method when associated with a submit input (formmethod).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L51" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "formTarget", "kind": "field", "description": "Target browsing context for form submission (formtarget).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L53" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "max", "kind": "field", "description": "Max value or token for the input.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L58" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "maxLength", "kind": "field", "description": "Maximum length for text-like inputs.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L60" }, "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "min", "kind": "field", "description": "Min value or token for the input.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L62" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "minLength", "kind": "field", "description": "Minimum length for text-like inputs.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L64" }, "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "multiple", "kind": "field", "description": "When true, multiple values are allowed (e.g. file inputs).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L66" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "pattern", "kind": "field", "description": "Pattern used for validation (RegExp as string).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L68" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "placeholder", "kind": "field", "description": "Placeholder text shown when no value is present.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L70" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "size", "kind": "field", "description": "Suggested control size (number of characters).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L72" }, "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "src", "kind": "field", "description": "Source URL for image-type inputs.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L74" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "step", "kind": "field", "description": "Step interval for numeric inputs.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L76" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "indeterminate", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L89" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "files", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L371" }, "type": { "text": "FileList" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "selectionDirection", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L384" }, "type": { "text": "\"none\" | \"forward\" | \"backward\"" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "selectionEnd", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L389" }, "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "selectionStart", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L394" }, "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "valueAsDate", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L399" }, "type": { "text": "Date" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "valueAsNumber", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L407" }, "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "height", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L415" }, "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "formAction", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L423" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "width", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L431" }, "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "color", "kind": "field", "description": "Palette or surface token used to select background/ink tokens.\nExamples: 'primary', 'background', 'surface-container-low'.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L52" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "ink", "kind": "field", "description": "Explicit ink override token (e.g. 'outline', 'on-primary', 'inverse-on-surface', 'inherit').\nMaps to `--mdw-ink`.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L57" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "typeStyle", "kind": "field", "description": "Typographic style shortcut that maps to type scale variables\n(e.g. 'headline-large', 'body-medium').", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L62" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "prototype", "kind": "field", "static": true, "type": { "text": "CustomElement" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "addRipple", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/RippleMixin.js#L37" }, "return": { "type": { "text": "(x?: number, y?: number, hold?: boolean) => CustomElement & { hadRippleHeld: boolean; hadRippleReleased: boolean; rippleStarted: boolean; } & { rippleState: string; keepAlive: boolean; _positionX: number; _positionY: number; _radius: number; holdRipple: boolean; } & { _positionStyle: ElementStylerOptions | { styles: { minHeight: string; minWidth: string; boxShadow: string; top: string; left: string; }; }; } & { updatePosition(x?: number, y?: number, size?: number): void; handleRippleComplete(): void; }" } }, "inheritedFrom": { "name": "default", "module": "mixins/RippleMixin.js" } }, { "name": "performImplicitSubmission", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L175" }, "return": { "type": { "text": "(event: Event) => void" } }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "setRangeText", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L345" }, "return": { "type": { "text": "{ (replacement: string): void; (replacement: string, start: number, end: number, selectionMode?: SelectionMode): void; }" } }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "setSelectionRange", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L348" }, "return": { "type": { "text": "(start: number, end: number, direction?: \"none\" | \"forward\" | \"backward\") => void" } }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "showPicker", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L351" }, "return": { "type": { "text": "() => void" } }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "stepDown", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L354" }, "return": { "type": { "text": "(n?: number) => void" } }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "stepUp", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L360" }, "return": { "type": { "text": "(n?: number) => void" } }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "select", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L366" }, "return": { "type": { "text": "() => void" } }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "compose", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L145" }, "type": { "text": "(parts: CompositionPart[]) => Composition" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#refsProxy", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1145" }, "type": { "text": "Record" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#refsCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1148" }, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#refsCompositionCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1151" }, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#composition", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1154" }, "type": { "text": "Composition" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#patching", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1156" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#pendingPatchRenders", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1159" }, "type": { "text": "[string, any, CustomElement][]" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#propAttributeCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1162" }, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#callbackArguments", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1165" }, "type": { "text": "CallbackArguments" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "elementInternals", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1172" }, "type": { "text": "ElementInternals" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "render", "kind": "field", "description": "Updates nodes based on data\nExpects data in JSON Merge Patch format", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1185" }, "type": { "text": "RenderDraw" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "propChangedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1213" }, "type": { "text": "(this: T, name: K, oldValue: K extends keyof T ? T[K] : unknown, newValue: K extends keyof T ? T[K] : unknown, changes?: K extends keyof T ? T[K] extends object ? Partial : T[K] : unknown) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attributeChangedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1234" }, "type": { "text": "(name: string, oldValue: string, newValue: string) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#template", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1284" }, "type": { "text": "DocumentFragment" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#onObserverPropertyChanged", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1294" }, "type": { "text": "(name: string, oldValue: any, newValue: any, changes: any) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "static", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1330" }, "type": { "text": "typeof CustomElement" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "patch", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1333" }, "type": { "text": "(patch: any) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "refs", "kind": "field", "description": "Proxy object that returns shadow DOM elements by tag.\nIf called before interpolation (eg: on composed), returns from template", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1404" }, "type": { "text": "Record" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attributeCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1391" }, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "callbackArguments", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1400" }, "type": { "text": "CallbackArguments | { composition: Composition; refs: Record; html: any; inline: (fn: (data: Partial) => any) => string; template: DocumentFragment; element: T; }" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "composition", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1403" }, "type": { "text": "Composition" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "connectedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1435" }, "type": { "text": "() => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "disconnectedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1441" }, "type": { "text": "() => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "elementName", "kind": "field", "static": true, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "observedAttributes", "kind": "field", "static": true, "type": { "text": "Iterable" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "interpolatesTemplate", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "supportsElementInternals", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "supportsElementInternalsRole", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "defined", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "registrations", "kind": "field", "static": true, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "expressions", "kind": "method", "static": true, "description": "Expressions are idempotent functions that are selectively called whenever\na render is requested.\nExpressions are constructed exactly as methods though differ in expected\narguments. The first argument should be destructured to ensure each used\nproperty is accessed at least once in order to inspect used properties.\n\nThe Composition API will inspect this function with a proxy for `this` to\ncatalog what observables are used by the expression. This allows the\nComposition API to build a cache as well as selective invoke the expression\nonly when needed.\n\nWhen used with in element templates, the element itself will be passed as\nits first argument.\n````js\n Button\n .prop('filled', 'boolean')\n .prop('outlined', 'boolean')\n .expresssions({\n _isFilledOrOutlined({filled, outlined}) {\n return (filled || outlined)\n },\n })\n .html`
`;\n````\n\nWhen used with external data source, that data source\nwill be passed to the expression with all properties being `null` at first\ninspection.\n````js\n const externalData = {first: 'John', last: 'Doe'};\n ContactCard\n .expresssions({\n _fullName({first, last}) {\n return [first, last].filter(Boolean).join(' ');\n },\n })\n myButton.render(externalData);\n````\n\nExpressions may be support argumentless calls by using default\nparameters with `this`.\n````js\n Button\n .expresssions({\n isFilledOrOutlined({filled, outlined} = this) {\n return (filled || outlined)\n },\n });\n myButton.isFilledorOutlined();\n````", "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends { [K in keyof any]: K extends `_${any}` ? ((data: INSTANCE, state?: Record) => string | boolean | null) : ((data?: INSTANCE, state?: Record) => string | boolean | null); } & ThisType>(this: CLASS, expressions: PROPS & ThisType) => CLASS & Class<{ [K in keyof PROPS]: K extends `_${any}` ? never : () => ReturnType; }, ARGS>" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "methods", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "overrides", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends Partial>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "props", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "idl", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "append", "kind": "field", "static": true, "description": "Append parts to composition", "type": { "text": "(this: T, ...parts: CompositionPart[]) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "recompose", "kind": "field", "static": true, "description": "After composition, invokes callback.\nMay be called multiple times.", "type": { "text": ", T3 extends CompositionCallback[\"composed\"]>(this: T1, callback: T3) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "css", "kind": "field", "static": true, "description": "Appends styles to composition", "type": { "text": "(this: T1, array: T2, ...rest: T2 extends string ? any : T2 extends TemplateStringsArray ? any[] : (HTMLStyleElement | CSSStyleSheet)[]) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "autoRegister", "kind": "field", "static": true, "description": "Registers class with customElements. If class is registered before then,\ndoes nothing.", "type": { "text": "(this: T, elementName: string) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "html", "kind": "field", "static": true, "description": "Appends DocumentFragment to composition", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1405" }, "type": { "text": "(this: T, string: TemplateStringsArray, ...substitutions: (string | Element | ((this: InstanceType, data: InstanceType, injections?: any) => any))[]) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "extend", "kind": "field", "static": true, "description": "Extends base class into a new class.\nUse to avoid mutating base class.", "type": { "text": " T2>(this: T1, customExtender?: T3) => T3 extends null ? T1 : T2" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "setStatic", "kind": "field", "static": true, "description": "Assigns static values to class", "type": { "text": " any) | string | number | boolean | any[] | object); }>(this: T1, source: T2 & ThisType) => T1 & T2" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "readonly", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "set", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "mixin", "kind": "field", "static": true, "description": "Returns result of calling mixin with current class", "type": { "text": " any, RETURN extends ReturnType, SUBCLASS extends ClassOf>(this: BASE, mixin: FN) => SUBCLASS & BASE" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "register", "kind": "field", "static": true, "description": "Registers class with window.customElements synchronously", "type": { "text": "(this: T, elementName?: string, force?: boolean) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "propList", "kind": "field", "static": true, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attrList", "kind": "field", "static": true, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "propChangedCallbacks", "kind": "field", "static": true, "type": { "text": "Map any)[]>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attributeChangedCallbacks", "kind": "field", "static": true, "type": { "text": "Map any)[]>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "prop", "kind": "field", "static": true, "description": "Creates observable property on instances (via prototype)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1007" }, "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "setPrototype", "kind": "field", "static": true, "description": "Creates observable property on instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any)>(this: CLASS, name: KEY, options: OPTIONS) => OPTIONS extends (...args2: any[]) => infer R ? R : OPTIONS extends ObserverPropertyType ? ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? unknown extends R ? object : R : OPTIONS extends { type: ObserverPropertyType; } ? ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? unknown extends R ? string : R : never" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "define", "kind": "field", "static": true, "description": "Define properties on instances via Object.defineProperties().\nAutomatically sets property non-enumerable if name begins with `_`.\nFunctions will be remapped as getters", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends { [P in keyof any]: { enumerable?: boolean; configurable?: boolean; writable?: boolean; value?: any; get?: ((this: INSTANCE) => any); set?: (this: INSTANCE, value: any) => void; } | ((this: INSTANCE, ...args: any[]) => any); }, VALUE extends { [KEY in keyof PROPS]: PROPS[KEY] extends (...args2: any[]) => infer R ? R : PROPS[KEY] extends TypedPropertyDescriptor ? R : never; }>(this: CLASS, props: PROPS & ThisType) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "undefine", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROP extends string, PROPS extends INSTANCE & Record>(this: CLASS, name: PROP) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "observe", "kind": "field", "static": true, "description": "Creates observable properties on instances", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends IDLParameter, VALUE extends { [KEY in keyof PROPS]: PROPS[KEY] extends (...args2: any[]) => infer R ? R : PROPS[KEY] extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : PROPS[KEY] extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : PROPS[KEY] extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : PROPS[KEY] extends ObserverOptions ? (unknown extends R ? string : R) : never; }>(this: CLASS, props: PROPS) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "defineStatic", "kind": "field", "static": true, "type": { "text": ">(this: T1, props: T2) => T1 & ParsedProps" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "events", "kind": "field", "static": true, "type": { "text": "(this: T, listeners?: CompositionEventListenerObject>, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "childEvents", "kind": "field", "static": true, "type": { "text": "(this: T, listenerMap: { [x: string]: CompositionEventListenerObject>; }, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "rootEvents", "kind": "field", "static": true, "type": { "text": "(this: T, listeners?: CompositionEventListenerObject>, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "on", "kind": "field", "static": true, "type": { "text": ", T3 extends CompositionCallback, T4 extends keyof T3>(this: T1, name: T3 | T4, callbacks?: T3[T4] & ThisType) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "off", "kind": "field", "static": true, "type": { "text": ", T3 extends CompositionCallback, T4 extends keyof T3>(this: T1, name: T3 | T4, callbacks?: T3[T4] & ThisType) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "offPropChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: ObjectOrObjectEntries<{ [P in keyof T2]?: (this: T2, oldValue: T2[P], newValue: T2[P], changes: any, element: T2) => void; }>) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "offAttributeChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: { [x: string]: (this: T2, oldValue: string, newValue: string, element: T2) => void; }) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "onPropChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: ObjectOrObjectEntries<{ [P in keyof T2]?: (this: T2, oldValue: T2[P], newValue: T2[P], changes: any, element: T2) => void; }>) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "onAttributeChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: { [x: string]: (this: T2, oldValue: string, newValue: string, element: T2) => void; }) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } } ], "slots": [ { "name": "", "description": "" } ], "cssParts": [ { "name": "control" } ], "events": [], "demos": [ { "url": "demo/components/radio.html" } ], "superclass": { "module": "core/CustomElement.js", "name": "default" }, "mixins": [ { "module": "mixins/ThemableMixin.js", "name": "default" }, { "module": "mixins/StateMixin.js", "name": "default" }, { "module": "mixins/RippleMixin.js", "name": "default" }, { "module": "mixins/InputMixin.js", "name": "default" }, { "module": "mixins/TouchTargetMixin.js", "name": "default" } ], "description": "Radio buttons allow selection of a single option within a set.\n@see https://m3.material.io/components/radio-button/overview" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "default", "module": "components/Radio.js" } }, { "kind": "custom-element-definition", "name": "mdw-radio", "declaration": { "name": "default", "module": "components/Radio.js" } } ] }, { "kind": "javascript-module", "path": "components/RadioIcon.js", "declarations": [ { "kind": "class", "name": "RadioIcon", "tagName": "mdw-radio-icon", "customElement": true, "attributes": [ { "name": "color", "fieldName": "color", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "ink", "fieldName": "ink", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "type-style", "fieldName": "typeStyle", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "shape-top", "fieldName": "shapeTop", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shape-bottom", "fieldName": "shapeBottom", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shape-start", "fieldName": "shapeStart", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shape-end", "fieldName": "shapeEnd", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shape-style", "fieldName": "shapeStyle", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "outlined", "fieldName": "outlined", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "selected", "description": "Whether the radio icon is selected (checked).", "fieldName": "selected", "type": { "text": "boolean" } }, { "name": "icon", "description": "Optional icon name to render inside the control (not normally used).", "fieldName": "icon", "type": { "text": "string" } }, { "name": "errored", "description": "When true the control is shown in an error state.", "fieldName": "errored", "type": { "text": "boolean" } }, { "name": "disabled", "description": "When true the control is disabled.", "fieldName": "disabled", "type": { "text": "boolean" } }, { "name": "hovered", "description": "Hover state used for styling.", "fieldName": "hovered", "type": { "text": "boolean" } }, { "name": "focused", "description": "Focus state used for styling.", "fieldName": "focused", "type": { "text": "boolean" } } ], "members": [ { "name": "disabled", "kind": "field", "description": "Whether the element is disabled (affects interactive states)\nWhen true the control is disabled.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/RadioIcon.js#L23" }, "type": { "text": "boolean" } }, { "name": "focused", "kind": "field", "description": "Force focus state (independent of document)\nFocus state used for styling.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/RadioIcon.js#L27" }, "type": { "text": "boolean" } }, { "name": "hovered", "kind": "field", "description": "Force hover state (independent of interaction)\nHover state used for styling.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/RadioIcon.js#L25" }, "type": { "text": "boolean" } }, { "name": "pressed", "kind": "field", "description": "Force pressed state (independent of interaction)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L20" }, "type": { "text": "boolean" } }, { "name": "stateLayer", "kind": "field", "description": "Show the visual state layer element when true", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L34" }, "type": { "text": "boolean" } }, { "name": "disabledState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L37" }, "type": { "text": "boolean" } }, { "name": "hoveredState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L38" }, "type": { "text": "boolean" } }, { "name": "focusedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L39" }, "type": { "text": "boolean" } }, { "name": "pressedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L40" }, "type": { "text": "boolean" } }, { "name": "touchedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L41" }, "type": { "text": "boolean" } }, { "name": "pointedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L44" }, "type": { "text": "boolean" } }, { "name": "stateTargetElement", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L50" }, "type": { "text": "HTMLElement" } }, { "name": "color", "kind": "field", "description": "Palette or surface token used to select background/ink tokens.\nExamples: 'primary', 'background', 'surface-container-low'.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L52" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "ink", "kind": "field", "description": "Explicit ink override token (e.g. 'outline', 'on-primary', 'inverse-on-surface', 'inherit').\nMaps to `--mdw-ink`.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L57" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "typeStyle", "kind": "field", "description": "Typographic style shortcut that maps to type scale variables\n(e.g. 'headline-large', 'body-medium').", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L62" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "shapeTop", "kind": "field", "description": "Show top cut/shape on the element", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L9" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shapeBottom", "kind": "field", "description": "Show bottom cut/shape on the element", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L11" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shapeStart", "kind": "field", "description": "Show start-side cut/shape (logical start)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L13" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shapeEnd", "kind": "field", "description": "Show end-side cut/shape (logical end)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L15" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shapeStyle", "kind": "field", "description": "Predefined shape size/style name (none|extra-small|small|medium|large|extra-large|full|inherit)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L17" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "outlined", "kind": "field", "description": "When true, an outline is rendered around the element", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L19" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "selected", "kind": "field", "description": "Whether the radio icon is selected (checked).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/RadioIcon.js#L17" }, "type": { "text": "boolean" } }, { "name": "icon", "kind": "field", "description": "Optional icon name to render inside the control (not normally used).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/RadioIcon.js#L19" }, "type": { "text": "string" } }, { "name": "errored", "kind": "field", "description": "When true the control is shown in an error state.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/RadioIcon.js#L21" }, "type": { "text": "boolean" } }, { "name": "checked", "kind": "field", "description": "Alias for `selected` to match common form terminology (`checked`).\nReading/writing `checked` proxies to the `selected` state.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/RadioIcon.js#L34" }, "type": { "text": "boolean" } }, { "name": "prototype", "kind": "field", "static": true, "type": { "text": "CustomElement" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "compose", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L145" }, "type": { "text": "(parts: CompositionPart[]) => Composition" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#refsProxy", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1145" }, "type": { "text": "Record" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#refsCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1148" }, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#refsCompositionCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1151" }, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#composition", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1154" }, "type": { "text": "Composition" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#patching", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1156" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#pendingPatchRenders", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1159" }, "type": { "text": "[string, any, CustomElement][]" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#propAttributeCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1162" }, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#callbackArguments", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1165" }, "type": { "text": "CallbackArguments" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "elementInternals", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1172" }, "type": { "text": "ElementInternals" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "render", "kind": "field", "description": "Updates nodes based on data\nExpects data in JSON Merge Patch format", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1185" }, "type": { "text": "RenderDraw" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "propChangedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1213" }, "type": { "text": "(this: T, name: K, oldValue: K extends keyof T ? T[K] : unknown, newValue: K extends keyof T ? T[K] : unknown, changes?: K extends keyof T ? T[K] extends object ? Partial : T[K] : unknown) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attributeChangedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1234" }, "type": { "text": "(name: string, oldValue: string, newValue: string) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#template", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1284" }, "type": { "text": "DocumentFragment" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#onObserverPropertyChanged", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1294" }, "type": { "text": "(name: string, oldValue: any, newValue: any, changes: any) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "static", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1330" }, "type": { "text": "typeof CustomElement" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "patch", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1333" }, "type": { "text": "(patch: any) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "refs", "kind": "field", "description": "Proxy object that returns shadow DOM elements by tag.\nIf called before interpolation (eg: on composed), returns from template", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1404" }, "type": { "text": "Record" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attributeCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1391" }, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "callbackArguments", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1400" }, "type": { "text": "CallbackArguments | { composition: Composition; refs: Record; html: any; inline: (fn: (data: Partial) => any) => string; template: DocumentFragment; element: T; }" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "composition", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1403" }, "type": { "text": "Composition" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "connectedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1435" }, "type": { "text": "() => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "disconnectedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1441" }, "type": { "text": "() => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "delegatesFocus", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1175" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "elementName", "kind": "field", "static": true, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "observedAttributes", "kind": "field", "static": true, "type": { "text": "Iterable" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "interpolatesTemplate", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "supportsElementInternals", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "supportsElementInternalsRole", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "defined", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "registrations", "kind": "field", "static": true, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "expressions", "kind": "method", "static": true, "description": "Expressions are idempotent functions that are selectively called whenever\na render is requested.\nExpressions are constructed exactly as methods though differ in expected\narguments. The first argument should be destructured to ensure each used\nproperty is accessed at least once in order to inspect used properties.\n\nThe Composition API will inspect this function with a proxy for `this` to\ncatalog what observables are used by the expression. This allows the\nComposition API to build a cache as well as selective invoke the expression\nonly when needed.\n\nWhen used with in element templates, the element itself will be passed as\nits first argument.\n````js\n Button\n .prop('filled', 'boolean')\n .prop('outlined', 'boolean')\n .expresssions({\n _isFilledOrOutlined({filled, outlined}) {\n return (filled || outlined)\n },\n })\n .html`
`;\n````\n\nWhen used with external data source, that data source\nwill be passed to the expression with all properties being `null` at first\ninspection.\n````js\n const externalData = {first: 'John', last: 'Doe'};\n ContactCard\n .expresssions({\n _fullName({first, last}) {\n return [first, last].filter(Boolean).join(' ');\n },\n })\n myButton.render(externalData);\n````\n\nExpressions may be support argumentless calls by using default\nparameters with `this`.\n````js\n Button\n .expresssions({\n isFilledOrOutlined({filled, outlined} = this) {\n return (filled || outlined)\n },\n });\n myButton.isFilledorOutlined();\n````", "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends { [K in keyof any]: K extends `_${any}` ? ((data: INSTANCE, state?: Record) => string | boolean | null) : ((data?: INSTANCE, state?: Record) => string | boolean | null); } & ThisType>(this: CLASS, expressions: PROPS & ThisType) => CLASS & Class<{ [K in keyof PROPS]: K extends `_${any}` ? never : () => ReturnType; }, ARGS>" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "methods", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "overrides", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends Partial>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "props", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "idl", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "append", "kind": "field", "static": true, "description": "Append parts to composition", "type": { "text": "(this: T, ...parts: CompositionPart[]) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "recompose", "kind": "field", "static": true, "description": "After composition, invokes callback.\nMay be called multiple times.", "type": { "text": ", T3 extends CompositionCallback[\"composed\"]>(this: T1, callback: T3) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "css", "kind": "field", "static": true, "description": "Appends styles to composition", "type": { "text": "(this: T1, array: T2, ...rest: T2 extends string ? any : T2 extends TemplateStringsArray ? any[] : (HTMLStyleElement | CSSStyleSheet)[]) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "autoRegister", "kind": "field", "static": true, "description": "Registers class with customElements. If class is registered before then,\ndoes nothing.", "type": { "text": "(this: T, elementName: string) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "html", "kind": "field", "static": true, "description": "Appends DocumentFragment to composition", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1405" }, "type": { "text": "(this: T, string: TemplateStringsArray, ...substitutions: (string | Element | ((this: InstanceType, data: InstanceType, injections?: any) => any))[]) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "extend", "kind": "field", "static": true, "description": "Extends base class into a new class.\nUse to avoid mutating base class.", "type": { "text": " T2>(this: T1, customExtender?: T3) => T3 extends null ? T1 : T2" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "setStatic", "kind": "field", "static": true, "description": "Assigns static values to class", "type": { "text": " any) | string | number | boolean | any[] | object); }>(this: T1, source: T2 & ThisType) => T1 & T2" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "readonly", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "set", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "mixin", "kind": "field", "static": true, "description": "Returns result of calling mixin with current class", "type": { "text": " any, RETURN extends ReturnType, SUBCLASS extends ClassOf>(this: BASE, mixin: FN) => SUBCLASS & BASE" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "register", "kind": "field", "static": true, "description": "Registers class with window.customElements synchronously", "type": { "text": "(this: T, elementName?: string, force?: boolean) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "propList", "kind": "field", "static": true, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attrList", "kind": "field", "static": true, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "propChangedCallbacks", "kind": "field", "static": true, "type": { "text": "Map any)[]>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attributeChangedCallbacks", "kind": "field", "static": true, "type": { "text": "Map any)[]>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "prop", "kind": "field", "static": true, "description": "Creates observable property on instances (via prototype)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1007" }, "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "setPrototype", "kind": "field", "static": true, "description": "Creates observable property on instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any)>(this: CLASS, name: KEY, options: OPTIONS) => OPTIONS extends (...args2: any[]) => infer R ? R : OPTIONS extends ObserverPropertyType ? ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? unknown extends R ? object : R : OPTIONS extends { type: ObserverPropertyType; } ? ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? unknown extends R ? string : R : never" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "define", "kind": "field", "static": true, "description": "Define properties on instances via Object.defineProperties().\nAutomatically sets property non-enumerable if name begins with `_`.\nFunctions will be remapped as getters", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends { [P in keyof any]: { enumerable?: boolean; configurable?: boolean; writable?: boolean; value?: any; get?: ((this: INSTANCE) => any); set?: (this: INSTANCE, value: any) => void; } | ((this: INSTANCE, ...args: any[]) => any); }, VALUE extends { [KEY in keyof PROPS]: PROPS[KEY] extends (...args2: any[]) => infer R ? R : PROPS[KEY] extends TypedPropertyDescriptor ? R : never; }>(this: CLASS, props: PROPS & ThisType) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "undefine", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROP extends string, PROPS extends INSTANCE & Record>(this: CLASS, name: PROP) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "observe", "kind": "field", "static": true, "description": "Creates observable properties on instances", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends IDLParameter, VALUE extends { [KEY in keyof PROPS]: PROPS[KEY] extends (...args2: any[]) => infer R ? R : PROPS[KEY] extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : PROPS[KEY] extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : PROPS[KEY] extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : PROPS[KEY] extends ObserverOptions ? (unknown extends R ? string : R) : never; }>(this: CLASS, props: PROPS) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "defineStatic", "kind": "field", "static": true, "type": { "text": ">(this: T1, props: T2) => T1 & ParsedProps" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "events", "kind": "field", "static": true, "type": { "text": "(this: T, listeners?: CompositionEventListenerObject>, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "childEvents", "kind": "field", "static": true, "type": { "text": "(this: T, listenerMap: { [x: string]: CompositionEventListenerObject>; }, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "rootEvents", "kind": "field", "static": true, "type": { "text": "(this: T, listeners?: CompositionEventListenerObject>, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "on", "kind": "field", "static": true, "type": { "text": ", T3 extends CompositionCallback, T4 extends keyof T3>(this: T1, name: T3 | T4, callbacks?: T3[T4] & ThisType) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "off", "kind": "field", "static": true, "type": { "text": ", T3 extends CompositionCallback, T4 extends keyof T3>(this: T1, name: T3 | T4, callbacks?: T3[T4] & ThisType) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "offPropChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: ObjectOrObjectEntries<{ [P in keyof T2]?: (this: T2, oldValue: T2[P], newValue: T2[P], changes: any, element: T2) => void; }>) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "offAttributeChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: { [x: string]: (this: T2, oldValue: string, newValue: string, element: T2) => void; }) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "onPropChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: ObjectOrObjectEntries<{ [P in keyof T2]?: (this: T2, oldValue: T2[P], newValue: T2[P], changes: any, element: T2) => void; }>) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "onAttributeChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: { [x: string]: (this: T2, oldValue: string, newValue: string, element: T2) => void; }) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } } ], "slots": [], "cssParts": [], "events": [], "demos": [], "superclass": { "module": "core/CustomElement.js", "name": "default" }, "mixins": [ { "module": "mixins/ThemableMixin.js", "name": "default" }, { "module": "mixins/ShapeMixin.js", "name": "default" } ], "description": "Visual helper for radio buttons, rendering the outer and inner rings.\n@see https://m3.material.io/components/radio-button/overview" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "default", "module": "components/RadioIcon.js" } }, { "kind": "custom-element-definition", "name": "mdw-radio-icon", "declaration": { "name": "default", "module": "components/RadioIcon.js" } } ] }, { "kind": "javascript-module", "path": "components/Ripple.js", "declarations": [ { "kind": "class", "name": "Ripple", "tagName": "mdw-ripple", "customElement": true, "attributes": [ { "name": "ripple-state", "description": "Current lifecycle state for the ripple (e.g. 'filled', 'complete').", "fieldName": "rippleState", "type": { "text": "string" } }, { "name": "keep-alive", "description": "When true, keep the ripple in the DOM after animation ends.", "fieldName": "keepAlive", "type": { "text": "boolean" } }, { "name": "hold-ripple", "description": "Hold the ripple (e.g. for long-press); triggers hold/release tracking.", "fieldName": "holdRipple", "type": { "text": "boolean" } } ], "members": [ { "name": "hadRippleHeld", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Ripple.js#L13" }, "type": { "text": "boolean" } }, { "name": "hadRippleReleased", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Ripple.js#L14" }, "type": { "text": "boolean" } }, { "name": "rippleStarted", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Ripple.js#L15" }, "type": { "text": "boolean" } }, { "name": "rippleState", "kind": "field", "description": "Current lifecycle state for the ripple (e.g. 'filled', 'complete').", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Ripple.js#L19" }, "type": { "text": "string" } }, { "name": "keepAlive", "kind": "field", "description": "When true, keep the ripple in the DOM after animation ends.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Ripple.js#L21" }, "type": { "text": "boolean" } }, { "name": "holdRipple", "kind": "field", "description": "Hold the ripple (e.g. for long-press); triggers hold/release tracking.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Ripple.js#L29" }, "type": { "text": "boolean" } }, { "name": "updatePosition", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Ripple.js#L66" }, "return": { "type": { "text": "(x?: number, y?: number, size?: number) => void" } } }, { "name": "handleRippleComplete", "kind": "method", "description": "Complete the ripple lifecycle: either mark complete or remove.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Ripple.js#L99" }, "return": { "type": { "text": "() => void" } } }, { "name": "prototype", "kind": "field", "static": true, "type": { "text": "CustomElement" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "compose", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L145" }, "type": { "text": "(parts: CompositionPart[]) => Composition" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#refsProxy", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1145" }, "type": { "text": "Record" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#refsCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1148" }, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#refsCompositionCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1151" }, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#composition", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1154" }, "type": { "text": "Composition" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#patching", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1156" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#pendingPatchRenders", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1159" }, "type": { "text": "[string, any, CustomElement][]" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#propAttributeCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1162" }, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#callbackArguments", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1165" }, "type": { "text": "CallbackArguments" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "elementInternals", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1172" }, "type": { "text": "ElementInternals" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "render", "kind": "field", "description": "Updates nodes based on data\nExpects data in JSON Merge Patch format", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1185" }, "type": { "text": "RenderDraw" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "propChangedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1213" }, "type": { "text": "(this: T, name: K, oldValue: K extends keyof T ? T[K] : unknown, newValue: K extends keyof T ? T[K] : unknown, changes?: K extends keyof T ? T[K] extends object ? Partial : T[K] : unknown) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attributeChangedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1234" }, "type": { "text": "(name: string, oldValue: string, newValue: string) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#template", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1284" }, "type": { "text": "DocumentFragment" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#onObserverPropertyChanged", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1294" }, "type": { "text": "(name: string, oldValue: any, newValue: any, changes: any) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "static", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1330" }, "type": { "text": "typeof CustomElement" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "patch", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1333" }, "type": { "text": "(patch: any) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "refs", "kind": "field", "description": "Proxy object that returns shadow DOM elements by tag.\nIf called before interpolation (eg: on composed), returns from template", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1404" }, "type": { "text": "Record" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attributeCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1391" }, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "callbackArguments", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1400" }, "type": { "text": "CallbackArguments | { composition: Composition; refs: Record; html: any; inline: (fn: (data: Partial) => any) => string; template: DocumentFragment; element: T; }" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "composition", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1403" }, "type": { "text": "Composition" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "connectedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1435" }, "type": { "text": "() => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "disconnectedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1441" }, "type": { "text": "() => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "delegatesFocus", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1175" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "elementName", "kind": "field", "static": true, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "observedAttributes", "kind": "field", "static": true, "type": { "text": "Iterable" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "interpolatesTemplate", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "supportsElementInternals", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "supportsElementInternalsRole", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "defined", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "registrations", "kind": "field", "static": true, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "expressions", "kind": "method", "static": true, "description": "Expressions are idempotent functions that are selectively called whenever\na render is requested.\nExpressions are constructed exactly as methods though differ in expected\narguments. The first argument should be destructured to ensure each used\nproperty is accessed at least once in order to inspect used properties.\n\nThe Composition API will inspect this function with a proxy for `this` to\ncatalog what observables are used by the expression. This allows the\nComposition API to build a cache as well as selective invoke the expression\nonly when needed.\n\nWhen used with in element templates, the element itself will be passed as\nits first argument.\n````js\n Button\n .prop('filled', 'boolean')\n .prop('outlined', 'boolean')\n .expresssions({\n _isFilledOrOutlined({filled, outlined}) {\n return (filled || outlined)\n },\n })\n .html`
`;\n````\n\nWhen used with external data source, that data source\nwill be passed to the expression with all properties being `null` at first\ninspection.\n````js\n const externalData = {first: 'John', last: 'Doe'};\n ContactCard\n .expresssions({\n _fullName({first, last}) {\n return [first, last].filter(Boolean).join(' ');\n },\n })\n myButton.render(externalData);\n````\n\nExpressions may be support argumentless calls by using default\nparameters with `this`.\n````js\n Button\n .expresssions({\n isFilledOrOutlined({filled, outlined} = this) {\n return (filled || outlined)\n },\n });\n myButton.isFilledorOutlined();\n````", "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends { [K in keyof any]: K extends `_${any}` ? ((data: INSTANCE, state?: Record) => string | boolean | null) : ((data?: INSTANCE, state?: Record) => string | boolean | null); } & ThisType>(this: CLASS, expressions: PROPS & ThisType) => CLASS & Class<{ [K in keyof PROPS]: K extends `_${any}` ? never : () => ReturnType; }, ARGS>" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "methods", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "overrides", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends Partial>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "props", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "idl", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "append", "kind": "field", "static": true, "description": "Append parts to composition", "type": { "text": "(this: T, ...parts: CompositionPart[]) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "recompose", "kind": "field", "static": true, "description": "After composition, invokes callback.\nMay be called multiple times.", "type": { "text": ", T3 extends CompositionCallback[\"composed\"]>(this: T1, callback: T3) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "css", "kind": "field", "static": true, "description": "Appends styles to composition", "type": { "text": "(this: T1, array: T2, ...rest: T2 extends string ? any : T2 extends TemplateStringsArray ? any[] : (HTMLStyleElement | CSSStyleSheet)[]) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "autoRegister", "kind": "field", "static": true, "description": "Registers class with customElements. If class is registered before then,\ndoes nothing.", "type": { "text": "(this: T, elementName: string) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "html", "kind": "field", "static": true, "description": "Appends DocumentFragment to composition", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1405" }, "type": { "text": "(this: T, string: TemplateStringsArray, ...substitutions: (string | Element | ((this: InstanceType, data: InstanceType, injections?: any) => any))[]) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "extend", "kind": "field", "static": true, "description": "Extends base class into a new class.\nUse to avoid mutating base class.", "type": { "text": " T2>(this: T1, customExtender?: T3) => T3 extends null ? T1 : T2" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "setStatic", "kind": "field", "static": true, "description": "Assigns static values to class", "type": { "text": " any) | string | number | boolean | any[] | object); }>(this: T1, source: T2 & ThisType) => T1 & T2" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "readonly", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "set", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "mixin", "kind": "field", "static": true, "description": "Returns result of calling mixin with current class", "type": { "text": " any, RETURN extends ReturnType, SUBCLASS extends ClassOf>(this: BASE, mixin: FN) => SUBCLASS & BASE" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "register", "kind": "field", "static": true, "description": "Registers class with window.customElements synchronously", "type": { "text": "(this: T, elementName?: string, force?: boolean) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "propList", "kind": "field", "static": true, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attrList", "kind": "field", "static": true, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "propChangedCallbacks", "kind": "field", "static": true, "type": { "text": "Map any)[]>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attributeChangedCallbacks", "kind": "field", "static": true, "type": { "text": "Map any)[]>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "prop", "kind": "field", "static": true, "description": "Creates observable property on instances (via prototype)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1007" }, "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "setPrototype", "kind": "field", "static": true, "description": "Creates observable property on instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any)>(this: CLASS, name: KEY, options: OPTIONS) => OPTIONS extends (...args2: any[]) => infer R ? R : OPTIONS extends ObserverPropertyType ? ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? unknown extends R ? object : R : OPTIONS extends { type: ObserverPropertyType; } ? ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? unknown extends R ? string : R : never" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "define", "kind": "field", "static": true, "description": "Define properties on instances via Object.defineProperties().\nAutomatically sets property non-enumerable if name begins with `_`.\nFunctions will be remapped as getters", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends { [P in keyof any]: { enumerable?: boolean; configurable?: boolean; writable?: boolean; value?: any; get?: ((this: INSTANCE) => any); set?: (this: INSTANCE, value: any) => void; } | ((this: INSTANCE, ...args: any[]) => any); }, VALUE extends { [KEY in keyof PROPS]: PROPS[KEY] extends (...args2: any[]) => infer R ? R : PROPS[KEY] extends TypedPropertyDescriptor ? R : never; }>(this: CLASS, props: PROPS & ThisType) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "undefine", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROP extends string, PROPS extends INSTANCE & Record>(this: CLASS, name: PROP) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "observe", "kind": "field", "static": true, "description": "Creates observable properties on instances", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends IDLParameter, VALUE extends { [KEY in keyof PROPS]: PROPS[KEY] extends (...args2: any[]) => infer R ? R : PROPS[KEY] extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : PROPS[KEY] extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : PROPS[KEY] extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : PROPS[KEY] extends ObserverOptions ? (unknown extends R ? string : R) : never; }>(this: CLASS, props: PROPS) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "defineStatic", "kind": "field", "static": true, "type": { "text": ">(this: T1, props: T2) => T1 & ParsedProps" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "events", "kind": "field", "static": true, "type": { "text": "(this: T, listeners?: CompositionEventListenerObject>, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "childEvents", "kind": "field", "static": true, "type": { "text": "(this: T, listenerMap: { [x: string]: CompositionEventListenerObject>; }, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "rootEvents", "kind": "field", "static": true, "type": { "text": "(this: T, listeners?: CompositionEventListenerObject>, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "on", "kind": "field", "static": true, "type": { "text": ", T3 extends CompositionCallback, T4 extends keyof T3>(this: T1, name: T3 | T4, callbacks?: T3[T4] & ThisType) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "off", "kind": "field", "static": true, "type": { "text": ", T3 extends CompositionCallback, T4 extends keyof T3>(this: T1, name: T3 | T4, callbacks?: T3[T4] & ThisType) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "offPropChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: ObjectOrObjectEntries<{ [P in keyof T2]?: (this: T2, oldValue: T2[P], newValue: T2[P], changes: any, element: T2) => void; }>) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "offAttributeChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: { [x: string]: (this: T2, oldValue: string, newValue: string, element: T2) => void; }) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "onPropChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: ObjectOrObjectEntries<{ [P in keyof T2]?: (this: T2, oldValue: T2[P], newValue: T2[P], changes: any, element: T2) => void; }>) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "onAttributeChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: { [x: string]: (this: T2, oldValue: string, newValue: string, element: T2) => void; }) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } } ], "slots": [], "cssParts": [], "events": [], "demos": [], "superclass": { "module": "core/CustomElement.js", "name": "default" }, "mixins": [], "description": "Ripple is a visual touch feedback effect used by controls to indicate\npointer/touch interaction. It renders and animates a circular ink ripple\nand exposes properties to control its position, size, and lifecycle.\n@see https://m3.material.io/foundations/interaction/states/applying-states" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "default", "module": "components/Ripple.js" } }, { "kind": "custom-element-definition", "name": "mdw-ripple", "declaration": { "name": "default", "module": "components/Ripple.js" } } ] }, { "kind": "javascript-module", "path": "components/Root.js", "declarations": [ { "kind": "class", "name": "Root", "tagName": "mdw-root", "customElement": true, "attributes": [], "members": [ { "name": "delegatesFocus", "kind": "field", "description": "When true, the element delegates focus to an internal focus target.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/DelegatesFocusMixin.js#L15" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "prototype", "kind": "field", "static": true, "type": { "text": "CustomElement" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "startScrollListener", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ScrollListenerMixin.js#L63" }, "return": { "type": { "text": "(scroller?: EventTarget) => boolean" } }, "inheritedFrom": { "name": "default", "module": "mixins/ScrollListenerMixin.js" } }, { "name": "compose", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L145" }, "type": { "text": "(parts: CompositionPart[]) => Composition" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#refsProxy", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1145" }, "type": { "text": "Record" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#refsCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1148" }, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#refsCompositionCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1151" }, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#composition", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1154" }, "type": { "text": "Composition" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#patching", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1156" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#pendingPatchRenders", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1159" }, "type": { "text": "[string, any, CustomElement][]" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#propAttributeCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1162" }, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#callbackArguments", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1165" }, "type": { "text": "CallbackArguments" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "elementInternals", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1172" }, "type": { "text": "ElementInternals" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "render", "kind": "field", "description": "Updates nodes based on data\nExpects data in JSON Merge Patch format", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1185" }, "type": { "text": "RenderDraw" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "propChangedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1213" }, "type": { "text": "(this: T, name: K, oldValue: K extends keyof T ? T[K] : unknown, newValue: K extends keyof T ? T[K] : unknown, changes?: K extends keyof T ? T[K] extends object ? Partial : T[K] : unknown) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attributeChangedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1234" }, "type": { "text": "(name: string, oldValue: string, newValue: string) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#template", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1284" }, "type": { "text": "DocumentFragment" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#onObserverPropertyChanged", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1294" }, "type": { "text": "(name: string, oldValue: any, newValue: any, changes: any) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "static", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1330" }, "type": { "text": "typeof CustomElement" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "patch", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1333" }, "type": { "text": "(patch: any) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "refs", "kind": "field", "description": "Proxy object that returns shadow DOM elements by tag.\nIf called before interpolation (eg: on composed), returns from template", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1404" }, "type": { "text": "Record" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attributeCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1391" }, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "callbackArguments", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1400" }, "type": { "text": "CallbackArguments | { composition: Composition; refs: Record; html: any; inline: (fn: (data: Partial) => any) => string; template: DocumentFragment; element: T; }" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "composition", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1403" }, "type": { "text": "Composition" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "connectedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1435" }, "type": { "text": "() => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "disconnectedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1441" }, "type": { "text": "() => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "elementName", "kind": "field", "static": true, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "observedAttributes", "kind": "field", "static": true, "type": { "text": "Iterable" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "interpolatesTemplate", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "supportsElementInternals", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "supportsElementInternalsRole", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "defined", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "registrations", "kind": "field", "static": true, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "expressions", "kind": "method", "static": true, "description": "Expressions are idempotent functions that are selectively called whenever\na render is requested.\nExpressions are constructed exactly as methods though differ in expected\narguments. The first argument should be destructured to ensure each used\nproperty is accessed at least once in order to inspect used properties.\n\nThe Composition API will inspect this function with a proxy for `this` to\ncatalog what observables are used by the expression. This allows the\nComposition API to build a cache as well as selective invoke the expression\nonly when needed.\n\nWhen used with in element templates, the element itself will be passed as\nits first argument.\n````js\n Button\n .prop('filled', 'boolean')\n .prop('outlined', 'boolean')\n .expresssions({\n _isFilledOrOutlined({filled, outlined}) {\n return (filled || outlined)\n },\n })\n .html`
`;\n````\n\nWhen used with external data source, that data source\nwill be passed to the expression with all properties being `null` at first\ninspection.\n````js\n const externalData = {first: 'John', last: 'Doe'};\n ContactCard\n .expresssions({\n _fullName({first, last}) {\n return [first, last].filter(Boolean).join(' ');\n },\n })\n myButton.render(externalData);\n````\n\nExpressions may be support argumentless calls by using default\nparameters with `this`.\n````js\n Button\n .expresssions({\n isFilledOrOutlined({filled, outlined} = this) {\n return (filled || outlined)\n },\n });\n myButton.isFilledorOutlined();\n````", "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends { [K in keyof any]: K extends `_${any}` ? ((data: INSTANCE, state?: Record) => string | boolean | null) : ((data?: INSTANCE, state?: Record) => string | boolean | null); } & ThisType>(this: CLASS, expressions: PROPS & ThisType) => CLASS & Class<{ [K in keyof PROPS]: K extends `_${any}` ? never : () => ReturnType; }, ARGS>" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "methods", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "overrides", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends Partial>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "props", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "idl", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "append", "kind": "field", "static": true, "description": "Append parts to composition", "type": { "text": "(this: T, ...parts: CompositionPart[]) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "recompose", "kind": "field", "static": true, "description": "After composition, invokes callback.\nMay be called multiple times.", "type": { "text": ", T3 extends CompositionCallback[\"composed\"]>(this: T1, callback: T3) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "css", "kind": "field", "static": true, "description": "Appends styles to composition", "type": { "text": "(this: T1, array: T2, ...rest: T2 extends string ? any : T2 extends TemplateStringsArray ? any[] : (HTMLStyleElement | CSSStyleSheet)[]) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "autoRegister", "kind": "field", "static": true, "description": "Registers class with customElements. If class is registered before then,\ndoes nothing.", "type": { "text": "(this: T, elementName: string) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "html", "kind": "field", "static": true, "description": "Appends DocumentFragment to composition", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1405" }, "type": { "text": "(this: T, string: TemplateStringsArray, ...substitutions: (string | Element | ((this: InstanceType, data: InstanceType, injections?: any) => any))[]) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "extend", "kind": "field", "static": true, "description": "Extends base class into a new class.\nUse to avoid mutating base class.", "type": { "text": " T2>(this: T1, customExtender?: T3) => T3 extends null ? T1 : T2" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "setStatic", "kind": "field", "static": true, "description": "Assigns static values to class", "type": { "text": " any) | string | number | boolean | any[] | object); }>(this: T1, source: T2 & ThisType) => T1 & T2" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "readonly", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "set", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "mixin", "kind": "field", "static": true, "description": "Returns result of calling mixin with current class", "type": { "text": " any, RETURN extends ReturnType, SUBCLASS extends ClassOf>(this: BASE, mixin: FN) => SUBCLASS & BASE" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "register", "kind": "field", "static": true, "description": "Registers class with window.customElements synchronously", "type": { "text": "(this: T, elementName?: string, force?: boolean) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "propList", "kind": "field", "static": true, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attrList", "kind": "field", "static": true, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "propChangedCallbacks", "kind": "field", "static": true, "type": { "text": "Map any)[]>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attributeChangedCallbacks", "kind": "field", "static": true, "type": { "text": "Map any)[]>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "prop", "kind": "field", "static": true, "description": "Creates observable property on instances (via prototype)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1007" }, "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "setPrototype", "kind": "field", "static": true, "description": "Creates observable property on instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any)>(this: CLASS, name: KEY, options: OPTIONS) => OPTIONS extends (...args2: any[]) => infer R ? R : OPTIONS extends ObserverPropertyType ? ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? unknown extends R ? object : R : OPTIONS extends { type: ObserverPropertyType; } ? ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? unknown extends R ? string : R : never" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "define", "kind": "field", "static": true, "description": "Define properties on instances via Object.defineProperties().\nAutomatically sets property non-enumerable if name begins with `_`.\nFunctions will be remapped as getters", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends { [P in keyof any]: { enumerable?: boolean; configurable?: boolean; writable?: boolean; value?: any; get?: ((this: INSTANCE) => any); set?: (this: INSTANCE, value: any) => void; } | ((this: INSTANCE, ...args: any[]) => any); }, VALUE extends { [KEY in keyof PROPS]: PROPS[KEY] extends (...args2: any[]) => infer R ? R : PROPS[KEY] extends TypedPropertyDescriptor ? R : never; }>(this: CLASS, props: PROPS & ThisType) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "undefine", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROP extends string, PROPS extends INSTANCE & Record>(this: CLASS, name: PROP) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "observe", "kind": "field", "static": true, "description": "Creates observable properties on instances", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends IDLParameter, VALUE extends { [KEY in keyof PROPS]: PROPS[KEY] extends (...args2: any[]) => infer R ? R : PROPS[KEY] extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : PROPS[KEY] extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : PROPS[KEY] extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : PROPS[KEY] extends ObserverOptions ? (unknown extends R ? string : R) : never; }>(this: CLASS, props: PROPS) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "defineStatic", "kind": "field", "static": true, "type": { "text": ">(this: T1, props: T2) => T1 & ParsedProps" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "events", "kind": "field", "static": true, "type": { "text": "(this: T, listeners?: CompositionEventListenerObject>, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "childEvents", "kind": "field", "static": true, "type": { "text": "(this: T, listenerMap: { [x: string]: CompositionEventListenerObject>; }, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "rootEvents", "kind": "field", "static": true, "type": { "text": "(this: T, listeners?: CompositionEventListenerObject>, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "on", "kind": "field", "static": true, "type": { "text": ", T3 extends CompositionCallback, T4 extends keyof T3>(this: T1, name: T3 | T4, callbacks?: T3[T4] & ThisType) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "off", "kind": "field", "static": true, "type": { "text": ", T3 extends CompositionCallback, T4 extends keyof T3>(this: T1, name: T3 | T4, callbacks?: T3[T4] & ThisType) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "offPropChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: ObjectOrObjectEntries<{ [P in keyof T2]?: (this: T2, oldValue: T2[P], newValue: T2[P], changes: any, element: T2) => void; }>) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "offAttributeChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: { [x: string]: (this: T2, oldValue: string, newValue: string, element: T2) => void; }) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "onPropChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: ObjectOrObjectEntries<{ [P in keyof T2]?: (this: T2, oldValue: T2[P], newValue: T2[P], changes: any, element: T2) => void; }>) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "onAttributeChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: { [x: string]: (this: T2, oldValue: string, newValue: string, element: T2) => void; }) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } } ], "slots": [ { "name": "start", "description": "" }, { "name": "bottom", "description": "" }, { "name": "bottom-fixed", "description": "" }, { "name": "", "description": "" }, { "name": "end", "description": "" } ], "cssParts": [], "events": [], "demos": [ { "url": "demo/components/root.html" } ], "superclass": { "module": "core/CustomElement.js", "name": "default" }, "mixins": [ { "module": "mixins/ScrollListenerMixin.js", "name": "default" }, { "module": "mixins/DelegatesFocusMixin.js", "name": "default" } ], "description": "Root is the application's top-level container that manages layout regions and\nshared floating areas such as bottom bars.\n@see https://m3.material.io/foundations/layout/applying-layout/window-size-classes" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "default", "module": "components/Root.js" } }, { "kind": "custom-element-definition", "name": "mdw-root", "declaration": { "name": "default", "module": "components/Root.js" } } ] }, { "kind": "javascript-module", "path": "components/Scrim.js", "declarations": [ { "kind": "class", "name": "Scrim", "tagName": "mdw-scrim", "customElement": true, "attributes": [ { "name": "hidden", "description": "When true the scrim is hidden and will be removed after its fade-out animation.", "fieldName": "hidden", "type": { "text": "boolean" } } ], "members": [ { "name": "prototype", "kind": "field", "static": true, "type": { "text": "CustomElement" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "compose", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L145" }, "type": { "text": "(parts: CompositionPart[]) => Composition" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#refsProxy", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1145" }, "type": { "text": "Record" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#refsCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1148" }, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#refsCompositionCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1151" }, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#composition", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1154" }, "type": { "text": "Composition" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#patching", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1156" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#pendingPatchRenders", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1159" }, "type": { "text": "[string, any, CustomElement][]" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#propAttributeCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1162" }, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#callbackArguments", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1165" }, "type": { "text": "CallbackArguments" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "elementInternals", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1172" }, "type": { "text": "ElementInternals" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "render", "kind": "field", "description": "Updates nodes based on data\nExpects data in JSON Merge Patch format", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1185" }, "type": { "text": "RenderDraw" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "propChangedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1213" }, "type": { "text": "(this: T, name: K, oldValue: K extends keyof T ? T[K] : unknown, newValue: K extends keyof T ? T[K] : unknown, changes?: K extends keyof T ? T[K] extends object ? Partial : T[K] : unknown) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attributeChangedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1234" }, "type": { "text": "(name: string, oldValue: string, newValue: string) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#template", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1284" }, "type": { "text": "DocumentFragment" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#onObserverPropertyChanged", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1294" }, "type": { "text": "(name: string, oldValue: any, newValue: any, changes: any) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "static", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1330" }, "type": { "text": "typeof CustomElement" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "patch", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1333" }, "type": { "text": "(patch: any) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "refs", "kind": "field", "description": "Proxy object that returns shadow DOM elements by tag.\nIf called before interpolation (eg: on composed), returns from template", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1404" }, "type": { "text": "Record" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attributeCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1391" }, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "callbackArguments", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1400" }, "type": { "text": "CallbackArguments | { composition: Composition; refs: Record; html: any; inline: (fn: (data: Partial) => any) => string; template: DocumentFragment; element: T; }" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "composition", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1403" }, "type": { "text": "Composition" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "connectedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1435" }, "type": { "text": "() => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "disconnectedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1441" }, "type": { "text": "() => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "delegatesFocus", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1175" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "elementName", "kind": "field", "static": true, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "observedAttributes", "kind": "field", "static": true, "type": { "text": "Iterable" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "interpolatesTemplate", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "supportsElementInternals", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "supportsElementInternalsRole", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "defined", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "registrations", "kind": "field", "static": true, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "expressions", "kind": "method", "static": true, "description": "Expressions are idempotent functions that are selectively called whenever\na render is requested.\nExpressions are constructed exactly as methods though differ in expected\narguments. The first argument should be destructured to ensure each used\nproperty is accessed at least once in order to inspect used properties.\n\nThe Composition API will inspect this function with a proxy for `this` to\ncatalog what observables are used by the expression. This allows the\nComposition API to build a cache as well as selective invoke the expression\nonly when needed.\n\nWhen used with in element templates, the element itself will be passed as\nits first argument.\n````js\n Button\n .prop('filled', 'boolean')\n .prop('outlined', 'boolean')\n .expresssions({\n _isFilledOrOutlined({filled, outlined}) {\n return (filled || outlined)\n },\n })\n .html`
`;\n````\n\nWhen used with external data source, that data source\nwill be passed to the expression with all properties being `null` at first\ninspection.\n````js\n const externalData = {first: 'John', last: 'Doe'};\n ContactCard\n .expresssions({\n _fullName({first, last}) {\n return [first, last].filter(Boolean).join(' ');\n },\n })\n myButton.render(externalData);\n````\n\nExpressions may be support argumentless calls by using default\nparameters with `this`.\n````js\n Button\n .expresssions({\n isFilledOrOutlined({filled, outlined} = this) {\n return (filled || outlined)\n },\n });\n myButton.isFilledorOutlined();\n````", "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends { [K in keyof any]: K extends `_${any}` ? ((data: INSTANCE, state?: Record) => string | boolean | null) : ((data?: INSTANCE, state?: Record) => string | boolean | null); } & ThisType>(this: CLASS, expressions: PROPS & ThisType) => CLASS & Class<{ [K in keyof PROPS]: K extends `_${any}` ? never : () => ReturnType; }, ARGS>" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "methods", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "overrides", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends Partial>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "props", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "idl", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "append", "kind": "field", "static": true, "description": "Append parts to composition", "type": { "text": "(this: T, ...parts: CompositionPart[]) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "recompose", "kind": "field", "static": true, "description": "After composition, invokes callback.\nMay be called multiple times.", "type": { "text": ", T3 extends CompositionCallback[\"composed\"]>(this: T1, callback: T3) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "css", "kind": "field", "static": true, "description": "Appends styles to composition", "type": { "text": "(this: T1, array: T2, ...rest: T2 extends string ? any : T2 extends TemplateStringsArray ? any[] : (HTMLStyleElement | CSSStyleSheet)[]) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "autoRegister", "kind": "field", "static": true, "description": "Registers class with customElements. If class is registered before then,\ndoes nothing.", "type": { "text": "(this: T, elementName: string) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "html", "kind": "field", "static": true, "description": "Appends DocumentFragment to composition", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1405" }, "type": { "text": "(this: T, string: TemplateStringsArray, ...substitutions: (string | Element | ((this: InstanceType, data: InstanceType, injections?: any) => any))[]) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "extend", "kind": "field", "static": true, "description": "Extends base class into a new class.\nUse to avoid mutating base class.", "type": { "text": " T2>(this: T1, customExtender?: T3) => T3 extends null ? T1 : T2" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "setStatic", "kind": "field", "static": true, "description": "Assigns static values to class", "type": { "text": " any) | string | number | boolean | any[] | object); }>(this: T1, source: T2 & ThisType) => T1 & T2" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "readonly", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "set", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "mixin", "kind": "field", "static": true, "description": "Returns result of calling mixin with current class", "type": { "text": " any, RETURN extends ReturnType, SUBCLASS extends ClassOf>(this: BASE, mixin: FN) => SUBCLASS & BASE" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "register", "kind": "field", "static": true, "description": "Registers class with window.customElements synchronously", "type": { "text": "(this: T, elementName?: string, force?: boolean) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "propList", "kind": "field", "static": true, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attrList", "kind": "field", "static": true, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "propChangedCallbacks", "kind": "field", "static": true, "type": { "text": "Map any)[]>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attributeChangedCallbacks", "kind": "field", "static": true, "type": { "text": "Map any)[]>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "prop", "kind": "field", "static": true, "description": "Creates observable property on instances (via prototype)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1007" }, "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "setPrototype", "kind": "field", "static": true, "description": "Creates observable property on instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any)>(this: CLASS, name: KEY, options: OPTIONS) => OPTIONS extends (...args2: any[]) => infer R ? R : OPTIONS extends ObserverPropertyType ? ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? unknown extends R ? object : R : OPTIONS extends { type: ObserverPropertyType; } ? ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? unknown extends R ? string : R : never" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "define", "kind": "field", "static": true, "description": "Define properties on instances via Object.defineProperties().\nAutomatically sets property non-enumerable if name begins with `_`.\nFunctions will be remapped as getters", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends { [P in keyof any]: { enumerable?: boolean; configurable?: boolean; writable?: boolean; value?: any; get?: ((this: INSTANCE) => any); set?: (this: INSTANCE, value: any) => void; } | ((this: INSTANCE, ...args: any[]) => any); }, VALUE extends { [KEY in keyof PROPS]: PROPS[KEY] extends (...args2: any[]) => infer R ? R : PROPS[KEY] extends TypedPropertyDescriptor ? R : never; }>(this: CLASS, props: PROPS & ThisType) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "undefine", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROP extends string, PROPS extends INSTANCE & Record>(this: CLASS, name: PROP) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "observe", "kind": "field", "static": true, "description": "Creates observable properties on instances", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends IDLParameter, VALUE extends { [KEY in keyof PROPS]: PROPS[KEY] extends (...args2: any[]) => infer R ? R : PROPS[KEY] extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : PROPS[KEY] extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : PROPS[KEY] extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : PROPS[KEY] extends ObserverOptions ? (unknown extends R ? string : R) : never; }>(this: CLASS, props: PROPS) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "defineStatic", "kind": "field", "static": true, "type": { "text": ">(this: T1, props: T2) => T1 & ParsedProps" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "events", "kind": "field", "static": true, "type": { "text": "(this: T, listeners?: CompositionEventListenerObject>, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "childEvents", "kind": "field", "static": true, "type": { "text": "(this: T, listenerMap: { [x: string]: CompositionEventListenerObject>; }, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "rootEvents", "kind": "field", "static": true, "type": { "text": "(this: T, listeners?: CompositionEventListenerObject>, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "on", "kind": "field", "static": true, "type": { "text": ", T3 extends CompositionCallback, T4 extends keyof T3>(this: T1, name: T3 | T4, callbacks?: T3[T4] & ThisType) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "off", "kind": "field", "static": true, "type": { "text": ", T3 extends CompositionCallback, T4 extends keyof T3>(this: T1, name: T3 | T4, callbacks?: T3[T4] & ThisType) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "offPropChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: ObjectOrObjectEntries<{ [P in keyof T2]?: (this: T2, oldValue: T2[P], newValue: T2[P], changes: any, element: T2) => void; }>) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "offAttributeChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: { [x: string]: (this: T2, oldValue: string, newValue: string, element: T2) => void; }) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "onPropChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: ObjectOrObjectEntries<{ [P in keyof T2]?: (this: T2, oldValue: T2[P], newValue: T2[P], changes: any, element: T2) => void; }>) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "onAttributeChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: { [x: string]: (this: T2, oldValue: string, newValue: string, element: T2) => void; }) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } } ], "slots": [], "cssParts": [], "events": [], "demos": [], "superclass": { "module": "core/CustomElement.js", "name": "default" }, "mixins": [], "description": "A scrim can bring focus to specific elements by increasing the visual contrast of a large layered surface.\nUse the scrim beneath elements like modals and expanded navigation menus.\n@see https://m3.material.io/styles/elevation/applying-elevation" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "default", "module": "components/Scrim.js" } }, { "kind": "custom-element-definition", "name": "mdw-scrim", "declaration": { "name": "default", "module": "components/Scrim.js" } } ] }, { "kind": "javascript-module", "path": "components/Search.js", "declarations": [ { "kind": "class", "name": "Search", "tagName": "mdw-search", "customElement": true, "attributes": [ { "name": "color", "description": "Visual color token to apply to the search surface.", "fieldName": "color", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/TopAppBar.js" } }, { "name": "ink", "fieldName": "ink", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/TopAppBar.js" } }, { "name": "type-style", "fieldName": "typeStyle", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/TopAppBar.js" } }, { "name": "shape-top", "fieldName": "shapeTop", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/TopAppBar.js" } }, { "name": "shape-bottom", "fieldName": "shapeBottom", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/TopAppBar.js" } }, { "name": "shape-start", "fieldName": "shapeStart", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/TopAppBar.js" } }, { "name": "shape-end", "fieldName": "shapeEnd", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/TopAppBar.js" } }, { "name": "shape-style", "description": "Shape style token to apply (e.g. 'full', 'none').", "fieldName": "shapeStyle", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/TopAppBar.js" } }, { "name": "outlined", "fieldName": "outlined", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/TopAppBar.js" } }, { "name": "kbd-nav", "description": "Enable keyboard navigation mode for search results when true.", "fieldName": "kbdNav", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/TopAppBar.js" } }, { "name": "sticky-always", "fieldName": "stickyAlways", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/TopAppBar.js" } }, { "name": "sticky-parent", "fieldName": "stickyParent", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/TopAppBar.js" } }, { "name": "raised-color", "fieldName": "raisedColor", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/TopAppBar.js" } }, { "name": "placeholder", "description": "Placeholder text shown in the search input.", "fieldName": "placeholder", "type": { "text": "string" } }, { "name": "headline", "description": "Headline text displayed in the center area.", "fieldName": "headline", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/TopAppBar.js" } }, { "name": "size", "description": "Size variant: 'small' | 'medium' | 'large' or `null` to auto-select.", "fieldName": "size", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/TopAppBar.js" } } ], "members": [ { "name": "delegatesFocus", "kind": "field", "description": "When true, the element delegates focus to an internal focus target.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/DelegatesFocusMixin.js#L15" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/TopAppBar.js" } }, { "name": "startScrollListener", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ScrollListenerMixin.js#L63" }, "type": { "text": "(scroller?: EventTarget) => boolean" } }, { "name": "stickyAlways", "kind": "field", "description": "When true, element remains always visible", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/SemiStickyMixin.js#L26" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/TopAppBar.js" } }, { "name": "stickyParent", "kind": "field", "description": "Stick to offsetParent instead of window", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/SemiStickyMixin.js#L28" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/TopAppBar.js" } }, { "name": "readAriaProperty", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/AriaReflectorMixin.js#L28" }, "type": { "text": "(name: \"shadowRoot\" | \"ariaActiveDescendantElement\" | \"ariaAtomic\" | \"ariaAutoComplete\" | \"ariaBrailleLabel\" | \"ariaBrailleRoleDescription\" | \"ariaBusy\" | \"ariaChecked\" | \"ariaColCount\" | \"ariaColIndex\" | \"ariaColIndexText\" | \"ariaColSpan\" | \"ariaControlsElements\" | \"ariaCurrent\" | \"ariaDescribedByElements\" | \"ariaDescription\" | \"ariaDetailsElements\" | \"ariaDisabled\" | \"ariaErrorMessageElements\" | \"ariaExpanded\" | \"ariaFlowToElements\" | \"ariaHasPopup\" | \"ariaHidden\" | \"ariaInvalid\" | \"ariaKeyShortcuts\" | \"ariaLabel\" | \"ariaLabelledByElements\" | \"ariaLevel\" | \"ariaLive\" | \"ariaModal\" | \"ariaMultiLine\" | \"ariaMultiSelectable\" | \"ariaOrientation\" | \"ariaOwnsElements\" | \"ariaPlaceholder\" | \"ariaPosInSet\" | \"ariaPressed\" | \"ariaReadOnly\" | \"ariaRelevant\" | \"ariaRequired\" | \"ariaRoleDescription\" | \"ariaRowCount\" | \"ariaRowIndex\" | \"ariaRowIndexText\" | \"ariaRowSpan\" | \"ariaSelected\" | \"ariaSetSize\" | \"ariaSort\" | \"ariaValueMax\" | \"ariaValueMin\" | \"ariaValueNow\" | \"ariaValueText\" | \"role\") => string | Element | ShadowRoot | readonly Element[]" } }, { "name": "updateAriaProperty", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/AriaReflectorMixin.js#L47" }, "type": { "text": ">(name: K, value: ARIAMixin[K]) => void" } }, { "name": "kbdNav", "kind": "field", "description": "Enable keyboard roving navigation when present (set to 'true').\nEnable keyboard navigation mode for search results when true.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Search.js#L22" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/TopAppBar.js" } }, { "name": "kbdNavQuery", "kind": "field", "description": "Query used to find roving tab index children", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/KeyboardNavMixin.js#L32" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/TopAppBar.js" } }, { "name": "kbdNavFocusableWhenDisabled", "kind": "field", "description": "Flag whether disabled elements participating in roving tab index\nshould be focusable.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/KeyboardNavMixin.js#L39" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/TopAppBar.js" } }, { "name": "ariaOrientationDefault", "kind": "field", "description": "Default orientation for toolbar: 'horizontal' or 'vertical'.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/AriaToolbarMixin.js#L14" }, "type": { "text": "\"horizontal\" | \"vertical\"" }, "inheritedFrom": { "name": "default", "module": "components/TopAppBar.js" } }, { "name": "kbdNavChildren", "kind": "field", "description": "List of roving tab index participating children", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/KeyboardNavMixin.js#L48" }, "type": { "text": "NodeListOf" }, "inheritedFrom": { "name": "default", "module": "components/TopAppBar.js" } }, { "name": "focusCurrentOrFirst", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/KeyboardNavMixin.js#L57" }, "type": { "text": "() => HTMLElement" } }, { "name": "focusNext", "kind": "field", "description": "Focuses next element participating in roving tab index list", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/KeyboardNavMixin.js#L78" }, "type": { "text": "(current?: HTMLElement, loop?: boolean, reverse?: boolean) => HTMLElement" } }, { "name": "focusPrevious", "kind": "field", "description": "Alias for focusNext(list, current, true).\nSelects previous element", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/KeyboardNavMixin.js#L133" }, "type": { "text": "(current?: HTMLElement, loop?: boolean) => HTMLElement" } }, { "name": "refreshTabIndexes", "kind": "field", "description": "Refreshes roving tab index attributes based on kbdNavChildren", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/KeyboardNavMixin.js#L156" }, "type": { "text": "() => void" } }, { "name": "disabled", "kind": "field", "description": "Whether the element is disabled (affects interactive states)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L14" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/TopAppBar.js" } }, { "name": "focused", "kind": "field", "description": "Force focus state (independent of document)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L16" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/TopAppBar.js" } }, { "name": "hovered", "kind": "field", "description": "Force hover state (independent of interaction)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L18" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/TopAppBar.js" } }, { "name": "pressed", "kind": "field", "description": "Force pressed state (independent of interaction)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L20" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/TopAppBar.js" } }, { "name": "stateLayer", "kind": "field", "description": "Show the visual state layer element when true", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L34" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/TopAppBar.js" } }, { "name": "disabledState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L37" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/TopAppBar.js" } }, { "name": "hoveredState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L38" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/TopAppBar.js" } }, { "name": "focusedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L39" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/TopAppBar.js" } }, { "name": "pressedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L40" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/TopAppBar.js" } }, { "name": "touchedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L41" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/TopAppBar.js" } }, { "name": "pointedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L44" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/TopAppBar.js" } }, { "name": "stateTargetElement", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L50" }, "type": { "text": "HTMLElement" }, "inheritedFrom": { "name": "default", "module": "components/TopAppBar.js" } }, { "name": "color", "kind": "field", "description": "Palette or surface token used to select background/ink tokens.\nExamples: 'primary', 'background', 'surface-container-low'.\nColor token name used for ink/background.\nVisual color token to apply to the search surface.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Search.js#L18" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/TopAppBar.js" } }, { "name": "ink", "kind": "field", "description": "Explicit ink override token (e.g. 'outline', 'on-primary', 'inverse-on-surface', 'inherit').\nMaps to `--mdw-ink`.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L57" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/TopAppBar.js" } }, { "name": "typeStyle", "kind": "field", "description": "Typographic style shortcut that maps to type scale variables\n(e.g. 'headline-large', 'body-medium').", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L62" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/TopAppBar.js" } }, { "name": "shapeTop", "kind": "field", "description": "Show top cut/shape on the element", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L9" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/TopAppBar.js" } }, { "name": "shapeBottom", "kind": "field", "description": "Show bottom cut/shape on the element", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L11" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/TopAppBar.js" } }, { "name": "shapeStart", "kind": "field", "description": "Show start-side cut/shape (logical start)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L13" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/TopAppBar.js" } }, { "name": "shapeEnd", "kind": "field", "description": "Show end-side cut/shape (logical end)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L15" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/TopAppBar.js" } }, { "name": "shapeStyle", "kind": "field", "description": "Predefined shape size/style name (none|extra-small|small|medium|large|extra-large|full|inherit)\nShape style token to apply (e.g. 'full', 'none').", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Search.js#L20" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/TopAppBar.js" } }, { "name": "outlined", "kind": "field", "description": "When true, an outline is rendered around the element", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L19" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/TopAppBar.js" } }, { "name": "placeholder", "kind": "field", "description": "Placeholder text shown in the search input.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Search.js#L16" }, "type": { "text": "string" } }, { "name": "input", "kind": "field", "description": "Returns the current text value of the internal input.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Search.js#L78" }, "type": { "text": "string" } }, { "name": "value", "kind": "field", "description": "The `value` accessor proxies the internal input's value.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Search.js#L30" }, "type": { "text": "string" } }, { "name": "onSlotChange", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Search.js#L71" }, "return": { "type": { "text": "({ currentTarget }: { currentTarget: HTMLSlotElement; }) => void" } } }, { "name": "prototype", "kind": "field", "static": true, "type": { "text": "CustomElement" }, "inheritedFrom": { "name": "default", "module": "components/TopAppBar.js" } }, { "name": "headline", "kind": "field", "description": "Headline text displayed in the center area.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/TopAppBar.js#L36" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/TopAppBar.js" } }, { "name": "size", "kind": "field", "description": "Size variant: 'small' | 'medium' | 'large' or `null` to auto-select.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/TopAppBar.js#L38" }, "type": { "text": "\"small\" | \"large\" | \"medium\"" }, "inheritedFrom": { "name": "default", "module": "components/TopAppBar.js" } }, { "name": "raisedColor", "kind": "field", "description": "Color token to use when the bar is raised.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/TopAppBar.js#L42" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/TopAppBar.js" } } ], "slots": [ { "name": "leading", "description": "" }, { "name": "trailing", "description": "" } ], "cssParts": [], "events": [ { "name": "slot-change", "type": { "text": "Event" } } ], "demos": [ { "url": "demo/components/search.html" } ], "superclass": { "module": "components/TopAppBar.js", "name": "default" }, "mixins": [], "description": "Search provides an app bar integrated search field for querying content.\nimplements {HTMLSelectElement}\n@see https://m3.material.io/components/search/overview" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "default", "module": "components/Search.js" } }, { "kind": "custom-element-definition", "name": "mdw-search", "declaration": { "name": "default", "module": "components/Search.js" } } ] }, { "kind": "javascript-module", "path": "components/SegmentedButton.js", "declarations": [ { "kind": "class", "name": "SegmentedButton", "tagName": "mdw-segmented-button", "customElement": true, "attributes": [ { "name": "color", "fieldName": "color", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "ink", "fieldName": "ink", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "type-style", "fieldName": "typeStyle", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "density", "fieldName": "density", "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "disabled", "fieldName": "disabled", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "focused", "fieldName": "focused", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "hovered", "fieldName": "hovered", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "pressed", "fieldName": "pressed", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "shape-top", "fieldName": "shapeTop", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "shape-bottom", "fieldName": "shapeBottom", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "shape-start", "fieldName": "shapeStart", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "shape-end", "fieldName": "shapeEnd", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "shape-style", "fieldName": "shapeStyle", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "aria-controls", "fieldName": "ariaControls", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "autocomplete", "fieldName": "autocomplete", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "name", "fieldName": "name", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "readonly", "fieldName": "readOnly", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "formnovalidate", "fieldName": "formNoValidate", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "checked", "fieldName": "defaultChecked", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "required", "fieldName": "required", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "type", "description": "Interaction model for the segment: 'radio' (single select) or 'checkbox' (multi-select).", "fieldName": "type", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "value", "fieldName": "_defaultValue", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "aria-label", "fieldName": "ariaLabel", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "accept", "fieldName": "accept", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "alt", "fieldName": "alt", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "dirname", "fieldName": "dirName", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "formenctype", "fieldName": "formEnctype", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "formmethod", "fieldName": "formMethod", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "formtarget", "fieldName": "formTarget", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "max", "fieldName": "max", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "maxlength", "fieldName": "maxLength", "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "min", "fieldName": "min", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "minlength", "fieldName": "minLength", "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "multiple", "fieldName": "multiple", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "pattern", "fieldName": "pattern", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "placeholder", "fieldName": "placeholder", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "size", "fieldName": "size", "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "src", "fieldName": "src", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "step", "fieldName": "step", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "indeterminate", "fieldName": "indeterminate", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "href", "fieldName": "href", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "target", "fieldName": "target", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "download", "fieldName": "download", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "ping", "fieldName": "ping", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "rel", "fieldName": "rel", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "hreflang", "fieldName": "hreflang", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "referrerpolicy", "fieldName": "referrerPolicy", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "elevated", "fieldName": "elevated", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "filled", "fieldName": "filled", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "icon", "fieldName": "icon", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "icon-ink", "fieldName": "iconInk", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "svg", "fieldName": "svg", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "view-box", "fieldName": "viewBox", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "svg-path", "fieldName": "svgPath", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "inner-segmented-button", "description": "When true this segment is rendered as an inner segment inside a segmented group.", "fieldName": "innerSegmentedButton", "type": { "text": "boolean" } }, { "name": "outlined", "description": "Whether the button should render an outline.", "fieldName": "outlined", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "state-layer", "type": { "text": "boolean" }, "description": "Show the visual state layer element when true", "fieldName": "stateLayer", "inheritedFrom": { "name": "default", "module": "components/Button.js" } } ], "members": [ { "name": "delegatesFocus", "kind": "field", "description": "When true, the element delegates focus to an internal focus target.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/DelegatesFocusMixin.js#L15" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "href", "kind": "field", "description": "The URL that the hyperlink points to.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L34" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "target", "kind": "field", "description": "The browsing context in which to open the linked resource (e.g. '_blank').", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L36" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "download", "kind": "field", "description": "Suggested filename for download.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L38" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "ping", "kind": "field", "description": "URLs to be pinged when the link is followed.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L40" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "rel", "kind": "field", "description": "Link relationship tokens (e.g. 'noopener', 'noreferrer').", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L42" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "hreflang", "kind": "field", "description": "Language of the linked resource.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L44" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "referrerPolicy", "kind": "field", "description": "Referrer policy for the link (serialized to 'referrerpolicy' attribute).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L46" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "origin", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L49" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "protocol", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L50" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "username", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L51" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "password", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L52" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "host", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L53" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "hostname", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L54" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "port", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L55" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "pathname", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L56" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "search", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L57" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "hash", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L58" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "disabled", "kind": "field", "description": "Whether the element is disabled (affects interactive states)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L14" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "focused", "kind": "field", "description": "Force focus state (independent of document)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L16" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "hovered", "kind": "field", "description": "Force hover state (independent of interaction)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L18" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "pressed", "kind": "field", "description": "Force pressed state (independent of interaction)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L20" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "disabledState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L171" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "hoveredState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L38" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "focusedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L39" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "pressedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L40" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "touchedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L41" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "pointedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L44" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "ariaControls", "kind": "field", "description": "ARIA 'controls' attribute (string).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L32" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "autocomplete", "kind": "field", "description": "Autocomplete token for the associated control (string).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L34" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "name", "kind": "field", "description": "Name attribute for the control used in forms.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L36" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "readOnly", "kind": "field", "description": "Read-only state reflected to control via 'readonly' attribute.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L38" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "formNoValidate", "kind": "field", "description": "When true, form validation is skipped for this control (formnovalidate).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L40" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "defaultChecked", "kind": "field", "description": "Default checked state for checkable controls (checkbox/radio).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L42" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "required", "kind": "field", "description": "Whether the control is required for form submission.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L47" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "type", "kind": "field", "description": "Control type token (e.g. 'text','checkbox','radio','file').\nThe underlying control `type` (button, submit, reset, file).\nInteraction model for the segment: 'radio' (single select) or 'checkbox' (multi-select).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/SegmentedButton.js#L15" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "erroredState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L65" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "defaultValue", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L66" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "value", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L108" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "checked", "kind": "field", "description": "Part of FormAssociatedMixin for simplicity.\nEnumerability doesn't guarantee checked state will be passed or used.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L145" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "form", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L160" }, "type": { "text": "HTMLFormElement" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "validity", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L161" }, "type": { "text": "ValidityState" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "validationMessage", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L162" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "willValidate", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L163" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "labels", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L168" }, "type": { "text": "NodeList" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "checkValidity", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ControlMixin.js#L69" }, "type": { "text": "(() => boolean) & (() => boolean)" } }, { "name": "reportValidity", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ControlMixin.js#L87" }, "type": { "text": "(() => boolean) & (() => boolean)" } }, { "name": "setCustomValidity", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ControlMixin.js#L96" }, "type": { "text": "((error: string) => void) & ((error: string) => void)" } }, { "name": "refreshFormAssociation", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L203" }, "type": { "text": "() => void" } }, { "name": "formAssociatedCallback", "kind": "field", "description": "New lifecycle callback. This is called when association with\n is changed.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L225" }, "type": { "text": "(form: HTMLFormElement) => void" } }, { "name": "formIPCEvent", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L234" }, "type": { "text": "(event: CustomEvent<[string, string]>) => void" } }, { "name": "formDisabledCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L254" }, "type": { "text": "(disabled: boolean) => void" } }, { "name": "formResetCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L258" }, "type": { "text": "() => void" } }, { "name": "formStateRestoreCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L270" }, "type": { "text": "(state: string | FormData, mode: \"autocomplete\" | \"restore\") => void" } }, { "name": "focusableOnDisabled", "kind": "field", "description": "Allow the control to receive focus even when disabled.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/SegmentedButton.js#L23" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "controlTagName", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L102" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "controlVoidElement", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ControlMixin.js#L32" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "onValueChangingContentAttribute", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ControlMixin.js#L43" }, "type": { "text": "() => void" } }, { "name": "accept", "kind": "field", "description": "Accepted file types for file input (e.g. '.png,.jpg').", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L41" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "alt", "kind": "field", "description": "Alternate text for images (for `type='image'`).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L43" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "dirName", "kind": "field", "description": "Directionality for form submission name (dirname attribute).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L45" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "formEnctype", "kind": "field", "description": "Form encoding type (formenctype).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L49" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "formMethod", "kind": "field", "description": "Form method when associated with a submit input (formmethod).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L51" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "formTarget", "kind": "field", "description": "Target browsing context for form submission (formtarget).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L53" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "max", "kind": "field", "description": "Max value or token for the input.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L58" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "maxLength", "kind": "field", "description": "Maximum length for text-like inputs.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L60" }, "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "min", "kind": "field", "description": "Min value or token for the input.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L62" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "minLength", "kind": "field", "description": "Minimum length for text-like inputs.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L64" }, "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "multiple", "kind": "field", "description": "When true, multiple values are allowed (e.g. file inputs).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L66" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "pattern", "kind": "field", "description": "Pattern used for validation (RegExp as string).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L68" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "placeholder", "kind": "field", "description": "Placeholder text shown when no value is present.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L70" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "size", "kind": "field", "description": "Suggested control size (number of characters).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L72" }, "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "step", "kind": "field", "description": "Step interval for numeric inputs.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L76" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "indeterminate", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L89" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "performImplicitSubmission", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L175" }, "type": { "text": "(event: Event) => void" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "setRangeText", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L345" }, "type": { "text": "{ (replacement: string): void; (replacement: string, start: number, end: number, selectionMode?: SelectionMode): void; }" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "setSelectionRange", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L348" }, "type": { "text": "(start: number, end: number, direction?: \"none\" | \"forward\" | \"backward\") => void" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "showPicker", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L351" }, "type": { "text": "() => void" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "stepDown", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L354" }, "type": { "text": "(n?: number) => void" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "stepUp", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L360" }, "type": { "text": "(n?: number) => void" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "select", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L366" }, "type": { "text": "() => void" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "files", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L371" }, "type": { "text": "FileList" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "selectionDirection", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L384" }, "type": { "text": "\"none\" | \"forward\" | \"backward\"" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "selectionEnd", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L389" }, "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "selectionStart", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L394" }, "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "valueAsDate", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L399" }, "type": { "text": "Date" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "valueAsNumber", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L407" }, "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "height", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L415" }, "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "formAction", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L423" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "width", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L431" }, "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "addRipple", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/RippleMixin.js#L37" }, "type": { "text": "(x?: number, y?: number, hold?: boolean) => CustomElement & { hadRippleHeld: boolean; hadRippleReleased: boolean; rippleStarted: boolean; } & { rippleState: string; keepAlive: boolean; _positionX: number; _positionY: number; _radius: number; holdRipple: boolean; } & { _positionStyle: ElementStylerOptions | { styles: { minHeight: string; minWidth: string; boxShadow: string; top: string; left: string; }; }; } & { updatePosition(x?: number, y?: number, size?: number): void; handleRippleComplete(): void; }" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "color", "kind": "field", "description": "Palette or surface token used to select background/ink tokens.\nExamples: 'primary', 'background', 'surface-container-low'.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L52" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "ink", "kind": "field", "description": "Explicit ink override token (e.g. 'outline', 'on-primary', 'inverse-on-surface', 'inherit').\nMaps to `--mdw-ink`.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L57" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "typeStyle", "kind": "field", "description": "Typographic style shortcut that maps to type scale variables\n(e.g. 'headline-large', 'body-medium').", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L62" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "shapeTop", "kind": "field", "description": "Show top cut/shape on the element", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L9" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "shapeBottom", "kind": "field", "description": "Show bottom cut/shape on the element", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L11" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "shapeStart", "kind": "field", "description": "Show start-side cut/shape (logical start)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L13" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "shapeEnd", "kind": "field", "description": "Show end-side cut/shape (logical end)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L15" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "shapeStyle", "kind": "field", "description": "Predefined shape size/style name (none|extra-small|small|medium|large|extra-large|full|inherit)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L17" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "outlined", "kind": "field", "description": "When true, an outline is rendered around the element\nWhether the button should render an outline.\nRender the button with an outline style.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/SegmentedButton.js#L21" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "density", "kind": "field", "description": "Density level affecting spacing and compactness. Integer from -4 (dense) to 4 (spacious).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/DensityMixin.js#L9" }, "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "innerSegmentedButton", "kind": "field", "description": "When true this segment is rendered as an inner segment inside a segmented group.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/SegmentedButton.js#L17" }, "type": { "text": "boolean" } }, { "name": "prototype", "kind": "field", "static": true, "type": { "text": "CustomElement" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "stateLayer", "kind": "field", "description": "Show the visual state layer element when true", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Button.js#L37" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "stateTargetElement", "kind": "field", "description": "Returns the element used as the state target for visual states\n(e.g., pressed/hover). Typically the internal control element.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Button.js#L34" }, "type": { "text": "HTMLElement" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "src", "kind": "field", "description": "Source URL for image-type inputs.\nImage source URL for an icon.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Button.js#L69" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "elevated", "kind": "field", "description": "Bound to [elevated] specifying whether the element should be elevated.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Button.js#L58" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "filled", "kind": "field", "description": "Visual filled variant; may be \"tonal\" or boolean-filled token.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Button.js#L60" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "icon", "kind": "field", "description": "Icon name (uses internal `mdw-icon` when set).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Button.js#L64" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "iconInk", "kind": "field", "description": "Ink color override for the icon.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Button.js#L66" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "svg", "kind": "field", "description": "Inline SVG markup to render as icon.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Button.js#L71" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "viewBox", "kind": "field", "description": "SVG `viewBox` attribute for inline SVG icons.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Button.js#L73" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "svgPath", "kind": "field", "description": "Path data for an inline SVG icon.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Button.js#L75" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "hasIcon", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Button.js#L78" }, "return": { "type": { "text": "() => string" } }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "iconVariation", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Button.js#L81" }, "return": { "type": { "text": "() => string" } }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "compose", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L145" }, "type": { "text": "(parts: CompositionPart[]) => Composition" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "#refsProxy", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1145" }, "type": { "text": "Record" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "#refsCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1148" }, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "#refsCompositionCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1151" }, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "#composition", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1154" }, "type": { "text": "Composition" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "#patching", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1156" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "#pendingPatchRenders", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1159" }, "type": { "text": "[string, any, CustomElement][]" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "#propAttributeCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1162" }, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "#callbackArguments", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1165" }, "type": { "text": "CallbackArguments" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "elementInternals", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1172" }, "type": { "text": "ElementInternals" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "render", "kind": "field", "description": "Updates nodes based on data\nExpects data in JSON Merge Patch format", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1185" }, "type": { "text": "RenderDraw" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "propChangedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1213" }, "type": { "text": "(this: T, name: K, oldValue: K extends keyof T ? T[K] : unknown, newValue: K extends keyof T ? T[K] : unknown, changes?: K extends keyof T ? T[K] extends object ? Partial : T[K] : unknown) => void" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "attributeChangedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1234" }, "type": { "text": "(name: string, oldValue: string, newValue: string) => void" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "#template", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1284" }, "type": { "text": "DocumentFragment" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "#onObserverPropertyChanged", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1294" }, "type": { "text": "(name: string, oldValue: any, newValue: any, changes: any) => void" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "static", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1330" }, "type": { "text": "typeof CustomElement" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "patch", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1333" }, "type": { "text": "(patch: any) => void" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "refs", "kind": "field", "description": "Proxy object that returns shadow DOM elements by tag.\nIf called before interpolation (eg: on composed), returns from template", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1404" }, "type": { "text": "Record" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "attributeCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1391" }, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "callbackArguments", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1400" }, "type": { "text": "CallbackArguments | { composition: Composition; refs: Record; html: any; inline: (fn: (data: Partial) => any) => string; template: DocumentFragment; element: T; }" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "composition", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1403" }, "type": { "text": "Composition" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "connectedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1435" }, "type": { "text": "() => void" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "disconnectedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1441" }, "type": { "text": "() => void" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "elementName", "kind": "field", "static": true, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "observedAttributes", "kind": "field", "static": true, "type": { "text": "Iterable" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "interpolatesTemplate", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "supportsElementInternals", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "supportsElementInternalsRole", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "defined", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "registrations", "kind": "field", "static": true, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "expressions", "kind": "method", "static": true, "description": "Expressions are idempotent functions that are selectively called whenever\na render is requested.\nExpressions are constructed exactly as methods though differ in expected\narguments. The first argument should be destructured to ensure each used\nproperty is accessed at least once in order to inspect used properties.\n\nThe Composition API will inspect this function with a proxy for `this` to\ncatalog what observables are used by the expression. This allows the\nComposition API to build a cache as well as selective invoke the expression\nonly when needed.\n\nWhen used with in element templates, the element itself will be passed as\nits first argument.\n````js\n Button\n .prop('filled', 'boolean')\n .prop('outlined', 'boolean')\n .expresssions({\n _isFilledOrOutlined({filled, outlined}) {\n return (filled || outlined)\n },\n })\n .html`
`;\n````\n\nWhen used with external data source, that data source\nwill be passed to the expression with all properties being `null` at first\ninspection.\n````js\n const externalData = {first: 'John', last: 'Doe'};\n ContactCard\n .expresssions({\n _fullName({first, last}) {\n return [first, last].filter(Boolean).join(' ');\n },\n })\n myButton.render(externalData);\n````\n\nExpressions may be support argumentless calls by using default\nparameters with `this`.\n````js\n Button\n .expresssions({\n isFilledOrOutlined({filled, outlined} = this) {\n return (filled || outlined)\n },\n });\n myButton.isFilledorOutlined();\n````", "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends { [K in keyof any]: K extends `_${any}` ? ((data: INSTANCE, state?: Record) => string | boolean | null) : ((data?: INSTANCE, state?: Record) => string | boolean | null); } & ThisType>(this: CLASS, expressions: PROPS & ThisType) => CLASS & Class<{ [K in keyof PROPS]: K extends `_${any}` ? never : () => ReturnType; }, ARGS>" } }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "methods", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "overrides", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends Partial>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "props", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "idl", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "append", "kind": "field", "static": true, "description": "Append parts to composition", "type": { "text": "(this: T, ...parts: CompositionPart[]) => T" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "recompose", "kind": "field", "static": true, "description": "After composition, invokes callback.\nMay be called multiple times.", "type": { "text": ", T3 extends CompositionCallback[\"composed\"]>(this: T1, callback: T3) => T1" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "css", "kind": "field", "static": true, "description": "Appends styles to composition", "type": { "text": "(this: T1, array: T2, ...rest: T2 extends string ? any : T2 extends TemplateStringsArray ? any[] : (HTMLStyleElement | CSSStyleSheet)[]) => T1" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "autoRegister", "kind": "field", "static": true, "description": "Registers class with customElements. If class is registered before then,\ndoes nothing.", "type": { "text": "(this: T, elementName: string) => T" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "html", "kind": "field", "static": true, "description": "Appends DocumentFragment to composition", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1405" }, "type": { "text": "(this: T, string: TemplateStringsArray, ...substitutions: (string | Element | ((this: InstanceType, data: InstanceType, injections?: any) => any))[]) => T" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "extend", "kind": "field", "static": true, "description": "Extends base class into a new class.\nUse to avoid mutating base class.", "type": { "text": " T2>(this: T1, customExtender?: T3) => T3 extends null ? T1 : T2" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "setStatic", "kind": "field", "static": true, "description": "Assigns static values to class", "type": { "text": " any) | string | number | boolean | any[] | object); }>(this: T1, source: T2 & ThisType) => T1 & T2" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "readonly", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "set", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "mixin", "kind": "field", "static": true, "description": "Returns result of calling mixin with current class", "type": { "text": " any, RETURN extends ReturnType, SUBCLASS extends ClassOf>(this: BASE, mixin: FN) => SUBCLASS & BASE" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "register", "kind": "field", "static": true, "description": "Registers class with window.customElements synchronously", "type": { "text": "(this: T, elementName?: string, force?: boolean) => T" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "propList", "kind": "field", "static": true, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "attrList", "kind": "field", "static": true, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "propChangedCallbacks", "kind": "field", "static": true, "type": { "text": "Map any)[]>" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "attributeChangedCallbacks", "kind": "field", "static": true, "type": { "text": "Map any)[]>" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "prop", "kind": "field", "static": true, "description": "Creates observable property on instances (via prototype)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1007" }, "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "setPrototype", "kind": "field", "static": true, "description": "Creates observable property on instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any)>(this: CLASS, name: KEY, options: OPTIONS) => OPTIONS extends (...args2: any[]) => infer R ? R : OPTIONS extends ObserverPropertyType ? ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? unknown extends R ? object : R : OPTIONS extends { type: ObserverPropertyType; } ? ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? unknown extends R ? string : R : never" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "define", "kind": "field", "static": true, "description": "Define properties on instances via Object.defineProperties().\nAutomatically sets property non-enumerable if name begins with `_`.\nFunctions will be remapped as getters", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends { [P in keyof any]: { enumerable?: boolean; configurable?: boolean; writable?: boolean; value?: any; get?: ((this: INSTANCE) => any); set?: (this: INSTANCE, value: any) => void; } | ((this: INSTANCE, ...args: any[]) => any); }, VALUE extends { [KEY in keyof PROPS]: PROPS[KEY] extends (...args2: any[]) => infer R ? R : PROPS[KEY] extends TypedPropertyDescriptor ? R : never; }>(this: CLASS, props: PROPS & ThisType) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "undefine", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROP extends string, PROPS extends INSTANCE & Record>(this: CLASS, name: PROP) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "observe", "kind": "field", "static": true, "description": "Creates observable properties on instances", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends IDLParameter, VALUE extends { [KEY in keyof PROPS]: PROPS[KEY] extends (...args2: any[]) => infer R ? R : PROPS[KEY] extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : PROPS[KEY] extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : PROPS[KEY] extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : PROPS[KEY] extends ObserverOptions ? (unknown extends R ? string : R) : never; }>(this: CLASS, props: PROPS) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "defineStatic", "kind": "field", "static": true, "type": { "text": ">(this: T1, props: T2) => T1 & ParsedProps" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "events", "kind": "field", "static": true, "type": { "text": "(this: T, listeners?: CompositionEventListenerObject>, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "childEvents", "kind": "field", "static": true, "type": { "text": "(this: T, listenerMap: { [x: string]: CompositionEventListenerObject>; }, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "rootEvents", "kind": "field", "static": true, "type": { "text": "(this: T, listeners?: CompositionEventListenerObject>, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "on", "kind": "field", "static": true, "type": { "text": ", T3 extends CompositionCallback, T4 extends keyof T3>(this: T1, name: T3 | T4, callbacks?: T3[T4] & ThisType) => T1" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "off", "kind": "field", "static": true, "type": { "text": ", T3 extends CompositionCallback, T4 extends keyof T3>(this: T1, name: T3 | T4, callbacks?: T3[T4] & ThisType) => T1" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "offPropChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: ObjectOrObjectEntries<{ [P in keyof T2]?: (this: T2, oldValue: T2[P], newValue: T2[P], changes: any, element: T2) => void; }>) => T1" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "offAttributeChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: { [x: string]: (this: T2, oldValue: string, newValue: string, element: T2) => void; }) => T1" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "onPropChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: ObjectOrObjectEntries<{ [P in keyof T2]?: (this: T2, oldValue: T2[P], newValue: T2[P], changes: any, element: T2) => void; }>) => T1" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } }, { "name": "onAttributeChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: { [x: string]: (this: T2, oldValue: string, newValue: string, element: T2) => void; }) => T1" }, "inheritedFrom": { "name": "default", "module": "components/Button.js" } } ], "slots": [ { "name": "", "description": "{_defaultValue}" } ], "cssParts": [ { "name": "control" } ], "events": [ { "name": "value-changing-content-attribute", "type": { "text": "Event" } } ], "demos": [], "superclass": { "module": "components/Button.js", "name": "default" }, "mixins": [], "description": "Segmented buttons group individual related actions or options where\nmultiple choices are presented inline; each segment acts like a toggle\nor option within a set.\n@see https://m3.material.io/components/segmented-buttons/specs" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "default", "module": "components/SegmentedButton.js" } }, { "kind": "custom-element-definition", "name": "mdw-segmented-button", "declaration": { "name": "default", "module": "components/SegmentedButton.js" } } ] }, { "kind": "javascript-module", "path": "components/SegmentedButtonGroup.js", "declarations": [ { "kind": "class", "name": "SegmentedButtonGroup", "tagName": "mdw-segmented-button-group", "customElement": true, "attributes": [ { "name": "color", "fieldName": "color", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "ink", "fieldName": "ink", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "type-style", "fieldName": "typeStyle", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "block", "fieldName": "block", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "inline", "fieldName": "inline", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "row", "fieldName": "row", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "x", "fieldName": "x", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "y", "fieldName": "y", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "gap", "fieldName": "gap", "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "padding", "fieldName": "padding", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "kbd-nav", "fieldName": "kbdNav", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/KeyboardNavMixin.js" } } ], "members": [ { "name": "kbdNav", "kind": "field", "description": "Enable keyboard roving navigation when present (set to 'true').", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/KeyboardNavMixin.js#L23" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/KeyboardNavMixin.js" } }, { "name": "kbdNavQuery", "kind": "field", "description": "Query used to find roving tab index children", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/SegmentedButtonGroup.js#L17" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/KeyboardNavMixin.js" } }, { "name": "kbdNavFocusableWhenDisabled", "kind": "field", "description": "Flag whether disabled elements participating in roving tab index\nshould be focusable.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/KeyboardNavMixin.js#L39" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/KeyboardNavMixin.js" } }, { "name": "ariaOrientationDefault", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/KeyboardNavMixin.js#L41" }, "type": { "text": "\"horizontal\" | \"vertical\"" }, "inheritedFrom": { "name": "default", "module": "mixins/KeyboardNavMixin.js" } }, { "name": "kbdNavChildren", "kind": "field", "description": "List of roving tab index participating children", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/KeyboardNavMixin.js#L48" }, "type": { "text": "NodeListOf" }, "inheritedFrom": { "name": "default", "module": "mixins/KeyboardNavMixin.js" } }, { "name": "block", "kind": "field", "description": "Set `display: block` on the host (boolean)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js#L9" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "inline", "kind": "field", "description": "Use inline flex layout: `display: inline-flex` (boolean)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js#L11" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "row", "kind": "field", "description": "Switch main axis to horizontal: `flex-direction: row` (boolean)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js#L13" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "x", "kind": "field", "description": "Main-axis alignment / justification.\nAllowed: 'start'|'center'|'end'|'between'|'around'|'stretch'|'baseline'.\nDefault: 'start'.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js#L19" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "y", "kind": "field", "description": "Cross-axis alignment / alignment of items.\nSame allowed values as `x`. Default: 'start'.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js#L29" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "gap", "kind": "field", "description": "Gap between children. Accepts preset numeric strings (e.g. '8') mapped to px, or floats.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js#L36" }, "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "padding", "kind": "field", "description": "Padding preset or numeric value (e.g. 'pane', '8', '16').", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js#L38" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "color", "kind": "field", "description": "Palette or surface token used to select background/ink tokens.\nExamples: 'primary', 'background', 'surface-container-low'.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L52" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "ink", "kind": "field", "description": "Explicit ink override token (e.g. 'outline', 'on-primary', 'inverse-on-surface', 'inherit').\nMaps to `--mdw-ink`.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L57" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "typeStyle", "kind": "field", "description": "Typographic style shortcut that maps to type scale variables\n(e.g. 'headline-large', 'body-medium').", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L62" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "prototype", "kind": "field", "static": true, "type": { "text": "CustomElement" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "focusCurrentOrFirst", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/KeyboardNavMixin.js#L57" }, "return": { "type": { "text": "() => HTMLElement" } }, "inheritedFrom": { "name": "default", "module": "mixins/KeyboardNavMixin.js" } }, { "name": "focusNext", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/KeyboardNavMixin.js#L78" }, "return": { "type": { "text": "(current?: HTMLElement, loop?: boolean, reverse?: boolean) => HTMLElement" } }, "inheritedFrom": { "name": "default", "module": "mixins/KeyboardNavMixin.js" } }, { "name": "focusPrevious", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/KeyboardNavMixin.js#L133" }, "return": { "type": { "text": "(current?: HTMLElement, loop?: boolean) => HTMLElement" } }, "inheritedFrom": { "name": "default", "module": "mixins/KeyboardNavMixin.js" } }, { "name": "refreshTabIndexes", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/KeyboardNavMixin.js#L156" }, "return": { "type": { "text": "() => void" } }, "inheritedFrom": { "name": "default", "module": "mixins/KeyboardNavMixin.js" } }, { "name": "compose", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L145" }, "type": { "text": "(parts: CompositionPart[]) => Composition" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "#refsProxy", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1145" }, "type": { "text": "Record" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "#refsCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1148" }, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "#refsCompositionCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1151" }, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "#composition", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1154" }, "type": { "text": "Composition" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "#patching", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1156" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "#pendingPatchRenders", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1159" }, "type": { "text": "[string, any, CustomElement][]" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "#propAttributeCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1162" }, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "#callbackArguments", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1165" }, "type": { "text": "CallbackArguments" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "elementInternals", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1172" }, "type": { "text": "ElementInternals" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "render", "kind": "field", "description": "Updates nodes based on data\nExpects data in JSON Merge Patch format", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1185" }, "type": { "text": "RenderDraw" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "propChangedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1213" }, "type": { "text": "(this: T, name: K, oldValue: K extends keyof T ? T[K] : unknown, newValue: K extends keyof T ? T[K] : unknown, changes?: K extends keyof T ? T[K] extends object ? Partial : T[K] : unknown) => void" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "attributeChangedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1234" }, "type": { "text": "(name: string, oldValue: string, newValue: string) => void" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "#template", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1284" }, "type": { "text": "DocumentFragment" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "#onObserverPropertyChanged", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1294" }, "type": { "text": "(name: string, oldValue: any, newValue: any, changes: any) => void" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "static", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1330" }, "type": { "text": "typeof CustomElement" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "patch", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1333" }, "type": { "text": "(patch: any) => void" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "refs", "kind": "field", "description": "Proxy object that returns shadow DOM elements by tag.\nIf called before interpolation (eg: on composed), returns from template", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1404" }, "type": { "text": "Record" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "attributeCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1391" }, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "callbackArguments", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1400" }, "type": { "text": "CallbackArguments | { composition: Composition; refs: Record; html: any; inline: (fn: (data: Partial) => any) => string; template: DocumentFragment; element: T; }" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "composition", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1403" }, "type": { "text": "Composition" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "connectedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1435" }, "type": { "text": "() => void" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "disconnectedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1441" }, "type": { "text": "() => void" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "delegatesFocus", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1175" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "elementName", "kind": "field", "static": true, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "observedAttributes", "kind": "field", "static": true, "type": { "text": "Iterable" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "interpolatesTemplate", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "supportsElementInternals", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "supportsElementInternalsRole", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "defined", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "registrations", "kind": "field", "static": true, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "expressions", "kind": "method", "static": true, "description": "Expressions are idempotent functions that are selectively called whenever\na render is requested.\nExpressions are constructed exactly as methods though differ in expected\narguments. The first argument should be destructured to ensure each used\nproperty is accessed at least once in order to inspect used properties.\n\nThe Composition API will inspect this function with a proxy for `this` to\ncatalog what observables are used by the expression. This allows the\nComposition API to build a cache as well as selective invoke the expression\nonly when needed.\n\nWhen used with in element templates, the element itself will be passed as\nits first argument.\n````js\n Button\n .prop('filled', 'boolean')\n .prop('outlined', 'boolean')\n .expresssions({\n _isFilledOrOutlined({filled, outlined}) {\n return (filled || outlined)\n },\n })\n .html`
`;\n````\n\nWhen used with external data source, that data source\nwill be passed to the expression with all properties being `null` at first\ninspection.\n````js\n const externalData = {first: 'John', last: 'Doe'};\n ContactCard\n .expresssions({\n _fullName({first, last}) {\n return [first, last].filter(Boolean).join(' ');\n },\n })\n myButton.render(externalData);\n````\n\nExpressions may be support argumentless calls by using default\nparameters with `this`.\n````js\n Button\n .expresssions({\n isFilledOrOutlined({filled, outlined} = this) {\n return (filled || outlined)\n },\n });\n myButton.isFilledorOutlined();\n````", "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends { [K in keyof any]: K extends `_${any}` ? ((data: INSTANCE, state?: Record) => string | boolean | null) : ((data?: INSTANCE, state?: Record) => string | boolean | null); } & ThisType>(this: CLASS, expressions: PROPS & ThisType) => CLASS & Class<{ [K in keyof PROPS]: K extends `_${any}` ? never : () => ReturnType; }, ARGS>" } }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "methods", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "overrides", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends Partial>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "props", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "idl", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "append", "kind": "field", "static": true, "description": "Append parts to composition", "type": { "text": "(this: T, ...parts: CompositionPart[]) => T" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "recompose", "kind": "field", "static": true, "description": "After composition, invokes callback.\nMay be called multiple times.", "type": { "text": ", T3 extends CompositionCallback[\"composed\"]>(this: T1, callback: T3) => T1" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "css", "kind": "field", "static": true, "description": "Appends styles to composition", "type": { "text": "(this: T1, array: T2, ...rest: T2 extends string ? any : T2 extends TemplateStringsArray ? any[] : (HTMLStyleElement | CSSStyleSheet)[]) => T1" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "autoRegister", "kind": "field", "static": true, "description": "Registers class with customElements. If class is registered before then,\ndoes nothing.", "type": { "text": "(this: T, elementName: string) => T" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "html", "kind": "field", "static": true, "description": "Appends DocumentFragment to composition", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1405" }, "type": { "text": "(this: T, string: TemplateStringsArray, ...substitutions: (string | Element | ((this: InstanceType, data: InstanceType, injections?: any) => any))[]) => T" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "extend", "kind": "field", "static": true, "description": "Extends base class into a new class.\nUse to avoid mutating base class.", "type": { "text": " T2>(this: T1, customExtender?: T3) => T3 extends null ? T1 : T2" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "setStatic", "kind": "field", "static": true, "description": "Assigns static values to class", "type": { "text": " any) | string | number | boolean | any[] | object); }>(this: T1, source: T2 & ThisType) => T1 & T2" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "readonly", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "set", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "mixin", "kind": "field", "static": true, "description": "Returns result of calling mixin with current class", "type": { "text": " any, RETURN extends ReturnType, SUBCLASS extends ClassOf>(this: BASE, mixin: FN) => SUBCLASS & BASE" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "register", "kind": "field", "static": true, "description": "Registers class with window.customElements synchronously", "type": { "text": "(this: T, elementName?: string, force?: boolean) => T" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "propList", "kind": "field", "static": true, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "attrList", "kind": "field", "static": true, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "propChangedCallbacks", "kind": "field", "static": true, "type": { "text": "Map any)[]>" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "attributeChangedCallbacks", "kind": "field", "static": true, "type": { "text": "Map any)[]>" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "prop", "kind": "field", "static": true, "description": "Creates observable property on instances (via prototype)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1007" }, "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "setPrototype", "kind": "field", "static": true, "description": "Creates observable property on instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any)>(this: CLASS, name: KEY, options: OPTIONS) => OPTIONS extends (...args2: any[]) => infer R ? R : OPTIONS extends ObserverPropertyType ? ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? unknown extends R ? object : R : OPTIONS extends { type: ObserverPropertyType; } ? ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? unknown extends R ? string : R : never" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "define", "kind": "field", "static": true, "description": "Define properties on instances via Object.defineProperties().\nAutomatically sets property non-enumerable if name begins with `_`.\nFunctions will be remapped as getters", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends { [P in keyof any]: { enumerable?: boolean; configurable?: boolean; writable?: boolean; value?: any; get?: ((this: INSTANCE) => any); set?: (this: INSTANCE, value: any) => void; } | ((this: INSTANCE, ...args: any[]) => any); }, VALUE extends { [KEY in keyof PROPS]: PROPS[KEY] extends (...args2: any[]) => infer R ? R : PROPS[KEY] extends TypedPropertyDescriptor ? R : never; }>(this: CLASS, props: PROPS & ThisType) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "undefine", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROP extends string, PROPS extends INSTANCE & Record>(this: CLASS, name: PROP) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "observe", "kind": "field", "static": true, "description": "Creates observable properties on instances", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends IDLParameter, VALUE extends { [KEY in keyof PROPS]: PROPS[KEY] extends (...args2: any[]) => infer R ? R : PROPS[KEY] extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : PROPS[KEY] extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : PROPS[KEY] extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : PROPS[KEY] extends ObserverOptions ? (unknown extends R ? string : R) : never; }>(this: CLASS, props: PROPS) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "defineStatic", "kind": "field", "static": true, "type": { "text": ">(this: T1, props: T2) => T1 & ParsedProps" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "events", "kind": "field", "static": true, "type": { "text": "(this: T, listeners?: CompositionEventListenerObject>, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "childEvents", "kind": "field", "static": true, "type": { "text": "(this: T, listenerMap: { [x: string]: CompositionEventListenerObject>; }, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "rootEvents", "kind": "field", "static": true, "type": { "text": "(this: T, listeners?: CompositionEventListenerObject>, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "on", "kind": "field", "static": true, "type": { "text": ", T3 extends CompositionCallback, T4 extends keyof T3>(this: T1, name: T3 | T4, callbacks?: T3[T4] & ThisType) => T1" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "off", "kind": "field", "static": true, "type": { "text": ", T3 extends CompositionCallback, T4 extends keyof T3>(this: T1, name: T3 | T4, callbacks?: T3[T4] & ThisType) => T1" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "offPropChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: ObjectOrObjectEntries<{ [P in keyof T2]?: (this: T2, oldValue: T2[P], newValue: T2[P], changes: any, element: T2) => void; }>) => T1" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "offAttributeChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: { [x: string]: (this: T2, oldValue: string, newValue: string, element: T2) => void; }) => T1" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "onPropChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: ObjectOrObjectEntries<{ [P in keyof T2]?: (this: T2, oldValue: T2[P], newValue: T2[P], changes: any, element: T2) => void; }>) => T1" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "onAttributeChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: { [x: string]: (this: T2, oldValue: string, newValue: string, element: T2) => void; }) => T1" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } } ], "slots": [ { "name": "", "description": "" } ], "cssParts": [], "events": [], "demos": [], "superclass": { "module": "components/Box.js", "name": "default" }, "mixins": [ { "module": "mixins/KeyboardNavMixin.js", "name": "default" } ], "description": "@typedef {'compact'} DeprecatedHTMLMenuElementProperties" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "default", "module": "components/SegmentedButtonGroup.js" } }, { "kind": "custom-element-definition", "name": "mdw-segmented-button-group", "declaration": { "name": "default", "module": "components/SegmentedButtonGroup.js" } } ] }, { "kind": "javascript-module", "path": "components/Select.js", "declarations": [ { "kind": "class", "name": "Select", "tagName": "mdw-select", "customElement": true, "attributes": [ { "name": "color", "fieldName": "color", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "ink", "fieldName": "ink", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "type-style", "fieldName": "typeStyle", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "disabled", "fieldName": "disabled", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "focused", "fieldName": "focused", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "hovered", "fieldName": "hovered", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "pressed", "fieldName": "pressed", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "aria-controls", "fieldName": "ariaControls", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ControlMixin.js" } }, { "name": "autocomplete", "fieldName": "autocomplete", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ControlMixin.js" } }, { "name": "name", "fieldName": "name", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ControlMixin.js" } }, { "name": "readonly", "fieldName": "readOnly", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ControlMixin.js" } }, { "name": "formnovalidate", "fieldName": "formNoValidate", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ControlMixin.js" } }, { "name": "checked", "fieldName": "defaultChecked", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ControlMixin.js" } }, { "name": "required", "fieldName": "required", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ControlMixin.js" } }, { "name": "value", "fieldName": "_defaultValue", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ControlMixin.js" } }, { "name": "aria-label", "fieldName": "ariaLabel", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ControlMixin.js" } }, { "name": "density", "fieldName": "density", "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "mixins/TextFieldMixin.js" } }, { "name": "shape-top", "fieldName": "shapeTop", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/TextFieldMixin.js" } }, { "name": "shape-bottom", "fieldName": "shapeBottom", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/TextFieldMixin.js" } }, { "name": "shape-start", "fieldName": "shapeStart", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/TextFieldMixin.js" } }, { "name": "shape-end", "fieldName": "shapeEnd", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/TextFieldMixin.js" } }, { "name": "shape-style", "fieldName": "shapeStyle", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/TextFieldMixin.js" } }, { "name": "outlined", "fieldName": "outlined", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/TextFieldMixin.js" } }, { "name": "icon", "fieldName": "icon", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/TextFieldMixin.js" } }, { "name": "icon-variation", "fieldName": "iconVariation", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/TextFieldMixin.js" } }, { "name": "label", "fieldName": "label", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/TextFieldMixin.js" } }, { "name": "filled", "fieldName": "filled", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/TextFieldMixin.js" } }, { "name": "input-prefix", "fieldName": "inputPrefix", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/TextFieldMixin.js" } }, { "name": "input-suffix", "fieldName": "inputSuffix", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/TextFieldMixin.js" } }, { "name": "trailing-icon", "description": "Name of the trailing icon to render (defaults to the dropdown arrow).", "fieldName": "trailingIcon", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/TextFieldMixin.js" } }, { "name": "trailing-icon-ink", "fieldName": "trailingIconInk", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/TextFieldMixin.js" } }, { "name": "trailing-icon-label", "fieldName": "trailingIconLabel", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/TextFieldMixin.js" } }, { "name": "supporting", "fieldName": "supporting", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/TextFieldMixin.js" } }, { "name": "error", "fieldName": "error", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/TextFieldMixin.js" } }, { "name": "placeholder", "fieldName": "placeholder", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/TextFieldMixin.js" } }, { "name": "state-layer", "type": { "text": "boolean" }, "description": "Show the visual state layer element when true", "fieldName": "stateLayer", "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "type", "type": { "text": "string" }, "fieldName": "type", "inheritedFrom": { "name": "default", "module": "mixins/ControlMixin.js" } } ], "members": [ { "name": "delegatesFocus", "kind": "field", "description": "When true, the element delegates focus to an internal focus target.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/DelegatesFocusMixin.js#L15" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "disabled", "kind": "field", "description": "Whether the element is disabled (affects interactive states)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L14" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "focused", "kind": "field", "description": "Force focus state (independent of document)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L16" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "hovered", "kind": "field", "description": "Force hover state (independent of interaction)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L18" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "pressed", "kind": "field", "description": "Force pressed state (independent of interaction)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L20" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "stateLayer", "kind": "field", "description": "Show the visual state layer element when true\nShow an internal visual state layer element", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/TextFieldMixin.js#L17" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "disabledState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L171" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "hoveredState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L38" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "focusedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L39" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "pressedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L40" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "touchedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L41" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "pointedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L44" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "stateTargetElement", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ControlMixin.js#L66" }, "type": { "text": "HTMLElement" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "color", "kind": "field", "description": "Palette or surface token used to select background/ink tokens.\nExamples: 'primary', 'background', 'surface-container-low'.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L52" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "ink", "kind": "field", "description": "Explicit ink override token (e.g. 'outline', 'on-primary', 'inverse-on-surface', 'inherit').\nMaps to `--mdw-ink`.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L57" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "typeStyle", "kind": "field", "description": "Typographic style shortcut that maps to type scale variables\n(e.g. 'headline-large', 'body-medium').", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L62" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "shapeTop", "kind": "field", "description": "Show top cut/shape on the element", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L9" }, "type": { "text": "boolean" } }, { "name": "shapeBottom", "kind": "field", "description": "Show bottom cut/shape on the element", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L11" }, "type": { "text": "boolean" } }, { "name": "shapeStart", "kind": "field", "description": "Show start-side cut/shape (logical start)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L13" }, "type": { "text": "boolean" } }, { "name": "shapeEnd", "kind": "field", "description": "Show end-side cut/shape (logical end)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L15" }, "type": { "text": "boolean" } }, { "name": "shapeStyle", "kind": "field", "description": "Predefined shape size/style name (none|extra-small|small|medium|large|extra-large|full|inherit)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L17" }, "type": { "text": "string" } }, { "name": "outlined", "kind": "field", "description": "When true, an outline is rendered around the element\nWhen true, use outlined styling", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/TextFieldMixin.js#L31" }, "type": { "text": "boolean" } }, { "name": "density", "kind": "field", "description": "Density level affecting spacing and compactness. Integer from -4 (dense) to 4 (spacious).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/DensityMixin.js#L9" }, "type": { "text": "number" } }, { "name": "ariaControls", "kind": "field", "description": "ARIA 'controls' attribute (string).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L32" }, "type": { "text": "string" } }, { "name": "autocomplete", "kind": "field", "description": "Autocomplete token for the associated control (string).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L34" }, "type": { "text": "string" } }, { "name": "name", "kind": "field", "description": "Name attribute for the control used in forms.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L36" }, "type": { "text": "string" } }, { "name": "readOnly", "kind": "field", "description": "Read-only state reflected to control via 'readonly' attribute.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L38" }, "type": { "text": "boolean" } }, { "name": "formNoValidate", "kind": "field", "description": "When true, form validation is skipped for this control (formnovalidate).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L40" }, "type": { "text": "boolean" } }, { "name": "defaultChecked", "kind": "field", "description": "Default checked state for checkable controls (checkbox/radio).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L42" }, "type": { "text": "boolean" } }, { "name": "required", "kind": "field", "description": "Whether the control is required for form submission.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L47" }, "type": { "text": "boolean" } }, { "name": "type", "kind": "field", "description": "Control type token (e.g. 'text','checkbox','radio','file').\nInput type (text, password, email, etc.)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Select.js#L25" }, "type": { "text": "string" } }, { "name": "erroredState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/TextFieldMixin.js#L50" }, "type": { "text": "boolean" } }, { "name": "defaultValue", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L66" }, "type": { "text": "string" } }, { "name": "value", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Select.js#L35" }, "type": { "text": "string" } }, { "name": "checked", "kind": "field", "description": "Part of FormAssociatedMixin for simplicity.\nEnumerability doesn't guarantee checked state will be passed or used.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L145" }, "type": { "text": "boolean" } }, { "name": "form", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L160" }, "type": { "text": "HTMLFormElement" } }, { "name": "validity", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L161" }, "type": { "text": "ValidityState" } }, { "name": "validationMessage", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L162" }, "type": { "text": "string" } }, { "name": "willValidate", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L163" }, "type": { "text": "boolean" } }, { "name": "labels", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L168" }, "type": { "text": "NodeList" } }, { "name": "focusableOnDisabled", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ControlMixin.js#L30" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ControlMixin.js" } }, { "name": "controlTagName", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Select.js#L23" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ControlMixin.js" } }, { "name": "controlVoidElement", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Select.js#L24" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ControlMixin.js" } }, { "name": "icon", "kind": "field", "description": "Leading icon key/name to render inside the field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/TextFieldMixin.js#L23" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/TextFieldMixin.js" } }, { "name": "iconVariation", "kind": "field", "description": "Variation of the icon display (e.g., filled)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/TextFieldMixin.js#L25" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/TextFieldMixin.js" } }, { "name": "label", "kind": "field", "description": "Floating label text for the field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/TextFieldMixin.js#L27" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/TextFieldMixin.js" } }, { "name": "filled", "kind": "field", "description": "When true, use filled styling", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/TextFieldMixin.js#L29" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/TextFieldMixin.js" } }, { "name": "inputPrefix", "kind": "field", "description": "Prefix text shown before the input", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/TextFieldMixin.js#L33" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/TextFieldMixin.js" } }, { "name": "inputSuffix", "kind": "field", "description": "Suffix text shown after the input", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/TextFieldMixin.js#L35" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/TextFieldMixin.js" } }, { "name": "trailingIcon", "kind": "field", "description": "Trailing icon key/name\nName of the trailing icon to render (defaults to the dropdown arrow).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Select.js#L20" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/TextFieldMixin.js" } }, { "name": "trailingIconInk", "kind": "field", "description": "Ink/color token for the trailing icon", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/TextFieldMixin.js#L39" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/TextFieldMixin.js" } }, { "name": "trailingIconLabel", "kind": "field", "description": "Accessible label for the trailing icon", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/TextFieldMixin.js#L41" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/TextFieldMixin.js" } }, { "name": "supporting", "kind": "field", "description": "Supporting/helper text shown beneath the field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/TextFieldMixin.js#L43" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/TextFieldMixin.js" } }, { "name": "error", "kind": "field", "description": "Error message text", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/TextFieldMixin.js#L45" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/TextFieldMixin.js" } }, { "name": "placeholder", "kind": "field", "description": "Placeholder text (DOMString)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/TextFieldMixin.js#L47" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/TextFieldMixin.js" } }, { "name": "multiple", "kind": "field", "description": "Readonly: whether the underlying control allows multiple selection.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Select.js#L33" }, "type": { "text": "boolean" } }, { "name": "size", "kind": "field", "description": "Readonly: the rendered size of the native select control.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Select.js#L35" }, "type": { "text": "number" } }, { "name": "prototype", "kind": "field", "static": true, "type": { "text": "CustomElement" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "onValueChangingContentAttribute", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ControlMixin.js#L43" }, "return": { "type": { "text": "() => void" } }, "inheritedFrom": { "name": "default", "module": "mixins/ControlMixin.js" } }, { "name": "computePlaceholder", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/TextFieldMixin.js#L53" }, "return": { "type": { "text": "() => string" } }, "inheritedFrom": { "name": "default", "module": "mixins/TextFieldMixin.js" } }, { "name": "shouldShowSupporting", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/TextFieldMixin.js#L58" }, "return": { "type": { "text": "() => boolean" } }, "inheritedFrom": { "name": "default", "module": "mixins/TextFieldMixin.js" } }, { "name": "computeSupportingText", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/TextFieldMixin.js#L62" }, "return": { "type": { "text": "() => string" } }, "inheritedFrom": { "name": "default", "module": "mixins/TextFieldMixin.js" } }, { "name": "populatedState", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/TextFieldMixin.js#L66" }, "return": { "type": { "text": "() => boolean" } }, "inheritedFrom": { "name": "default", "module": "mixins/TextFieldMixin.js" } }, { "name": "computedIconVariation", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/TextFieldMixin.js#L77" }, "return": { "type": { "text": "() => string" } }, "inheritedFrom": { "name": "default", "module": "mixins/TextFieldMixin.js" } }, { "name": "compose", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L145" }, "type": { "text": "(parts: CompositionPart[]) => Composition" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#refsProxy", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1145" }, "type": { "text": "Record" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#refsCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1148" }, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#refsCompositionCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1151" }, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#composition", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1154" }, "type": { "text": "Composition" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#patching", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1156" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#pendingPatchRenders", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1159" }, "type": { "text": "[string, any, CustomElement][]" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#propAttributeCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1162" }, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#callbackArguments", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1165" }, "type": { "text": "CallbackArguments" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "elementInternals", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1172" }, "type": { "text": "ElementInternals" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "render", "kind": "field", "description": "Updates nodes based on data\nExpects data in JSON Merge Patch format", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1185" }, "type": { "text": "RenderDraw" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "propChangedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1213" }, "type": { "text": "(this: T, name: K, oldValue: K extends keyof T ? T[K] : unknown, newValue: K extends keyof T ? T[K] : unknown, changes?: K extends keyof T ? T[K] extends object ? Partial : T[K] : unknown) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attributeChangedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1234" }, "type": { "text": "(name: string, oldValue: string, newValue: string) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#template", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1284" }, "type": { "text": "DocumentFragment" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#onObserverPropertyChanged", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1294" }, "type": { "text": "(name: string, oldValue: any, newValue: any, changes: any) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "static", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1330" }, "type": { "text": "typeof CustomElement" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "patch", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1333" }, "type": { "text": "(patch: any) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "refs", "kind": "field", "description": "Proxy object that returns shadow DOM elements by tag.\nIf called before interpolation (eg: on composed), returns from template", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1404" }, "type": { "text": "Record" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attributeCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1391" }, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "callbackArguments", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1400" }, "type": { "text": "CallbackArguments | { composition: Composition; refs: Record; html: any; inline: (fn: (data: Partial) => any) => string; template: DocumentFragment; element: T; }" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "composition", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1403" }, "type": { "text": "Composition" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "connectedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1435" }, "type": { "text": "() => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "disconnectedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1441" }, "type": { "text": "() => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "elementName", "kind": "field", "static": true, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "observedAttributes", "kind": "field", "static": true, "type": { "text": "Iterable" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "interpolatesTemplate", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "supportsElementInternals", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "supportsElementInternalsRole", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "defined", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "registrations", "kind": "field", "static": true, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "expressions", "kind": "method", "static": true, "description": "Expressions are idempotent functions that are selectively called whenever\na render is requested.\nExpressions are constructed exactly as methods though differ in expected\narguments. The first argument should be destructured to ensure each used\nproperty is accessed at least once in order to inspect used properties.\n\nThe Composition API will inspect this function with a proxy for `this` to\ncatalog what observables are used by the expression. This allows the\nComposition API to build a cache as well as selective invoke the expression\nonly when needed.\n\nWhen used with in element templates, the element itself will be passed as\nits first argument.\n````js\n Button\n .prop('filled', 'boolean')\n .prop('outlined', 'boolean')\n .expresssions({\n _isFilledOrOutlined({filled, outlined}) {\n return (filled || outlined)\n },\n })\n .html`
`;\n````\n\nWhen used with external data source, that data source\nwill be passed to the expression with all properties being `null` at first\ninspection.\n````js\n const externalData = {first: 'John', last: 'Doe'};\n ContactCard\n .expresssions({\n _fullName({first, last}) {\n return [first, last].filter(Boolean).join(' ');\n },\n })\n myButton.render(externalData);\n````\n\nExpressions may be support argumentless calls by using default\nparameters with `this`.\n````js\n Button\n .expresssions({\n isFilledOrOutlined({filled, outlined} = this) {\n return (filled || outlined)\n },\n });\n myButton.isFilledorOutlined();\n````", "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends { [K in keyof any]: K extends `_${any}` ? ((data: INSTANCE, state?: Record) => string | boolean | null) : ((data?: INSTANCE, state?: Record) => string | boolean | null); } & ThisType>(this: CLASS, expressions: PROPS & ThisType) => CLASS & Class<{ [K in keyof PROPS]: K extends `_${any}` ? never : () => ReturnType; }, ARGS>" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "methods", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "overrides", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends Partial>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "props", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "idl", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "append", "kind": "field", "static": true, "description": "Append parts to composition", "type": { "text": "(this: T, ...parts: CompositionPart[]) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "recompose", "kind": "field", "static": true, "description": "After composition, invokes callback.\nMay be called multiple times.", "type": { "text": ", T3 extends CompositionCallback[\"composed\"]>(this: T1, callback: T3) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "css", "kind": "field", "static": true, "description": "Appends styles to composition", "type": { "text": "(this: T1, array: T2, ...rest: T2 extends string ? any : T2 extends TemplateStringsArray ? any[] : (HTMLStyleElement | CSSStyleSheet)[]) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "autoRegister", "kind": "field", "static": true, "description": "Registers class with customElements. If class is registered before then,\ndoes nothing.", "type": { "text": "(this: T, elementName: string) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "html", "kind": "field", "static": true, "description": "Appends DocumentFragment to composition", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1405" }, "type": { "text": "(this: T, string: TemplateStringsArray, ...substitutions: (string | Element | ((this: InstanceType, data: InstanceType, injections?: any) => any))[]) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "extend", "kind": "field", "static": true, "description": "Extends base class into a new class.\nUse to avoid mutating base class.", "type": { "text": " T2>(this: T1, customExtender?: T3) => T3 extends null ? T1 : T2" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "setStatic", "kind": "field", "static": true, "description": "Assigns static values to class", "type": { "text": " any) | string | number | boolean | any[] | object); }>(this: T1, source: T2 & ThisType) => T1 & T2" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "readonly", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "set", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "mixin", "kind": "field", "static": true, "description": "Returns result of calling mixin with current class", "type": { "text": " any, RETURN extends ReturnType, SUBCLASS extends ClassOf>(this: BASE, mixin: FN) => SUBCLASS & BASE" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "register", "kind": "field", "static": true, "description": "Registers class with window.customElements synchronously", "type": { "text": "(this: T, elementName?: string, force?: boolean) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "propList", "kind": "field", "static": true, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attrList", "kind": "field", "static": true, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "propChangedCallbacks", "kind": "field", "static": true, "type": { "text": "Map any)[]>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attributeChangedCallbacks", "kind": "field", "static": true, "type": { "text": "Map any)[]>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "prop", "kind": "field", "static": true, "description": "Creates observable property on instances (via prototype)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1007" }, "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "setPrototype", "kind": "field", "static": true, "description": "Creates observable property on instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any)>(this: CLASS, name: KEY, options: OPTIONS) => OPTIONS extends (...args2: any[]) => infer R ? R : OPTIONS extends ObserverPropertyType ? ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? unknown extends R ? object : R : OPTIONS extends { type: ObserverPropertyType; } ? ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? unknown extends R ? string : R : never" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "define", "kind": "field", "static": true, "description": "Define properties on instances via Object.defineProperties().\nAutomatically sets property non-enumerable if name begins with `_`.\nFunctions will be remapped as getters", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends { [P in keyof any]: { enumerable?: boolean; configurable?: boolean; writable?: boolean; value?: any; get?: ((this: INSTANCE) => any); set?: (this: INSTANCE, value: any) => void; } | ((this: INSTANCE, ...args: any[]) => any); }, VALUE extends { [KEY in keyof PROPS]: PROPS[KEY] extends (...args2: any[]) => infer R ? R : PROPS[KEY] extends TypedPropertyDescriptor ? R : never; }>(this: CLASS, props: PROPS & ThisType) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "undefine", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROP extends string, PROPS extends INSTANCE & Record>(this: CLASS, name: PROP) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "observe", "kind": "field", "static": true, "description": "Creates observable properties on instances", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends IDLParameter, VALUE extends { [KEY in keyof PROPS]: PROPS[KEY] extends (...args2: any[]) => infer R ? R : PROPS[KEY] extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : PROPS[KEY] extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : PROPS[KEY] extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : PROPS[KEY] extends ObserverOptions ? (unknown extends R ? string : R) : never; }>(this: CLASS, props: PROPS) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "defineStatic", "kind": "field", "static": true, "type": { "text": ">(this: T1, props: T2) => T1 & ParsedProps" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "events", "kind": "field", "static": true, "type": { "text": "(this: T, listeners?: CompositionEventListenerObject>, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "childEvents", "kind": "field", "static": true, "type": { "text": "(this: T, listenerMap: { [x: string]: CompositionEventListenerObject>; }, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "rootEvents", "kind": "field", "static": true, "type": { "text": "(this: T, listeners?: CompositionEventListenerObject>, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "on", "kind": "field", "static": true, "type": { "text": ", T3 extends CompositionCallback, T4 extends keyof T3>(this: T1, name: T3 | T4, callbacks?: T3[T4] & ThisType) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "off", "kind": "field", "static": true, "type": { "text": ", T3 extends CompositionCallback, T4 extends keyof T3>(this: T1, name: T3 | T4, callbacks?: T3[T4] & ThisType) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "offPropChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: ObjectOrObjectEntries<{ [P in keyof T2]?: (this: T2, oldValue: T2[P], newValue: T2[P], changes: any, element: T2) => void; }>) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "offAttributeChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: { [x: string]: (this: T2, oldValue: string, newValue: string, element: T2) => void; }) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "onPropChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: ObjectOrObjectEntries<{ [P in keyof T2]?: (this: T2, oldValue: T2[P], newValue: T2[P], changes: any, element: T2) => void; }>) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "onAttributeChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: { [x: string]: (this: T2, oldValue: string, newValue: string, element: T2) => void; }) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } } ], "slots": [ { "name": "supporting", "description": "" }, { "name": "", "description": "" } ], "cssParts": [ { "name": "control" } ], "events": [], "demos": [ { "url": "demo/components/select.html" } ], "superclass": { "module": "core/CustomElement.js", "name": "default" }, "mixins": [ { "module": "mixins/ThemableMixin.js", "name": "default" }, { "module": "mixins/StateMixin.js", "name": "default" }, { "module": "mixins/ControlMixin.js", "name": "default" }, { "module": "mixins/TextFieldMixin.js", "name": "default" } ], "description": "Select provides a control for choosing an option from a list of options.\nimplements {HTMLSelectElement}\n@see https://m3.material.io/components/text-fields/overview" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "default", "module": "components/Select.js" } }, { "kind": "custom-element-definition", "name": "mdw-select", "declaration": { "name": "default", "module": "components/Select.js" } } ] }, { "kind": "javascript-module", "path": "components/Shape.js", "declarations": [ { "kind": "class", "name": "Shape", "tagName": "mdw-shape", "customElement": true, "attributes": [ { "name": "shape-top", "fieldName": "shapeTop", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMaskedMixin.js" } }, { "name": "shape-bottom", "fieldName": "shapeBottom", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMaskedMixin.js" } }, { "name": "shape-start", "fieldName": "shapeStart", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMaskedMixin.js" } }, { "name": "shape-end", "fieldName": "shapeEnd", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMaskedMixin.js" } }, { "name": "shape-style", "fieldName": "shapeStyle", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMaskedMixin.js" } } ], "members": [ { "name": "shapeTop", "kind": "field", "description": "Show top cut/shape on the element", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMaskedMixin.js#L9" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMaskedMixin.js" } }, { "name": "shapeBottom", "kind": "field", "description": "Show bottom cut/shape on the element", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMaskedMixin.js#L11" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMaskedMixin.js" } }, { "name": "shapeStart", "kind": "field", "description": "Show start-side cut/shape (logical start)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMaskedMixin.js#L13" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMaskedMixin.js" } }, { "name": "shapeEnd", "kind": "field", "description": "Show end-side cut/shape (logical end)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMaskedMixin.js#L15" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMaskedMixin.js" } }, { "name": "shapeStyle", "kind": "field", "description": "Predefined shape size/style name (none|extra-small|small|medium|large|extra-large|full|inherit)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMaskedMixin.js#L17" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMaskedMixin.js" } }, { "name": "prototype", "kind": "field", "static": true, "type": { "text": "CustomElement" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "compose", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L145" }, "type": { "text": "(parts: CompositionPart[]) => Composition" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#refsProxy", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1145" }, "type": { "text": "Record" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#refsCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1148" }, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#refsCompositionCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1151" }, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#composition", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1154" }, "type": { "text": "Composition" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#patching", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1156" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#pendingPatchRenders", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1159" }, "type": { "text": "[string, any, CustomElement][]" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#propAttributeCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1162" }, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#callbackArguments", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1165" }, "type": { "text": "CallbackArguments" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "elementInternals", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1172" }, "type": { "text": "ElementInternals" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "render", "kind": "field", "description": "Updates nodes based on data\nExpects data in JSON Merge Patch format", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1185" }, "type": { "text": "RenderDraw" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "propChangedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1213" }, "type": { "text": "(this: T, name: K, oldValue: K extends keyof T ? T[K] : unknown, newValue: K extends keyof T ? T[K] : unknown, changes?: K extends keyof T ? T[K] extends object ? Partial : T[K] : unknown) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attributeChangedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1234" }, "type": { "text": "(name: string, oldValue: string, newValue: string) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#template", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1284" }, "type": { "text": "DocumentFragment" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#onObserverPropertyChanged", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1294" }, "type": { "text": "(name: string, oldValue: any, newValue: any, changes: any) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "static", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1330" }, "type": { "text": "typeof CustomElement" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "patch", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1333" }, "type": { "text": "(patch: any) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "refs", "kind": "field", "description": "Proxy object that returns shadow DOM elements by tag.\nIf called before interpolation (eg: on composed), returns from template", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1404" }, "type": { "text": "Record" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attributeCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1391" }, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "callbackArguments", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1400" }, "type": { "text": "CallbackArguments | { composition: Composition; refs: Record; html: any; inline: (fn: (data: Partial) => any) => string; template: DocumentFragment; element: T; }" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "composition", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1403" }, "type": { "text": "Composition" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "connectedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1435" }, "type": { "text": "() => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "disconnectedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1441" }, "type": { "text": "() => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "delegatesFocus", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1175" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "elementName", "kind": "field", "static": true, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "observedAttributes", "kind": "field", "static": true, "type": { "text": "Iterable" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "interpolatesTemplate", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "supportsElementInternals", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "supportsElementInternalsRole", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "defined", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "registrations", "kind": "field", "static": true, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "expressions", "kind": "method", "static": true, "description": "Expressions are idempotent functions that are selectively called whenever\na render is requested.\nExpressions are constructed exactly as methods though differ in expected\narguments. The first argument should be destructured to ensure each used\nproperty is accessed at least once in order to inspect used properties.\n\nThe Composition API will inspect this function with a proxy for `this` to\ncatalog what observables are used by the expression. This allows the\nComposition API to build a cache as well as selective invoke the expression\nonly when needed.\n\nWhen used with in element templates, the element itself will be passed as\nits first argument.\n````js\n Button\n .prop('filled', 'boolean')\n .prop('outlined', 'boolean')\n .expresssions({\n _isFilledOrOutlined({filled, outlined}) {\n return (filled || outlined)\n },\n })\n .html`
`;\n````\n\nWhen used with external data source, that data source\nwill be passed to the expression with all properties being `null` at first\ninspection.\n````js\n const externalData = {first: 'John', last: 'Doe'};\n ContactCard\n .expresssions({\n _fullName({first, last}) {\n return [first, last].filter(Boolean).join(' ');\n },\n })\n myButton.render(externalData);\n````\n\nExpressions may be support argumentless calls by using default\nparameters with `this`.\n````js\n Button\n .expresssions({\n isFilledOrOutlined({filled, outlined} = this) {\n return (filled || outlined)\n },\n });\n myButton.isFilledorOutlined();\n````", "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends { [K in keyof any]: K extends `_${any}` ? ((data: INSTANCE, state?: Record) => string | boolean | null) : ((data?: INSTANCE, state?: Record) => string | boolean | null); } & ThisType>(this: CLASS, expressions: PROPS & ThisType) => CLASS & Class<{ [K in keyof PROPS]: K extends `_${any}` ? never : () => ReturnType; }, ARGS>" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "methods", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "overrides", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends Partial>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "props", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "idl", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "append", "kind": "field", "static": true, "description": "Append parts to composition", "type": { "text": "(this: T, ...parts: CompositionPart[]) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "recompose", "kind": "field", "static": true, "description": "After composition, invokes callback.\nMay be called multiple times.", "type": { "text": ", T3 extends CompositionCallback[\"composed\"]>(this: T1, callback: T3) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "css", "kind": "field", "static": true, "description": "Appends styles to composition", "type": { "text": "(this: T1, array: T2, ...rest: T2 extends string ? any : T2 extends TemplateStringsArray ? any[] : (HTMLStyleElement | CSSStyleSheet)[]) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "autoRegister", "kind": "field", "static": true, "description": "Registers class with customElements. If class is registered before then,\ndoes nothing.", "type": { "text": "(this: T, elementName: string) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "html", "kind": "field", "static": true, "description": "Appends DocumentFragment to composition", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1405" }, "type": { "text": "(this: T, string: TemplateStringsArray, ...substitutions: (string | Element | ((this: InstanceType, data: InstanceType, injections?: any) => any))[]) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "extend", "kind": "field", "static": true, "description": "Extends base class into a new class.\nUse to avoid mutating base class.", "type": { "text": " T2>(this: T1, customExtender?: T3) => T3 extends null ? T1 : T2" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "setStatic", "kind": "field", "static": true, "description": "Assigns static values to class", "type": { "text": " any) | string | number | boolean | any[] | object); }>(this: T1, source: T2 & ThisType) => T1 & T2" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "readonly", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "set", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "mixin", "kind": "field", "static": true, "description": "Returns result of calling mixin with current class", "type": { "text": " any, RETURN extends ReturnType, SUBCLASS extends ClassOf>(this: BASE, mixin: FN) => SUBCLASS & BASE" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "register", "kind": "field", "static": true, "description": "Registers class with window.customElements synchronously", "type": { "text": "(this: T, elementName?: string, force?: boolean) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "propList", "kind": "field", "static": true, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attrList", "kind": "field", "static": true, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "propChangedCallbacks", "kind": "field", "static": true, "type": { "text": "Map any)[]>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attributeChangedCallbacks", "kind": "field", "static": true, "type": { "text": "Map any)[]>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "prop", "kind": "field", "static": true, "description": "Creates observable property on instances (via prototype)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1007" }, "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "setPrototype", "kind": "field", "static": true, "description": "Creates observable property on instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any)>(this: CLASS, name: KEY, options: OPTIONS) => OPTIONS extends (...args2: any[]) => infer R ? R : OPTIONS extends ObserverPropertyType ? ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? unknown extends R ? object : R : OPTIONS extends { type: ObserverPropertyType; } ? ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? unknown extends R ? string : R : never" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "define", "kind": "field", "static": true, "description": "Define properties on instances via Object.defineProperties().\nAutomatically sets property non-enumerable if name begins with `_`.\nFunctions will be remapped as getters", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends { [P in keyof any]: { enumerable?: boolean; configurable?: boolean; writable?: boolean; value?: any; get?: ((this: INSTANCE) => any); set?: (this: INSTANCE, value: any) => void; } | ((this: INSTANCE, ...args: any[]) => any); }, VALUE extends { [KEY in keyof PROPS]: PROPS[KEY] extends (...args2: any[]) => infer R ? R : PROPS[KEY] extends TypedPropertyDescriptor ? R : never; }>(this: CLASS, props: PROPS & ThisType) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "undefine", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROP extends string, PROPS extends INSTANCE & Record>(this: CLASS, name: PROP) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "observe", "kind": "field", "static": true, "description": "Creates observable properties on instances", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends IDLParameter, VALUE extends { [KEY in keyof PROPS]: PROPS[KEY] extends (...args2: any[]) => infer R ? R : PROPS[KEY] extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : PROPS[KEY] extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : PROPS[KEY] extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : PROPS[KEY] extends ObserverOptions ? (unknown extends R ? string : R) : never; }>(this: CLASS, props: PROPS) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "defineStatic", "kind": "field", "static": true, "type": { "text": ">(this: T1, props: T2) => T1 & ParsedProps" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "events", "kind": "field", "static": true, "type": { "text": "(this: T, listeners?: CompositionEventListenerObject>, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "childEvents", "kind": "field", "static": true, "type": { "text": "(this: T, listenerMap: { [x: string]: CompositionEventListenerObject>; }, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "rootEvents", "kind": "field", "static": true, "type": { "text": "(this: T, listeners?: CompositionEventListenerObject>, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "on", "kind": "field", "static": true, "type": { "text": ", T3 extends CompositionCallback, T4 extends keyof T3>(this: T1, name: T3 | T4, callbacks?: T3[T4] & ThisType) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "off", "kind": "field", "static": true, "type": { "text": ", T3 extends CompositionCallback, T4 extends keyof T3>(this: T1, name: T3 | T4, callbacks?: T3[T4] & ThisType) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "offPropChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: ObjectOrObjectEntries<{ [P in keyof T2]?: (this: T2, oldValue: T2[P], newValue: T2[P], changes: any, element: T2) => void; }>) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "offAttributeChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: { [x: string]: (this: T2, oldValue: string, newValue: string, element: T2) => void; }) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "onPropChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: ObjectOrObjectEntries<{ [P in keyof T2]?: (this: T2, oldValue: T2[P], newValue: T2[P], changes: any, element: T2) => void; }>) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "onAttributeChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: { [x: string]: (this: T2, oldValue: string, newValue: string, element: T2) => void; }) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } } ], "slots": [ { "name": "", "description": "" } ], "cssParts": [], "events": [], "demos": [ { "url": "demo/components/shape.html" } ], "superclass": { "module": "core/CustomElement.js", "name": "default" }, "mixins": [ { "module": "mixins/ShapeMaskedMixin.js", "name": "default" } ], "description": "Shape applies shape tokens (corner radius) to elements and surfaces.\n@see https://m3.material.io/styles/shape/overview-principles" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "default", "module": "components/Shape.js" } }, { "kind": "custom-element-definition", "name": "mdw-shape", "declaration": { "name": "default", "module": "components/Shape.js" } } ] }, { "kind": "javascript-module", "path": "components/SideSheet.js", "declarations": [ { "kind": "class", "name": "SideSheet", "tagName": "mdw-side-sheet", "customElement": true, "attributes": [ { "name": "color", "description": "The theme color token used for the sheet background.", "fieldName": "color", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "ink", "fieldName": "ink", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "type-style", "fieldName": "typeStyle", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "block", "fieldName": "block", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/FlexboxMixin.js" } }, { "name": "inline", "fieldName": "inline", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/FlexboxMixin.js" } }, { "name": "row", "fieldName": "row", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/FlexboxMixin.js" } }, { "name": "x", "fieldName": "x", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/FlexboxMixin.js" } }, { "name": "y", "fieldName": "y", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/FlexboxMixin.js" } }, { "name": "gap", "fieldName": "gap", "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "mixins/FlexboxMixin.js" } }, { "name": "padding", "fieldName": "padding", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/FlexboxMixin.js" } }, { "name": "shape-top", "fieldName": "shapeTop", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shape-bottom", "fieldName": "shapeBottom", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shape-start", "fieldName": "shapeStart", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shape-end", "fieldName": "shapeEnd", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shape-style", "fieldName": "shapeStyle", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "outlined", "fieldName": "outlined", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "fixed", "description": "When true the side sheet is fixed (non-modal/static), occupying layout space.", "fieldName": "fixed", "type": { "text": "boolean" } }, { "name": "open", "description": "Whether the sheet is currently open (visible).", "fieldName": "open", "type": { "text": "boolean" } }, { "name": "inline-end", "description": "When true, position the sheet at the inline end edge.", "fieldName": "inlineEnd", "type": { "text": "boolean" } }, { "name": "ontoggle", "description": "Event handler invoked when the sheet toggles.", "fieldName": "ontoggle", "type": { "text": "function" } }, { "name": "onclose", "description": "Event handler invoked when the sheet closes.", "fieldName": "onclose", "type": { "text": "function" } }, { "name": "auto-open", "description": "Optional auto-open minimum viewport inline-size (px); -1 disables.", "fieldName": "autoOpen", "type": { "text": "number" } }, { "name": "auto-close", "description": "Optional auto-close maximum viewport inline-size (px); -1 disables.", "fieldName": "autoClose", "type": { "text": "number" } }, { "name": "fixed-breakpoint", "description": "Inline-size breakpoint (px) at which the sheet becomes `fixed`.", "fieldName": "fixedBreakpoint", "type": { "text": "number" } }, { "name": "fixed-color", "description": "Optional fixed-mode color token applied when sheet is fixed.", "fieldName": "fixedColor", "type": { "text": "string" } } ], "members": [ { "name": "delegatesFocus", "kind": "field", "description": "When true, the element delegates focus to an internal focus target.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/DelegatesFocusMixin.js#L15" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "disabled", "kind": "field", "description": "Whether the element is disabled (affects interactive states)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L14" }, "type": { "text": "boolean" } }, { "name": "focused", "kind": "field", "description": "Force focus state (independent of document)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L16" }, "type": { "text": "boolean" } }, { "name": "hovered", "kind": "field", "description": "Force hover state (independent of interaction)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L18" }, "type": { "text": "boolean" } }, { "name": "pressed", "kind": "field", "description": "Force pressed state (independent of interaction)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L20" }, "type": { "text": "boolean" } }, { "name": "stateLayer", "kind": "field", "description": "Show the visual state layer element when true", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L34" }, "type": { "text": "boolean" } }, { "name": "disabledState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L37" }, "type": { "text": "boolean" } }, { "name": "hoveredState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L38" }, "type": { "text": "boolean" } }, { "name": "focusedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L39" }, "type": { "text": "boolean" } }, { "name": "pressedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L40" }, "type": { "text": "boolean" } }, { "name": "touchedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L41" }, "type": { "text": "boolean" } }, { "name": "pointedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L44" }, "type": { "text": "boolean" } }, { "name": "stateTargetElement", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L50" }, "type": { "text": "HTMLElement" } }, { "name": "color", "kind": "field", "description": "Palette or surface token used to select background/ink tokens.\nExamples: 'primary', 'background', 'surface-container-low'.\nThe theme color token used for the sheet background.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/SideSheet.js#L96" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "ink", "kind": "field", "description": "Explicit ink override token (e.g. 'outline', 'on-primary', 'inverse-on-surface', 'inherit').\nMaps to `--mdw-ink`.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L57" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "typeStyle", "kind": "field", "description": "Typographic style shortcut that maps to type scale variables\n(e.g. 'headline-large', 'body-medium').", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L62" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "shapeTop", "kind": "field", "description": "Show top cut/shape on the element", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L9" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shapeBottom", "kind": "field", "description": "Show bottom cut/shape on the element", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L11" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shapeStart", "kind": "field", "description": "Show start-side cut/shape (logical start)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L13" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shapeEnd", "kind": "field", "description": "Show end-side cut/shape (logical end)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L15" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shapeStyle", "kind": "field", "description": "Predefined shape size/style name (none|extra-small|small|medium|large|extra-large|full|inherit)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L17" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "outlined", "kind": "field", "description": "When true, an outline is rendered around the element", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L19" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "block", "kind": "field", "description": "Set `display: block` on the host (boolean)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js#L9" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/FlexboxMixin.js" } }, { "name": "inline", "kind": "field", "description": "Use inline flex layout: `display: inline-flex` (boolean)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js#L11" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/FlexboxMixin.js" } }, { "name": "row", "kind": "field", "description": "Switch main axis to horizontal: `flex-direction: row` (boolean)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js#L13" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/FlexboxMixin.js" } }, { "name": "x", "kind": "field", "description": "Main-axis alignment / justification.\nAllowed: 'start'|'center'|'end'|'between'|'around'|'stretch'|'baseline'.\nDefault: 'start'.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js#L19" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/FlexboxMixin.js" } }, { "name": "y", "kind": "field", "description": "Cross-axis alignment / alignment of items.\nSame allowed values as `x`. Default: 'start'.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js#L29" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/FlexboxMixin.js" } }, { "name": "gap", "kind": "field", "description": "Gap between children. Accepts preset numeric strings (e.g. '8') mapped to px, or floats.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js#L36" }, "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "mixins/FlexboxMixin.js" } }, { "name": "padding", "kind": "field", "description": "Padding preset or numeric value (e.g. 'pane', '8', '16').", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js#L38" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/FlexboxMixin.js" } }, { "name": "fixed", "kind": "field", "description": "When true the side sheet is fixed (non-modal/static), occupying layout space.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/SideSheet.js#L47" }, "type": { "text": "boolean" } }, { "name": "open", "kind": "field", "description": "Whether the sheet is currently open (visible).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/SideSheet.js#L49" }, "type": { "text": "boolean" } }, { "name": "inlineEnd", "kind": "field", "description": "When true, position the sheet at the inline end edge.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/SideSheet.js#L51" }, "type": { "text": "boolean" } }, { "name": "autoOpen", "kind": "field", "description": "Optional auto-open minimum viewport inline-size (px); -1 disables.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/SideSheet.js#L79" }, "type": { "text": "number" } }, { "name": "autoClose", "kind": "field", "description": "Optional auto-close maximum viewport inline-size (px); -1 disables.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/SideSheet.js#L84" }, "type": { "text": "number" } }, { "name": "fixedBreakpoint", "kind": "field", "description": "Inline-size breakpoint (px) at which the sheet becomes `fixed`.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/SideSheet.js#L89" }, "type": { "text": "number" } }, { "name": "fixedColor", "kind": "field", "description": "Optional fixed-mode color token applied when sheet is fixed.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/SideSheet.js#L98" }, "type": { "text": "string" } }, { "name": "hostStyles", "kind": "field", "description": "Computed animation/style object applied to the host for open/close.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/SideSheet.js#L115" }, "type": { "text": "ElementStylerOptions | { styles: { marginLeft: string | number; marginRight: string | number; transform: string; }; timing: { duration: number; easing: string; }; }" } }, { "name": "checkForScrim", "kind": "method", "description": "Ensure a scrim is present when the sheet is modal (open && !fixed).\nWhen `animate` is true, keep the scrim around to run its fade-out.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/SideSheet.js#L142" }, "return": { "type": { "text": "(animate?: boolean) => void" } } }, { "name": "checkDragFinished", "kind": "method", "description": "Evaluate drag state and decide whether to close or snap open.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/SideSheet.js#L166" }, "return": { "type": { "text": "() => void" } } }, { "name": "onWindowResize", "kind": "method", "description": "Recompute `fixed`/`open` state based on the window width and breakpoints.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/SideSheet.js#L185" }, "return": { "type": { "text": "() => void" } } }, { "name": "prototype", "kind": "field", "static": true, "type": { "text": "CustomElement" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "readAriaProperty", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/AriaReflectorMixin.js#L28" }, "return": { "type": { "text": "(name: \"shadowRoot\" | \"ariaActiveDescendantElement\" | \"ariaAtomic\" | \"ariaAutoComplete\" | \"ariaBrailleLabel\" | \"ariaBrailleRoleDescription\" | \"ariaBusy\" | \"ariaChecked\" | \"ariaColCount\" | \"ariaColIndex\" | \"ariaColIndexText\" | \"ariaColSpan\" | \"ariaControlsElements\" | \"ariaCurrent\" | \"ariaDescribedByElements\" | \"ariaDescription\" | \"ariaDetailsElements\" | \"ariaDisabled\" | \"ariaErrorMessageElements\" | \"ariaExpanded\" | \"ariaFlowToElements\" | \"ariaHasPopup\" | \"ariaHidden\" | \"ariaInvalid\" | \"ariaKeyShortcuts\" | \"ariaLabel\" | \"ariaLabelledByElements\" | \"ariaLevel\" | \"ariaLive\" | \"ariaModal\" | \"ariaMultiLine\" | \"ariaMultiSelectable\" | \"ariaOrientation\" | \"ariaOwnsElements\" | \"ariaPlaceholder\" | \"ariaPosInSet\" | \"ariaPressed\" | \"ariaReadOnly\" | \"ariaRelevant\" | \"ariaRequired\" | \"ariaRoleDescription\" | \"ariaRowCount\" | \"ariaRowIndex\" | \"ariaRowIndexText\" | \"ariaRowSpan\" | \"ariaSelected\" | \"ariaSetSize\" | \"ariaSort\" | \"ariaValueMax\" | \"ariaValueMin\" | \"ariaValueNow\" | \"ariaValueText\" | \"role\") => string | Element | ShadowRoot | readonly Element[]" } }, "inheritedFrom": { "name": "default", "module": "mixins/AriaReflectorMixin.js" } }, { "name": "updateAriaProperty", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/AriaReflectorMixin.js#L47" }, "return": { "type": { "text": ">(name: K, value: ARIAMixin[K]) => void" } }, "inheritedFrom": { "name": "default", "module": "mixins/AriaReflectorMixin.js" } }, { "name": "onResizeObserved", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ResizeObserverMixin.js#L23" }, "return": { "type": { "text": "(entry: ResizeObserverEntry) => void" } }, "inheritedFrom": { "name": "default", "module": "mixins/ResizeObserverMixin.js" } }, { "name": "observeResize", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ResizeObserverMixin.js#L26" }, "return": { "type": { "text": "() => void" } }, "inheritedFrom": { "name": "default", "module": "mixins/ResizeObserverMixin.js" } }, { "name": "unobserveResize", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ResizeObserverMixin.js#L31" }, "return": { "type": { "text": "() => void" } }, "inheritedFrom": { "name": "default", "module": "mixins/ResizeObserverMixin.js" } }, { "name": "compose", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L145" }, "type": { "text": "(parts: CompositionPart[]) => Composition" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#refsProxy", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1145" }, "type": { "text": "Record" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#refsCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1148" }, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#refsCompositionCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1151" }, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#composition", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1154" }, "type": { "text": "Composition" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#patching", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1156" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#pendingPatchRenders", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1159" }, "type": { "text": "[string, any, CustomElement][]" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#propAttributeCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1162" }, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#callbackArguments", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1165" }, "type": { "text": "CallbackArguments" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "elementInternals", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1172" }, "type": { "text": "ElementInternals" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "render", "kind": "field", "description": "Updates nodes based on data\nExpects data in JSON Merge Patch format", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1185" }, "type": { "text": "RenderDraw" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "propChangedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1213" }, "type": { "text": "(this: T, name: K, oldValue: K extends keyof T ? T[K] : unknown, newValue: K extends keyof T ? T[K] : unknown, changes?: K extends keyof T ? T[K] extends object ? Partial : T[K] : unknown) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attributeChangedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1234" }, "type": { "text": "(name: string, oldValue: string, newValue: string) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#template", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1284" }, "type": { "text": "DocumentFragment" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#onObserverPropertyChanged", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1294" }, "type": { "text": "(name: string, oldValue: any, newValue: any, changes: any) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "static", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1330" }, "type": { "text": "typeof CustomElement" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "patch", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1333" }, "type": { "text": "(patch: any) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "refs", "kind": "field", "description": "Proxy object that returns shadow DOM elements by tag.\nIf called before interpolation (eg: on composed), returns from template", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1404" }, "type": { "text": "Record" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attributeCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1391" }, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "callbackArguments", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1400" }, "type": { "text": "CallbackArguments | { composition: Composition; refs: Record; html: any; inline: (fn: (data: Partial) => any) => string; template: DocumentFragment; element: T; }" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "composition", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1403" }, "type": { "text": "Composition" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "connectedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1435" }, "type": { "text": "() => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "disconnectedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1441" }, "type": { "text": "() => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "elementName", "kind": "field", "static": true, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "observedAttributes", "kind": "field", "static": true, "type": { "text": "Iterable" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "interpolatesTemplate", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "supportsElementInternals", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "supportsElementInternalsRole", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "defined", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "registrations", "kind": "field", "static": true, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "expressions", "kind": "method", "static": true, "description": "Expressions are idempotent functions that are selectively called whenever\na render is requested.\nExpressions are constructed exactly as methods though differ in expected\narguments. The first argument should be destructured to ensure each used\nproperty is accessed at least once in order to inspect used properties.\n\nThe Composition API will inspect this function with a proxy for `this` to\ncatalog what observables are used by the expression. This allows the\nComposition API to build a cache as well as selective invoke the expression\nonly when needed.\n\nWhen used with in element templates, the element itself will be passed as\nits first argument.\n````js\n Button\n .prop('filled', 'boolean')\n .prop('outlined', 'boolean')\n .expresssions({\n _isFilledOrOutlined({filled, outlined}) {\n return (filled || outlined)\n },\n })\n .html`
`;\n````\n\nWhen used with external data source, that data source\nwill be passed to the expression with all properties being `null` at first\ninspection.\n````js\n const externalData = {first: 'John', last: 'Doe'};\n ContactCard\n .expresssions({\n _fullName({first, last}) {\n return [first, last].filter(Boolean).join(' ');\n },\n })\n myButton.render(externalData);\n````\n\nExpressions may be support argumentless calls by using default\nparameters with `this`.\n````js\n Button\n .expresssions({\n isFilledOrOutlined({filled, outlined} = this) {\n return (filled || outlined)\n },\n });\n myButton.isFilledorOutlined();\n````", "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends { [K in keyof any]: K extends `_${any}` ? ((data: INSTANCE, state?: Record) => string | boolean | null) : ((data?: INSTANCE, state?: Record) => string | boolean | null); } & ThisType>(this: CLASS, expressions: PROPS & ThisType) => CLASS & Class<{ [K in keyof PROPS]: K extends `_${any}` ? never : () => ReturnType; }, ARGS>" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "methods", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "overrides", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends Partial>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "props", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "idl", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "append", "kind": "field", "static": true, "description": "Append parts to composition", "type": { "text": "(this: T, ...parts: CompositionPart[]) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "recompose", "kind": "field", "static": true, "description": "After composition, invokes callback.\nMay be called multiple times.", "type": { "text": ", T3 extends CompositionCallback[\"composed\"]>(this: T1, callback: T3) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "css", "kind": "field", "static": true, "description": "Appends styles to composition", "type": { "text": "(this: T1, array: T2, ...rest: T2 extends string ? any : T2 extends TemplateStringsArray ? any[] : (HTMLStyleElement | CSSStyleSheet)[]) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "autoRegister", "kind": "field", "static": true, "description": "Registers class with customElements. If class is registered before then,\ndoes nothing.", "type": { "text": "(this: T, elementName: string) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "html", "kind": "field", "static": true, "description": "Appends DocumentFragment to composition", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1405" }, "type": { "text": "(this: T, string: TemplateStringsArray, ...substitutions: (string | Element | ((this: InstanceType, data: InstanceType, injections?: any) => any))[]) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "extend", "kind": "field", "static": true, "description": "Extends base class into a new class.\nUse to avoid mutating base class.", "type": { "text": " T2>(this: T1, customExtender?: T3) => T3 extends null ? T1 : T2" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "setStatic", "kind": "field", "static": true, "description": "Assigns static values to class", "type": { "text": " any) | string | number | boolean | any[] | object); }>(this: T1, source: T2 & ThisType) => T1 & T2" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "readonly", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "set", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "mixin", "kind": "field", "static": true, "description": "Returns result of calling mixin with current class", "type": { "text": " any, RETURN extends ReturnType, SUBCLASS extends ClassOf>(this: BASE, mixin: FN) => SUBCLASS & BASE" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "register", "kind": "field", "static": true, "description": "Registers class with window.customElements synchronously", "type": { "text": "(this: T, elementName?: string, force?: boolean) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "propList", "kind": "field", "static": true, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attrList", "kind": "field", "static": true, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "propChangedCallbacks", "kind": "field", "static": true, "type": { "text": "Map any)[]>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attributeChangedCallbacks", "kind": "field", "static": true, "type": { "text": "Map any)[]>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "prop", "kind": "field", "static": true, "description": "Creates observable property on instances (via prototype)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1007" }, "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "setPrototype", "kind": "field", "static": true, "description": "Creates observable property on instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any)>(this: CLASS, name: KEY, options: OPTIONS) => OPTIONS extends (...args2: any[]) => infer R ? R : OPTIONS extends ObserverPropertyType ? ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? unknown extends R ? object : R : OPTIONS extends { type: ObserverPropertyType; } ? ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? unknown extends R ? string : R : never" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "define", "kind": "field", "static": true, "description": "Define properties on instances via Object.defineProperties().\nAutomatically sets property non-enumerable if name begins with `_`.\nFunctions will be remapped as getters", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends { [P in keyof any]: { enumerable?: boolean; configurable?: boolean; writable?: boolean; value?: any; get?: ((this: INSTANCE) => any); set?: (this: INSTANCE, value: any) => void; } | ((this: INSTANCE, ...args: any[]) => any); }, VALUE extends { [KEY in keyof PROPS]: PROPS[KEY] extends (...args2: any[]) => infer R ? R : PROPS[KEY] extends TypedPropertyDescriptor ? R : never; }>(this: CLASS, props: PROPS & ThisType) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "undefine", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROP extends string, PROPS extends INSTANCE & Record>(this: CLASS, name: PROP) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "observe", "kind": "field", "static": true, "description": "Creates observable properties on instances", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends IDLParameter, VALUE extends { [KEY in keyof PROPS]: PROPS[KEY] extends (...args2: any[]) => infer R ? R : PROPS[KEY] extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : PROPS[KEY] extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : PROPS[KEY] extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : PROPS[KEY] extends ObserverOptions ? (unknown extends R ? string : R) : never; }>(this: CLASS, props: PROPS) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "defineStatic", "kind": "field", "static": true, "type": { "text": ">(this: T1, props: T2) => T1 & ParsedProps" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "events", "kind": "field", "static": true, "type": { "text": "(this: T, listeners?: CompositionEventListenerObject>, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "childEvents", "kind": "field", "static": true, "type": { "text": "(this: T, listenerMap: { [x: string]: CompositionEventListenerObject>; }, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "rootEvents", "kind": "field", "static": true, "type": { "text": "(this: T, listeners?: CompositionEventListenerObject>, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "on", "kind": "field", "static": true, "type": { "text": ", T3 extends CompositionCallback, T4 extends keyof T3>(this: T1, name: T3 | T4, callbacks?: T3[T4] & ThisType) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "off", "kind": "field", "static": true, "type": { "text": ", T3 extends CompositionCallback, T4 extends keyof T3>(this: T1, name: T3 | T4, callbacks?: T3[T4] & ThisType) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "offPropChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: ObjectOrObjectEntries<{ [P in keyof T2]?: (this: T2, oldValue: T2[P], newValue: T2[P], changes: any, element: T2) => void; }>) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "offAttributeChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: { [x: string]: (this: T2, oldValue: string, newValue: string, element: T2) => void; }) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "onPropChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: ObjectOrObjectEntries<{ [P in keyof T2]?: (this: T2, oldValue: T2[P], newValue: T2[P], changes: any, element: T2) => void; }>) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "onAttributeChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: { [x: string]: (this: T2, oldValue: string, newValue: string, element: T2) => void; }) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } } ], "slots": [ { "name": "", "description": "" } ], "cssParts": [], "events": [ { "name": "window-resize", "type": { "text": "Event" } } ], "demos": [], "superclass": { "module": "core/CustomElement.js", "name": "default" }, "mixins": [ { "module": "mixins/ThemableMixin.js", "name": "default" }, { "module": "mixins/FlexboxMixin.js", "name": "default" }, { "module": "mixins/ElevationMixin.js", "name": "default" }, { "module": "mixins/ShapeMixin.js", "name": "default" }, { "module": "mixins/AriaReflectorMixin.js", "name": "default" }, { "module": "mixins/DelegatesFocusMixin.js", "name": "default" }, { "module": "mixins/ResizeObserverMixin.js", "name": "default" } ], "description": "Side sheets may be static.\nSide sheets may be modal while retaining their own position.\nSide sheets can have different modal and static max-sizes.\nSide sheets can be themed with background color and ink.\nSide sheets can be shaped.\nSide sheets do not have states\nSide sheets can have roles\nSide sheets delegate focus\nStatic side sheets push in and out content.\nModal side sheets slide in and out over content.\nModal side sheets anchor position does not need to match static position.\nModal side sheets must become \"dialog-like\", blocking access to all other elements on the screen.\nModal side sheets can display elevation" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "default", "module": "components/SideSheet.js" } }, { "kind": "custom-element-definition", "name": "mdw-side-sheet", "declaration": { "name": "default", "module": "components/SideSheet.js" } } ] }, { "kind": "javascript-module", "path": "components/Slider.js", "declarations": [ { "kind": "class", "name": "Slider", "tagName": "mdw-slider", "customElement": true, "attributes": [ { "name": "color", "fieldName": "color", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "ink", "fieldName": "ink", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "type-style", "fieldName": "typeStyle", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "disabled", "fieldName": "disabled", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "focused", "fieldName": "focused", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "hovered", "fieldName": "hovered", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "pressed", "fieldName": "pressed", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "aria-controls", "fieldName": "ariaControls", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "autocomplete", "fieldName": "autocomplete", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "name", "fieldName": "name", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "readonly", "fieldName": "readOnly", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "formnovalidate", "fieldName": "formNoValidate", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "checked", "fieldName": "defaultChecked", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "required", "fieldName": "required", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "value", "fieldName": "_defaultValue", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "aria-label", "fieldName": "ariaLabel", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "accept", "fieldName": "accept", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "alt", "fieldName": "alt", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "dirname", "fieldName": "dirName", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "formenctype", "fieldName": "formEnctype", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "formmethod", "fieldName": "formMethod", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "formtarget", "fieldName": "formTarget", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "max", "fieldName": "max", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "maxlength", "fieldName": "maxLength", "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "min", "fieldName": "min", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "minlength", "fieldName": "minLength", "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "multiple", "fieldName": "multiple", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "pattern", "fieldName": "pattern", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "placeholder", "fieldName": "placeholder", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "size", "fieldName": "size", "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "src", "fieldName": "src", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "step", "fieldName": "step", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "indeterminate", "fieldName": "indeterminate", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "ticks", "description": "Number of tick marks to show along the track (integer).", "fieldName": "ticks", "type": { "text": "number" } }, { "name": "thumb-label", "description": "Text to show in the thumb label; when null the numeric value is shown.", "fieldName": "thumbLabel", "type": { "text": "string" } }, { "name": "state-layer", "type": { "text": "boolean" }, "description": "Show the visual state layer element when true", "fieldName": "stateLayer", "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "type", "type": { "text": "string" }, "fieldName": "type", "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } } ], "members": [ { "name": "delegatesFocus", "kind": "field", "description": "When true, the element delegates focus to an internal focus target.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/DelegatesFocusMixin.js#L15" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "disabled", "kind": "field", "description": "Whether the element is disabled (affects interactive states)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L14" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "focused", "kind": "field", "description": "Force focus state (independent of document)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L16" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "hovered", "kind": "field", "description": "Force hover state (independent of interaction)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L18" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "pressed", "kind": "field", "description": "Force pressed state (independent of interaction)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L20" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "stateLayer", "kind": "field", "description": "Show the visual state layer element when true", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Slider.js#L45" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "disabledState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L171" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "hoveredState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L38" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "focusedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L39" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "pressedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L40" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "touchedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L41" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "pointedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L44" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "stateTargetElement", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ControlMixin.js#L66" }, "type": { "text": "HTMLElement" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "ariaControls", "kind": "field", "description": "ARIA 'controls' attribute (string).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L32" }, "type": { "text": "string" } }, { "name": "autocomplete", "kind": "field", "description": "Autocomplete token for the associated control (string).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L34" }, "type": { "text": "string" } }, { "name": "name", "kind": "field", "description": "Name attribute for the control used in forms.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L36" }, "type": { "text": "string" } }, { "name": "readOnly", "kind": "field", "description": "Read-only state reflected to control via 'readonly' attribute.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L38" }, "type": { "text": "boolean" } }, { "name": "formNoValidate", "kind": "field", "description": "When true, form validation is skipped for this control (formnovalidate).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L40" }, "type": { "text": "boolean" } }, { "name": "defaultChecked", "kind": "field", "description": "Default checked state for checkable controls (checkbox/radio).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L42" }, "type": { "text": "boolean" } }, { "name": "required", "kind": "field", "description": "Whether the control is required for form submission.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L47" }, "type": { "text": "boolean" } }, { "name": "type", "kind": "field", "description": "Control type token (e.g. 'text','checkbox','radio','file').", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Slider.js#L55" }, "type": { "text": "string" } }, { "name": "erroredState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L65" }, "type": { "text": "boolean" } }, { "name": "defaultValue", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L66" }, "type": { "text": "string" } }, { "name": "value", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L108" }, "type": { "text": "string" } }, { "name": "checked", "kind": "field", "description": "Part of FormAssociatedMixin for simplicity.\nEnumerability doesn't guarantee checked state will be passed or used.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L145" }, "type": { "text": "boolean" } }, { "name": "form", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L160" }, "type": { "text": "HTMLFormElement" } }, { "name": "validity", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L161" }, "type": { "text": "ValidityState" } }, { "name": "validationMessage", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L162" }, "type": { "text": "string" } }, { "name": "willValidate", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L163" }, "type": { "text": "boolean" } }, { "name": "labels", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L168" }, "type": { "text": "NodeList" } }, { "name": "focusableOnDisabled", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ControlMixin.js#L30" }, "type": { "text": "boolean" } }, { "name": "controlTagName", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L102" }, "type": { "text": "string" } }, { "name": "controlVoidElement", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ControlMixin.js#L32" }, "type": { "text": "boolean" } }, { "name": "accept", "kind": "field", "description": "Accepted file types for file input (e.g. '.png,.jpg').", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L41" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "alt", "kind": "field", "description": "Alternate text for images (for `type='image'`).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L43" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "dirName", "kind": "field", "description": "Directionality for form submission name (dirname attribute).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L45" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "formEnctype", "kind": "field", "description": "Form encoding type (formenctype).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L49" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "formMethod", "kind": "field", "description": "Form method when associated with a submit input (formmethod).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L51" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "formTarget", "kind": "field", "description": "Target browsing context for form submission (formtarget).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L53" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "max", "kind": "field", "description": "Max value or token for the input.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L58" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "maxLength", "kind": "field", "description": "Maximum length for text-like inputs.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L60" }, "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "min", "kind": "field", "description": "Min value or token for the input.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L62" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "minLength", "kind": "field", "description": "Minimum length for text-like inputs.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L64" }, "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "multiple", "kind": "field", "description": "When true, multiple values are allowed (e.g. file inputs).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L66" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "pattern", "kind": "field", "description": "Pattern used for validation (RegExp as string).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L68" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "placeholder", "kind": "field", "description": "Placeholder text shown when no value is present.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L70" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "size", "kind": "field", "description": "Suggested control size (number of characters).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L72" }, "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "src", "kind": "field", "description": "Source URL for image-type inputs.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L74" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "step", "kind": "field", "description": "Step interval for numeric inputs.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L76" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "indeterminate", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L89" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "files", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L371" }, "type": { "text": "FileList" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "selectionDirection", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L384" }, "type": { "text": "\"none\" | \"forward\" | \"backward\"" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "selectionEnd", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L389" }, "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "selectionStart", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L394" }, "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "valueAsDate", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L399" }, "type": { "text": "Date" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "valueAsNumber", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L407" }, "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "height", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L415" }, "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "formAction", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L423" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "width", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L431" }, "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "color", "kind": "field", "description": "Palette or surface token used to select background/ink tokens.\nExamples: 'primary', 'background', 'surface-container-low'.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L52" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "ink", "kind": "field", "description": "Explicit ink override token (e.g. 'outline', 'on-primary', 'inverse-on-surface', 'inherit').\nMaps to `--mdw-ink`.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L57" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "typeStyle", "kind": "field", "description": "Typographic style shortcut that maps to type scale variables\n(e.g. 'headline-large', 'body-medium').", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L62" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "ticks", "kind": "field", "description": "Number of tick marks to show along the track (integer).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Slider.js#L50" }, "type": { "text": "number" } }, { "name": "thumbLabel", "kind": "field", "description": "Text to show in the thumb label; when null the numeric value is shown.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Slider.js#L54" }, "type": { "text": "string" } }, { "name": "onControlMouseOrTouch", "kind": "method", "description": "Handle pointer or touch interactions on the native control to compute\nposition and update the intermediate rounded value while dragging.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Slider.js#L72" }, "return": { "type": { "text": "(event: (MouseEvent | TouchEvent) & { currentTarget: HTMLInputElement; }) => void" } } }, { "name": "onLeaveEvent", "kind": "method", "description": "Pointer leave/blur handler for the control; hides the thumb label when focus is lost.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Slider.js#L174" }, "return": { "type": { "text": "({ currentTarget }: Event) => void" } } }, { "name": "onControlFinish", "kind": "method", "description": "Finalize interaction with the control: commit the rounded value to the\nnative input and dispatch a `change` event if the value changed.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Slider.js#L185" }, "return": { "type": { "text": "(event: (MouseEvent | TouchEvent) & { currentTarget: HTMLInputElement; }) => void" } } }, { "name": "computeTrackStyle", "kind": "method", "description": "Compute inline style variables for the track, including ticks and value fraction.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Slider.js#L227" }, "return": { "type": { "text": "() => string" } } }, { "name": "prototype", "kind": "field", "static": true, "type": { "text": "CustomElement" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "performImplicitSubmission", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L175" }, "return": { "type": { "text": "(event: Event) => void" } }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "setRangeText", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L345" }, "return": { "type": { "text": "{ (replacement: string): void; (replacement: string, start: number, end: number, selectionMode?: SelectionMode): void; }" } }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "setSelectionRange", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L348" }, "return": { "type": { "text": "(start: number, end: number, direction?: \"none\" | \"forward\" | \"backward\") => void" } }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "showPicker", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L351" }, "return": { "type": { "text": "() => void" } }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "stepDown", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L354" }, "return": { "type": { "text": "(n?: number) => void" } }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "stepUp", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L360" }, "return": { "type": { "text": "(n?: number) => void" } }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "select", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L366" }, "return": { "type": { "text": "() => void" } }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "compose", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L145" }, "type": { "text": "(parts: CompositionPart[]) => Composition" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#refsProxy", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1145" }, "type": { "text": "Record" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#refsCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1148" }, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#refsCompositionCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1151" }, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#composition", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1154" }, "type": { "text": "Composition" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#patching", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1156" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#pendingPatchRenders", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1159" }, "type": { "text": "[string, any, CustomElement][]" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#propAttributeCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1162" }, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#callbackArguments", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1165" }, "type": { "text": "CallbackArguments" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "elementInternals", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1172" }, "type": { "text": "ElementInternals" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "render", "kind": "field", "description": "Updates nodes based on data\nExpects data in JSON Merge Patch format", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1185" }, "type": { "text": "RenderDraw" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "propChangedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1213" }, "type": { "text": "(this: T, name: K, oldValue: K extends keyof T ? T[K] : unknown, newValue: K extends keyof T ? T[K] : unknown, changes?: K extends keyof T ? T[K] extends object ? Partial : T[K] : unknown) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attributeChangedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1234" }, "type": { "text": "(name: string, oldValue: string, newValue: string) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#template", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1284" }, "type": { "text": "DocumentFragment" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#onObserverPropertyChanged", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1294" }, "type": { "text": "(name: string, oldValue: any, newValue: any, changes: any) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "static", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1330" }, "type": { "text": "typeof CustomElement" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "patch", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1333" }, "type": { "text": "(patch: any) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "refs", "kind": "field", "description": "Proxy object that returns shadow DOM elements by tag.\nIf called before interpolation (eg: on composed), returns from template", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1404" }, "type": { "text": "Record" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attributeCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1391" }, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "callbackArguments", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1400" }, "type": { "text": "CallbackArguments | { composition: Composition; refs: Record; html: any; inline: (fn: (data: Partial) => any) => string; template: DocumentFragment; element: T; }" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "composition", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1403" }, "type": { "text": "Composition" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "connectedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1435" }, "type": { "text": "() => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "disconnectedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1441" }, "type": { "text": "() => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "elementName", "kind": "field", "static": true, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "observedAttributes", "kind": "field", "static": true, "type": { "text": "Iterable" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "interpolatesTemplate", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "supportsElementInternals", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "supportsElementInternalsRole", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "defined", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "registrations", "kind": "field", "static": true, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "expressions", "kind": "method", "static": true, "description": "Expressions are idempotent functions that are selectively called whenever\na render is requested.\nExpressions are constructed exactly as methods though differ in expected\narguments. The first argument should be destructured to ensure each used\nproperty is accessed at least once in order to inspect used properties.\n\nThe Composition API will inspect this function with a proxy for `this` to\ncatalog what observables are used by the expression. This allows the\nComposition API to build a cache as well as selective invoke the expression\nonly when needed.\n\nWhen used with in element templates, the element itself will be passed as\nits first argument.\n````js\n Button\n .prop('filled', 'boolean')\n .prop('outlined', 'boolean')\n .expresssions({\n _isFilledOrOutlined({filled, outlined}) {\n return (filled || outlined)\n },\n })\n .html`
`;\n````\n\nWhen used with external data source, that data source\nwill be passed to the expression with all properties being `null` at first\ninspection.\n````js\n const externalData = {first: 'John', last: 'Doe'};\n ContactCard\n .expresssions({\n _fullName({first, last}) {\n return [first, last].filter(Boolean).join(' ');\n },\n })\n myButton.render(externalData);\n````\n\nExpressions may be support argumentless calls by using default\nparameters with `this`.\n````js\n Button\n .expresssions({\n isFilledOrOutlined({filled, outlined} = this) {\n return (filled || outlined)\n },\n });\n myButton.isFilledorOutlined();\n````", "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends { [K in keyof any]: K extends `_${any}` ? ((data: INSTANCE, state?: Record) => string | boolean | null) : ((data?: INSTANCE, state?: Record) => string | boolean | null); } & ThisType>(this: CLASS, expressions: PROPS & ThisType) => CLASS & Class<{ [K in keyof PROPS]: K extends `_${any}` ? never : () => ReturnType; }, ARGS>" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "methods", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "overrides", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends Partial>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "props", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "idl", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "append", "kind": "field", "static": true, "description": "Append parts to composition", "type": { "text": "(this: T, ...parts: CompositionPart[]) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "recompose", "kind": "field", "static": true, "description": "After composition, invokes callback.\nMay be called multiple times.", "type": { "text": ", T3 extends CompositionCallback[\"composed\"]>(this: T1, callback: T3) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "css", "kind": "field", "static": true, "description": "Appends styles to composition", "type": { "text": "(this: T1, array: T2, ...rest: T2 extends string ? any : T2 extends TemplateStringsArray ? any[] : (HTMLStyleElement | CSSStyleSheet)[]) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "autoRegister", "kind": "field", "static": true, "description": "Registers class with customElements. If class is registered before then,\ndoes nothing.", "type": { "text": "(this: T, elementName: string) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "html", "kind": "field", "static": true, "description": "Appends DocumentFragment to composition", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1405" }, "type": { "text": "(this: T, string: TemplateStringsArray, ...substitutions: (string | Element | ((this: InstanceType, data: InstanceType, injections?: any) => any))[]) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "extend", "kind": "field", "static": true, "description": "Extends base class into a new class.\nUse to avoid mutating base class.", "type": { "text": " T2>(this: T1, customExtender?: T3) => T3 extends null ? T1 : T2" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "setStatic", "kind": "field", "static": true, "description": "Assigns static values to class", "type": { "text": " any) | string | number | boolean | any[] | object); }>(this: T1, source: T2 & ThisType) => T1 & T2" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "readonly", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "set", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "mixin", "kind": "field", "static": true, "description": "Returns result of calling mixin with current class", "type": { "text": " any, RETURN extends ReturnType, SUBCLASS extends ClassOf>(this: BASE, mixin: FN) => SUBCLASS & BASE" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "register", "kind": "field", "static": true, "description": "Registers class with window.customElements synchronously", "type": { "text": "(this: T, elementName?: string, force?: boolean) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "propList", "kind": "field", "static": true, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attrList", "kind": "field", "static": true, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "propChangedCallbacks", "kind": "field", "static": true, "type": { "text": "Map any)[]>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attributeChangedCallbacks", "kind": "field", "static": true, "type": { "text": "Map any)[]>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "prop", "kind": "field", "static": true, "description": "Creates observable property on instances (via prototype)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1007" }, "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "setPrototype", "kind": "field", "static": true, "description": "Creates observable property on instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any)>(this: CLASS, name: KEY, options: OPTIONS) => OPTIONS extends (...args2: any[]) => infer R ? R : OPTIONS extends ObserverPropertyType ? ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? unknown extends R ? object : R : OPTIONS extends { type: ObserverPropertyType; } ? ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? unknown extends R ? string : R : never" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "define", "kind": "field", "static": true, "description": "Define properties on instances via Object.defineProperties().\nAutomatically sets property non-enumerable if name begins with `_`.\nFunctions will be remapped as getters", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends { [P in keyof any]: { enumerable?: boolean; configurable?: boolean; writable?: boolean; value?: any; get?: ((this: INSTANCE) => any); set?: (this: INSTANCE, value: any) => void; } | ((this: INSTANCE, ...args: any[]) => any); }, VALUE extends { [KEY in keyof PROPS]: PROPS[KEY] extends (...args2: any[]) => infer R ? R : PROPS[KEY] extends TypedPropertyDescriptor ? R : never; }>(this: CLASS, props: PROPS & ThisType) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "undefine", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROP extends string, PROPS extends INSTANCE & Record>(this: CLASS, name: PROP) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "observe", "kind": "field", "static": true, "description": "Creates observable properties on instances", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends IDLParameter, VALUE extends { [KEY in keyof PROPS]: PROPS[KEY] extends (...args2: any[]) => infer R ? R : PROPS[KEY] extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : PROPS[KEY] extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : PROPS[KEY] extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : PROPS[KEY] extends ObserverOptions ? (unknown extends R ? string : R) : never; }>(this: CLASS, props: PROPS) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "defineStatic", "kind": "field", "static": true, "type": { "text": ">(this: T1, props: T2) => T1 & ParsedProps" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "events", "kind": "field", "static": true, "type": { "text": "(this: T, listeners?: CompositionEventListenerObject>, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "childEvents", "kind": "field", "static": true, "type": { "text": "(this: T, listenerMap: { [x: string]: CompositionEventListenerObject>; }, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "rootEvents", "kind": "field", "static": true, "type": { "text": "(this: T, listeners?: CompositionEventListenerObject>, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "on", "kind": "field", "static": true, "type": { "text": ", T3 extends CompositionCallback, T4 extends keyof T3>(this: T1, name: T3 | T4, callbacks?: T3[T4] & ThisType) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "off", "kind": "field", "static": true, "type": { "text": ", T3 extends CompositionCallback, T4 extends keyof T3>(this: T1, name: T3 | T4, callbacks?: T3[T4] & ThisType) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "offPropChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: ObjectOrObjectEntries<{ [P in keyof T2]?: (this: T2, oldValue: T2[P], newValue: T2[P], changes: any, element: T2) => void; }>) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "offAttributeChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: { [x: string]: (this: T2, oldValue: string, newValue: string, element: T2) => void; }) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "onPropChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: ObjectOrObjectEntries<{ [P in keyof T2]?: (this: T2, oldValue: T2[P], newValue: T2[P], changes: any, element: T2) => void; }>) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "onAttributeChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: { [x: string]: (this: T2, oldValue: string, newValue: string, element: T2) => void; }) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } } ], "slots": [], "cssParts": [ { "name": "control" } ], "events": [ { "name": "control-mouse-or-touch", "type": { "text": "Event" } }, { "name": "leave-event", "type": { "text": "Event" } }, { "name": "control-finish", "type": { "text": "Event" } } ], "demos": [ { "url": "demo/components/sliders.html" } ], "superclass": { "module": "core/CustomElement.js", "name": "default" }, "mixins": [ { "module": "mixins/ThemableMixin.js", "name": "default" }, { "module": "mixins/StateMixin.js", "name": "default" }, { "module": "mixins/InputMixin.js", "name": "default" } ], "description": "@param {string} value\n@param {number} onNaN\n@return {number}" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "default", "module": "components/Slider.js" } }, { "kind": "custom-element-definition", "name": "mdw-slider", "declaration": { "name": "default", "module": "components/Slider.js" } } ] }, { "kind": "javascript-module", "path": "components/Snackbar.js", "declarations": [ { "kind": "class", "name": "Snackbar", "tagName": "mdw-snackbar", "customElement": true, "attributes": [ { "name": "color", "fieldName": "color", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "ink", "fieldName": "ink", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "type-style", "fieldName": "typeStyle", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "shape-top", "fieldName": "shapeTop", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shape-bottom", "fieldName": "shapeBottom", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shape-start", "fieldName": "shapeStart", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shape-end", "fieldName": "shapeEnd", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shape-style", "fieldName": "shapeStyle", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "outlined", "fieldName": "outlined", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "density", "fieldName": "density", "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "mixins/DensityMixin.js" } }, { "name": "open", "description": "Whether the snackbar is visible.", "fieldName": "open", "type": { "text": "boolean" } }, { "name": "persistent", "description": "When true the snackbar does not auto-dismiss.", "fieldName": "persistent", "type": { "text": "boolean" } }, { "name": "action", "fieldName": "action", "type": { "text": "string" } }, { "name": "action-ink", "description": "Ink token used for the action button (defaults to inverse-primary).", "fieldName": "actionInk", "type": { "text": "string" } }, { "name": "action-type-style", "description": "Typographic style used for the action (e.g. 'label-large').", "fieldName": "actionTypeStyle", "type": { "text": "string" } }, { "name": "close-button", "description": "Render a close icon button when true.", "fieldName": "closeButton", "type": { "text": "boolean" } }, { "name": "close-icon", "description": "Icon name used for the close button.", "fieldName": "closeIcon", "type": { "text": "string" } }, { "name": "close-ink", "description": "Ink token used for the close icon.", "fieldName": "closeInk", "type": { "text": "string" } }, { "name": "onaction", "description": "Event handler invoked when the action is triggered.", "fieldName": "onaction", "type": { "text": "function" } }, { "name": "ontoggle", "description": "Event handler invoked when the snackbar toggles open/closed.", "fieldName": "ontoggle", "type": { "text": "function" } } ], "members": [ { "name": "disabled", "kind": "field", "description": "Whether the element is disabled (affects interactive states)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L14" }, "type": { "text": "boolean" } }, { "name": "focused", "kind": "field", "description": "Force focus state (independent of document)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L16" }, "type": { "text": "boolean" } }, { "name": "hovered", "kind": "field", "description": "Force hover state (independent of interaction)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L18" }, "type": { "text": "boolean" } }, { "name": "pressed", "kind": "field", "description": "Force pressed state (independent of interaction)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L20" }, "type": { "text": "boolean" } }, { "name": "stateLayer", "kind": "field", "description": "Show the visual state layer element when true", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L34" }, "type": { "text": "boolean" } }, { "name": "disabledState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L37" }, "type": { "text": "boolean" } }, { "name": "hoveredState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L38" }, "type": { "text": "boolean" } }, { "name": "focusedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L39" }, "type": { "text": "boolean" } }, { "name": "pressedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L40" }, "type": { "text": "boolean" } }, { "name": "touchedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L41" }, "type": { "text": "boolean" } }, { "name": "pointedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L44" }, "type": { "text": "boolean" } }, { "name": "stateTargetElement", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L50" }, "type": { "text": "HTMLElement" } }, { "name": "color", "kind": "field", "description": "Palette or surface token used to select background/ink tokens.\nExamples: 'primary', 'background', 'surface-container-low'.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L52" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "ink", "kind": "field", "description": "Explicit ink override token (e.g. 'outline', 'on-primary', 'inverse-on-surface', 'inherit').\nMaps to `--mdw-ink`.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L57" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "typeStyle", "kind": "field", "description": "Typographic style shortcut that maps to type scale variables\n(e.g. 'headline-large', 'body-medium').", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L62" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "density", "kind": "field", "description": "Density level affecting spacing and compactness. Integer from -4 (dense) to 4 (spacious).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/DensityMixin.js#L9" }, "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "mixins/DensityMixin.js" } }, { "name": "shapeTop", "kind": "field", "description": "Show top cut/shape on the element", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L9" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shapeBottom", "kind": "field", "description": "Show bottom cut/shape on the element", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L11" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shapeStart", "kind": "field", "description": "Show start-side cut/shape (logical start)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L13" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shapeEnd", "kind": "field", "description": "Show end-side cut/shape (logical end)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L15" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shapeStyle", "kind": "field", "description": "Predefined shape size/style name (none|extra-small|small|medium|large|extra-large|full|inherit)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L17" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "outlined", "kind": "field", "description": "When true, an outline is rendered around the element", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L19" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "elevated", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Snackbar.js#L27" }, "type": { "text": "boolean" } }, { "name": "open", "kind": "field", "description": "Whether the snackbar is visible.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Snackbar.js#L31" }, "type": { "text": "boolean" } }, { "name": "persistent", "kind": "field", "description": "When true the snackbar does not auto-dismiss.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Snackbar.js#L33" }, "type": { "text": "boolean" } }, { "name": "action", "kind": "field", "description": "Optional action label to display as a button.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Snackbar.js#L83" }, "type": { "text": "string" } }, { "name": "actionInk", "kind": "field", "description": "Ink token used for the action button (defaults to inverse-primary).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Snackbar.js#L37" }, "type": { "text": "string" } }, { "name": "actionTypeStyle", "kind": "field", "description": "Typographic style used for the action (e.g. 'label-large').", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Snackbar.js#L39" }, "type": { "text": "string" } }, { "name": "closeButton", "kind": "field", "description": "Render a close icon button when true.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Snackbar.js#L41" }, "type": { "text": "boolean" } }, { "name": "closeIcon", "kind": "field", "description": "Icon name used for the close button.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Snackbar.js#L43" }, "type": { "text": "string" } }, { "name": "closeInk", "kind": "field", "description": "Ink token used for the close icon.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Snackbar.js#L45" }, "type": { "text": "string" } }, { "name": "onaction", "kind": "field", "description": "Event handler invoked when the action is triggered.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Snackbar.js#L47" }, "type": { "text": "EventListener" } }, { "name": "close", "kind": "method", "description": "Close the snackbar. Dispatches a cancelable `close` event; if not\nprevented the snackbar will hide and await the closing transition.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Snackbar.js#L89" }, "return": { "type": { "text": "() => Promise" } } }, { "name": "show", "kind": "method", "description": "Show the snackbar (set `open` true).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Snackbar.js#L66" }, "return": { "type": { "text": "() => void" } } }, { "name": "update", "kind": "method", "description": "Update the snackbar text content.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Snackbar.js#L73" }, "return": { "type": { "text": "(text: string) => void" } } }, { "name": "prototype", "kind": "field", "static": true, "type": { "text": "CustomElement" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "readAriaProperty", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/AriaReflectorMixin.js#L28" }, "return": { "type": { "text": "(name: \"shadowRoot\" | \"ariaActiveDescendantElement\" | \"ariaAtomic\" | \"ariaAutoComplete\" | \"ariaBrailleLabel\" | \"ariaBrailleRoleDescription\" | \"ariaBusy\" | \"ariaChecked\" | \"ariaColCount\" | \"ariaColIndex\" | \"ariaColIndexText\" | \"ariaColSpan\" | \"ariaControlsElements\" | \"ariaCurrent\" | \"ariaDescribedByElements\" | \"ariaDescription\" | \"ariaDetailsElements\" | \"ariaDisabled\" | \"ariaErrorMessageElements\" | \"ariaExpanded\" | \"ariaFlowToElements\" | \"ariaHasPopup\" | \"ariaHidden\" | \"ariaInvalid\" | \"ariaKeyShortcuts\" | \"ariaLabel\" | \"ariaLabelledByElements\" | \"ariaLevel\" | \"ariaLive\" | \"ariaModal\" | \"ariaMultiLine\" | \"ariaMultiSelectable\" | \"ariaOrientation\" | \"ariaOwnsElements\" | \"ariaPlaceholder\" | \"ariaPosInSet\" | \"ariaPressed\" | \"ariaReadOnly\" | \"ariaRelevant\" | \"ariaRequired\" | \"ariaRoleDescription\" | \"ariaRowCount\" | \"ariaRowIndex\" | \"ariaRowIndexText\" | \"ariaRowSpan\" | \"ariaSelected\" | \"ariaSetSize\" | \"ariaSort\" | \"ariaValueMax\" | \"ariaValueMin\" | \"ariaValueNow\" | \"ariaValueText\" | \"role\") => string | Element | ShadowRoot | readonly Element[]" } }, "inheritedFrom": { "name": "default", "module": "mixins/AriaReflectorMixin.js" } }, { "name": "updateAriaProperty", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/AriaReflectorMixin.js#L47" }, "return": { "type": { "text": ">(name: K, value: ARIAMixin[K]) => void" } }, "inheritedFrom": { "name": "default", "module": "mixins/AriaReflectorMixin.js" } }, { "name": "compose", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L145" }, "type": { "text": "(parts: CompositionPart[]) => Composition" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#refsProxy", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1145" }, "type": { "text": "Record" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#refsCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1148" }, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#refsCompositionCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1151" }, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#composition", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1154" }, "type": { "text": "Composition" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#patching", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1156" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#pendingPatchRenders", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1159" }, "type": { "text": "[string, any, CustomElement][]" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#propAttributeCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1162" }, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#callbackArguments", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1165" }, "type": { "text": "CallbackArguments" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "elementInternals", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1172" }, "type": { "text": "ElementInternals" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "render", "kind": "field", "description": "Updates nodes based on data\nExpects data in JSON Merge Patch format", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1185" }, "type": { "text": "RenderDraw" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "propChangedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1213" }, "type": { "text": "(this: T, name: K, oldValue: K extends keyof T ? T[K] : unknown, newValue: K extends keyof T ? T[K] : unknown, changes?: K extends keyof T ? T[K] extends object ? Partial : T[K] : unknown) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attributeChangedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1234" }, "type": { "text": "(name: string, oldValue: string, newValue: string) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#template", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1284" }, "type": { "text": "DocumentFragment" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#onObserverPropertyChanged", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1294" }, "type": { "text": "(name: string, oldValue: any, newValue: any, changes: any) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "static", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1330" }, "type": { "text": "typeof CustomElement" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "patch", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1333" }, "type": { "text": "(patch: any) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "refs", "kind": "field", "description": "Proxy object that returns shadow DOM elements by tag.\nIf called before interpolation (eg: on composed), returns from template", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1404" }, "type": { "text": "Record" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attributeCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1391" }, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "callbackArguments", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1400" }, "type": { "text": "CallbackArguments | { composition: Composition; refs: Record; html: any; inline: (fn: (data: Partial) => any) => string; template: DocumentFragment; element: T; }" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "composition", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1403" }, "type": { "text": "Composition" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "connectedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1435" }, "type": { "text": "() => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "disconnectedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1441" }, "type": { "text": "() => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "delegatesFocus", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1175" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "elementName", "kind": "field", "static": true, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "observedAttributes", "kind": "field", "static": true, "type": { "text": "Iterable" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "interpolatesTemplate", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "supportsElementInternals", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "supportsElementInternalsRole", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "defined", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "registrations", "kind": "field", "static": true, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "expressions", "kind": "method", "static": true, "description": "Expressions are idempotent functions that are selectively called whenever\na render is requested.\nExpressions are constructed exactly as methods though differ in expected\narguments. The first argument should be destructured to ensure each used\nproperty is accessed at least once in order to inspect used properties.\n\nThe Composition API will inspect this function with a proxy for `this` to\ncatalog what observables are used by the expression. This allows the\nComposition API to build a cache as well as selective invoke the expression\nonly when needed.\n\nWhen used with in element templates, the element itself will be passed as\nits first argument.\n````js\n Button\n .prop('filled', 'boolean')\n .prop('outlined', 'boolean')\n .expresssions({\n _isFilledOrOutlined({filled, outlined}) {\n return (filled || outlined)\n },\n })\n .html`
`;\n````\n\nWhen used with external data source, that data source\nwill be passed to the expression with all properties being `null` at first\ninspection.\n````js\n const externalData = {first: 'John', last: 'Doe'};\n ContactCard\n .expresssions({\n _fullName({first, last}) {\n return [first, last].filter(Boolean).join(' ');\n },\n })\n myButton.render(externalData);\n````\n\nExpressions may be support argumentless calls by using default\nparameters with `this`.\n````js\n Button\n .expresssions({\n isFilledOrOutlined({filled, outlined} = this) {\n return (filled || outlined)\n },\n });\n myButton.isFilledorOutlined();\n````", "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends { [K in keyof any]: K extends `_${any}` ? ((data: INSTANCE, state?: Record) => string | boolean | null) : ((data?: INSTANCE, state?: Record) => string | boolean | null); } & ThisType>(this: CLASS, expressions: PROPS & ThisType) => CLASS & Class<{ [K in keyof PROPS]: K extends `_${any}` ? never : () => ReturnType; }, ARGS>" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "methods", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "overrides", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends Partial>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "props", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "idl", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "append", "kind": "field", "static": true, "description": "Append parts to composition", "type": { "text": "(this: T, ...parts: CompositionPart[]) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "recompose", "kind": "field", "static": true, "description": "After composition, invokes callback.\nMay be called multiple times.", "type": { "text": ", T3 extends CompositionCallback[\"composed\"]>(this: T1, callback: T3) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "css", "kind": "field", "static": true, "description": "Appends styles to composition", "type": { "text": "(this: T1, array: T2, ...rest: T2 extends string ? any : T2 extends TemplateStringsArray ? any[] : (HTMLStyleElement | CSSStyleSheet)[]) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "autoRegister", "kind": "field", "static": true, "description": "Registers class with customElements. If class is registered before then,\ndoes nothing.", "type": { "text": "(this: T, elementName: string) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "html", "kind": "field", "static": true, "description": "Appends DocumentFragment to composition", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1405" }, "type": { "text": "(this: T, string: TemplateStringsArray, ...substitutions: (string | Element | ((this: InstanceType, data: InstanceType, injections?: any) => any))[]) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "extend", "kind": "field", "static": true, "description": "Extends base class into a new class.\nUse to avoid mutating base class.", "type": { "text": " T2>(this: T1, customExtender?: T3) => T3 extends null ? T1 : T2" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "setStatic", "kind": "field", "static": true, "description": "Assigns static values to class", "type": { "text": " any) | string | number | boolean | any[] | object); }>(this: T1, source: T2 & ThisType) => T1 & T2" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "readonly", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "set", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "mixin", "kind": "field", "static": true, "description": "Returns result of calling mixin with current class", "type": { "text": " any, RETURN extends ReturnType, SUBCLASS extends ClassOf>(this: BASE, mixin: FN) => SUBCLASS & BASE" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "register", "kind": "field", "static": true, "description": "Registers class with window.customElements synchronously", "type": { "text": "(this: T, elementName?: string, force?: boolean) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "propList", "kind": "field", "static": true, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attrList", "kind": "field", "static": true, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "propChangedCallbacks", "kind": "field", "static": true, "type": { "text": "Map any)[]>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attributeChangedCallbacks", "kind": "field", "static": true, "type": { "text": "Map any)[]>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "prop", "kind": "field", "static": true, "description": "Creates observable property on instances (via prototype)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1007" }, "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "setPrototype", "kind": "field", "static": true, "description": "Creates observable property on instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any)>(this: CLASS, name: KEY, options: OPTIONS) => OPTIONS extends (...args2: any[]) => infer R ? R : OPTIONS extends ObserverPropertyType ? ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? unknown extends R ? object : R : OPTIONS extends { type: ObserverPropertyType; } ? ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? unknown extends R ? string : R : never" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "define", "kind": "field", "static": true, "description": "Define properties on instances via Object.defineProperties().\nAutomatically sets property non-enumerable if name begins with `_`.\nFunctions will be remapped as getters", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends { [P in keyof any]: { enumerable?: boolean; configurable?: boolean; writable?: boolean; value?: any; get?: ((this: INSTANCE) => any); set?: (this: INSTANCE, value: any) => void; } | ((this: INSTANCE, ...args: any[]) => any); }, VALUE extends { [KEY in keyof PROPS]: PROPS[KEY] extends (...args2: any[]) => infer R ? R : PROPS[KEY] extends TypedPropertyDescriptor ? R : never; }>(this: CLASS, props: PROPS & ThisType) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "undefine", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROP extends string, PROPS extends INSTANCE & Record>(this: CLASS, name: PROP) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "observe", "kind": "field", "static": true, "description": "Creates observable properties on instances", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends IDLParameter, VALUE extends { [KEY in keyof PROPS]: PROPS[KEY] extends (...args2: any[]) => infer R ? R : PROPS[KEY] extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : PROPS[KEY] extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : PROPS[KEY] extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : PROPS[KEY] extends ObserverOptions ? (unknown extends R ? string : R) : never; }>(this: CLASS, props: PROPS) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "defineStatic", "kind": "field", "static": true, "type": { "text": ">(this: T1, props: T2) => T1 & ParsedProps" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "events", "kind": "field", "static": true, "type": { "text": "(this: T, listeners?: CompositionEventListenerObject>, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "childEvents", "kind": "field", "static": true, "type": { "text": "(this: T, listenerMap: { [x: string]: CompositionEventListenerObject>; }, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "rootEvents", "kind": "field", "static": true, "type": { "text": "(this: T, listeners?: CompositionEventListenerObject>, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "on", "kind": "field", "static": true, "type": { "text": ", T3 extends CompositionCallback, T4 extends keyof T3>(this: T1, name: T3 | T4, callbacks?: T3[T4] & ThisType) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "off", "kind": "field", "static": true, "type": { "text": ", T3 extends CompositionCallback, T4 extends keyof T3>(this: T1, name: T3 | T4, callbacks?: T3[T4] & ThisType) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "offPropChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: ObjectOrObjectEntries<{ [P in keyof T2]?: (this: T2, oldValue: T2[P], newValue: T2[P], changes: any, element: T2) => void; }>) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "offAttributeChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: { [x: string]: (this: T2, oldValue: string, newValue: string, element: T2) => void; }) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "onPropChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: ObjectOrObjectEntries<{ [P in keyof T2]?: (this: T2, oldValue: T2[P], newValue: T2[P], changes: any, element: T2) => void; }>) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "onAttributeChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: { [x: string]: (this: T2, oldValue: string, newValue: string, element: T2) => void; }) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } } ], "slots": [ { "name": "", "description": "" } ], "cssParts": [], "events": [ { "name": "action", "type": { "text": "Event" } } ], "demos": [ { "url": "demo/components/snackbar.html" } ], "superclass": { "module": "core/CustomElement.js", "name": "default" }, "mixins": [ { "module": "mixins/ThemableMixin.js", "name": "default" }, { "module": "mixins/ShapeMixin.js", "name": "default" }, { "module": "mixins/DensityMixin.js", "name": "default" }, { "module": "mixins/AriaReflectorMixin.js", "name": "default" }, { "module": "mixins/ElevationMixin.js", "name": "default" } ], "description": "Snackbars provide brief messages about app processes and optional actions.\n@see https://m3.material.io/components/snackbar/specs" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "default", "module": "components/Snackbar.js" } }, { "kind": "custom-element-definition", "name": "mdw-snackbar", "declaration": { "name": "default", "module": "components/Snackbar.js" } } ] }, { "kind": "javascript-module", "path": "components/SnackbarContainer.js", "declarations": [ { "kind": "class", "name": "SnackbarContainer", "tagName": "mdw-snackbar-container", "customElement": true, "attributes": [], "members": [ { "name": "delegatesFocus", "kind": "field", "description": "When true, the element delegates focus to an internal focus target.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/DelegatesFocusMixin.js#L15" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "prototype", "kind": "field", "static": true, "type": { "text": "CustomElement" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "compose", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L145" }, "type": { "text": "(parts: CompositionPart[]) => Composition" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#refsProxy", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1145" }, "type": { "text": "Record" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#refsCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1148" }, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#refsCompositionCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1151" }, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#composition", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1154" }, "type": { "text": "Composition" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#patching", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1156" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#pendingPatchRenders", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1159" }, "type": { "text": "[string, any, CustomElement][]" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#propAttributeCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1162" }, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#callbackArguments", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1165" }, "type": { "text": "CallbackArguments" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "elementInternals", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1172" }, "type": { "text": "ElementInternals" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "render", "kind": "field", "description": "Updates nodes based on data\nExpects data in JSON Merge Patch format", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1185" }, "type": { "text": "RenderDraw" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "propChangedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1213" }, "type": { "text": "(this: T, name: K, oldValue: K extends keyof T ? T[K] : unknown, newValue: K extends keyof T ? T[K] : unknown, changes?: K extends keyof T ? T[K] extends object ? Partial : T[K] : unknown) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attributeChangedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1234" }, "type": { "text": "(name: string, oldValue: string, newValue: string) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#template", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1284" }, "type": { "text": "DocumentFragment" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#onObserverPropertyChanged", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1294" }, "type": { "text": "(name: string, oldValue: any, newValue: any, changes: any) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "static", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1330" }, "type": { "text": "typeof CustomElement" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "patch", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1333" }, "type": { "text": "(patch: any) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "refs", "kind": "field", "description": "Proxy object that returns shadow DOM elements by tag.\nIf called before interpolation (eg: on composed), returns from template", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1404" }, "type": { "text": "Record" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attributeCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1391" }, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "callbackArguments", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1400" }, "type": { "text": "CallbackArguments | { composition: Composition; refs: Record; html: any; inline: (fn: (data: Partial) => any) => string; template: DocumentFragment; element: T; }" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "composition", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1403" }, "type": { "text": "Composition" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "connectedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1435" }, "type": { "text": "() => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "disconnectedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1441" }, "type": { "text": "() => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "elementName", "kind": "field", "static": true, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "observedAttributes", "kind": "field", "static": true, "type": { "text": "Iterable" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "interpolatesTemplate", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "supportsElementInternals", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "supportsElementInternalsRole", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "defined", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "registrations", "kind": "field", "static": true, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "expressions", "kind": "method", "static": true, "description": "Expressions are idempotent functions that are selectively called whenever\na render is requested.\nExpressions are constructed exactly as methods though differ in expected\narguments. The first argument should be destructured to ensure each used\nproperty is accessed at least once in order to inspect used properties.\n\nThe Composition API will inspect this function with a proxy for `this` to\ncatalog what observables are used by the expression. This allows the\nComposition API to build a cache as well as selective invoke the expression\nonly when needed.\n\nWhen used with in element templates, the element itself will be passed as\nits first argument.\n````js\n Button\n .prop('filled', 'boolean')\n .prop('outlined', 'boolean')\n .expresssions({\n _isFilledOrOutlined({filled, outlined}) {\n return (filled || outlined)\n },\n })\n .html`
`;\n````\n\nWhen used with external data source, that data source\nwill be passed to the expression with all properties being `null` at first\ninspection.\n````js\n const externalData = {first: 'John', last: 'Doe'};\n ContactCard\n .expresssions({\n _fullName({first, last}) {\n return [first, last].filter(Boolean).join(' ');\n },\n })\n myButton.render(externalData);\n````\n\nExpressions may be support argumentless calls by using default\nparameters with `this`.\n````js\n Button\n .expresssions({\n isFilledOrOutlined({filled, outlined} = this) {\n return (filled || outlined)\n },\n });\n myButton.isFilledorOutlined();\n````", "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends { [K in keyof any]: K extends `_${any}` ? ((data: INSTANCE, state?: Record) => string | boolean | null) : ((data?: INSTANCE, state?: Record) => string | boolean | null); } & ThisType>(this: CLASS, expressions: PROPS & ThisType) => CLASS & Class<{ [K in keyof PROPS]: K extends `_${any}` ? never : () => ReturnType; }, ARGS>" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "methods", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "overrides", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends Partial>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "props", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "idl", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "append", "kind": "field", "static": true, "description": "Append parts to composition", "type": { "text": "(this: T, ...parts: CompositionPart[]) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "recompose", "kind": "field", "static": true, "description": "After composition, invokes callback.\nMay be called multiple times.", "type": { "text": ", T3 extends CompositionCallback[\"composed\"]>(this: T1, callback: T3) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "css", "kind": "field", "static": true, "description": "Appends styles to composition", "type": { "text": "(this: T1, array: T2, ...rest: T2 extends string ? any : T2 extends TemplateStringsArray ? any[] : (HTMLStyleElement | CSSStyleSheet)[]) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "autoRegister", "kind": "field", "static": true, "description": "Registers class with customElements. If class is registered before then,\ndoes nothing.", "type": { "text": "(this: T, elementName: string) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "html", "kind": "field", "static": true, "description": "Appends DocumentFragment to composition", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1405" }, "type": { "text": "(this: T, string: TemplateStringsArray, ...substitutions: (string | Element | ((this: InstanceType, data: InstanceType, injections?: any) => any))[]) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "extend", "kind": "field", "static": true, "description": "Extends base class into a new class.\nUse to avoid mutating base class.", "type": { "text": " T2>(this: T1, customExtender?: T3) => T3 extends null ? T1 : T2" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "setStatic", "kind": "field", "static": true, "description": "Assigns static values to class", "type": { "text": " any) | string | number | boolean | any[] | object); }>(this: T1, source: T2 & ThisType) => T1 & T2" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "readonly", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "set", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "mixin", "kind": "field", "static": true, "description": "Returns result of calling mixin with current class", "type": { "text": " any, RETURN extends ReturnType, SUBCLASS extends ClassOf>(this: BASE, mixin: FN) => SUBCLASS & BASE" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "register", "kind": "field", "static": true, "description": "Registers class with window.customElements synchronously", "type": { "text": "(this: T, elementName?: string, force?: boolean) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "propList", "kind": "field", "static": true, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attrList", "kind": "field", "static": true, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "propChangedCallbacks", "kind": "field", "static": true, "type": { "text": "Map any)[]>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attributeChangedCallbacks", "kind": "field", "static": true, "type": { "text": "Map any)[]>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "prop", "kind": "field", "static": true, "description": "Creates observable property on instances (via prototype)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1007" }, "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "setPrototype", "kind": "field", "static": true, "description": "Creates observable property on instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any)>(this: CLASS, name: KEY, options: OPTIONS) => OPTIONS extends (...args2: any[]) => infer R ? R : OPTIONS extends ObserverPropertyType ? ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? unknown extends R ? object : R : OPTIONS extends { type: ObserverPropertyType; } ? ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? unknown extends R ? string : R : never" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "define", "kind": "field", "static": true, "description": "Define properties on instances via Object.defineProperties().\nAutomatically sets property non-enumerable if name begins with `_`.\nFunctions will be remapped as getters", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends { [P in keyof any]: { enumerable?: boolean; configurable?: boolean; writable?: boolean; value?: any; get?: ((this: INSTANCE) => any); set?: (this: INSTANCE, value: any) => void; } | ((this: INSTANCE, ...args: any[]) => any); }, VALUE extends { [KEY in keyof PROPS]: PROPS[KEY] extends (...args2: any[]) => infer R ? R : PROPS[KEY] extends TypedPropertyDescriptor ? R : never; }>(this: CLASS, props: PROPS & ThisType) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "undefine", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROP extends string, PROPS extends INSTANCE & Record>(this: CLASS, name: PROP) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "observe", "kind": "field", "static": true, "description": "Creates observable properties on instances", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends IDLParameter, VALUE extends { [KEY in keyof PROPS]: PROPS[KEY] extends (...args2: any[]) => infer R ? R : PROPS[KEY] extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : PROPS[KEY] extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : PROPS[KEY] extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : PROPS[KEY] extends ObserverOptions ? (unknown extends R ? string : R) : never; }>(this: CLASS, props: PROPS) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "defineStatic", "kind": "field", "static": true, "type": { "text": ">(this: T1, props: T2) => T1 & ParsedProps" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "events", "kind": "field", "static": true, "type": { "text": "(this: T, listeners?: CompositionEventListenerObject>, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "childEvents", "kind": "field", "static": true, "type": { "text": "(this: T, listenerMap: { [x: string]: CompositionEventListenerObject>; }, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "rootEvents", "kind": "field", "static": true, "type": { "text": "(this: T, listeners?: CompositionEventListenerObject>, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "on", "kind": "field", "static": true, "type": { "text": ", T3 extends CompositionCallback, T4 extends keyof T3>(this: T1, name: T3 | T4, callbacks?: T3[T4] & ThisType) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "off", "kind": "field", "static": true, "type": { "text": ", T3 extends CompositionCallback, T4 extends keyof T3>(this: T1, name: T3 | T4, callbacks?: T3[T4] & ThisType) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "offPropChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: ObjectOrObjectEntries<{ [P in keyof T2]?: (this: T2, oldValue: T2[P], newValue: T2[P], changes: any, element: T2) => void; }>) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "offAttributeChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: { [x: string]: (this: T2, oldValue: string, newValue: string, element: T2) => void; }) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "onPropChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: ObjectOrObjectEntries<{ [P in keyof T2]?: (this: T2, oldValue: T2[P], newValue: T2[P], changes: any, element: T2) => void; }>) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "onAttributeChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: { [x: string]: (this: T2, oldValue: string, newValue: string, element: T2) => void; }) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } } ], "slots": [ { "name": "", "description": "" } ], "cssParts": [], "events": [], "demos": [], "superclass": { "module": "core/CustomElement.js", "name": "default" }, "mixins": [ { "module": "mixins/DelegatesFocusMixin.js", "name": "default" } ], "description": "Snackbar container positions snackbars within the app window and manages\nlayout and pointer-events for stacked snackbars.\n@see https://m3.material.io/components/snackbar/specs" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "default", "module": "components/SnackbarContainer.js" } }, { "kind": "custom-element-definition", "name": "mdw-snackbar-container", "declaration": { "name": "default", "module": "components/SnackbarContainer.js" } } ] }, { "kind": "javascript-module", "path": "components/Surface.js", "declarations": [ { "kind": "class", "name": "Surface", "tagName": "mdw-surface", "customElement": true, "attributes": [ { "name": "color", "fieldName": "color", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "ink", "fieldName": "ink", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "type-style", "fieldName": "typeStyle", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "block", "fieldName": "block", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/FlexboxMixin.js" } }, { "name": "inline", "fieldName": "inline", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/FlexboxMixin.js" } }, { "name": "row", "fieldName": "row", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/FlexboxMixin.js" } }, { "name": "x", "fieldName": "x", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/FlexboxMixin.js" } }, { "name": "y", "fieldName": "y", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/FlexboxMixin.js" } }, { "name": "gap", "fieldName": "gap", "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "mixins/FlexboxMixin.js" } }, { "name": "padding", "fieldName": "padding", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/FlexboxMixin.js" } }, { "name": "shape-top", "fieldName": "shapeTop", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shape-bottom", "fieldName": "shapeBottom", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shape-start", "fieldName": "shapeStart", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shape-end", "fieldName": "shapeEnd", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shape-style", "fieldName": "shapeStyle", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "outlined", "fieldName": "outlined", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } } ], "members": [ { "name": "disabled", "kind": "field", "description": "Whether the element is disabled (affects interactive states)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L14" }, "type": { "text": "boolean" } }, { "name": "focused", "kind": "field", "description": "Force focus state (independent of document)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L16" }, "type": { "text": "boolean" } }, { "name": "hovered", "kind": "field", "description": "Force hover state (independent of interaction)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L18" }, "type": { "text": "boolean" } }, { "name": "pressed", "kind": "field", "description": "Force pressed state (independent of interaction)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L20" }, "type": { "text": "boolean" } }, { "name": "stateLayer", "kind": "field", "description": "Show the visual state layer element when true", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L34" }, "type": { "text": "boolean" } }, { "name": "disabledState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L37" }, "type": { "text": "boolean" } }, { "name": "hoveredState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L38" }, "type": { "text": "boolean" } }, { "name": "focusedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L39" }, "type": { "text": "boolean" } }, { "name": "pressedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L40" }, "type": { "text": "boolean" } }, { "name": "touchedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L41" }, "type": { "text": "boolean" } }, { "name": "pointedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L44" }, "type": { "text": "boolean" } }, { "name": "stateTargetElement", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L50" }, "type": { "text": "HTMLElement" } }, { "name": "color", "kind": "field", "description": "Palette or surface token used to select background/ink tokens.\nExamples: 'primary', 'background', 'surface-container-low'.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L52" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "ink", "kind": "field", "description": "Explicit ink override token (e.g. 'outline', 'on-primary', 'inverse-on-surface', 'inherit').\nMaps to `--mdw-ink`.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L57" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "typeStyle", "kind": "field", "description": "Typographic style shortcut that maps to type scale variables\n(e.g. 'headline-large', 'body-medium').", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L62" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "shapeTop", "kind": "field", "description": "Show top cut/shape on the element", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L9" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shapeBottom", "kind": "field", "description": "Show bottom cut/shape on the element", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L11" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shapeStart", "kind": "field", "description": "Show start-side cut/shape (logical start)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L13" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shapeEnd", "kind": "field", "description": "Show end-side cut/shape (logical end)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L15" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shapeStyle", "kind": "field", "description": "Predefined shape size/style name (none|extra-small|small|medium|large|extra-large|full|inherit)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L17" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "outlined", "kind": "field", "description": "When true, an outline is rendered around the element", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L19" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "block", "kind": "field", "description": "Set `display: block` on the host (boolean)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js#L9" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/FlexboxMixin.js" } }, { "name": "inline", "kind": "field", "description": "Use inline flex layout: `display: inline-flex` (boolean)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js#L11" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/FlexboxMixin.js" } }, { "name": "row", "kind": "field", "description": "Switch main axis to horizontal: `flex-direction: row` (boolean)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js#L13" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/FlexboxMixin.js" } }, { "name": "x", "kind": "field", "description": "Main-axis alignment / justification.\nAllowed: 'start'|'center'|'end'|'between'|'around'|'stretch'|'baseline'.\nDefault: 'start'.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js#L19" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/FlexboxMixin.js" } }, { "name": "y", "kind": "field", "description": "Cross-axis alignment / alignment of items.\nSame allowed values as `x`. Default: 'start'.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js#L29" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/FlexboxMixin.js" } }, { "name": "gap", "kind": "field", "description": "Gap between children. Accepts preset numeric strings (e.g. '8') mapped to px, or floats.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js#L36" }, "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "mixins/FlexboxMixin.js" } }, { "name": "padding", "kind": "field", "description": "Padding preset or numeric value (e.g. 'pane', '8', '16').", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js#L38" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/FlexboxMixin.js" } }, { "name": "prototype", "kind": "field", "static": true, "type": { "text": "CustomElement" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "compose", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L145" }, "type": { "text": "(parts: CompositionPart[]) => Composition" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#refsProxy", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1145" }, "type": { "text": "Record" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#refsCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1148" }, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#refsCompositionCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1151" }, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#composition", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1154" }, "type": { "text": "Composition" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#patching", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1156" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#pendingPatchRenders", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1159" }, "type": { "text": "[string, any, CustomElement][]" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#propAttributeCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1162" }, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#callbackArguments", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1165" }, "type": { "text": "CallbackArguments" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "elementInternals", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1172" }, "type": { "text": "ElementInternals" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "render", "kind": "field", "description": "Updates nodes based on data\nExpects data in JSON Merge Patch format", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1185" }, "type": { "text": "RenderDraw" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "propChangedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1213" }, "type": { "text": "(this: T, name: K, oldValue: K extends keyof T ? T[K] : unknown, newValue: K extends keyof T ? T[K] : unknown, changes?: K extends keyof T ? T[K] extends object ? Partial : T[K] : unknown) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attributeChangedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1234" }, "type": { "text": "(name: string, oldValue: string, newValue: string) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#template", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1284" }, "type": { "text": "DocumentFragment" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#onObserverPropertyChanged", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1294" }, "type": { "text": "(name: string, oldValue: any, newValue: any, changes: any) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "static", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1330" }, "type": { "text": "typeof CustomElement" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "patch", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1333" }, "type": { "text": "(patch: any) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "refs", "kind": "field", "description": "Proxy object that returns shadow DOM elements by tag.\nIf called before interpolation (eg: on composed), returns from template", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1404" }, "type": { "text": "Record" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attributeCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1391" }, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "callbackArguments", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1400" }, "type": { "text": "CallbackArguments | { composition: Composition; refs: Record; html: any; inline: (fn: (data: Partial) => any) => string; template: DocumentFragment; element: T; }" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "composition", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1403" }, "type": { "text": "Composition" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "connectedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1435" }, "type": { "text": "() => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "disconnectedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1441" }, "type": { "text": "() => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "delegatesFocus", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1175" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "elementName", "kind": "field", "static": true, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "observedAttributes", "kind": "field", "static": true, "type": { "text": "Iterable" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "interpolatesTemplate", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "supportsElementInternals", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "supportsElementInternalsRole", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "defined", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "registrations", "kind": "field", "static": true, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "expressions", "kind": "method", "static": true, "description": "Expressions are idempotent functions that are selectively called whenever\na render is requested.\nExpressions are constructed exactly as methods though differ in expected\narguments. The first argument should be destructured to ensure each used\nproperty is accessed at least once in order to inspect used properties.\n\nThe Composition API will inspect this function with a proxy for `this` to\ncatalog what observables are used by the expression. This allows the\nComposition API to build a cache as well as selective invoke the expression\nonly when needed.\n\nWhen used with in element templates, the element itself will be passed as\nits first argument.\n````js\n Button\n .prop('filled', 'boolean')\n .prop('outlined', 'boolean')\n .expresssions({\n _isFilledOrOutlined({filled, outlined}) {\n return (filled || outlined)\n },\n })\n .html`
`;\n````\n\nWhen used with external data source, that data source\nwill be passed to the expression with all properties being `null` at first\ninspection.\n````js\n const externalData = {first: 'John', last: 'Doe'};\n ContactCard\n .expresssions({\n _fullName({first, last}) {\n return [first, last].filter(Boolean).join(' ');\n },\n })\n myButton.render(externalData);\n````\n\nExpressions may be support argumentless calls by using default\nparameters with `this`.\n````js\n Button\n .expresssions({\n isFilledOrOutlined({filled, outlined} = this) {\n return (filled || outlined)\n },\n });\n myButton.isFilledorOutlined();\n````", "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends { [K in keyof any]: K extends `_${any}` ? ((data: INSTANCE, state?: Record) => string | boolean | null) : ((data?: INSTANCE, state?: Record) => string | boolean | null); } & ThisType>(this: CLASS, expressions: PROPS & ThisType) => CLASS & Class<{ [K in keyof PROPS]: K extends `_${any}` ? never : () => ReturnType; }, ARGS>" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "methods", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "overrides", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends Partial>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "props", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "idl", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "append", "kind": "field", "static": true, "description": "Append parts to composition", "type": { "text": "(this: T, ...parts: CompositionPart[]) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "recompose", "kind": "field", "static": true, "description": "After composition, invokes callback.\nMay be called multiple times.", "type": { "text": ", T3 extends CompositionCallback[\"composed\"]>(this: T1, callback: T3) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "css", "kind": "field", "static": true, "description": "Appends styles to composition", "type": { "text": "(this: T1, array: T2, ...rest: T2 extends string ? any : T2 extends TemplateStringsArray ? any[] : (HTMLStyleElement | CSSStyleSheet)[]) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "autoRegister", "kind": "field", "static": true, "description": "Registers class with customElements. If class is registered before then,\ndoes nothing.", "type": { "text": "(this: T, elementName: string) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "html", "kind": "field", "static": true, "description": "Appends DocumentFragment to composition", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1405" }, "type": { "text": "(this: T, string: TemplateStringsArray, ...substitutions: (string | Element | ((this: InstanceType, data: InstanceType, injections?: any) => any))[]) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "extend", "kind": "field", "static": true, "description": "Extends base class into a new class.\nUse to avoid mutating base class.", "type": { "text": " T2>(this: T1, customExtender?: T3) => T3 extends null ? T1 : T2" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "setStatic", "kind": "field", "static": true, "description": "Assigns static values to class", "type": { "text": " any) | string | number | boolean | any[] | object); }>(this: T1, source: T2 & ThisType) => T1 & T2" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "readonly", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "set", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "mixin", "kind": "field", "static": true, "description": "Returns result of calling mixin with current class", "type": { "text": " any, RETURN extends ReturnType, SUBCLASS extends ClassOf>(this: BASE, mixin: FN) => SUBCLASS & BASE" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "register", "kind": "field", "static": true, "description": "Registers class with window.customElements synchronously", "type": { "text": "(this: T, elementName?: string, force?: boolean) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "propList", "kind": "field", "static": true, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attrList", "kind": "field", "static": true, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "propChangedCallbacks", "kind": "field", "static": true, "type": { "text": "Map any)[]>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attributeChangedCallbacks", "kind": "field", "static": true, "type": { "text": "Map any)[]>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "prop", "kind": "field", "static": true, "description": "Creates observable property on instances (via prototype)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1007" }, "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "setPrototype", "kind": "field", "static": true, "description": "Creates observable property on instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any)>(this: CLASS, name: KEY, options: OPTIONS) => OPTIONS extends (...args2: any[]) => infer R ? R : OPTIONS extends ObserverPropertyType ? ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? unknown extends R ? object : R : OPTIONS extends { type: ObserverPropertyType; } ? ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? unknown extends R ? string : R : never" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "define", "kind": "field", "static": true, "description": "Define properties on instances via Object.defineProperties().\nAutomatically sets property non-enumerable if name begins with `_`.\nFunctions will be remapped as getters", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends { [P in keyof any]: { enumerable?: boolean; configurable?: boolean; writable?: boolean; value?: any; get?: ((this: INSTANCE) => any); set?: (this: INSTANCE, value: any) => void; } | ((this: INSTANCE, ...args: any[]) => any); }, VALUE extends { [KEY in keyof PROPS]: PROPS[KEY] extends (...args2: any[]) => infer R ? R : PROPS[KEY] extends TypedPropertyDescriptor ? R : never; }>(this: CLASS, props: PROPS & ThisType) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "undefine", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROP extends string, PROPS extends INSTANCE & Record>(this: CLASS, name: PROP) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "observe", "kind": "field", "static": true, "description": "Creates observable properties on instances", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends IDLParameter, VALUE extends { [KEY in keyof PROPS]: PROPS[KEY] extends (...args2: any[]) => infer R ? R : PROPS[KEY] extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : PROPS[KEY] extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : PROPS[KEY] extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : PROPS[KEY] extends ObserverOptions ? (unknown extends R ? string : R) : never; }>(this: CLASS, props: PROPS) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "defineStatic", "kind": "field", "static": true, "type": { "text": ">(this: T1, props: T2) => T1 & ParsedProps" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "events", "kind": "field", "static": true, "type": { "text": "(this: T, listeners?: CompositionEventListenerObject>, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "childEvents", "kind": "field", "static": true, "type": { "text": "(this: T, listenerMap: { [x: string]: CompositionEventListenerObject>; }, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "rootEvents", "kind": "field", "static": true, "type": { "text": "(this: T, listeners?: CompositionEventListenerObject>, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "on", "kind": "field", "static": true, "type": { "text": ", T3 extends CompositionCallback, T4 extends keyof T3>(this: T1, name: T3 | T4, callbacks?: T3[T4] & ThisType) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "off", "kind": "field", "static": true, "type": { "text": ", T3 extends CompositionCallback, T4 extends keyof T3>(this: T1, name: T3 | T4, callbacks?: T3[T4] & ThisType) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "offPropChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: ObjectOrObjectEntries<{ [P in keyof T2]?: (this: T2, oldValue: T2[P], newValue: T2[P], changes: any, element: T2) => void; }>) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "offAttributeChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: { [x: string]: (this: T2, oldValue: string, newValue: string, element: T2) => void; }) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "onPropChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: ObjectOrObjectEntries<{ [P in keyof T2]?: (this: T2, oldValue: T2[P], newValue: T2[P], changes: any, element: T2) => void; }>) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "onAttributeChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: { [x: string]: (this: T2, oldValue: string, newValue: string, element: T2) => void; }) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } } ], "slots": [ { "name": "", "description": "" } ], "cssParts": [], "events": [], "demos": [], "superclass": { "module": "core/CustomElement.js", "name": "default" }, "mixins": [ { "module": "mixins/ThemableMixin.js", "name": "default" }, { "module": "mixins/FlexboxMixin.js", "name": "default" }, { "module": "mixins/ElevationMixin.js", "name": "default" }, { "module": "mixins/ShapeMixin.js", "name": "default" } ], "description": "Surface represents a themed elevated surface used to display content with\nelevation, shape, and color tokens applied.\n@see https://m3.material.io/styles/elevation/overview" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "default", "module": "components/Surface.js" } }, { "kind": "custom-element-definition", "name": "mdw-surface", "declaration": { "name": "default", "module": "components/Surface.js" } } ] }, { "kind": "javascript-module", "path": "components/Switch.js", "declarations": [ { "kind": "class", "name": "Switch", "tagName": "mdw-switch", "customElement": true, "attributes": [ { "name": "color", "fieldName": "color", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "ink", "fieldName": "ink", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "type-style", "fieldName": "typeStyle", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "aria-controls", "fieldName": "ariaControls", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "autocomplete", "fieldName": "autocomplete", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "name", "fieldName": "name", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "readonly", "fieldName": "readOnly", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "formnovalidate", "fieldName": "formNoValidate", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "checked", "fieldName": "defaultChecked", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "required", "fieldName": "required", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "value", "fieldName": "_defaultValue", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "aria-label", "fieldName": "ariaLabel", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "accept", "fieldName": "accept", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "alt", "fieldName": "alt", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "dirname", "fieldName": "dirName", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "formenctype", "fieldName": "formEnctype", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "formmethod", "fieldName": "formMethod", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "formtarget", "fieldName": "formTarget", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "max", "fieldName": "max", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "maxlength", "fieldName": "maxLength", "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "min", "fieldName": "min", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "minlength", "fieldName": "minLength", "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "multiple", "fieldName": "multiple", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "pattern", "fieldName": "pattern", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "placeholder", "fieldName": "placeholder", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "size", "fieldName": "size", "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "src", "description": "The image `src` to show inside the thumb when provided.", "fieldName": "src", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "step", "fieldName": "step", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "indeterminate", "fieldName": "indeterminate", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "disabled", "fieldName": "disabled", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "focused", "fieldName": "focused", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "hovered", "fieldName": "hovered", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "pressed", "fieldName": "pressed", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "icon", "description": "The icon name to show inside the thumb when provided.", "fieldName": "icon", "type": { "text": "string" } }, { "name": "selected-icon", "description": "The icon name to show when the switch is selected/on.", "fieldName": "selectedIcon", "type": { "text": "string" } }, { "name": "unselected-icon", "description": "The icon name to show when the switch is unselected/off.", "fieldName": "unselectedIcon", "type": { "text": "string" } }, { "name": "selected-src", "description": "The image `src` to show when the switch is selected/on.", "fieldName": "selectedSrc", "type": { "text": "string" } }, { "name": "unselected-src", "description": "The image `src` to show when the switch is unselected/off.", "fieldName": "unselectedSrc", "type": { "text": "string" } }, { "name": "type", "type": { "text": "string" }, "fieldName": "type", "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "state-layer", "type": { "text": "boolean" }, "description": "Show the visual state layer element when true", "fieldName": "stateLayer", "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } } ], "members": [ { "name": "delegatesFocus", "kind": "field", "description": "When true, the element delegates focus to an internal focus target.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/DelegatesFocusMixin.js#L15" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "disabled", "kind": "field", "description": "Whether the element is disabled (affects interactive states)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L14" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "focused", "kind": "field", "description": "Force focus state (independent of document)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L16" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "hovered", "kind": "field", "description": "Force hover state (independent of interaction)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L18" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "pressed", "kind": "field", "description": "Force pressed state (independent of interaction)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L20" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "stateLayer", "kind": "field", "description": "Show the visual state layer element when true\nEnables the state-layer visual treatment for pressed/hover states.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Switch.js#L23" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "disabledState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L171" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "hoveredState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L38" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "focusedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L39" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "pressedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L40" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "touchedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L41" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "pointedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L44" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "stateTargetElement", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ControlMixin.js#L66" }, "type": { "text": "HTMLElement" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "ariaControls", "kind": "field", "description": "ARIA 'controls' attribute (string).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L32" }, "type": { "text": "string" } }, { "name": "autocomplete", "kind": "field", "description": "Autocomplete token for the associated control (string).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L34" }, "type": { "text": "string" } }, { "name": "name", "kind": "field", "description": "Name attribute for the control used in forms.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L36" }, "type": { "text": "string" } }, { "name": "readOnly", "kind": "field", "description": "Read-only state reflected to control via 'readonly' attribute.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L38" }, "type": { "text": "boolean" } }, { "name": "formNoValidate", "kind": "field", "description": "When true, form validation is skipped for this control (formnovalidate).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L40" }, "type": { "text": "boolean" } }, { "name": "defaultChecked", "kind": "field", "description": "Default checked state for checkable controls (checkbox/radio).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L42" }, "type": { "text": "boolean" } }, { "name": "required", "kind": "field", "description": "Whether the control is required for form submission.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L47" }, "type": { "text": "boolean" } }, { "name": "type", "kind": "field", "description": "Control type token (e.g. 'text','checkbox','radio','file').\nThe control `type` used for the underlying input element (always 'checkbox').", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Switch.js#L21" }, "type": { "text": "string" } }, { "name": "erroredState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L65" }, "type": { "text": "boolean" } }, { "name": "defaultValue", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L66" }, "type": { "text": "string" } }, { "name": "value", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L108" }, "type": { "text": "string" } }, { "name": "checked", "kind": "field", "description": "Part of FormAssociatedMixin for simplicity.\nEnumerability doesn't guarantee checked state will be passed or used.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L145" }, "type": { "text": "boolean" } }, { "name": "form", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L160" }, "type": { "text": "HTMLFormElement" } }, { "name": "validity", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L161" }, "type": { "text": "ValidityState" } }, { "name": "validationMessage", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L162" }, "type": { "text": "string" } }, { "name": "willValidate", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L163" }, "type": { "text": "boolean" } }, { "name": "labels", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L168" }, "type": { "text": "NodeList" } }, { "name": "focusableOnDisabled", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ControlMixin.js#L30" }, "type": { "text": "boolean" } }, { "name": "controlTagName", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L102" }, "type": { "text": "string" } }, { "name": "controlVoidElement", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ControlMixin.js#L32" }, "type": { "text": "boolean" } }, { "name": "accept", "kind": "field", "description": "Accepted file types for file input (e.g. '.png,.jpg').", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L41" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "alt", "kind": "field", "description": "Alternate text for images (for `type='image'`).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L43" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "dirName", "kind": "field", "description": "Directionality for form submission name (dirname attribute).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L45" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "formEnctype", "kind": "field", "description": "Form encoding type (formenctype).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L49" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "formMethod", "kind": "field", "description": "Form method when associated with a submit input (formmethod).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L51" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "formTarget", "kind": "field", "description": "Target browsing context for form submission (formtarget).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L53" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "max", "kind": "field", "description": "Max value or token for the input.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L58" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "maxLength", "kind": "field", "description": "Maximum length for text-like inputs.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L60" }, "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "min", "kind": "field", "description": "Min value or token for the input.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L62" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "minLength", "kind": "field", "description": "Minimum length for text-like inputs.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L64" }, "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "multiple", "kind": "field", "description": "When true, multiple values are allowed (e.g. file inputs).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L66" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "pattern", "kind": "field", "description": "Pattern used for validation (RegExp as string).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L68" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "placeholder", "kind": "field", "description": "Placeholder text shown when no value is present.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L70" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "size", "kind": "field", "description": "Suggested control size (number of characters).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L72" }, "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "src", "kind": "field", "description": "Source URL for image-type inputs.\nThe image `src` to show inside the thumb when provided.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Switch.js#L33" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "step", "kind": "field", "description": "Step interval for numeric inputs.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L76" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "indeterminate", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L89" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "files", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L371" }, "type": { "text": "FileList" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "selectionDirection", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L384" }, "type": { "text": "\"none\" | \"forward\" | \"backward\"" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "selectionEnd", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L389" }, "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "selectionStart", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L394" }, "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "valueAsDate", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L399" }, "type": { "text": "Date" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "valueAsNumber", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L407" }, "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "height", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L415" }, "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "formAction", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L423" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "width", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L431" }, "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "color", "kind": "field", "description": "Palette or surface token used to select background/ink tokens.\nExamples: 'primary', 'background', 'surface-container-low'.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L52" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "ink", "kind": "field", "description": "Explicit ink override token (e.g. 'outline', 'on-primary', 'inverse-on-surface', 'inherit').\nMaps to `--mdw-ink`.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L57" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "typeStyle", "kind": "field", "description": "Typographic style shortcut that maps to type scale variables\n(e.g. 'headline-large', 'body-medium').", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L62" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "icon", "kind": "field", "description": "The icon name to show inside the thumb when provided.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Switch.js#L27" }, "type": { "text": "string" } }, { "name": "selectedIcon", "kind": "field", "description": "The icon name to show when the switch is selected/on.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Switch.js#L29" }, "type": { "text": "string" } }, { "name": "unselectedIcon", "kind": "field", "description": "The icon name to show when the switch is unselected/off.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Switch.js#L31" }, "type": { "text": "string" } }, { "name": "selectedSrc", "kind": "field", "description": "The image `src` to show when the switch is selected/on.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Switch.js#L35" }, "type": { "text": "string" } }, { "name": "unselectedSrc", "kind": "field", "description": "The image `src` to show when the switch is unselected/off.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Switch.js#L37" }, "type": { "text": "string" } }, { "name": "onControlMouseOrTouch", "kind": "method", "description": "Handle pointer/touch input on the native control to compute dragging\nposition and update the thumb drag state.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Switch.js#L64" }, "return": { "type": { "text": "(event: (MouseEvent | TouchEvent) & { currentTarget: HTMLInputElement; }) => void" } } }, { "name": "prototype", "kind": "field", "static": true, "type": { "text": "CustomElement" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "performImplicitSubmission", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L175" }, "return": { "type": { "text": "(event: Event) => void" } }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "setRangeText", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L345" }, "return": { "type": { "text": "{ (replacement: string): void; (replacement: string, start: number, end: number, selectionMode?: SelectionMode): void; }" } }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "setSelectionRange", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L348" }, "return": { "type": { "text": "(start: number, end: number, direction?: \"none\" | \"forward\" | \"backward\") => void" } }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "showPicker", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L351" }, "return": { "type": { "text": "() => void" } }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "stepDown", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L354" }, "return": { "type": { "text": "(n?: number) => void" } }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "stepUp", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L360" }, "return": { "type": { "text": "(n?: number) => void" } }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "select", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L366" }, "return": { "type": { "text": "() => void" } }, "inheritedFrom": { "name": "default", "module": "mixins/InputMixin.js" } }, { "name": "compose", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L145" }, "type": { "text": "(parts: CompositionPart[]) => Composition" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#refsProxy", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1145" }, "type": { "text": "Record" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#refsCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1148" }, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#refsCompositionCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1151" }, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#composition", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1154" }, "type": { "text": "Composition" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#patching", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1156" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#pendingPatchRenders", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1159" }, "type": { "text": "[string, any, CustomElement][]" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#propAttributeCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1162" }, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#callbackArguments", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1165" }, "type": { "text": "CallbackArguments" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "elementInternals", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1172" }, "type": { "text": "ElementInternals" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "render", "kind": "field", "description": "Updates nodes based on data\nExpects data in JSON Merge Patch format", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1185" }, "type": { "text": "RenderDraw" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "propChangedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1213" }, "type": { "text": "(this: T, name: K, oldValue: K extends keyof T ? T[K] : unknown, newValue: K extends keyof T ? T[K] : unknown, changes?: K extends keyof T ? T[K] extends object ? Partial : T[K] : unknown) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attributeChangedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1234" }, "type": { "text": "(name: string, oldValue: string, newValue: string) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#template", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1284" }, "type": { "text": "DocumentFragment" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#onObserverPropertyChanged", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1294" }, "type": { "text": "(name: string, oldValue: any, newValue: any, changes: any) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "static", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1330" }, "type": { "text": "typeof CustomElement" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "patch", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1333" }, "type": { "text": "(patch: any) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "refs", "kind": "field", "description": "Proxy object that returns shadow DOM elements by tag.\nIf called before interpolation (eg: on composed), returns from template", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1404" }, "type": { "text": "Record" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attributeCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1391" }, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "callbackArguments", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1400" }, "type": { "text": "CallbackArguments | { composition: Composition; refs: Record; html: any; inline: (fn: (data: Partial) => any) => string; template: DocumentFragment; element: T; }" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "composition", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1403" }, "type": { "text": "Composition" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "connectedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1435" }, "type": { "text": "() => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "disconnectedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1441" }, "type": { "text": "() => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "elementName", "kind": "field", "static": true, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "observedAttributes", "kind": "field", "static": true, "type": { "text": "Iterable" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "interpolatesTemplate", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "supportsElementInternals", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "supportsElementInternalsRole", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "defined", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "registrations", "kind": "field", "static": true, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "expressions", "kind": "method", "static": true, "description": "Expressions are idempotent functions that are selectively called whenever\na render is requested.\nExpressions are constructed exactly as methods though differ in expected\narguments. The first argument should be destructured to ensure each used\nproperty is accessed at least once in order to inspect used properties.\n\nThe Composition API will inspect this function with a proxy for `this` to\ncatalog what observables are used by the expression. This allows the\nComposition API to build a cache as well as selective invoke the expression\nonly when needed.\n\nWhen used with in element templates, the element itself will be passed as\nits first argument.\n````js\n Button\n .prop('filled', 'boolean')\n .prop('outlined', 'boolean')\n .expresssions({\n _isFilledOrOutlined({filled, outlined}) {\n return (filled || outlined)\n },\n })\n .html`
`;\n````\n\nWhen used with external data source, that data source\nwill be passed to the expression with all properties being `null` at first\ninspection.\n````js\n const externalData = {first: 'John', last: 'Doe'};\n ContactCard\n .expresssions({\n _fullName({first, last}) {\n return [first, last].filter(Boolean).join(' ');\n },\n })\n myButton.render(externalData);\n````\n\nExpressions may be support argumentless calls by using default\nparameters with `this`.\n````js\n Button\n .expresssions({\n isFilledOrOutlined({filled, outlined} = this) {\n return (filled || outlined)\n },\n });\n myButton.isFilledorOutlined();\n````", "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends { [K in keyof any]: K extends `_${any}` ? ((data: INSTANCE, state?: Record) => string | boolean | null) : ((data?: INSTANCE, state?: Record) => string | boolean | null); } & ThisType>(this: CLASS, expressions: PROPS & ThisType) => CLASS & Class<{ [K in keyof PROPS]: K extends `_${any}` ? never : () => ReturnType; }, ARGS>" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "methods", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "overrides", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends Partial>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "props", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "idl", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "append", "kind": "field", "static": true, "description": "Append parts to composition", "type": { "text": "(this: T, ...parts: CompositionPart[]) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "recompose", "kind": "field", "static": true, "description": "After composition, invokes callback.\nMay be called multiple times.", "type": { "text": ", T3 extends CompositionCallback[\"composed\"]>(this: T1, callback: T3) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "css", "kind": "field", "static": true, "description": "Appends styles to composition", "type": { "text": "(this: T1, array: T2, ...rest: T2 extends string ? any : T2 extends TemplateStringsArray ? any[] : (HTMLStyleElement | CSSStyleSheet)[]) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "autoRegister", "kind": "field", "static": true, "description": "Registers class with customElements. If class is registered before then,\ndoes nothing.", "type": { "text": "(this: T, elementName: string) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "html", "kind": "field", "static": true, "description": "Appends DocumentFragment to composition", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1405" }, "type": { "text": "(this: T, string: TemplateStringsArray, ...substitutions: (string | Element | ((this: InstanceType, data: InstanceType, injections?: any) => any))[]) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "extend", "kind": "field", "static": true, "description": "Extends base class into a new class.\nUse to avoid mutating base class.", "type": { "text": " T2>(this: T1, customExtender?: T3) => T3 extends null ? T1 : T2" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "setStatic", "kind": "field", "static": true, "description": "Assigns static values to class", "type": { "text": " any) | string | number | boolean | any[] | object); }>(this: T1, source: T2 & ThisType) => T1 & T2" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "readonly", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "set", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "mixin", "kind": "field", "static": true, "description": "Returns result of calling mixin with current class", "type": { "text": " any, RETURN extends ReturnType, SUBCLASS extends ClassOf>(this: BASE, mixin: FN) => SUBCLASS & BASE" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "register", "kind": "field", "static": true, "description": "Registers class with window.customElements synchronously", "type": { "text": "(this: T, elementName?: string, force?: boolean) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "propList", "kind": "field", "static": true, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attrList", "kind": "field", "static": true, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "propChangedCallbacks", "kind": "field", "static": true, "type": { "text": "Map any)[]>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attributeChangedCallbacks", "kind": "field", "static": true, "type": { "text": "Map any)[]>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "prop", "kind": "field", "static": true, "description": "Creates observable property on instances (via prototype)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1007" }, "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "setPrototype", "kind": "field", "static": true, "description": "Creates observable property on instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any)>(this: CLASS, name: KEY, options: OPTIONS) => OPTIONS extends (...args2: any[]) => infer R ? R : OPTIONS extends ObserverPropertyType ? ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? unknown extends R ? object : R : OPTIONS extends { type: ObserverPropertyType; } ? ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? unknown extends R ? string : R : never" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "define", "kind": "field", "static": true, "description": "Define properties on instances via Object.defineProperties().\nAutomatically sets property non-enumerable if name begins with `_`.\nFunctions will be remapped as getters", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends { [P in keyof any]: { enumerable?: boolean; configurable?: boolean; writable?: boolean; value?: any; get?: ((this: INSTANCE) => any); set?: (this: INSTANCE, value: any) => void; } | ((this: INSTANCE, ...args: any[]) => any); }, VALUE extends { [KEY in keyof PROPS]: PROPS[KEY] extends (...args2: any[]) => infer R ? R : PROPS[KEY] extends TypedPropertyDescriptor ? R : never; }>(this: CLASS, props: PROPS & ThisType) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "undefine", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROP extends string, PROPS extends INSTANCE & Record>(this: CLASS, name: PROP) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "observe", "kind": "field", "static": true, "description": "Creates observable properties on instances", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends IDLParameter, VALUE extends { [KEY in keyof PROPS]: PROPS[KEY] extends (...args2: any[]) => infer R ? R : PROPS[KEY] extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : PROPS[KEY] extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : PROPS[KEY] extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : PROPS[KEY] extends ObserverOptions ? (unknown extends R ? string : R) : never; }>(this: CLASS, props: PROPS) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "defineStatic", "kind": "field", "static": true, "type": { "text": ">(this: T1, props: T2) => T1 & ParsedProps" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "events", "kind": "field", "static": true, "type": { "text": "(this: T, listeners?: CompositionEventListenerObject>, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "childEvents", "kind": "field", "static": true, "type": { "text": "(this: T, listenerMap: { [x: string]: CompositionEventListenerObject>; }, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "rootEvents", "kind": "field", "static": true, "type": { "text": "(this: T, listeners?: CompositionEventListenerObject>, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "on", "kind": "field", "static": true, "type": { "text": ", T3 extends CompositionCallback, T4 extends keyof T3>(this: T1, name: T3 | T4, callbacks?: T3[T4] & ThisType) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "off", "kind": "field", "static": true, "type": { "text": ", T3 extends CompositionCallback, T4 extends keyof T3>(this: T1, name: T3 | T4, callbacks?: T3[T4] & ThisType) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "offPropChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: ObjectOrObjectEntries<{ [P in keyof T2]?: (this: T2, oldValue: T2[P], newValue: T2[P], changes: any, element: T2) => void; }>) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "offAttributeChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: { [x: string]: (this: T2, oldValue: string, newValue: string, element: T2) => void; }) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "onPropChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: ObjectOrObjectEntries<{ [P in keyof T2]?: (this: T2, oldValue: T2[P], newValue: T2[P], changes: any, element: T2) => void; }>) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "onAttributeChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: { [x: string]: (this: T2, oldValue: string, newValue: string, element: T2) => void; }) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } } ], "slots": [ { "name": "", "description": "" } ], "cssParts": [ { "name": "control" } ], "events": [ { "name": "control-mouse-or-touch", "type": { "text": "Event" } } ], "demos": [], "superclass": { "module": "core/CustomElement.js", "name": "default" }, "mixins": [ { "module": "mixins/ThemableMixin.js", "name": "default" }, { "module": "mixins/InputMixin.js", "name": "default" }, { "module": "mixins/StateMixin.js", "name": "default" }, { "module": "mixins/TouchTargetMixin.js", "name": "default" } ], "description": "Switch is a binary control that toggles between on and off states.\n@see https://m3.material.io/components/switch/specs" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "default", "module": "components/Switch.js" } }, { "kind": "custom-element-definition", "name": "mdw-switch", "declaration": { "name": "default", "module": "components/Switch.js" } } ] }, { "kind": "javascript-module", "path": "components/SwitchIcon.js", "declarations": [ { "kind": "class", "name": "SwitchIcon", "tagName": "mdw-switch-icon", "customElement": true, "attributes": [ { "name": "color", "description": "Color token to use for the thumb (defaults to primary).", "fieldName": "color", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "ink", "fieldName": "ink", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "type-style", "fieldName": "typeStyle", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "shape-top", "fieldName": "shapeTop", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shape-bottom", "fieldName": "shapeBottom", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shape-start", "fieldName": "shapeStart", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shape-end", "fieldName": "shapeEnd", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shape-style", "fieldName": "shapeStyle", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "outlined", "fieldName": "outlined", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "selected", "description": "Whether the switch is selected/on.", "fieldName": "selected", "type": { "text": "boolean" } }, { "name": "icon", "description": "Named icon to render inside the thumb.", "fieldName": "icon", "type": { "text": "string" } }, { "name": "errored", "description": "Whether the control is visually in an errored state.", "fieldName": "errored", "type": { "text": "boolean" } }, { "name": "disabled", "description": "Whether the control is disabled.", "fieldName": "disabled", "type": { "text": "boolean" } }, { "name": "selected-icon", "description": "Icon name to show when selected/on.", "fieldName": "selectedIcon", "type": { "text": "string" } }, { "name": "unselected-icon", "description": "Icon name to show when unselected/off.", "fieldName": "unselectedIcon", "type": { "text": "string" } }, { "name": "src", "description": "Image `src` to render inside the thumb.", "fieldName": "src", "type": { "text": "string" } }, { "name": "selected-src", "description": "Image `src` to render when selected/on.", "fieldName": "selectedSrc", "type": { "text": "string" } }, { "name": "unselected-src", "description": "Image `src` to render when unselected/off.", "fieldName": "unselectedSrc", "type": { "text": "string" } }, { "name": "hovered", "description": "Hover state for the thumb.", "fieldName": "hovered", "type": { "text": "boolean" } }, { "name": "pressed", "description": "Pressed state for the thumb.", "fieldName": "pressed", "type": { "text": "boolean" } }, { "name": "focused", "description": "Focused state for the thumb.", "fieldName": "focused", "type": { "text": "boolean" } }, { "name": "drag-value", "description": "Temporary drag position value (0..1) while the thumb is being dragged.", "fieldName": "dragValue", "type": { "text": "number" } }, { "name": "checked", "description": "Alias for `selected` to match common control naming.", "fieldName": "checked", "type": { "text": "boolean" } } ], "members": [ { "name": "disabled", "kind": "field", "description": "Whether the element is disabled (affects interactive states)\nWhether the control is disabled.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/SwitchIcon.js#L26" }, "type": { "text": "boolean" } }, { "name": "focused", "kind": "field", "description": "Force focus state (independent of document)\nFocused state for the thumb.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/SwitchIcon.js#L42" }, "type": { "text": "boolean" } }, { "name": "hovered", "kind": "field", "description": "Force hover state (independent of interaction)\nHover state for the thumb.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/SwitchIcon.js#L38" }, "type": { "text": "boolean" } }, { "name": "pressed", "kind": "field", "description": "Force pressed state (independent of interaction)\nPressed state for the thumb.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/SwitchIcon.js#L40" }, "type": { "text": "boolean" } }, { "name": "stateLayer", "kind": "field", "description": "Show the visual state layer element when true", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L34" }, "type": { "text": "boolean" } }, { "name": "disabledState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L37" }, "type": { "text": "boolean" } }, { "name": "hoveredState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L38" }, "type": { "text": "boolean" } }, { "name": "focusedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L39" }, "type": { "text": "boolean" } }, { "name": "pressedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L40" }, "type": { "text": "boolean" } }, { "name": "touchedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L41" }, "type": { "text": "boolean" } }, { "name": "pointedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L44" }, "type": { "text": "boolean" } }, { "name": "stateTargetElement", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L50" }, "type": { "text": "HTMLElement" } }, { "name": "color", "kind": "field", "description": "Palette or surface token used to select background/ink tokens.\nExamples: 'primary', 'background', 'surface-container-low'.\nColor token to use for the thumb (defaults to primary).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/SwitchIcon.js#L46" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "ink", "kind": "field", "description": "Explicit ink override token (e.g. 'outline', 'on-primary', 'inverse-on-surface', 'inherit').\nMaps to `--mdw-ink`.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L57" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "typeStyle", "kind": "field", "description": "Typographic style shortcut that maps to type scale variables\n(e.g. 'headline-large', 'body-medium').", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L62" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "shapeTop", "kind": "field", "description": "Show top cut/shape on the element", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L9" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shapeBottom", "kind": "field", "description": "Show bottom cut/shape on the element", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L11" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shapeStart", "kind": "field", "description": "Show start-side cut/shape (logical start)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L13" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shapeEnd", "kind": "field", "description": "Show end-side cut/shape (logical end)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L15" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shapeStyle", "kind": "field", "description": "Predefined shape size/style name (none|extra-small|small|medium|large|extra-large|full|inherit)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L17" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "outlined", "kind": "field", "description": "When true, an outline is rendered around the element", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L19" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "selected", "kind": "field", "description": "Whether the switch is selected/on.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/SwitchIcon.js#L20" }, "type": { "text": "boolean" } }, { "name": "icon", "kind": "field", "description": "Named icon to render inside the thumb.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/SwitchIcon.js#L22" }, "type": { "text": "string" } }, { "name": "errored", "kind": "field", "description": "Whether the control is visually in an errored state.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/SwitchIcon.js#L24" }, "type": { "text": "boolean" } }, { "name": "selectedIcon", "kind": "field", "description": "Icon name to show when selected/on.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/SwitchIcon.js#L28" }, "type": { "text": "string" } }, { "name": "unselectedIcon", "kind": "field", "description": "Icon name to show when unselected/off.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/SwitchIcon.js#L30" }, "type": { "text": "string" } }, { "name": "src", "kind": "field", "description": "Image `src` to render inside the thumb.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/SwitchIcon.js#L32" }, "type": { "text": "string" } }, { "name": "selectedSrc", "kind": "field", "description": "Image `src` to render when selected/on.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/SwitchIcon.js#L34" }, "type": { "text": "string" } }, { "name": "unselectedSrc", "kind": "field", "description": "Image `src` to render when unselected/off.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/SwitchIcon.js#L36" }, "type": { "text": "string" } }, { "name": "dragValue", "kind": "field", "description": "Temporary drag position value (0..1) while the thumb is being dragged.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/SwitchIcon.js#L44" }, "type": { "text": "number" } }, { "name": "checked", "kind": "field", "description": "Alias for `selected` to match common control naming.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/SwitchIcon.js#L50" }, "type": { "text": "boolean" } }, { "name": "hasIcon", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/SwitchIcon.js#L74" }, "return": { "type": { "text": "() => boolean" } } }, { "name": "iconVariation", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/SwitchIcon.js#L77" }, "return": { "type": { "text": "() => string" } } }, { "name": "prototype", "kind": "field", "static": true, "type": { "text": "CustomElement" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "compose", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L145" }, "type": { "text": "(parts: CompositionPart[]) => Composition" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#refsProxy", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1145" }, "type": { "text": "Record" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#refsCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1148" }, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#refsCompositionCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1151" }, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#composition", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1154" }, "type": { "text": "Composition" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#patching", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1156" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#pendingPatchRenders", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1159" }, "type": { "text": "[string, any, CustomElement][]" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#propAttributeCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1162" }, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#callbackArguments", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1165" }, "type": { "text": "CallbackArguments" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "elementInternals", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1172" }, "type": { "text": "ElementInternals" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "render", "kind": "field", "description": "Updates nodes based on data\nExpects data in JSON Merge Patch format", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1185" }, "type": { "text": "RenderDraw" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "propChangedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1213" }, "type": { "text": "(this: T, name: K, oldValue: K extends keyof T ? T[K] : unknown, newValue: K extends keyof T ? T[K] : unknown, changes?: K extends keyof T ? T[K] extends object ? Partial : T[K] : unknown) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attributeChangedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1234" }, "type": { "text": "(name: string, oldValue: string, newValue: string) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#template", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1284" }, "type": { "text": "DocumentFragment" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#onObserverPropertyChanged", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1294" }, "type": { "text": "(name: string, oldValue: any, newValue: any, changes: any) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "static", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1330" }, "type": { "text": "typeof CustomElement" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "patch", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1333" }, "type": { "text": "(patch: any) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "refs", "kind": "field", "description": "Proxy object that returns shadow DOM elements by tag.\nIf called before interpolation (eg: on composed), returns from template", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1404" }, "type": { "text": "Record" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attributeCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1391" }, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "callbackArguments", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1400" }, "type": { "text": "CallbackArguments | { composition: Composition; refs: Record; html: any; inline: (fn: (data: Partial) => any) => string; template: DocumentFragment; element: T; }" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "composition", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1403" }, "type": { "text": "Composition" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "connectedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1435" }, "type": { "text": "() => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "disconnectedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1441" }, "type": { "text": "() => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "delegatesFocus", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1175" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "elementName", "kind": "field", "static": true, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "observedAttributes", "kind": "field", "static": true, "type": { "text": "Iterable" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "interpolatesTemplate", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "supportsElementInternals", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "supportsElementInternalsRole", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "defined", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "registrations", "kind": "field", "static": true, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "expressions", "kind": "method", "static": true, "description": "Expressions are idempotent functions that are selectively called whenever\na render is requested.\nExpressions are constructed exactly as methods though differ in expected\narguments. The first argument should be destructured to ensure each used\nproperty is accessed at least once in order to inspect used properties.\n\nThe Composition API will inspect this function with a proxy for `this` to\ncatalog what observables are used by the expression. This allows the\nComposition API to build a cache as well as selective invoke the expression\nonly when needed.\n\nWhen used with in element templates, the element itself will be passed as\nits first argument.\n````js\n Button\n .prop('filled', 'boolean')\n .prop('outlined', 'boolean')\n .expresssions({\n _isFilledOrOutlined({filled, outlined}) {\n return (filled || outlined)\n },\n })\n .html`
`;\n````\n\nWhen used with external data source, that data source\nwill be passed to the expression with all properties being `null` at first\ninspection.\n````js\n const externalData = {first: 'John', last: 'Doe'};\n ContactCard\n .expresssions({\n _fullName({first, last}) {\n return [first, last].filter(Boolean).join(' ');\n },\n })\n myButton.render(externalData);\n````\n\nExpressions may be support argumentless calls by using default\nparameters with `this`.\n````js\n Button\n .expresssions({\n isFilledOrOutlined({filled, outlined} = this) {\n return (filled || outlined)\n },\n });\n myButton.isFilledorOutlined();\n````", "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends { [K in keyof any]: K extends `_${any}` ? ((data: INSTANCE, state?: Record) => string | boolean | null) : ((data?: INSTANCE, state?: Record) => string | boolean | null); } & ThisType>(this: CLASS, expressions: PROPS & ThisType) => CLASS & Class<{ [K in keyof PROPS]: K extends `_${any}` ? never : () => ReturnType; }, ARGS>" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "methods", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "overrides", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends Partial>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "props", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "idl", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "append", "kind": "field", "static": true, "description": "Append parts to composition", "type": { "text": "(this: T, ...parts: CompositionPart[]) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "recompose", "kind": "field", "static": true, "description": "After composition, invokes callback.\nMay be called multiple times.", "type": { "text": ", T3 extends CompositionCallback[\"composed\"]>(this: T1, callback: T3) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "css", "kind": "field", "static": true, "description": "Appends styles to composition", "type": { "text": "(this: T1, array: T2, ...rest: T2 extends string ? any : T2 extends TemplateStringsArray ? any[] : (HTMLStyleElement | CSSStyleSheet)[]) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "autoRegister", "kind": "field", "static": true, "description": "Registers class with customElements. If class is registered before then,\ndoes nothing.", "type": { "text": "(this: T, elementName: string) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "html", "kind": "field", "static": true, "description": "Appends DocumentFragment to composition", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1405" }, "type": { "text": "(this: T, string: TemplateStringsArray, ...substitutions: (string | Element | ((this: InstanceType, data: InstanceType, injections?: any) => any))[]) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "extend", "kind": "field", "static": true, "description": "Extends base class into a new class.\nUse to avoid mutating base class.", "type": { "text": " T2>(this: T1, customExtender?: T3) => T3 extends null ? T1 : T2" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "setStatic", "kind": "field", "static": true, "description": "Assigns static values to class", "type": { "text": " any) | string | number | boolean | any[] | object); }>(this: T1, source: T2 & ThisType) => T1 & T2" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "readonly", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "set", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "mixin", "kind": "field", "static": true, "description": "Returns result of calling mixin with current class", "type": { "text": " any, RETURN extends ReturnType, SUBCLASS extends ClassOf>(this: BASE, mixin: FN) => SUBCLASS & BASE" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "register", "kind": "field", "static": true, "description": "Registers class with window.customElements synchronously", "type": { "text": "(this: T, elementName?: string, force?: boolean) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "propList", "kind": "field", "static": true, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attrList", "kind": "field", "static": true, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "propChangedCallbacks", "kind": "field", "static": true, "type": { "text": "Map any)[]>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attributeChangedCallbacks", "kind": "field", "static": true, "type": { "text": "Map any)[]>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "prop", "kind": "field", "static": true, "description": "Creates observable property on instances (via prototype)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1007" }, "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "setPrototype", "kind": "field", "static": true, "description": "Creates observable property on instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any)>(this: CLASS, name: KEY, options: OPTIONS) => OPTIONS extends (...args2: any[]) => infer R ? R : OPTIONS extends ObserverPropertyType ? ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? unknown extends R ? object : R : OPTIONS extends { type: ObserverPropertyType; } ? ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? unknown extends R ? string : R : never" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "define", "kind": "field", "static": true, "description": "Define properties on instances via Object.defineProperties().\nAutomatically sets property non-enumerable if name begins with `_`.\nFunctions will be remapped as getters", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends { [P in keyof any]: { enumerable?: boolean; configurable?: boolean; writable?: boolean; value?: any; get?: ((this: INSTANCE) => any); set?: (this: INSTANCE, value: any) => void; } | ((this: INSTANCE, ...args: any[]) => any); }, VALUE extends { [KEY in keyof PROPS]: PROPS[KEY] extends (...args2: any[]) => infer R ? R : PROPS[KEY] extends TypedPropertyDescriptor ? R : never; }>(this: CLASS, props: PROPS & ThisType) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "undefine", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROP extends string, PROPS extends INSTANCE & Record>(this: CLASS, name: PROP) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "observe", "kind": "field", "static": true, "description": "Creates observable properties on instances", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends IDLParameter, VALUE extends { [KEY in keyof PROPS]: PROPS[KEY] extends (...args2: any[]) => infer R ? R : PROPS[KEY] extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : PROPS[KEY] extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : PROPS[KEY] extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : PROPS[KEY] extends ObserverOptions ? (unknown extends R ? string : R) : never; }>(this: CLASS, props: PROPS) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "defineStatic", "kind": "field", "static": true, "type": { "text": ">(this: T1, props: T2) => T1 & ParsedProps" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "events", "kind": "field", "static": true, "type": { "text": "(this: T, listeners?: CompositionEventListenerObject>, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "childEvents", "kind": "field", "static": true, "type": { "text": "(this: T, listenerMap: { [x: string]: CompositionEventListenerObject>; }, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "rootEvents", "kind": "field", "static": true, "type": { "text": "(this: T, listeners?: CompositionEventListenerObject>, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "on", "kind": "field", "static": true, "type": { "text": ", T3 extends CompositionCallback, T4 extends keyof T3>(this: T1, name: T3 | T4, callbacks?: T3[T4] & ThisType) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "off", "kind": "field", "static": true, "type": { "text": ", T3 extends CompositionCallback, T4 extends keyof T3>(this: T1, name: T3 | T4, callbacks?: T3[T4] & ThisType) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "offPropChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: ObjectOrObjectEntries<{ [P in keyof T2]?: (this: T2, oldValue: T2[P], newValue: T2[P], changes: any, element: T2) => void; }>) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "offAttributeChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: { [x: string]: (this: T2, oldValue: string, newValue: string, element: T2) => void; }) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "onPropChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: ObjectOrObjectEntries<{ [P in keyof T2]?: (this: T2, oldValue: T2[P], newValue: T2[P], changes: any, element: T2) => void; }>) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "onAttributeChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: { [x: string]: (this: T2, oldValue: string, newValue: string, element: T2) => void; }) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } } ], "slots": [ { "name": "", "description": "" } ], "cssParts": [], "events": [], "demos": [], "superclass": { "module": "core/CustomElement.js", "name": "default" }, "mixins": [ { "module": "mixins/ThemableMixin.js", "name": "default" }, { "module": "mixins/ShapeMixin.js", "name": "default" } ], "description": "Visual helper that renders the switch thumb and related visual states.\n@see https://m3.material.io/components/switch/specs" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "default", "module": "components/SwitchIcon.js" } }, { "kind": "custom-element-definition", "name": "mdw-switch-icon", "declaration": { "name": "default", "module": "components/SwitchIcon.js" } } ] }, { "kind": "javascript-module", "path": "components/Tab.js", "declarations": [ { "kind": "class", "name": "Tab", "tagName": "mdw-tab", "customElement": true, "attributes": [ { "name": "shape-top", "fieldName": "shapeTop", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shape-bottom", "fieldName": "shapeBottom", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shape-start", "fieldName": "shapeStart", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shape-end", "fieldName": "shapeEnd", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shape-style", "fieldName": "shapeStyle", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "outlined", "fieldName": "outlined", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "disabled", "fieldName": "disabled", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "focused", "fieldName": "focused", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "hovered", "fieldName": "hovered", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "pressed", "fieldName": "pressed", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "href", "fieldName": "href", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/HyperlinkMixin.js" } }, { "name": "target", "fieldName": "target", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/HyperlinkMixin.js" } }, { "name": "download", "fieldName": "download", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/HyperlinkMixin.js" } }, { "name": "ping", "fieldName": "ping", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/HyperlinkMixin.js" } }, { "name": "rel", "fieldName": "rel", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/HyperlinkMixin.js" } }, { "name": "hreflang", "fieldName": "hreflang", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/HyperlinkMixin.js" } }, { "name": "referrerpolicy", "fieldName": "referrerPolicy", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/HyperlinkMixin.js" } }, { "name": "active", "description": "Whether this tab is currently active/selected.", "fieldName": "active", "type": { "text": "boolean" } }, { "name": "icon", "description": "Named icon to display above the label.", "fieldName": "icon", "type": { "text": "string" } }, { "name": "src", "description": "Image `src` for the icon when used instead of a named icon.", "fieldName": "src", "type": { "text": "string" } }, { "name": "aria-label", "description": "Optional aria-label for the tab's anchor element.", "fieldName": "ariaLabel", "type": { "text": "string" } }, { "name": "state-layer", "type": { "text": "boolean" }, "description": "Show the visual state layer element when true", "fieldName": "stateLayer", "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } } ], "members": [ { "name": "delegatesFocus", "kind": "field", "description": "When true, the element delegates focus to an internal focus target.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/DelegatesFocusMixin.js#L15" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "href", "kind": "field", "description": "The URL that the hyperlink points to.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L34" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/HyperlinkMixin.js" } }, { "name": "target", "kind": "field", "description": "The browsing context in which to open the linked resource (e.g. '_blank').", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L36" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/HyperlinkMixin.js" } }, { "name": "download", "kind": "field", "description": "Suggested filename for download.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L38" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/HyperlinkMixin.js" } }, { "name": "ping", "kind": "field", "description": "URLs to be pinged when the link is followed.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L40" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/HyperlinkMixin.js" } }, { "name": "rel", "kind": "field", "description": "Link relationship tokens (e.g. 'noopener', 'noreferrer').", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L42" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/HyperlinkMixin.js" } }, { "name": "hreflang", "kind": "field", "description": "Language of the linked resource.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L44" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/HyperlinkMixin.js" } }, { "name": "referrerPolicy", "kind": "field", "description": "Referrer policy for the link (serialized to 'referrerpolicy' attribute).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L46" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/HyperlinkMixin.js" } }, { "name": "origin", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L49" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/HyperlinkMixin.js" } }, { "name": "protocol", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L50" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/HyperlinkMixin.js" } }, { "name": "username", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L51" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/HyperlinkMixin.js" } }, { "name": "password", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L52" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/HyperlinkMixin.js" } }, { "name": "host", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L53" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/HyperlinkMixin.js" } }, { "name": "hostname", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L54" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/HyperlinkMixin.js" } }, { "name": "port", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L55" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/HyperlinkMixin.js" } }, { "name": "pathname", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L56" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/HyperlinkMixin.js" } }, { "name": "search", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L57" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/HyperlinkMixin.js" } }, { "name": "hash", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L58" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/HyperlinkMixin.js" } }, { "name": "disabled", "kind": "field", "description": "Whether the element is disabled (affects interactive states)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L14" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "focused", "kind": "field", "description": "Force focus state (independent of document)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L16" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "hovered", "kind": "field", "description": "Force hover state (independent of interaction)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L18" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "pressed", "kind": "field", "description": "Force pressed state (independent of interaction)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L20" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "stateLayer", "kind": "field", "description": "Show the visual state layer element when true\nEnable state-layer visual treatment for pressed/hover states.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Tab.js#L32" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "disabledState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L37" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "hoveredState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L38" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "focusedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L39" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "pressedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L40" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "touchedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L41" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "pointedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L44" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "stateTargetElement", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Tab.js#L28" }, "type": { "text": "HTMLElement" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "color", "kind": "field", "description": "Palette or surface token used to select background/ink tokens.\nExamples: 'primary', 'background', 'surface-container-low'.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L52" }, "type": { "text": "string" } }, { "name": "ink", "kind": "field", "description": "Explicit ink override token (e.g. 'outline', 'on-primary', 'inverse-on-surface', 'inherit').\nMaps to `--mdw-ink`.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L57" }, "type": { "text": "string" } }, { "name": "typeStyle", "kind": "field", "description": "Typographic style shortcut that maps to type scale variables\n(e.g. 'headline-large', 'body-medium').", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L62" }, "type": { "text": "string" } }, { "name": "shapeTop", "kind": "field", "description": "Show top cut/shape on the element", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L9" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shapeBottom", "kind": "field", "description": "Show bottom cut/shape on the element", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L11" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shapeStart", "kind": "field", "description": "Show start-side cut/shape (logical start)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L13" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shapeEnd", "kind": "field", "description": "Show end-side cut/shape (logical end)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L15" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shapeStyle", "kind": "field", "description": "Predefined shape size/style name (none|extra-small|small|medium|large|extra-large|full|inherit)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L17" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "outlined", "kind": "field", "description": "When true, an outline is rendered around the element", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L19" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "active", "kind": "field", "description": "Whether this tab is currently active/selected.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Tab.js#L36" }, "type": { "text": "boolean" } }, { "name": "icon", "kind": "field", "description": "Named icon to display above the label.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Tab.js#L38" }, "type": { "text": "string" } }, { "name": "src", "kind": "field", "description": "Image `src` for the icon when used instead of a named icon.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Tab.js#L40" }, "type": { "text": "string" } }, { "name": "computeLabelMetrics", "kind": "method", "description": "Compute the label metrics used for indicator alignment.\nReturns an object with `width` and `left` in pixels.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Tab.js#L54" }, "return": { "type": { "text": "() => { width: number; left: number; }" } } }, { "name": "anchorAriaControls", "kind": "method", "description": "Derive the `aria-controls` value from `href` if it references an id.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Tab.js#L65" }, "return": { "type": { "text": "() => string" } } }, { "name": "anchorAriaSelected", "kind": "method", "description": "Stringified `aria-selected` for the anchor.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Tab.js#L69" }, "return": { "type": { "text": "() => string" } } }, { "name": "anchorAriaDisabled", "kind": "method", "description": "Stringified `aria-disabled` for the anchor.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Tab.js#L73" }, "return": { "type": { "text": "() => string" } } }, { "name": "anchorHref", "kind": "method", "description": "Ensure anchor `href` defaults to `#` when unset.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Tab.js#L77" }, "return": { "type": { "text": "() => string" } } }, { "name": "iconIf", "kind": "method", "description": "True when an icon or src is provided and should render.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Tab.js#L81" }, "return": { "type": { "text": "() => string" } } }, { "name": "iconVariation", "kind": "method", "description": "Icon variation to use when active.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Tab.js#L85" }, "return": { "type": { "text": "() => string" } } }, { "name": "prototype", "kind": "field", "static": true, "type": { "text": "CustomElement" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "addRipple", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/RippleMixin.js#L37" }, "return": { "type": { "text": "(x?: number, y?: number, hold?: boolean) => CustomElement & { hadRippleHeld: boolean; hadRippleReleased: boolean; rippleStarted: boolean; } & { rippleState: string; keepAlive: boolean; _positionX: number; _positionY: number; _radius: number; holdRipple: boolean; } & { _positionStyle: ElementStylerOptions | { styles: { minHeight: string; minWidth: string; boxShadow: string; top: string; left: string; }; }; } & { updatePosition(x?: number, y?: number, size?: number): void; handleRippleComplete(): void; }" } }, "inheritedFrom": { "name": "default", "module": "mixins/RippleMixin.js" } }, { "name": "startScrollListener", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ScrollListenerMixin.js#L63" }, "return": { "type": { "text": "(scroller?: EventTarget) => boolean" } }, "inheritedFrom": { "name": "default", "module": "mixins/ScrollListenerMixin.js" } }, { "name": "compose", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L145" }, "type": { "text": "(parts: CompositionPart[]) => Composition" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#refsProxy", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1145" }, "type": { "text": "Record" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#refsCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1148" }, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#refsCompositionCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1151" }, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#composition", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1154" }, "type": { "text": "Composition" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#patching", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1156" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#pendingPatchRenders", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1159" }, "type": { "text": "[string, any, CustomElement][]" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#propAttributeCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1162" }, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#callbackArguments", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1165" }, "type": { "text": "CallbackArguments" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "elementInternals", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1172" }, "type": { "text": "ElementInternals" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "render", "kind": "field", "description": "Updates nodes based on data\nExpects data in JSON Merge Patch format", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1185" }, "type": { "text": "RenderDraw" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "propChangedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1213" }, "type": { "text": "(this: T, name: K, oldValue: K extends keyof T ? T[K] : unknown, newValue: K extends keyof T ? T[K] : unknown, changes?: K extends keyof T ? T[K] extends object ? Partial : T[K] : unknown) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attributeChangedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1234" }, "type": { "text": "(name: string, oldValue: string, newValue: string) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#template", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1284" }, "type": { "text": "DocumentFragment" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#onObserverPropertyChanged", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1294" }, "type": { "text": "(name: string, oldValue: any, newValue: any, changes: any) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "static", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1330" }, "type": { "text": "typeof CustomElement" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "patch", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1333" }, "type": { "text": "(patch: any) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "refs", "kind": "field", "description": "Proxy object that returns shadow DOM elements by tag.\nIf called before interpolation (eg: on composed), returns from template", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1404" }, "type": { "text": "Record" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attributeCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1391" }, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "callbackArguments", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1400" }, "type": { "text": "CallbackArguments | { composition: Composition; refs: Record; html: any; inline: (fn: (data: Partial) => any) => string; template: DocumentFragment; element: T; }" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "composition", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1403" }, "type": { "text": "Composition" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "connectedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1435" }, "type": { "text": "() => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "disconnectedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1441" }, "type": { "text": "() => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "elementName", "kind": "field", "static": true, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "observedAttributes", "kind": "field", "static": true, "type": { "text": "Iterable" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "interpolatesTemplate", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "supportsElementInternals", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "supportsElementInternalsRole", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "defined", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "registrations", "kind": "field", "static": true, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "expressions", "kind": "method", "static": true, "description": "Expressions are idempotent functions that are selectively called whenever\na render is requested.\nExpressions are constructed exactly as methods though differ in expected\narguments. The first argument should be destructured to ensure each used\nproperty is accessed at least once in order to inspect used properties.\n\nThe Composition API will inspect this function with a proxy for `this` to\ncatalog what observables are used by the expression. This allows the\nComposition API to build a cache as well as selective invoke the expression\nonly when needed.\n\nWhen used with in element templates, the element itself will be passed as\nits first argument.\n````js\n Button\n .prop('filled', 'boolean')\n .prop('outlined', 'boolean')\n .expresssions({\n _isFilledOrOutlined({filled, outlined}) {\n return (filled || outlined)\n },\n })\n .html`
`;\n````\n\nWhen used with external data source, that data source\nwill be passed to the expression with all properties being `null` at first\ninspection.\n````js\n const externalData = {first: 'John', last: 'Doe'};\n ContactCard\n .expresssions({\n _fullName({first, last}) {\n return [first, last].filter(Boolean).join(' ');\n },\n })\n myButton.render(externalData);\n````\n\nExpressions may be support argumentless calls by using default\nparameters with `this`.\n````js\n Button\n .expresssions({\n isFilledOrOutlined({filled, outlined} = this) {\n return (filled || outlined)\n },\n });\n myButton.isFilledorOutlined();\n````", "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends { [K in keyof any]: K extends `_${any}` ? ((data: INSTANCE, state?: Record) => string | boolean | null) : ((data?: INSTANCE, state?: Record) => string | boolean | null); } & ThisType>(this: CLASS, expressions: PROPS & ThisType) => CLASS & Class<{ [K in keyof PROPS]: K extends `_${any}` ? never : () => ReturnType; }, ARGS>" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "methods", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "overrides", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends Partial>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "props", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "idl", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "append", "kind": "field", "static": true, "description": "Append parts to composition", "type": { "text": "(this: T, ...parts: CompositionPart[]) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "recompose", "kind": "field", "static": true, "description": "After composition, invokes callback.\nMay be called multiple times.", "type": { "text": ", T3 extends CompositionCallback[\"composed\"]>(this: T1, callback: T3) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "css", "kind": "field", "static": true, "description": "Appends styles to composition", "type": { "text": "(this: T1, array: T2, ...rest: T2 extends string ? any : T2 extends TemplateStringsArray ? any[] : (HTMLStyleElement | CSSStyleSheet)[]) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "autoRegister", "kind": "field", "static": true, "description": "Registers class with customElements. If class is registered before then,\ndoes nothing.", "type": { "text": "(this: T, elementName: string) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "html", "kind": "field", "static": true, "description": "Appends DocumentFragment to composition", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1405" }, "type": { "text": "(this: T, string: TemplateStringsArray, ...substitutions: (string | Element | ((this: InstanceType, data: InstanceType, injections?: any) => any))[]) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "extend", "kind": "field", "static": true, "description": "Extends base class into a new class.\nUse to avoid mutating base class.", "type": { "text": " T2>(this: T1, customExtender?: T3) => T3 extends null ? T1 : T2" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "setStatic", "kind": "field", "static": true, "description": "Assigns static values to class", "type": { "text": " any) | string | number | boolean | any[] | object); }>(this: T1, source: T2 & ThisType) => T1 & T2" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "readonly", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "set", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "mixin", "kind": "field", "static": true, "description": "Returns result of calling mixin with current class", "type": { "text": " any, RETURN extends ReturnType, SUBCLASS extends ClassOf>(this: BASE, mixin: FN) => SUBCLASS & BASE" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "register", "kind": "field", "static": true, "description": "Registers class with window.customElements synchronously", "type": { "text": "(this: T, elementName?: string, force?: boolean) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "propList", "kind": "field", "static": true, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attrList", "kind": "field", "static": true, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "propChangedCallbacks", "kind": "field", "static": true, "type": { "text": "Map any)[]>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attributeChangedCallbacks", "kind": "field", "static": true, "type": { "text": "Map any)[]>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "prop", "kind": "field", "static": true, "description": "Creates observable property on instances (via prototype)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1007" }, "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "setPrototype", "kind": "field", "static": true, "description": "Creates observable property on instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any)>(this: CLASS, name: KEY, options: OPTIONS) => OPTIONS extends (...args2: any[]) => infer R ? R : OPTIONS extends ObserverPropertyType ? ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? unknown extends R ? object : R : OPTIONS extends { type: ObserverPropertyType; } ? ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? unknown extends R ? string : R : never" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "define", "kind": "field", "static": true, "description": "Define properties on instances via Object.defineProperties().\nAutomatically sets property non-enumerable if name begins with `_`.\nFunctions will be remapped as getters", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends { [P in keyof any]: { enumerable?: boolean; configurable?: boolean; writable?: boolean; value?: any; get?: ((this: INSTANCE) => any); set?: (this: INSTANCE, value: any) => void; } | ((this: INSTANCE, ...args: any[]) => any); }, VALUE extends { [KEY in keyof PROPS]: PROPS[KEY] extends (...args2: any[]) => infer R ? R : PROPS[KEY] extends TypedPropertyDescriptor ? R : never; }>(this: CLASS, props: PROPS & ThisType) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "undefine", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROP extends string, PROPS extends INSTANCE & Record>(this: CLASS, name: PROP) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "observe", "kind": "field", "static": true, "description": "Creates observable properties on instances", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends IDLParameter, VALUE extends { [KEY in keyof PROPS]: PROPS[KEY] extends (...args2: any[]) => infer R ? R : PROPS[KEY] extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : PROPS[KEY] extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : PROPS[KEY] extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : PROPS[KEY] extends ObserverOptions ? (unknown extends R ? string : R) : never; }>(this: CLASS, props: PROPS) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "defineStatic", "kind": "field", "static": true, "type": { "text": ">(this: T1, props: T2) => T1 & ParsedProps" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "events", "kind": "field", "static": true, "type": { "text": "(this: T, listeners?: CompositionEventListenerObject>, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "childEvents", "kind": "field", "static": true, "type": { "text": "(this: T, listenerMap: { [x: string]: CompositionEventListenerObject>; }, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "rootEvents", "kind": "field", "static": true, "type": { "text": "(this: T, listeners?: CompositionEventListenerObject>, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "on", "kind": "field", "static": true, "type": { "text": ", T3 extends CompositionCallback, T4 extends keyof T3>(this: T1, name: T3 | T4, callbacks?: T3[T4] & ThisType) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "off", "kind": "field", "static": true, "type": { "text": ", T3 extends CompositionCallback, T4 extends keyof T3>(this: T1, name: T3 | T4, callbacks?: T3[T4] & ThisType) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "offPropChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: ObjectOrObjectEntries<{ [P in keyof T2]?: (this: T2, oldValue: T2[P], newValue: T2[P], changes: any, element: T2) => void; }>) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "offAttributeChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: { [x: string]: (this: T2, oldValue: string, newValue: string, element: T2) => void; }) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "onPropChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: ObjectOrObjectEntries<{ [P in keyof T2]?: (this: T2, oldValue: T2[P], newValue: T2[P], changes: any, element: T2) => void; }>) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "onAttributeChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: { [x: string]: (this: T2, oldValue: string, newValue: string, element: T2) => void; }) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } } ], "slots": [ { "name": "", "description": "" } ], "cssParts": [], "events": [], "demos": [ { "url": "demo/components/tabs.html" } ], "superclass": { "module": "core/CustomElement.js", "name": "default" }, "mixins": [ { "module": "mixins/ShapeMixin.js", "name": "default" }, { "module": "mixins/StateMixin.js", "name": "default" }, { "module": "mixins/RippleMixin.js", "name": "default" }, { "module": "mixins/ScrollListenerMixin.js", "name": "default" }, { "module": "mixins/HyperlinkMixin.js", "name": "default" }, { "module": "mixins/DelegatesFocusMixin.js", "name": "default" } ], "description": "Tabs organize content into separate views where only one view is visible\nat a time; tabs provide navigation between those views.\n@see https://m3.material.io/components/tabs/specs" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "default", "module": "components/Tab.js" } }, { "kind": "custom-element-definition", "name": "mdw-tab", "declaration": { "name": "default", "module": "components/Tab.js" } } ] }, { "kind": "javascript-module", "path": "components/TabContent.js", "declarations": [ { "kind": "class", "name": "TabContent", "tagName": "mdw-tab-content", "customElement": true, "attributes": [], "members": [ { "name": "panels", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/TabContent.js#L40" }, "type": { "text": "(CustomElement & { _ariaRole: string; } & { _onConnectAriaValues: Map<\"ariaAtomic\" | \"ariaAutoComplete\" | \"ariaBrailleLabel\" | \"ariaBrailleRoleDescription\" | \"ariaBusy\" | \"ariaChecked\" | \"ariaColCount\" | \"ariaColIndex\" | \"ariaColIndexText\" | \"ariaColSpan\" | \"ariaCurrent\" | \"ariaDescription\" | \"ariaDisabled\" | \"ariaExpanded\" | \"ariaHasPopup\" | \"ariaHidden\" | \"ariaInvalid\" | \"ariaKeyShortcuts\" | \"ariaLabel\" | \"ariaLevel\" | \"ariaLive\" | \"ariaModal\" | \"ariaMultiLine\" | \"ariaMultiSelectable\" | \"ariaOrientation\" | \"ariaPlaceholder\" | \"ariaPosInSet\" | \"ariaPressed\" | \"ariaReadOnly\" | \"ariaRelevant\" | \"ariaRequired\" | \"ariaRoleDescription\" | \"ariaRowCount\" | \"ariaRowIndex\" | \"ariaRowIndexText\" | \"ariaRowSpan\" | \"ariaSelected\" | \"ariaSetSize\" | \"ariaSort\" | \"ariaValueMax\" | \"ariaValueMin\" | \"ariaValueNow\" | \"ariaValueText\" | \"role\", string>; } & { readAriaProperty(name: \"shadowRoot\" | \"ariaActiveDescendantElement\" | \"ariaAtomic\" | \"ariaAutoComplete\" | \"ariaBrailleLabel\" | \"ariaBrailleRoleDescription\" | \"ariaBusy\" | \"ariaChecked\" | \"ariaColCount\" | \"ariaColIndex\" | \"ariaColIndexText\" | \"ariaColSpan\" | \"ariaControlsElements\" | \"ariaCurrent\" | \"ariaDescribedByElements\" | \"ariaDescription\" | \"ariaDetailsElements\" | \"ariaDisabled\" | \"ariaErrorMessageElements\" | \"ariaExpanded\" | \"ariaFlowToElements\" | \"ariaHasPopup\" | \"ariaHidden\" | \"ariaInvalid\" | \"ariaKeyShortcuts\" | \"ariaLabel\" | \"ariaLabelledByElements\" | \"ariaLevel\" | \"ariaLive\" | \"ariaModal\" | \"ariaMultiLine\" | \"ariaMultiSelectable\" | \"ariaOrientation\" | \"ariaOwnsElements\" | \"ariaPlaceholder\" | \"ariaPosInSet\" | \"ariaPressed\" | \"ariaReadOnly\" | \"ariaRelevant\" | \"ariaRequired\" | \"ariaRoleDescription\" | \"ariaRowCount\" | \"ariaRowIndex\" | \"ariaRowIndexText\" | \"ariaRowSpan\" | \"ariaSelected\" | \"ariaSetSize\" | \"ariaSort\" | \"ariaValueMax\" | \"ariaValueMin\" | \"ariaValueNow\" | \"ariaValueText\" | \"role\"): string | Element | ShadowRoot | readonly Element[]; updateAriaProperty>(name: K, value: ARIAMixin[K]): void; } & { block: boolean; inline: boolean; row: boolean; x: string; y: string; gap: number; padding: string; } & { color: string; ink: string; typeStyle: string; } & { _ariaRole: string; } & { active: boolean; peeking: boolean; })[]" } }, { "name": "panelMetrics", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/TabContent.js#L43" }, "type": { "text": "{ left: number; width: number; right: number; center: number; index: number; }[]" } }, { "name": "selectedIndex", "kind": "field", "description": "Modifiable index of the currently-selected panel. 0-based index.\nSetting this updates panel `active` states accordingly.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/TabContent.js#L59" }, "type": { "text": "number" } }, { "name": "selectedPanel", "kind": "field", "description": "Modifiable currently selected panel.\nSetting this updates panel `active` states accordingly.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/TabContent.js#L88" }, "type": { "text": "CustomElement & { _ariaRole: string; } & { _onConnectAriaValues: Map<\"ariaAtomic\" | \"ariaAutoComplete\" | \"ariaBrailleLabel\" | \"ariaBrailleRoleDescription\" | \"ariaBusy\" | \"ariaChecked\" | \"ariaColCount\" | \"ariaColIndex\" | \"ariaColIndexText\" | \"ariaColSpan\" | \"ariaCurrent\" | \"ariaDescription\" | \"ariaDisabled\" | \"ariaExpanded\" | \"ariaHasPopup\" | \"ariaHidden\" | \"ariaInvalid\" | \"ariaKeyShortcuts\" | \"ariaLabel\" | \"ariaLevel\" | \"ariaLive\" | \"ariaModal\" | \"ariaMultiLine\" | \"ariaMultiSelectable\" | \"ariaOrientation\" | \"ariaPlaceholder\" | \"ariaPosInSet\" | \"ariaPressed\" | \"ariaReadOnly\" | \"ariaRelevant\" | \"ariaRequired\" | \"ariaRoleDescription\" | \"ariaRowCount\" | \"ariaRowIndex\" | \"ariaRowIndexText\" | \"ariaRowSpan\" | \"ariaSelected\" | \"ariaSetSize\" | \"ariaSort\" | \"ariaValueMax\" | \"ariaValueMin\" | \"ariaValueNow\" | \"ariaValueText\" | \"role\", string>; } & { readAriaProperty(name: \"shadowRoot\" | \"ariaActiveDescendantElement\" | \"ariaAtomic\" | \"ariaAutoComplete\" | \"ariaBrailleLabel\" | \"ariaBrailleRoleDescription\" | \"ariaBusy\" | \"ariaChecked\" | \"ariaColCount\" | \"ariaColIndex\" | \"ariaColIndexText\" | \"ariaColSpan\" | \"ariaControlsElements\" | \"ariaCurrent\" | \"ariaDescribedByElements\" | \"ariaDescription\" | \"ariaDetailsElements\" | \"ariaDisabled\" | \"ariaErrorMessageElements\" | \"ariaExpanded\" | \"ariaFlowToElements\" | \"ariaHasPopup\" | \"ariaHidden\" | \"ariaInvalid\" | \"ariaKeyShortcuts\" | \"ariaLabel\" | \"ariaLabelledByElements\" | \"ariaLevel\" | \"ariaLive\" | \"ariaModal\" | \"ariaMultiLine\" | \"ariaMultiSelectable\" | \"ariaOrientation\" | \"ariaOwnsElements\" | \"ariaPlaceholder\" | \"ariaPosInSet\" | \"ariaPressed\" | \"ariaReadOnly\" | \"ariaRelevant\" | \"ariaRequired\" | \"ariaRoleDescription\" | \"ariaRowCount\" | \"ariaRowIndex\" | \"ariaRowIndexText\" | \"ariaRowSpan\" | \"ariaSelected\" | \"ariaSetSize\" | \"ariaSort\" | \"ariaValueMax\" | \"ariaValueMin\" | \"ariaValueNow\" | \"ariaValueText\" | \"role\"): string | Element | ShadowRoot | readonly Element[]; updateAriaProperty>(name: K, value: ARIAMixin[K]): void; } & { block: boolean; inline: boolean; row: boolean; x: string; y: string; gap: number; padding: string; } & { color: string; ink: string; typeStyle: string; } & { _ariaRole: string; } & { active: boolean; peeking: boolean; }" } }, { "name": "updatePanels", "kind": "method", "description": "Recompute which panels are visible based on scroll position and\nactivate the panel whose visible percentage is >= 50%.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/TabContent.js#L117" }, "return": { "type": { "text": "() => void" } } }, { "name": "prototype", "kind": "field", "static": true, "type": { "text": "CustomElement" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "onResizeObserved", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ResizeObserverMixin.js#L23" }, "return": { "type": { "text": "(entry: ResizeObserverEntry) => void" } }, "inheritedFrom": { "name": "default", "module": "mixins/ResizeObserverMixin.js" } }, { "name": "observeResize", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ResizeObserverMixin.js#L26" }, "return": { "type": { "text": "() => void" } }, "inheritedFrom": { "name": "default", "module": "mixins/ResizeObserverMixin.js" } }, { "name": "unobserveResize", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ResizeObserverMixin.js#L31" }, "return": { "type": { "text": "() => void" } }, "inheritedFrom": { "name": "default", "module": "mixins/ResizeObserverMixin.js" } }, { "name": "compose", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L145" }, "type": { "text": "(parts: CompositionPart[]) => Composition" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#refsProxy", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1145" }, "type": { "text": "Record" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#refsCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1148" }, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#refsCompositionCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1151" }, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#composition", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1154" }, "type": { "text": "Composition" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#patching", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1156" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#pendingPatchRenders", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1159" }, "type": { "text": "[string, any, CustomElement][]" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#propAttributeCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1162" }, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#callbackArguments", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1165" }, "type": { "text": "CallbackArguments" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "elementInternals", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1172" }, "type": { "text": "ElementInternals" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "render", "kind": "field", "description": "Updates nodes based on data\nExpects data in JSON Merge Patch format", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1185" }, "type": { "text": "RenderDraw" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "propChangedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1213" }, "type": { "text": "(this: T, name: K, oldValue: K extends keyof T ? T[K] : unknown, newValue: K extends keyof T ? T[K] : unknown, changes?: K extends keyof T ? T[K] extends object ? Partial : T[K] : unknown) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attributeChangedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1234" }, "type": { "text": "(name: string, oldValue: string, newValue: string) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#template", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1284" }, "type": { "text": "DocumentFragment" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#onObserverPropertyChanged", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1294" }, "type": { "text": "(name: string, oldValue: any, newValue: any, changes: any) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "static", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1330" }, "type": { "text": "typeof CustomElement" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "patch", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1333" }, "type": { "text": "(patch: any) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "refs", "kind": "field", "description": "Proxy object that returns shadow DOM elements by tag.\nIf called before interpolation (eg: on composed), returns from template", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1404" }, "type": { "text": "Record" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attributeCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1391" }, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "callbackArguments", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1400" }, "type": { "text": "CallbackArguments | { composition: Composition; refs: Record; html: any; inline: (fn: (data: Partial) => any) => string; template: DocumentFragment; element: T; }" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "composition", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1403" }, "type": { "text": "Composition" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "connectedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1435" }, "type": { "text": "() => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "disconnectedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1441" }, "type": { "text": "() => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "delegatesFocus", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1175" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "elementName", "kind": "field", "static": true, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "observedAttributes", "kind": "field", "static": true, "type": { "text": "Iterable" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "interpolatesTemplate", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "supportsElementInternals", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "supportsElementInternalsRole", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "defined", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "registrations", "kind": "field", "static": true, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "expressions", "kind": "method", "static": true, "description": "Expressions are idempotent functions that are selectively called whenever\na render is requested.\nExpressions are constructed exactly as methods though differ in expected\narguments. The first argument should be destructured to ensure each used\nproperty is accessed at least once in order to inspect used properties.\n\nThe Composition API will inspect this function with a proxy for `this` to\ncatalog what observables are used by the expression. This allows the\nComposition API to build a cache as well as selective invoke the expression\nonly when needed.\n\nWhen used with in element templates, the element itself will be passed as\nits first argument.\n````js\n Button\n .prop('filled', 'boolean')\n .prop('outlined', 'boolean')\n .expresssions({\n _isFilledOrOutlined({filled, outlined}) {\n return (filled || outlined)\n },\n })\n .html`
`;\n````\n\nWhen used with external data source, that data source\nwill be passed to the expression with all properties being `null` at first\ninspection.\n````js\n const externalData = {first: 'John', last: 'Doe'};\n ContactCard\n .expresssions({\n _fullName({first, last}) {\n return [first, last].filter(Boolean).join(' ');\n },\n })\n myButton.render(externalData);\n````\n\nExpressions may be support argumentless calls by using default\nparameters with `this`.\n````js\n Button\n .expresssions({\n isFilledOrOutlined({filled, outlined} = this) {\n return (filled || outlined)\n },\n });\n myButton.isFilledorOutlined();\n````", "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends { [K in keyof any]: K extends `_${any}` ? ((data: INSTANCE, state?: Record) => string | boolean | null) : ((data?: INSTANCE, state?: Record) => string | boolean | null); } & ThisType>(this: CLASS, expressions: PROPS & ThisType) => CLASS & Class<{ [K in keyof PROPS]: K extends `_${any}` ? never : () => ReturnType; }, ARGS>" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "methods", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "overrides", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends Partial>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "props", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "idl", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "append", "kind": "field", "static": true, "description": "Append parts to composition", "type": { "text": "(this: T, ...parts: CompositionPart[]) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "recompose", "kind": "field", "static": true, "description": "After composition, invokes callback.\nMay be called multiple times.", "type": { "text": ", T3 extends CompositionCallback[\"composed\"]>(this: T1, callback: T3) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "css", "kind": "field", "static": true, "description": "Appends styles to composition", "type": { "text": "(this: T1, array: T2, ...rest: T2 extends string ? any : T2 extends TemplateStringsArray ? any[] : (HTMLStyleElement | CSSStyleSheet)[]) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "autoRegister", "kind": "field", "static": true, "description": "Registers class with customElements. If class is registered before then,\ndoes nothing.", "type": { "text": "(this: T, elementName: string) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "html", "kind": "field", "static": true, "description": "Appends DocumentFragment to composition", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1405" }, "type": { "text": "(this: T, string: TemplateStringsArray, ...substitutions: (string | Element | ((this: InstanceType, data: InstanceType, injections?: any) => any))[]) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "extend", "kind": "field", "static": true, "description": "Extends base class into a new class.\nUse to avoid mutating base class.", "type": { "text": " T2>(this: T1, customExtender?: T3) => T3 extends null ? T1 : T2" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "setStatic", "kind": "field", "static": true, "description": "Assigns static values to class", "type": { "text": " any) | string | number | boolean | any[] | object); }>(this: T1, source: T2 & ThisType) => T1 & T2" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "readonly", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "set", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "mixin", "kind": "field", "static": true, "description": "Returns result of calling mixin with current class", "type": { "text": " any, RETURN extends ReturnType, SUBCLASS extends ClassOf>(this: BASE, mixin: FN) => SUBCLASS & BASE" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "register", "kind": "field", "static": true, "description": "Registers class with window.customElements synchronously", "type": { "text": "(this: T, elementName?: string, force?: boolean) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "propList", "kind": "field", "static": true, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attrList", "kind": "field", "static": true, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "propChangedCallbacks", "kind": "field", "static": true, "type": { "text": "Map any)[]>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attributeChangedCallbacks", "kind": "field", "static": true, "type": { "text": "Map any)[]>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "prop", "kind": "field", "static": true, "description": "Creates observable property on instances (via prototype)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1007" }, "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "setPrototype", "kind": "field", "static": true, "description": "Creates observable property on instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any)>(this: CLASS, name: KEY, options: OPTIONS) => OPTIONS extends (...args2: any[]) => infer R ? R : OPTIONS extends ObserverPropertyType ? ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? unknown extends R ? object : R : OPTIONS extends { type: ObserverPropertyType; } ? ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? unknown extends R ? string : R : never" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "define", "kind": "field", "static": true, "description": "Define properties on instances via Object.defineProperties().\nAutomatically sets property non-enumerable if name begins with `_`.\nFunctions will be remapped as getters", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends { [P in keyof any]: { enumerable?: boolean; configurable?: boolean; writable?: boolean; value?: any; get?: ((this: INSTANCE) => any); set?: (this: INSTANCE, value: any) => void; } | ((this: INSTANCE, ...args: any[]) => any); }, VALUE extends { [KEY in keyof PROPS]: PROPS[KEY] extends (...args2: any[]) => infer R ? R : PROPS[KEY] extends TypedPropertyDescriptor ? R : never; }>(this: CLASS, props: PROPS & ThisType) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "undefine", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROP extends string, PROPS extends INSTANCE & Record>(this: CLASS, name: PROP) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "observe", "kind": "field", "static": true, "description": "Creates observable properties on instances", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends IDLParameter, VALUE extends { [KEY in keyof PROPS]: PROPS[KEY] extends (...args2: any[]) => infer R ? R : PROPS[KEY] extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : PROPS[KEY] extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : PROPS[KEY] extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : PROPS[KEY] extends ObserverOptions ? (unknown extends R ? string : R) : never; }>(this: CLASS, props: PROPS) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "defineStatic", "kind": "field", "static": true, "type": { "text": ">(this: T1, props: T2) => T1 & ParsedProps" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "events", "kind": "field", "static": true, "type": { "text": "(this: T, listeners?: CompositionEventListenerObject>, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "childEvents", "kind": "field", "static": true, "type": { "text": "(this: T, listenerMap: { [x: string]: CompositionEventListenerObject>; }, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "rootEvents", "kind": "field", "static": true, "type": { "text": "(this: T, listeners?: CompositionEventListenerObject>, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "on", "kind": "field", "static": true, "type": { "text": ", T3 extends CompositionCallback, T4 extends keyof T3>(this: T1, name: T3 | T4, callbacks?: T3[T4] & ThisType) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "off", "kind": "field", "static": true, "type": { "text": ", T3 extends CompositionCallback, T4 extends keyof T3>(this: T1, name: T3 | T4, callbacks?: T3[T4] & ThisType) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "offPropChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: ObjectOrObjectEntries<{ [P in keyof T2]?: (this: T2, oldValue: T2[P], newValue: T2[P], changes: any, element: T2) => void; }>) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "offAttributeChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: { [x: string]: (this: T2, oldValue: string, newValue: string, element: T2) => void; }) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "onPropChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: ObjectOrObjectEntries<{ [P in keyof T2]?: (this: T2, oldValue: T2[P], newValue: T2[P], changes: any, element: T2) => void; }>) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "onAttributeChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: { [x: string]: (this: T2, oldValue: string, newValue: string, element: T2) => void; }) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } } ], "slots": [ { "name": "", "description": "" } ], "cssParts": [], "events": [], "demos": [], "superclass": { "module": "core/CustomElement.js", "name": "default" }, "mixins": [ { "module": "mixins/ResizeObserverMixin.js", "name": "default" } ], "description": "Tab content hosts tab panels and manages which panel is visible based on\nscroll position or selected tab.\n@see https://m3.material.io/components/tabs/specs" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "default", "module": "components/TabContent.js" } }, { "kind": "custom-element-definition", "name": "mdw-tab-content", "declaration": { "name": "default", "module": "components/TabContent.js" } } ] }, { "kind": "javascript-module", "path": "components/TabList.js", "declarations": [ { "kind": "class", "name": "TabList", "tagName": "mdw-tab-list", "customElement": true, "attributes": [ { "name": "color", "description": "Color token used for the tab ink.", "fieldName": "color", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "ink", "fieldName": "ink", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "type-style", "fieldName": "typeStyle", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "kbd-nav", "fieldName": "kbdNav", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/KeyboardNavMixin.js" } }, { "name": "page-is-r-t-l", "fieldName": "pageIsRTL", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/RTLObserverMixin.js" } }, { "name": "shape-top", "fieldName": "shapeTop", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shape-bottom", "fieldName": "shapeBottom", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shape-start", "fieldName": "shapeStart", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shape-end", "fieldName": "shapeEnd", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shape-style", "fieldName": "shapeStyle", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "outlined", "fieldName": "outlined", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "sticky-always", "fieldName": "stickyAlways", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/SemiStickyMixin.js" } }, { "name": "sticky-parent", "fieldName": "stickyParent", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/SemiStickyMixin.js" } }, { "name": "scrollable", "description": "When true the tablist is scrollable (renders differently).", "fieldName": "scrollable", "type": { "text": "boolean" } }, { "name": "tab-content-id", "description": "Id of an external `TabContent` element to bind and observe.", "fieldName": "tabContentId", "type": { "text": "string" } }, { "name": "active", "description": "Whether the tablist is visually active (has a selected tab).", "fieldName": "active", "type": { "text": "boolean" } }, { "name": "secondary", "description": "Render the secondary (label-width) indicator style when true.", "fieldName": "secondary", "type": { "text": "boolean" } } ], "members": [ { "name": "stickyAlways", "kind": "field", "description": "When true, element remains always visible", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/SemiStickyMixin.js#L26" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/SemiStickyMixin.js" } }, { "name": "stickyParent", "kind": "field", "description": "Stick to offsetParent instead of window", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/SemiStickyMixin.js#L28" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/SemiStickyMixin.js" } }, { "name": "disabled", "kind": "field", "description": "Whether the element is disabled (affects interactive states)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L14" }, "type": { "text": "boolean" } }, { "name": "focused", "kind": "field", "description": "Force focus state (independent of document)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L16" }, "type": { "text": "boolean" } }, { "name": "hovered", "kind": "field", "description": "Force hover state (independent of interaction)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L18" }, "type": { "text": "boolean" } }, { "name": "pressed", "kind": "field", "description": "Force pressed state (independent of interaction)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L20" }, "type": { "text": "boolean" } }, { "name": "stateLayer", "kind": "field", "description": "Show the visual state layer element when true", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L34" }, "type": { "text": "boolean" } }, { "name": "disabledState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L37" }, "type": { "text": "boolean" } }, { "name": "hoveredState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L38" }, "type": { "text": "boolean" } }, { "name": "focusedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L39" }, "type": { "text": "boolean" } }, { "name": "pressedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L40" }, "type": { "text": "boolean" } }, { "name": "touchedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L41" }, "type": { "text": "boolean" } }, { "name": "pointedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L44" }, "type": { "text": "boolean" } }, { "name": "stateTargetElement", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L50" }, "type": { "text": "HTMLElement" } }, { "name": "color", "kind": "field", "description": "Palette or surface token used to select background/ink tokens.\nExamples: 'primary', 'background', 'surface-container-low'.\nColor token used for the tab ink.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/TabList.js#L85" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "ink", "kind": "field", "description": "Explicit ink override token (e.g. 'outline', 'on-primary', 'inverse-on-surface', 'inherit').\nMaps to `--mdw-ink`.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L57" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "typeStyle", "kind": "field", "description": "Typographic style shortcut that maps to type scale variables\n(e.g. 'headline-large', 'body-medium').", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L62" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "shapeTop", "kind": "field", "description": "Show top cut/shape on the element", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L9" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shapeBottom", "kind": "field", "description": "Show bottom cut/shape on the element", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L11" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shapeStart", "kind": "field", "description": "Show start-side cut/shape (logical start)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L13" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shapeEnd", "kind": "field", "description": "Show end-side cut/shape (logical end)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L15" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shapeStyle", "kind": "field", "description": "Predefined shape size/style name (none|extra-small|small|medium|large|extra-large|full|inherit)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L17" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "outlined", "kind": "field", "description": "When true, an outline is rendered around the element", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L19" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "pageIsRTL", "kind": "field", "description": "Whether the page/document direction is RTL; kept in sync", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/RTLObserverMixin.js#L14" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/RTLObserverMixin.js" } }, { "name": "kbdNav", "kind": "field", "description": "Enable keyboard roving navigation when present (set to 'true').", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/KeyboardNavMixin.js#L23" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/KeyboardNavMixin.js" } }, { "name": "kbdNavQuery", "kind": "field", "description": "Query used to find roving tab index children", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/TabList.js#L110" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/KeyboardNavMixin.js" } }, { "name": "kbdNavFocusableWhenDisabled", "kind": "field", "description": "Flag whether disabled elements participating in roving tab index\nshould be focusable.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/KeyboardNavMixin.js#L39" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/KeyboardNavMixin.js" } }, { "name": "ariaOrientationDefault", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/TabList.js#L113" }, "type": { "text": "\"horizontal\" | \"vertical\"" }, "inheritedFrom": { "name": "default", "module": "mixins/KeyboardNavMixin.js" } }, { "name": "kbdNavChildren", "kind": "field", "description": "List of roving tab index participating children", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/KeyboardNavMixin.js#L48" }, "type": { "text": "NodeListOf" }, "inheritedFrom": { "name": "default", "module": "mixins/KeyboardNavMixin.js" } }, { "name": "scrollable", "kind": "field", "description": "When true the tablist is scrollable (renders differently).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/TabList.js#L28" }, "type": { "text": "boolean" } }, { "name": "tabContent", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/TabList.js#L52" }, "type": { "text": "HTMLElement" } }, { "name": "tabContentId", "kind": "field", "description": "Id of an external `TabContent` element to bind and observe.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/TabList.js#L77" }, "type": { "text": "string" } }, { "name": "active", "kind": "field", "description": "Whether the tablist is visually active (has a selected tab).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/TabList.js#L79" }, "type": { "text": "boolean" } }, { "name": "secondary", "kind": "field", "description": "Render the secondary (label-width) indicator style when true.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/TabList.js#L81" }, "type": { "text": "boolean" } }, { "name": "tabs", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/TabList.js#L88" }, "type": { "text": "HTMLCollectionOf; _scrollerScrollListener: EventListener; _scrollerResizeListener: EventListener; _scrollDebounce: any; } & { _scrollListenerOnScrollIdle(): void; _scrollListenerOnScrollerScroll(event: Event): void; _scrollListenerOnScrollerResize(event: Event): void; startScrollListener(scroller?: EventTarget): boolean; } & { _scrollListenerScroller: HTMLElement | Window; } & { _scrollListenerScrollerScrollHeight: any; _scrollListenerScrollerClientHeight: any; } & { _scrollListenerClear(scroller?: EventTarget): boolean; } & { disabled: boolean; focused: boolean; hovered: boolean; pressed: boolean; _lastInteraction: \"mouse\" | \"touch\" | \"key\" | \"pen\"; _hovered: boolean; _focused: boolean; _focusedSynthetic: boolean; _keyPressed: boolean; _keyReleased: boolean; _pointerPressed: boolean; stateLayer: boolean; } & { disabledState: boolean; hoveredState: boolean; focusedState: boolean; pressedState: boolean; touchedState: boolean; pointedState: boolean; } & { stateTargetElement: HTMLElement; } & { _lastRippleWeakRef: WeakRef; _rippleAdded: boolean; } & { _lastRipple: CustomElement & { hadRippleHeld: boolean; hadRippleReleased: boolean; rippleStarted: boolean; } & { rippleState: string; keepAlive: boolean; _positionX: number; _positionY: number; _radius: number; holdRipple: boolean; } & { _positionStyle: ElementStylerOptions | { styles: { minHeight: string; minWidth: string; boxShadow: string; top: string; left: string; }; }; } & { updatePosition(x?: number, y?: number, size?: number): void; handleRippleComplete(): void; }; } & { addRipple(x?: number, y?: number, hold?: boolean): CustomElement & { hadRippleHeld: boolean; hadRippleReleased: boolean; rippleStarted: boolean; } & { rippleState: string; keepAlive: boolean; _positionX: number; _positionY: number; _radius: number; holdRipple: boolean; } & { _positionStyle: ElementStylerOptions | { styles: { minHeight: string; minWidth: string; boxShadow: string; top: string; left: string; }; }; } & { updatePosition(x?: number, y?: number, size?: number): void; handleRippleComplete(): void; }; } & { color: string; ink: string; typeStyle: string; } & { shapeTop: boolean; shapeBottom: boolean; shapeStart: boolean; shapeEnd: boolean; shapeStyle: string; outlined: boolean; } & { stateTargetElement: HTMLElement; } & { stateLayer: boolean; } & { active: boolean; icon: string; src: string; ariaLabel: string; } & { focus(options?: FocusOptions): void; computeLabelMetrics(): { width: number; left: number; }; } & { anchorAriaControls: () => string; anchorAriaSelected: () => string; anchorAriaDisabled: () => string; anchorHref: () => string; iconIf: () => string; iconVariation: () => string; }>" } }, { "name": "childTabItems", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/TabList.js#L117" }, "type": { "text": "NodeListOf; _scrollerScrollListener: EventListener; _scrollerResizeListener: EventListener; _scrollDebounce: any; } & { _scrollListenerOnScrollIdle(): void; _scrollListenerOnScrollerScroll(event: Event): void; _scrollListenerOnScrollerResize(event: Event): void; startScrollListener(scroller?: EventTarget): boolean; } & { _scrollListenerScroller: HTMLElement | Window; } & { _scrollListenerScrollerScrollHeight: any; _scrollListenerScrollerClientHeight: any; } & { _scrollListenerClear(scroller?: EventTarget): boolean; } & { disabled: boolean; focused: boolean; hovered: boolean; pressed: boolean; _lastInteraction: \"mouse\" | \"touch\" | \"key\" | \"pen\"; _hovered: boolean; _focused: boolean; _focusedSynthetic: boolean; _keyPressed: boolean; _keyReleased: boolean; _pointerPressed: boolean; stateLayer: boolean; } & { disabledState: boolean; hoveredState: boolean; focusedState: boolean; pressedState: boolean; touchedState: boolean; pointedState: boolean; } & { stateTargetElement: HTMLElement; } & { _lastRippleWeakRef: WeakRef; _rippleAdded: boolean; } & { _lastRipple: CustomElement & { hadRippleHeld: boolean; hadRippleReleased: boolean; rippleStarted: boolean; } & { rippleState: string; keepAlive: boolean; _positionX: number; _positionY: number; _radius: number; holdRipple: boolean; } & { _positionStyle: ElementStylerOptions | { styles: { minHeight: string; minWidth: string; boxShadow: string; top: string; left: string; }; }; } & { updatePosition(x?: number, y?: number, size?: number): void; handleRippleComplete(): void; }; } & { addRipple(x?: number, y?: number, hold?: boolean): CustomElement & { hadRippleHeld: boolean; hadRippleReleased: boolean; rippleStarted: boolean; } & { rippleState: string; keepAlive: boolean; _positionX: number; _positionY: number; _radius: number; holdRipple: boolean; } & { _positionStyle: ElementStylerOptions | { styles: { minHeight: string; minWidth: string; boxShadow: string; top: string; left: string; }; }; } & { updatePosition(x?: number, y?: number, size?: number): void; handleRippleComplete(): void; }; } & { color: string; ink: string; typeStyle: string; } & { shapeTop: boolean; shapeBottom: boolean; shapeStart: boolean; shapeEnd: boolean; shapeStyle: string; outlined: boolean; } & { stateTargetElement: HTMLElement; } & { stateLayer: boolean; } & { active: boolean; icon: string; src: string; ariaLabel: string; } & { focus(options?: FocusOptions): void; computeLabelMetrics(): { width: number; left: number; }; } & { anchorAriaControls: () => string; anchorAriaSelected: () => string; anchorAriaDisabled: () => string; anchorHref: () => string; iconIf: () => string; iconVariation: () => string; }>" } }, { "name": "tabMetrics", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/TabList.js#L120" }, "type": { "text": "{ left: number; width: number; right: number; center: number; label: { left: number; width: number; }; tab: CustomElement & { delegatesFocus: boolean; } & { href: string; target: string; download: string; ping: string; rel: string; hreflang: string; referrerPolicy: string; } & { origin: string; protocol: string; username: string; password: string; host: string; hostname: string; port: string; pathname: string; search: string; hash: string; } & object & { _scrollListenerPositionX: number; _scrollListenerPositionY: number; _scrollListenerLastIdle: number; _scrollListenerLastScroll: number; _scrollListenerLastResize: number; } & { _scroller: WeakRef; _scrollerScrollListener: EventListener; _scrollerResizeListener: EventListener; _scrollDebounce: any; } & { _scrollListenerOnScrollIdle(): void; _scrollListenerOnScrollerScroll(event: Event): void; _scrollListenerOnScrollerResize(event: Event): void; startScrollListener(scroller?: EventTarget): boolean; } & { _scrollListenerScroller: HTMLElement | Window; } & { _scrollListenerScrollerScrollHeight: any; _scrollListenerScrollerClientHeight: any; } & { _scrollListenerClear(scroller?: EventTarget): boolean; } & { disabled: boolean; focused: boolean; hovered: boolean; pressed: boolean; _lastInteraction: \"mouse\" | \"touch\" | \"key\" | \"pen\"; _hovered: boolean; _focused: boolean; _focusedSynthetic: boolean; _keyPressed: boolean; _keyReleased: boolean; _pointerPressed: boolean; stateLayer: boolean; } & { disabledState: boolean; hoveredState: boolean; focusedState: boolean; pressedState: boolean; touchedState: boolean; pointedState: boolean; } & { stateTargetElement: HTMLElement; } & { _lastRippleWeakRef: WeakRef; _rippleAdded: boolean; } & { _lastRipple: CustomElement & { hadRippleHeld: boolean; hadRippleReleased: boolean; rippleStarted: boolean; } & { rippleState: string; keepAlive: boolean; _positionX: number; _positionY: number; _radius: number; holdRipple: boolean; } & { _positionStyle: ElementStylerOptions | { styles: { minHeight: string; minWidth: string; boxShadow: string; top: string; left: string; }; }; } & { updatePosition(x?: number, y?: number, size?: number): void; handleRippleComplete(): void; }; } & { addRipple(x?: number, y?: number, hold?: boolean): CustomElement & { hadRippleHeld: boolean; hadRippleReleased: boolean; rippleStarted: boolean; } & { rippleState: string; keepAlive: boolean; _positionX: number; _positionY: number; _radius: number; holdRipple: boolean; } & { _positionStyle: ElementStylerOptions | { styles: { minHeight: string; minWidth: string; boxShadow: string; top: string; left: string; }; }; } & { updatePosition(x?: number, y?: number, size?: number): void; handleRippleComplete(): void; }; } & { color: string; ink: string; typeStyle: string; } & { shapeTop: boolean; shapeBottom: boolean; shapeStart: boolean; shapeEnd: boolean; shapeStyle: string; outlined: boolean; } & { stateTargetElement: HTMLElement; } & { stateLayer: boolean; } & { active: boolean; icon: string; src: string; ariaLabel: string; } & { focus(options?: FocusOptions): void; computeLabelMetrics(): { width: number; left: number; }; } & { anchorAriaControls: () => string; anchorAriaSelected: () => string; anchorAriaDisabled: () => string; anchorHref: () => string; iconIf: () => string; iconVariation: () => string; }; index: number; }[]" } }, { "name": "selectedIndex", "kind": "field", "description": "Modifiable index of the currently selected tab. 0-based index.\nSetting this updates tab `active` states accordingly.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/TabList.js#L141" }, "type": { "text": "number" } }, { "name": "selectedItem", "kind": "field", "description": "Modifiable currently selected tab.\nSetting this updates tab `active` states accordingly.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/TabList.js#L169" }, "type": { "text": "CustomElement & { delegatesFocus: boolean; } & { href: string; target: string; download: string; ping: string; rel: string; hreflang: string; referrerPolicy: string; } & { origin: string; protocol: string; username: string; password: string; host: string; hostname: string; port: string; pathname: string; search: string; hash: string; } & object & { _scrollListenerPositionX: number; _scrollListenerPositionY: number; _scrollListenerLastIdle: number; _scrollListenerLastScroll: number; _scrollListenerLastResize: number; } & { _scroller: WeakRef; _scrollerScrollListener: EventListener; _scrollerResizeListener: EventListener; _scrollDebounce: any; } & { _scrollListenerOnScrollIdle(): void; _scrollListenerOnScrollerScroll(event: Event): void; _scrollListenerOnScrollerResize(event: Event): void; startScrollListener(scroller?: EventTarget): boolean; } & { _scrollListenerScroller: HTMLElement | Window; } & { _scrollListenerScrollerScrollHeight: any; _scrollListenerScrollerClientHeight: any; } & { _scrollListenerClear(scroller?: EventTarget): boolean; } & { disabled: boolean; focused: boolean; hovered: boolean; pressed: boolean; _lastInteraction: \"mouse\" | \"touch\" | \"key\" | \"pen\"; _hovered: boolean; _focused: boolean; _focusedSynthetic: boolean; _keyPressed: boolean; _keyReleased: boolean; _pointerPressed: boolean; stateLayer: boolean; } & { disabledState: boolean; hoveredState: boolean; focusedState: boolean; pressedState: boolean; touchedState: boolean; pointedState: boolean; } & { stateTargetElement: HTMLElement; } & { _lastRippleWeakRef: WeakRef; _rippleAdded: boolean; } & { _lastRipple: CustomElement & { hadRippleHeld: boolean; hadRippleReleased: boolean; rippleStarted: boolean; } & { rippleState: string; keepAlive: boolean; _positionX: number; _positionY: number; _radius: number; holdRipple: boolean; } & { _positionStyle: ElementStylerOptions | { styles: { minHeight: string; minWidth: string; boxShadow: string; top: string; left: string; }; }; } & { updatePosition(x?: number, y?: number, size?: number): void; handleRippleComplete(): void; }; } & { addRipple(x?: number, y?: number, hold?: boolean): CustomElement & { hadRippleHeld: boolean; hadRippleReleased: boolean; rippleStarted: boolean; } & { rippleState: string; keepAlive: boolean; _positionX: number; _positionY: number; _radius: number; holdRipple: boolean; } & { _positionStyle: ElementStylerOptions | { styles: { minHeight: string; minWidth: string; boxShadow: string; top: string; left: string; }; }; } & { updatePosition(x?: number, y?: number, size?: number): void; handleRippleComplete(): void; }; } & { color: string; ink: string; typeStyle: string; } & { shapeTop: boolean; shapeBottom: boolean; shapeStart: boolean; shapeEnd: boolean; shapeStyle: string; outlined: boolean; } & { stateTargetElement: HTMLElement; } & { stateLayer: boolean; } & { active: boolean; icon: string; src: string; ariaLabel: string; } & { focus(options?: FocusOptions): void; computeLabelMetrics(): { width: number; left: number; }; } & { anchorAriaControls: () => string; anchorAriaSelected: () => string; anchorAriaDisabled: () => string; anchorHref: () => string; iconIf: () => string; iconVariation: () => string; }" } }, { "name": "ariaRole", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/TabList.js#L302" }, "type": { "text": "string" } }, { "name": "clearCache", "kind": "method", "description": "Clear cached tab metrics (widths/positions).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/TabList.js#L198" }, "return": { "type": { "text": "() => void" } } }, { "name": "searchForTabContent", "kind": "method", "description": "Find and bind to the external `TabContent` element by id.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/TabList.js#L202" }, "return": { "type": { "text": "() => void" } } }, { "name": "updateIndicatorByTab", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/TabList.js#L211" }, "return": { "type": { "text": "(tab?: CustomElement & { delegatesFocus: boolean; } & { href: string; target: string; download: string; ping: string; rel: string; hreflang: string; referrerPolicy: string; } & { origin: string; protocol: string; username: string; password: string; host: string; hostname: string; port: string; pathname: string; search: string; hash: string; } & object & { _scrollListenerPositionX: number; _scrollListenerPositionY: number; _scrollListenerLastIdle: number; _scrollListenerLastScroll: number; _scrollListenerLastResize: number; } & { _scroller: WeakRef; _scrollerScrollListener: EventListener; _scrollerResizeListener: EventListener; _scrollDebounce: any; } & { _scrollListenerOnScrollIdle(): void; _scrollListenerOnScrollerScroll(event: Event): void; _scrollListenerOnScrollerResize(event: Event): void; startScrollListener(scroller?: EventTarget): boolean; } & { _scrollListenerScroller: HTMLElement | Window; } & { _scrollListenerScrollerScrollHeight: any; _scrollListenerScrollerClientHeight: any; } & { _scrollListenerClear(scroller?: EventTarget): boolean; } & { disabled: boolean; focused: boolean; hovered: boolean; pressed: boolean; _lastInteraction: \"mouse\" | \"touch\" | \"key\" | \"pen\"; _hovered: boolean; _focused: boolean; _focusedSynthetic: boolean; _keyPressed: boolean; _keyReleased: boolean; _pointerPressed: boolean; stateLayer: boolean; } & { disabledState: boolean; hoveredState: boolean; focusedState: boolean; pressedState: boolean; touchedState: boolean; pointedState: boolean; } & { stateTargetElement: HTMLElement; } & { _lastRippleWeakRef: WeakRef; _rippleAdded: boolean; } & { _lastRipple: CustomElement & { hadRippleHeld: boolean; hadRippleReleased: boolean; rippleStarted: boolean; } & { rippleState: string; keepAlive: boolean; _positionX: number; _positionY: number; _radius: number; holdRipple: boolean; } & { _positionStyle: ElementStylerOptions | { styles: { minHeight: string; minWidth: string; boxShadow: string; top: string; left: string; }; }; } & { updatePosition(x?: number, y?: number, size?: number): void; handleRippleComplete(): void; }; } & { addRipple(x?: number, y?: number, hold?: boolean): CustomElement & { hadRippleHeld: boolean; hadRippleReleased: boolean; rippleStarted: boolean; } & { rippleState: string; keepAlive: boolean; _positionX: number; _positionY: number; _radius: number; holdRipple: boolean; } & { _positionStyle: ElementStylerOptions | { styles: { minHeight: string; minWidth: string; boxShadow: string; top: string; left: string; }; }; } & { updatePosition(x?: number, y?: number, size?: number): void; handleRippleComplete(): void; }; } & { color: string; ink: string; typeStyle: string; } & { shapeTop: boolean; shapeBottom: boolean; shapeStart: boolean; shapeEnd: boolean; shapeStyle: string; outlined: boolean; } & { stateTargetElement: HTMLElement; } & { stateLayer: boolean; } & { active: boolean; icon: string; src: string; ariaLabel: string; } & { focus(options?: FocusOptions): void; computeLabelMetrics(): { width: number; left: number; }; } & { anchorAriaControls: () => string; anchorAriaSelected: () => string; anchorAriaDisabled: () => string; anchorHref: () => string; iconIf: () => string; iconVariation: () => string; }) => void" } } }, { "name": "updateIndicator", "kind": "method", "description": "Recompute and apply indicator; optionally disable animation when `animate` is false.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/TabList.js#L220" }, "return": { "type": { "text": "(animate?: boolean) => void" } } }, { "name": "updateIndicatorByPosition", "kind": "method", "description": "Update the indicator position by a floating `percentage` between 0..1\nrepresenting the scroll progress across tab panels.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/TabList.js#L231" }, "return": { "type": { "text": "(percentage: number) => void" } } }, { "name": "updateIndicatorByIndex", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/TabList.js#L278" }, "return": { "type": { "text": "(index: number) => void" } } }, { "name": "observeTabContent", "kind": "method", "description": "Observe the bound TabContent scroll and update indicator accordingly.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/TabList.js#L282" }, "return": { "type": { "text": "() => void" } } }, { "name": "prototype", "kind": "field", "static": true, "type": { "text": "CustomElement" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "focusCurrentOrFirst", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/KeyboardNavMixin.js#L57" }, "return": { "type": { "text": "() => HTMLElement" } }, "inheritedFrom": { "name": "default", "module": "mixins/KeyboardNavMixin.js" } }, { "name": "focusNext", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/KeyboardNavMixin.js#L78" }, "return": { "type": { "text": "(current?: HTMLElement, loop?: boolean, reverse?: boolean) => HTMLElement" } }, "inheritedFrom": { "name": "default", "module": "mixins/KeyboardNavMixin.js" } }, { "name": "focusPrevious", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/KeyboardNavMixin.js#L133" }, "return": { "type": { "text": "(current?: HTMLElement, loop?: boolean) => HTMLElement" } }, "inheritedFrom": { "name": "default", "module": "mixins/KeyboardNavMixin.js" } }, { "name": "refreshTabIndexes", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/KeyboardNavMixin.js#L156" }, "return": { "type": { "text": "() => void" } }, "inheritedFrom": { "name": "default", "module": "mixins/KeyboardNavMixin.js" } }, { "name": "onResizeObserved", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ResizeObserverMixin.js#L23" }, "return": { "type": { "text": "(entry: ResizeObserverEntry) => void" } }, "inheritedFrom": { "name": "default", "module": "mixins/ResizeObserverMixin.js" } }, { "name": "observeResize", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ResizeObserverMixin.js#L26" }, "return": { "type": { "text": "() => void" } }, "inheritedFrom": { "name": "default", "module": "mixins/ResizeObserverMixin.js" } }, { "name": "unobserveResize", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ResizeObserverMixin.js#L31" }, "return": { "type": { "text": "() => void" } }, "inheritedFrom": { "name": "default", "module": "mixins/ResizeObserverMixin.js" } }, { "name": "compose", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L145" }, "type": { "text": "(parts: CompositionPart[]) => Composition" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#refsProxy", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1145" }, "type": { "text": "Record" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#refsCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1148" }, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#refsCompositionCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1151" }, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#composition", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1154" }, "type": { "text": "Composition" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#patching", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1156" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#pendingPatchRenders", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1159" }, "type": { "text": "[string, any, CustomElement][]" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#propAttributeCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1162" }, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#callbackArguments", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1165" }, "type": { "text": "CallbackArguments" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "elementInternals", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1172" }, "type": { "text": "ElementInternals" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "render", "kind": "field", "description": "Updates nodes based on data\nExpects data in JSON Merge Patch format", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1185" }, "type": { "text": "RenderDraw" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "propChangedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1213" }, "type": { "text": "(this: T, name: K, oldValue: K extends keyof T ? T[K] : unknown, newValue: K extends keyof T ? T[K] : unknown, changes?: K extends keyof T ? T[K] extends object ? Partial : T[K] : unknown) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attributeChangedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1234" }, "type": { "text": "(name: string, oldValue: string, newValue: string) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#template", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1284" }, "type": { "text": "DocumentFragment" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#onObserverPropertyChanged", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1294" }, "type": { "text": "(name: string, oldValue: any, newValue: any, changes: any) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "static", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1330" }, "type": { "text": "typeof CustomElement" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "patch", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1333" }, "type": { "text": "(patch: any) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "refs", "kind": "field", "description": "Proxy object that returns shadow DOM elements by tag.\nIf called before interpolation (eg: on composed), returns from template", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1404" }, "type": { "text": "Record" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attributeCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1391" }, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "callbackArguments", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1400" }, "type": { "text": "CallbackArguments | { composition: Composition; refs: Record; html: any; inline: (fn: (data: Partial) => any) => string; template: DocumentFragment; element: T; }" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "composition", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1403" }, "type": { "text": "Composition" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "connectedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1435" }, "type": { "text": "() => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "disconnectedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1441" }, "type": { "text": "() => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "delegatesFocus", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1175" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "elementName", "kind": "field", "static": true, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "observedAttributes", "kind": "field", "static": true, "type": { "text": "Iterable" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "interpolatesTemplate", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "supportsElementInternals", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "supportsElementInternalsRole", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "defined", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "registrations", "kind": "field", "static": true, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "expressions", "kind": "method", "static": true, "description": "Expressions are idempotent functions that are selectively called whenever\na render is requested.\nExpressions are constructed exactly as methods though differ in expected\narguments. The first argument should be destructured to ensure each used\nproperty is accessed at least once in order to inspect used properties.\n\nThe Composition API will inspect this function with a proxy for `this` to\ncatalog what observables are used by the expression. This allows the\nComposition API to build a cache as well as selective invoke the expression\nonly when needed.\n\nWhen used with in element templates, the element itself will be passed as\nits first argument.\n````js\n Button\n .prop('filled', 'boolean')\n .prop('outlined', 'boolean')\n .expresssions({\n _isFilledOrOutlined({filled, outlined}) {\n return (filled || outlined)\n },\n })\n .html`
`;\n````\n\nWhen used with external data source, that data source\nwill be passed to the expression with all properties being `null` at first\ninspection.\n````js\n const externalData = {first: 'John', last: 'Doe'};\n ContactCard\n .expresssions({\n _fullName({first, last}) {\n return [first, last].filter(Boolean).join(' ');\n },\n })\n myButton.render(externalData);\n````\n\nExpressions may be support argumentless calls by using default\nparameters with `this`.\n````js\n Button\n .expresssions({\n isFilledOrOutlined({filled, outlined} = this) {\n return (filled || outlined)\n },\n });\n myButton.isFilledorOutlined();\n````", "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends { [K in keyof any]: K extends `_${any}` ? ((data: INSTANCE, state?: Record) => string | boolean | null) : ((data?: INSTANCE, state?: Record) => string | boolean | null); } & ThisType>(this: CLASS, expressions: PROPS & ThisType) => CLASS & Class<{ [K in keyof PROPS]: K extends `_${any}` ? never : () => ReturnType; }, ARGS>" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "methods", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "overrides", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends Partial>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "props", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "idl", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "append", "kind": "field", "static": true, "description": "Append parts to composition", "type": { "text": "(this: T, ...parts: CompositionPart[]) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "recompose", "kind": "field", "static": true, "description": "After composition, invokes callback.\nMay be called multiple times.", "type": { "text": ", T3 extends CompositionCallback[\"composed\"]>(this: T1, callback: T3) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "css", "kind": "field", "static": true, "description": "Appends styles to composition", "type": { "text": "(this: T1, array: T2, ...rest: T2 extends string ? any : T2 extends TemplateStringsArray ? any[] : (HTMLStyleElement | CSSStyleSheet)[]) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "autoRegister", "kind": "field", "static": true, "description": "Registers class with customElements. If class is registered before then,\ndoes nothing.", "type": { "text": "(this: T, elementName: string) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "html", "kind": "field", "static": true, "description": "Appends DocumentFragment to composition", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1405" }, "type": { "text": "(this: T, string: TemplateStringsArray, ...substitutions: (string | Element | ((this: InstanceType, data: InstanceType, injections?: any) => any))[]) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "extend", "kind": "field", "static": true, "description": "Extends base class into a new class.\nUse to avoid mutating base class.", "type": { "text": " T2>(this: T1, customExtender?: T3) => T3 extends null ? T1 : T2" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "setStatic", "kind": "field", "static": true, "description": "Assigns static values to class", "type": { "text": " any) | string | number | boolean | any[] | object); }>(this: T1, source: T2 & ThisType) => T1 & T2" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "readonly", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "set", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "mixin", "kind": "field", "static": true, "description": "Returns result of calling mixin with current class", "type": { "text": " any, RETURN extends ReturnType, SUBCLASS extends ClassOf>(this: BASE, mixin: FN) => SUBCLASS & BASE" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "register", "kind": "field", "static": true, "description": "Registers class with window.customElements synchronously", "type": { "text": "(this: T, elementName?: string, force?: boolean) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "propList", "kind": "field", "static": true, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attrList", "kind": "field", "static": true, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "propChangedCallbacks", "kind": "field", "static": true, "type": { "text": "Map any)[]>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attributeChangedCallbacks", "kind": "field", "static": true, "type": { "text": "Map any)[]>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "prop", "kind": "field", "static": true, "description": "Creates observable property on instances (via prototype)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1007" }, "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "setPrototype", "kind": "field", "static": true, "description": "Creates observable property on instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any)>(this: CLASS, name: KEY, options: OPTIONS) => OPTIONS extends (...args2: any[]) => infer R ? R : OPTIONS extends ObserverPropertyType ? ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? unknown extends R ? object : R : OPTIONS extends { type: ObserverPropertyType; } ? ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? unknown extends R ? string : R : never" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "define", "kind": "field", "static": true, "description": "Define properties on instances via Object.defineProperties().\nAutomatically sets property non-enumerable if name begins with `_`.\nFunctions will be remapped as getters", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends { [P in keyof any]: { enumerable?: boolean; configurable?: boolean; writable?: boolean; value?: any; get?: ((this: INSTANCE) => any); set?: (this: INSTANCE, value: any) => void; } | ((this: INSTANCE, ...args: any[]) => any); }, VALUE extends { [KEY in keyof PROPS]: PROPS[KEY] extends (...args2: any[]) => infer R ? R : PROPS[KEY] extends TypedPropertyDescriptor ? R : never; }>(this: CLASS, props: PROPS & ThisType) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "undefine", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROP extends string, PROPS extends INSTANCE & Record>(this: CLASS, name: PROP) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "observe", "kind": "field", "static": true, "description": "Creates observable properties on instances", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends IDLParameter, VALUE extends { [KEY in keyof PROPS]: PROPS[KEY] extends (...args2: any[]) => infer R ? R : PROPS[KEY] extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : PROPS[KEY] extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : PROPS[KEY] extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : PROPS[KEY] extends ObserverOptions ? (unknown extends R ? string : R) : never; }>(this: CLASS, props: PROPS) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "defineStatic", "kind": "field", "static": true, "type": { "text": ">(this: T1, props: T2) => T1 & ParsedProps" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "events", "kind": "field", "static": true, "type": { "text": "(this: T, listeners?: CompositionEventListenerObject>, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "childEvents", "kind": "field", "static": true, "type": { "text": "(this: T, listenerMap: { [x: string]: CompositionEventListenerObject>; }, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "rootEvents", "kind": "field", "static": true, "type": { "text": "(this: T, listeners?: CompositionEventListenerObject>, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "on", "kind": "field", "static": true, "type": { "text": ", T3 extends CompositionCallback, T4 extends keyof T3>(this: T1, name: T3 | T4, callbacks?: T3[T4] & ThisType) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "off", "kind": "field", "static": true, "type": { "text": ", T3 extends CompositionCallback, T4 extends keyof T3>(this: T1, name: T3 | T4, callbacks?: T3[T4] & ThisType) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "offPropChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: ObjectOrObjectEntries<{ [P in keyof T2]?: (this: T2, oldValue: T2[P], newValue: T2[P], changes: any, element: T2) => void; }>) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "offAttributeChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: { [x: string]: (this: T2, oldValue: string, newValue: string, element: T2) => void; }) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "onPropChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: ObjectOrObjectEntries<{ [P in keyof T2]?: (this: T2, oldValue: T2[P], newValue: T2[P], changes: any, element: T2) => void; }>) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "onAttributeChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: { [x: string]: (this: T2, oldValue: string, newValue: string, element: T2) => void; }) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } } ], "slots": [ { "name": "", "description": "" } ], "cssParts": [], "events": [], "demos": [], "superclass": { "module": "core/CustomElement.js", "name": "default" }, "mixins": [ { "module": "mixins/ThemableMixin.js", "name": "default" }, { "module": "mixins/KeyboardNavMixin.js", "name": "default" }, { "module": "mixins/ResizeObserverMixin.js", "name": "default" }, { "module": "mixins/RTLObserverMixin.js", "name": "default" }, { "module": "mixins/ShapeMixin.js", "name": "default" }, { "module": "mixins/SemiStickyMixin.js", "name": "default" } ], "description": "Tab list is the container for `mdw-tab` elements and renders the active\nindicator and keyboard navigation behavior.\n@see https://m3.material.io/components/tabs/specs" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "default", "module": "components/TabList.js" } }, { "kind": "custom-element-definition", "name": "mdw-tab-list", "declaration": { "name": "default", "module": "components/TabList.js" } } ] }, { "kind": "javascript-module", "path": "components/TabPanel.js", "declarations": [ { "kind": "class", "name": "TabPanel", "tagName": "mdw-tab-panel", "customElement": true, "attributes": [ { "name": "color", "fieldName": "color", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "ink", "fieldName": "ink", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "type-style", "fieldName": "typeStyle", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "block", "fieldName": "block", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "inline", "fieldName": "inline", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "row", "fieldName": "row", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "x", "fieldName": "x", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "y", "fieldName": "y", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "gap", "fieldName": "gap", "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "padding", "fieldName": "padding", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "active", "description": "Whether this panel is active/visible; updates ARIA `aria-hidden`.", "fieldName": "active", "type": { "text": "boolean" } }, { "name": "peeking", "description": "True when the panel is partially visible (peeking).", "fieldName": "peeking", "type": { "text": "boolean" } } ], "members": [ { "name": "block", "kind": "field", "description": "Set `display: block` on the host (boolean)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js#L9" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "inline", "kind": "field", "description": "Use inline flex layout: `display: inline-flex` (boolean)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js#L11" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "row", "kind": "field", "description": "Switch main axis to horizontal: `flex-direction: row` (boolean)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js#L13" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "x", "kind": "field", "description": "Main-axis alignment / justification.\nAllowed: 'start'|'center'|'end'|'between'|'around'|'stretch'|'baseline'.\nDefault: 'start'.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js#L19" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "y", "kind": "field", "description": "Cross-axis alignment / alignment of items.\nSame allowed values as `x`. Default: 'start'.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js#L29" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "gap", "kind": "field", "description": "Gap between children. Accepts preset numeric strings (e.g. '8') mapped to px, or floats.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js#L36" }, "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "padding", "kind": "field", "description": "Padding preset or numeric value (e.g. 'pane', '8', '16').", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js#L38" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "color", "kind": "field", "description": "Palette or surface token used to select background/ink tokens.\nExamples: 'primary', 'background', 'surface-container-low'.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L52" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "ink", "kind": "field", "description": "Explicit ink override token (e.g. 'outline', 'on-primary', 'inverse-on-surface', 'inherit').\nMaps to `--mdw-ink`.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L57" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "typeStyle", "kind": "field", "description": "Typographic style shortcut that maps to type scale variables\n(e.g. 'headline-large', 'body-medium').", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L62" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "active", "kind": "field", "description": "Whether this panel is active/visible; updates ARIA `aria-hidden`.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/TabPanel.js#L19" }, "type": { "text": "boolean" } }, { "name": "peeking", "kind": "field", "description": "True when the panel is partially visible (peeking).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/TabPanel.js#L27" }, "type": { "text": "boolean" } }, { "name": "prototype", "kind": "field", "static": true, "type": { "text": "CustomElement" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "readAriaProperty", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/AriaReflectorMixin.js#L28" }, "return": { "type": { "text": "(name: \"shadowRoot\" | \"ariaActiveDescendantElement\" | \"ariaAtomic\" | \"ariaAutoComplete\" | \"ariaBrailleLabel\" | \"ariaBrailleRoleDescription\" | \"ariaBusy\" | \"ariaChecked\" | \"ariaColCount\" | \"ariaColIndex\" | \"ariaColIndexText\" | \"ariaColSpan\" | \"ariaControlsElements\" | \"ariaCurrent\" | \"ariaDescribedByElements\" | \"ariaDescription\" | \"ariaDetailsElements\" | \"ariaDisabled\" | \"ariaErrorMessageElements\" | \"ariaExpanded\" | \"ariaFlowToElements\" | \"ariaHasPopup\" | \"ariaHidden\" | \"ariaInvalid\" | \"ariaKeyShortcuts\" | \"ariaLabel\" | \"ariaLabelledByElements\" | \"ariaLevel\" | \"ariaLive\" | \"ariaModal\" | \"ariaMultiLine\" | \"ariaMultiSelectable\" | \"ariaOrientation\" | \"ariaOwnsElements\" | \"ariaPlaceholder\" | \"ariaPosInSet\" | \"ariaPressed\" | \"ariaReadOnly\" | \"ariaRelevant\" | \"ariaRequired\" | \"ariaRoleDescription\" | \"ariaRowCount\" | \"ariaRowIndex\" | \"ariaRowIndexText\" | \"ariaRowSpan\" | \"ariaSelected\" | \"ariaSetSize\" | \"ariaSort\" | \"ariaValueMax\" | \"ariaValueMin\" | \"ariaValueNow\" | \"ariaValueText\" | \"role\") => string | Element | ShadowRoot | readonly Element[]" } }, "inheritedFrom": { "name": "default", "module": "mixins/AriaReflectorMixin.js" } }, { "name": "updateAriaProperty", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/AriaReflectorMixin.js#L47" }, "return": { "type": { "text": ">(name: K, value: ARIAMixin[K]) => void" } }, "inheritedFrom": { "name": "default", "module": "mixins/AriaReflectorMixin.js" } }, { "name": "compose", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L145" }, "type": { "text": "(parts: CompositionPart[]) => Composition" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "#refsProxy", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1145" }, "type": { "text": "Record" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "#refsCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1148" }, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "#refsCompositionCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1151" }, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "#composition", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1154" }, "type": { "text": "Composition" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "#patching", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1156" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "#pendingPatchRenders", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1159" }, "type": { "text": "[string, any, CustomElement][]" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "#propAttributeCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1162" }, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "#callbackArguments", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1165" }, "type": { "text": "CallbackArguments" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "elementInternals", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1172" }, "type": { "text": "ElementInternals" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "render", "kind": "field", "description": "Updates nodes based on data\nExpects data in JSON Merge Patch format", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1185" }, "type": { "text": "RenderDraw" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "propChangedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1213" }, "type": { "text": "(this: T, name: K, oldValue: K extends keyof T ? T[K] : unknown, newValue: K extends keyof T ? T[K] : unknown, changes?: K extends keyof T ? T[K] extends object ? Partial : T[K] : unknown) => void" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "attributeChangedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1234" }, "type": { "text": "(name: string, oldValue: string, newValue: string) => void" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "#template", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1284" }, "type": { "text": "DocumentFragment" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "#onObserverPropertyChanged", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1294" }, "type": { "text": "(name: string, oldValue: any, newValue: any, changes: any) => void" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "static", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1330" }, "type": { "text": "typeof CustomElement" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "patch", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1333" }, "type": { "text": "(patch: any) => void" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "refs", "kind": "field", "description": "Proxy object that returns shadow DOM elements by tag.\nIf called before interpolation (eg: on composed), returns from template", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1404" }, "type": { "text": "Record" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "attributeCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1391" }, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "callbackArguments", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1400" }, "type": { "text": "CallbackArguments | { composition: Composition; refs: Record; html: any; inline: (fn: (data: Partial) => any) => string; template: DocumentFragment; element: T; }" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "composition", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1403" }, "type": { "text": "Composition" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "connectedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1435" }, "type": { "text": "() => void" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "disconnectedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1441" }, "type": { "text": "() => void" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "delegatesFocus", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1175" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "elementName", "kind": "field", "static": true, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "observedAttributes", "kind": "field", "static": true, "type": { "text": "Iterable" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "interpolatesTemplate", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "supportsElementInternals", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "supportsElementInternalsRole", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "defined", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "registrations", "kind": "field", "static": true, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "expressions", "kind": "method", "static": true, "description": "Expressions are idempotent functions that are selectively called whenever\na render is requested.\nExpressions are constructed exactly as methods though differ in expected\narguments. The first argument should be destructured to ensure each used\nproperty is accessed at least once in order to inspect used properties.\n\nThe Composition API will inspect this function with a proxy for `this` to\ncatalog what observables are used by the expression. This allows the\nComposition API to build a cache as well as selective invoke the expression\nonly when needed.\n\nWhen used with in element templates, the element itself will be passed as\nits first argument.\n````js\n Button\n .prop('filled', 'boolean')\n .prop('outlined', 'boolean')\n .expresssions({\n _isFilledOrOutlined({filled, outlined}) {\n return (filled || outlined)\n },\n })\n .html`
`;\n````\n\nWhen used with external data source, that data source\nwill be passed to the expression with all properties being `null` at first\ninspection.\n````js\n const externalData = {first: 'John', last: 'Doe'};\n ContactCard\n .expresssions({\n _fullName({first, last}) {\n return [first, last].filter(Boolean).join(' ');\n },\n })\n myButton.render(externalData);\n````\n\nExpressions may be support argumentless calls by using default\nparameters with `this`.\n````js\n Button\n .expresssions({\n isFilledOrOutlined({filled, outlined} = this) {\n return (filled || outlined)\n },\n });\n myButton.isFilledorOutlined();\n````", "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends { [K in keyof any]: K extends `_${any}` ? ((data: INSTANCE, state?: Record) => string | boolean | null) : ((data?: INSTANCE, state?: Record) => string | boolean | null); } & ThisType>(this: CLASS, expressions: PROPS & ThisType) => CLASS & Class<{ [K in keyof PROPS]: K extends `_${any}` ? never : () => ReturnType; }, ARGS>" } }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "methods", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "overrides", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends Partial>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "props", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "idl", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "append", "kind": "field", "static": true, "description": "Append parts to composition", "type": { "text": "(this: T, ...parts: CompositionPart[]) => T" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "recompose", "kind": "field", "static": true, "description": "After composition, invokes callback.\nMay be called multiple times.", "type": { "text": ", T3 extends CompositionCallback[\"composed\"]>(this: T1, callback: T3) => T1" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "css", "kind": "field", "static": true, "description": "Appends styles to composition", "type": { "text": "(this: T1, array: T2, ...rest: T2 extends string ? any : T2 extends TemplateStringsArray ? any[] : (HTMLStyleElement | CSSStyleSheet)[]) => T1" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "autoRegister", "kind": "field", "static": true, "description": "Registers class with customElements. If class is registered before then,\ndoes nothing.", "type": { "text": "(this: T, elementName: string) => T" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "html", "kind": "field", "static": true, "description": "Appends DocumentFragment to composition", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1405" }, "type": { "text": "(this: T, string: TemplateStringsArray, ...substitutions: (string | Element | ((this: InstanceType, data: InstanceType, injections?: any) => any))[]) => T" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "extend", "kind": "field", "static": true, "description": "Extends base class into a new class.\nUse to avoid mutating base class.", "type": { "text": " T2>(this: T1, customExtender?: T3) => T3 extends null ? T1 : T2" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "setStatic", "kind": "field", "static": true, "description": "Assigns static values to class", "type": { "text": " any) | string | number | boolean | any[] | object); }>(this: T1, source: T2 & ThisType) => T1 & T2" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "readonly", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "set", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "mixin", "kind": "field", "static": true, "description": "Returns result of calling mixin with current class", "type": { "text": " any, RETURN extends ReturnType, SUBCLASS extends ClassOf>(this: BASE, mixin: FN) => SUBCLASS & BASE" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "register", "kind": "field", "static": true, "description": "Registers class with window.customElements synchronously", "type": { "text": "(this: T, elementName?: string, force?: boolean) => T" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "propList", "kind": "field", "static": true, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "attrList", "kind": "field", "static": true, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "propChangedCallbacks", "kind": "field", "static": true, "type": { "text": "Map any)[]>" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "attributeChangedCallbacks", "kind": "field", "static": true, "type": { "text": "Map any)[]>" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "prop", "kind": "field", "static": true, "description": "Creates observable property on instances (via prototype)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1007" }, "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "setPrototype", "kind": "field", "static": true, "description": "Creates observable property on instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any)>(this: CLASS, name: KEY, options: OPTIONS) => OPTIONS extends (...args2: any[]) => infer R ? R : OPTIONS extends ObserverPropertyType ? ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? unknown extends R ? object : R : OPTIONS extends { type: ObserverPropertyType; } ? ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? unknown extends R ? string : R : never" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "define", "kind": "field", "static": true, "description": "Define properties on instances via Object.defineProperties().\nAutomatically sets property non-enumerable if name begins with `_`.\nFunctions will be remapped as getters", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends { [P in keyof any]: { enumerable?: boolean; configurable?: boolean; writable?: boolean; value?: any; get?: ((this: INSTANCE) => any); set?: (this: INSTANCE, value: any) => void; } | ((this: INSTANCE, ...args: any[]) => any); }, VALUE extends { [KEY in keyof PROPS]: PROPS[KEY] extends (...args2: any[]) => infer R ? R : PROPS[KEY] extends TypedPropertyDescriptor ? R : never; }>(this: CLASS, props: PROPS & ThisType) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "undefine", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROP extends string, PROPS extends INSTANCE & Record>(this: CLASS, name: PROP) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "observe", "kind": "field", "static": true, "description": "Creates observable properties on instances", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends IDLParameter, VALUE extends { [KEY in keyof PROPS]: PROPS[KEY] extends (...args2: any[]) => infer R ? R : PROPS[KEY] extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : PROPS[KEY] extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : PROPS[KEY] extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : PROPS[KEY] extends ObserverOptions ? (unknown extends R ? string : R) : never; }>(this: CLASS, props: PROPS) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "defineStatic", "kind": "field", "static": true, "type": { "text": ">(this: T1, props: T2) => T1 & ParsedProps" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "events", "kind": "field", "static": true, "type": { "text": "(this: T, listeners?: CompositionEventListenerObject>, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "childEvents", "kind": "field", "static": true, "type": { "text": "(this: T, listenerMap: { [x: string]: CompositionEventListenerObject>; }, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "rootEvents", "kind": "field", "static": true, "type": { "text": "(this: T, listeners?: CompositionEventListenerObject>, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "on", "kind": "field", "static": true, "type": { "text": ", T3 extends CompositionCallback, T4 extends keyof T3>(this: T1, name: T3 | T4, callbacks?: T3[T4] & ThisType) => T1" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "off", "kind": "field", "static": true, "type": { "text": ", T3 extends CompositionCallback, T4 extends keyof T3>(this: T1, name: T3 | T4, callbacks?: T3[T4] & ThisType) => T1" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "offPropChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: ObjectOrObjectEntries<{ [P in keyof T2]?: (this: T2, oldValue: T2[P], newValue: T2[P], changes: any, element: T2) => void; }>) => T1" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "offAttributeChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: { [x: string]: (this: T2, oldValue: string, newValue: string, element: T2) => void; }) => T1" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "onPropChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: ObjectOrObjectEntries<{ [P in keyof T2]?: (this: T2, oldValue: T2[P], newValue: T2[P], changes: any, element: T2) => void; }>) => T1" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } }, { "name": "onAttributeChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: { [x: string]: (this: T2, oldValue: string, newValue: string, element: T2) => void; }) => T1" }, "inheritedFrom": { "name": "default", "module": "components/Box.js" } } ], "slots": [ { "name": "", "description": "" } ], "cssParts": [], "events": [], "demos": [], "superclass": { "module": "components/Box.js", "name": "default" }, "mixins": [ { "module": "mixins/AriaReflectorMixin.js", "name": "default" } ], "description": "TabPanel represents the content area for a single tab and updates ARIA\nwhen activated.\n@see https://m3.material.io/components/tabs/specs" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "default", "module": "components/TabPanel.js" } }, { "kind": "custom-element-definition", "name": "mdw-tab-panel", "declaration": { "name": "default", "module": "components/TabPanel.js" } } ] }, { "kind": "javascript-module", "path": "components/Table.js", "declarations": [ { "kind": "class", "name": "Table", "tagName": "mdw-table", "customElement": true, "attributes": [], "members": [ { "name": "caption", "kind": "field", "description": "The table caption element (`mdw-caption`) or `null` when not present.\nMirrors `HTMLTableElement.caption` semantics.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Table.js#L81" }, "type": { "text": "Element" } }, { "name": "tHead", "kind": "field", "description": "The table header section (`mdw-thead`) element or `null` when not present.\nMirrors `HTMLTableElement.tHead` semantics.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Table.js#L93" }, "type": { "text": "Element" } }, { "name": "tFoot", "kind": "field", "description": "The table footer section (`mdw-tfoot`) element or `null` when not present.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Table.js#L104" }, "type": { "text": "Element" } }, { "name": "tBodies", "kind": "field", "description": "Live `HTMLCollection` of `mdw-tbody` elements contained by the table.\nMirrors `HTMLTableElement.tBodies`.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Table.js#L117" }, "type": { "text": "HTMLCollectionOf" } }, { "name": "rows", "kind": "field", "description": "Live `HTMLCollection` of row elements (`mdw-tr`) in the table.\nMirrors `HTMLTableElement.rows`.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Table.js#L125" }, "type": { "text": "HTMLCollectionOf" } }, { "name": "createCaption", "kind": "method", "description": "Create and return a `mdw-caption` element, appending when necessary.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Table.js#L131" }, "return": { "type": { "text": "() => Element" } } }, { "name": "deleteCaption", "kind": "method", "description": "Remove the table's caption element when present.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Table.js#L133" }, "return": { "type": { "text": "() => void" } } }, { "name": "createTHead", "kind": "method", "description": "Create and return a `mdw-thead` element for the table.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Table.js#L135" }, "return": { "type": { "text": "() => Element" } } }, { "name": "deleteTHead", "kind": "method", "description": "Remove the table's `mdw-thead` element when present.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Table.js#L137" }, "return": { "type": { "text": "() => void" } } }, { "name": "createTFoot", "kind": "method", "description": "Create and return a `mdw-tfoot` element for the table.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Table.js#L139" }, "return": { "type": { "text": "() => Element" } } }, { "name": "deleteTFoot", "kind": "method", "description": "Remove the table's `mdw-tfoot` element when present.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Table.js#L141" }, "return": { "type": { "text": "() => void" } } }, { "name": "createTBody", "kind": "method", "description": "Insert and return a new `mdw-tbody` element before the tFoot (if any).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Table.js#L143" }, "return": { "type": { "text": "() => Element" } } }, { "name": "prototype", "kind": "field", "static": true, "type": { "text": "CustomElement" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "compose", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L145" }, "type": { "text": "(parts: CompositionPart[]) => Composition" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#refsProxy", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1145" }, "type": { "text": "Record" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#refsCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1148" }, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#refsCompositionCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1151" }, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#composition", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1154" }, "type": { "text": "Composition" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#patching", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1156" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#pendingPatchRenders", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1159" }, "type": { "text": "[string, any, CustomElement][]" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#propAttributeCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1162" }, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#callbackArguments", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1165" }, "type": { "text": "CallbackArguments" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "elementInternals", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1172" }, "type": { "text": "ElementInternals" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "render", "kind": "field", "description": "Updates nodes based on data\nExpects data in JSON Merge Patch format", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1185" }, "type": { "text": "RenderDraw" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "propChangedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1213" }, "type": { "text": "(this: T, name: K, oldValue: K extends keyof T ? T[K] : unknown, newValue: K extends keyof T ? T[K] : unknown, changes?: K extends keyof T ? T[K] extends object ? Partial : T[K] : unknown) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attributeChangedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1234" }, "type": { "text": "(name: string, oldValue: string, newValue: string) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#template", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1284" }, "type": { "text": "DocumentFragment" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#onObserverPropertyChanged", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1294" }, "type": { "text": "(name: string, oldValue: any, newValue: any, changes: any) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "static", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1330" }, "type": { "text": "typeof CustomElement" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "patch", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1333" }, "type": { "text": "(patch: any) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "refs", "kind": "field", "description": "Proxy object that returns shadow DOM elements by tag.\nIf called before interpolation (eg: on composed), returns from template", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1404" }, "type": { "text": "Record" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attributeCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1391" }, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "callbackArguments", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1400" }, "type": { "text": "CallbackArguments | { composition: Composition; refs: Record; html: any; inline: (fn: (data: Partial) => any) => string; template: DocumentFragment; element: T; }" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "composition", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1403" }, "type": { "text": "Composition" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "connectedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1435" }, "type": { "text": "() => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "disconnectedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1441" }, "type": { "text": "() => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "delegatesFocus", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1175" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "elementName", "kind": "field", "static": true, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "observedAttributes", "kind": "field", "static": true, "type": { "text": "Iterable" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "interpolatesTemplate", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "supportsElementInternals", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "supportsElementInternalsRole", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "defined", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "registrations", "kind": "field", "static": true, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "expressions", "kind": "method", "static": true, "description": "Expressions are idempotent functions that are selectively called whenever\na render is requested.\nExpressions are constructed exactly as methods though differ in expected\narguments. The first argument should be destructured to ensure each used\nproperty is accessed at least once in order to inspect used properties.\n\nThe Composition API will inspect this function with a proxy for `this` to\ncatalog what observables are used by the expression. This allows the\nComposition API to build a cache as well as selective invoke the expression\nonly when needed.\n\nWhen used with in element templates, the element itself will be passed as\nits first argument.\n````js\n Button\n .prop('filled', 'boolean')\n .prop('outlined', 'boolean')\n .expresssions({\n _isFilledOrOutlined({filled, outlined}) {\n return (filled || outlined)\n },\n })\n .html`
`;\n````\n\nWhen used with external data source, that data source\nwill be passed to the expression with all properties being `null` at first\ninspection.\n````js\n const externalData = {first: 'John', last: 'Doe'};\n ContactCard\n .expresssions({\n _fullName({first, last}) {\n return [first, last].filter(Boolean).join(' ');\n },\n })\n myButton.render(externalData);\n````\n\nExpressions may be support argumentless calls by using default\nparameters with `this`.\n````js\n Button\n .expresssions({\n isFilledOrOutlined({filled, outlined} = this) {\n return (filled || outlined)\n },\n });\n myButton.isFilledorOutlined();\n````", "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends { [K in keyof any]: K extends `_${any}` ? ((data: INSTANCE, state?: Record) => string | boolean | null) : ((data?: INSTANCE, state?: Record) => string | boolean | null); } & ThisType>(this: CLASS, expressions: PROPS & ThisType) => CLASS & Class<{ [K in keyof PROPS]: K extends `_${any}` ? never : () => ReturnType; }, ARGS>" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "methods", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "overrides", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends Partial>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "props", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "idl", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "append", "kind": "field", "static": true, "description": "Append parts to composition", "type": { "text": "(this: T, ...parts: CompositionPart[]) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "recompose", "kind": "field", "static": true, "description": "After composition, invokes callback.\nMay be called multiple times.", "type": { "text": ", T3 extends CompositionCallback[\"composed\"]>(this: T1, callback: T3) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "css", "kind": "field", "static": true, "description": "Appends styles to composition", "type": { "text": "(this: T1, array: T2, ...rest: T2 extends string ? any : T2 extends TemplateStringsArray ? any[] : (HTMLStyleElement | CSSStyleSheet)[]) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "autoRegister", "kind": "field", "static": true, "description": "Registers class with customElements. If class is registered before then,\ndoes nothing.", "type": { "text": "(this: T, elementName: string) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "html", "kind": "field", "static": true, "description": "Appends DocumentFragment to composition", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1405" }, "type": { "text": "(this: T, string: TemplateStringsArray, ...substitutions: (string | Element | ((this: InstanceType, data: InstanceType, injections?: any) => any))[]) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "extend", "kind": "field", "static": true, "description": "Extends base class into a new class.\nUse to avoid mutating base class.", "type": { "text": " T2>(this: T1, customExtender?: T3) => T3 extends null ? T1 : T2" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "setStatic", "kind": "field", "static": true, "description": "Assigns static values to class", "type": { "text": " any) | string | number | boolean | any[] | object); }>(this: T1, source: T2 & ThisType) => T1 & T2" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "readonly", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "set", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "mixin", "kind": "field", "static": true, "description": "Returns result of calling mixin with current class", "type": { "text": " any, RETURN extends ReturnType, SUBCLASS extends ClassOf>(this: BASE, mixin: FN) => SUBCLASS & BASE" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "register", "kind": "field", "static": true, "description": "Registers class with window.customElements synchronously", "type": { "text": "(this: T, elementName?: string, force?: boolean) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "propList", "kind": "field", "static": true, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attrList", "kind": "field", "static": true, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "propChangedCallbacks", "kind": "field", "static": true, "type": { "text": "Map any)[]>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attributeChangedCallbacks", "kind": "field", "static": true, "type": { "text": "Map any)[]>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "prop", "kind": "field", "static": true, "description": "Creates observable property on instances (via prototype)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1007" }, "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "setPrototype", "kind": "field", "static": true, "description": "Creates observable property on instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any)>(this: CLASS, name: KEY, options: OPTIONS) => OPTIONS extends (...args2: any[]) => infer R ? R : OPTIONS extends ObserverPropertyType ? ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? unknown extends R ? object : R : OPTIONS extends { type: ObserverPropertyType; } ? ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? unknown extends R ? string : R : never" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "define", "kind": "field", "static": true, "description": "Define properties on instances via Object.defineProperties().\nAutomatically sets property non-enumerable if name begins with `_`.\nFunctions will be remapped as getters", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends { [P in keyof any]: { enumerable?: boolean; configurable?: boolean; writable?: boolean; value?: any; get?: ((this: INSTANCE) => any); set?: (this: INSTANCE, value: any) => void; } | ((this: INSTANCE, ...args: any[]) => any); }, VALUE extends { [KEY in keyof PROPS]: PROPS[KEY] extends (...args2: any[]) => infer R ? R : PROPS[KEY] extends TypedPropertyDescriptor ? R : never; }>(this: CLASS, props: PROPS & ThisType) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "undefine", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROP extends string, PROPS extends INSTANCE & Record>(this: CLASS, name: PROP) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "observe", "kind": "field", "static": true, "description": "Creates observable properties on instances", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends IDLParameter, VALUE extends { [KEY in keyof PROPS]: PROPS[KEY] extends (...args2: any[]) => infer R ? R : PROPS[KEY] extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : PROPS[KEY] extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : PROPS[KEY] extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : PROPS[KEY] extends ObserverOptions ? (unknown extends R ? string : R) : never; }>(this: CLASS, props: PROPS) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "defineStatic", "kind": "field", "static": true, "type": { "text": ">(this: T1, props: T2) => T1 & ParsedProps" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "events", "kind": "field", "static": true, "type": { "text": "(this: T, listeners?: CompositionEventListenerObject>, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "childEvents", "kind": "field", "static": true, "type": { "text": "(this: T, listenerMap: { [x: string]: CompositionEventListenerObject>; }, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "rootEvents", "kind": "field", "static": true, "type": { "text": "(this: T, listeners?: CompositionEventListenerObject>, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "on", "kind": "field", "static": true, "type": { "text": ", T3 extends CompositionCallback, T4 extends keyof T3>(this: T1, name: T3 | T4, callbacks?: T3[T4] & ThisType) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "off", "kind": "field", "static": true, "type": { "text": ", T3 extends CompositionCallback, T4 extends keyof T3>(this: T1, name: T3 | T4, callbacks?: T3[T4] & ThisType) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "offPropChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: ObjectOrObjectEntries<{ [P in keyof T2]?: (this: T2, oldValue: T2[P], newValue: T2[P], changes: any, element: T2) => void; }>) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "offAttributeChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: { [x: string]: (this: T2, oldValue: string, newValue: string, element: T2) => void; }) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "onPropChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: ObjectOrObjectEntries<{ [P in keyof T2]?: (this: T2, oldValue: T2[P], newValue: T2[P], changes: any, element: T2) => void; }>) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "onAttributeChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: { [x: string]: (this: T2, oldValue: string, newValue: string, element: T2) => void; }) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } } ], "slots": [ { "name": "", "description": "" } ], "cssParts": [], "events": [], "demos": [], "superclass": { "module": "core/CustomElement.js", "name": "default" }, "mixins": [], "description": "@param {Element} parent\n@param {string} tagName\n@return {Element?}" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "default", "module": "components/Table.js" } }, { "kind": "custom-element-definition", "name": "mdw-table", "declaration": { "name": "default", "module": "components/Table.js" } } ] }, { "kind": "javascript-module", "path": "components/TextArea.js", "declarations": [ { "kind": "class", "name": "TextArea", "tagName": "mdw-textarea", "customElement": true, "attributes": [ { "name": "color", "fieldName": "color", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "ink", "fieldName": "ink", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "type-style", "fieldName": "typeStyle", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "disabled", "fieldName": "disabled", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "focused", "fieldName": "focused", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "hovered", "fieldName": "hovered", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "pressed", "fieldName": "pressed", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "aria-controls", "fieldName": "ariaControls", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ControlMixin.js" } }, { "name": "autocomplete", "fieldName": "autocomplete", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ControlMixin.js" } }, { "name": "name", "fieldName": "name", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ControlMixin.js" } }, { "name": "readonly", "fieldName": "readOnly", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ControlMixin.js" } }, { "name": "formnovalidate", "fieldName": "formNoValidate", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ControlMixin.js" } }, { "name": "checked", "fieldName": "defaultChecked", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ControlMixin.js" } }, { "name": "required", "fieldName": "required", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ControlMixin.js" } }, { "name": "value", "description": "Forwards a `value` attribute to the internal `defaultValue`.", "fieldName": "defaultValueAttr", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ControlMixin.js" } }, { "name": "aria-label", "fieldName": "ariaLabel", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ControlMixin.js" } }, { "name": "density", "fieldName": "density", "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "mixins/TextFieldMixin.js" } }, { "name": "shape-top", "fieldName": "shapeTop", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/TextFieldMixin.js" } }, { "name": "shape-bottom", "fieldName": "shapeBottom", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/TextFieldMixin.js" } }, { "name": "shape-start", "fieldName": "shapeStart", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/TextFieldMixin.js" } }, { "name": "shape-end", "fieldName": "shapeEnd", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/TextFieldMixin.js" } }, { "name": "shape-style", "fieldName": "shapeStyle", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/TextFieldMixin.js" } }, { "name": "outlined", "fieldName": "outlined", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/TextFieldMixin.js" } }, { "name": "icon", "fieldName": "icon", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/TextFieldMixin.js" } }, { "name": "icon-variation", "fieldName": "iconVariation", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/TextFieldMixin.js" } }, { "name": "label", "fieldName": "label", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/TextFieldMixin.js" } }, { "name": "filled", "fieldName": "filled", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/TextFieldMixin.js" } }, { "name": "input-prefix", "fieldName": "inputPrefix", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/TextFieldMixin.js" } }, { "name": "input-suffix", "fieldName": "inputSuffix", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/TextFieldMixin.js" } }, { "name": "trailing-icon", "fieldName": "trailingIcon", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/TextFieldMixin.js" } }, { "name": "trailing-icon-ink", "fieldName": "trailingIconInk", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/TextFieldMixin.js" } }, { "name": "trailing-icon-label", "fieldName": "trailingIconLabel", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/TextFieldMixin.js" } }, { "name": "supporting", "fieldName": "supporting", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/TextFieldMixin.js" } }, { "name": "error", "fieldName": "error", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/TextFieldMixin.js" } }, { "name": "placeholder", "fieldName": "placeholder", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/TextFieldMixin.js" } }, { "name": "fixed", "description": "When true the textarea is fixed-size and will not auto-resize.", "fieldName": "fixed", "type": { "text": "boolean" } }, { "name": "minrows", "description": "Minimum number of rows to display. Mirrors the `minrows` attribute.", "fieldName": "minRows", "type": { "text": "number" } }, { "name": "maxrows", "description": "Maximum number of rows to allow when auto-resizing.", "fieldName": "maxRows", "type": { "text": "number" } }, { "name": "cols", "fieldName": "cols", "type": { "text": "number" } }, { "name": "dirname", "description": "The `dirname` attribute value forwarded to the native control.", "fieldName": "dirName", "type": { "text": "string" } }, { "name": "maxlength", "description": "Maximum allowed characters for the control.", "fieldName": "maxLength", "type": { "text": "number" } }, { "name": "minlength", "description": "Minimum required characters for the control.", "fieldName": "minLength", "type": { "text": "number" } }, { "name": "rows", "description": "Number of rows to render; updated when resizing.", "fieldName": "rows", "type": { "text": "number" } }, { "name": "wrap", "description": "Wrapping behavior token forwarded to the native control.", "fieldName": "wrap", "type": { "text": "string" } }, { "name": "state-layer", "type": { "text": "boolean" }, "description": "Show the visual state layer element when true", "fieldName": "stateLayer", "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "type", "type": { "text": "string" }, "fieldName": "type", "inheritedFrom": { "name": "default", "module": "mixins/ControlMixin.js" } } ], "members": [ { "name": "delegatesFocus", "kind": "field", "description": "When true, the element delegates focus to an internal focus target.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/DelegatesFocusMixin.js#L15" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "disabled", "kind": "field", "description": "Whether the element is disabled (affects interactive states)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L14" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "focused", "kind": "field", "description": "Force focus state (independent of document)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L16" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "hovered", "kind": "field", "description": "Force hover state (independent of interaction)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L18" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "pressed", "kind": "field", "description": "Force pressed state (independent of interaction)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L20" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "stateLayer", "kind": "field", "description": "Show the visual state layer element when true\nShow an internal visual state layer element", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/TextFieldMixin.js#L17" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "disabledState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L171" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "hoveredState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L38" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "focusedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L39" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "pressedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L40" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "touchedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L41" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "pointedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L44" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "stateTargetElement", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ControlMixin.js#L66" }, "type": { "text": "HTMLElement" }, "inheritedFrom": { "name": "default", "module": "mixins/StateMixin.js" } }, { "name": "color", "kind": "field", "description": "Palette or surface token used to select background/ink tokens.\nExamples: 'primary', 'background', 'surface-container-low'.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L52" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "ink", "kind": "field", "description": "Explicit ink override token (e.g. 'outline', 'on-primary', 'inverse-on-surface', 'inherit').\nMaps to `--mdw-ink`.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L57" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "typeStyle", "kind": "field", "description": "Typographic style shortcut that maps to type scale variables\n(e.g. 'headline-large', 'body-medium').", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L62" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "shapeTop", "kind": "field", "description": "Show top cut/shape on the element", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L9" }, "type": { "text": "boolean" } }, { "name": "shapeBottom", "kind": "field", "description": "Show bottom cut/shape on the element", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L11" }, "type": { "text": "boolean" } }, { "name": "shapeStart", "kind": "field", "description": "Show start-side cut/shape (logical start)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L13" }, "type": { "text": "boolean" } }, { "name": "shapeEnd", "kind": "field", "description": "Show end-side cut/shape (logical end)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L15" }, "type": { "text": "boolean" } }, { "name": "shapeStyle", "kind": "field", "description": "Predefined shape size/style name (none|extra-small|small|medium|large|extra-large|full|inherit)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L17" }, "type": { "text": "string" } }, { "name": "outlined", "kind": "field", "description": "When true, an outline is rendered around the element\nWhen true, use outlined styling", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/TextFieldMixin.js#L31" }, "type": { "text": "boolean" } }, { "name": "density", "kind": "field", "description": "Density level affecting spacing and compactness. Integer from -4 (dense) to 4 (spacious).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/DensityMixin.js#L9" }, "type": { "text": "number" } }, { "name": "ariaControls", "kind": "field", "description": "ARIA 'controls' attribute (string).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L32" }, "type": { "text": "string" } }, { "name": "autocomplete", "kind": "field", "description": "Autocomplete token for the associated control (string).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L34" }, "type": { "text": "string" } }, { "name": "name", "kind": "field", "description": "Name attribute for the control used in forms.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L36" }, "type": { "text": "string" } }, { "name": "readOnly", "kind": "field", "description": "Read-only state reflected to control via 'readonly' attribute.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L38" }, "type": { "text": "boolean" } }, { "name": "formNoValidate", "kind": "field", "description": "When true, form validation is skipped for this control (formnovalidate).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L40" }, "type": { "text": "boolean" } }, { "name": "defaultChecked", "kind": "field", "description": "Default checked state for checkable controls (checkbox/radio).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L42" }, "type": { "text": "boolean" } }, { "name": "required", "kind": "field", "description": "Whether the control is required for form submission.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L47" }, "type": { "text": "boolean" } }, { "name": "type", "kind": "field", "description": "Control type token (e.g. 'text','checkbox','radio','file').\nInput type (text, password, email, etc.)\nThe control type used by the component.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/TextArea.js#L58" }, "type": { "text": "string" } }, { "name": "erroredState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/TextFieldMixin.js#L50" }, "type": { "text": "boolean" } }, { "name": "defaultValue", "kind": "field", "description": "The default value (initial value) of the internal textarea.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/TextArea.js#L71" }, "type": { "text": "string" } }, { "name": "value", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/TextArea.js#L8" }, "type": { "text": "string" } }, { "name": "checked", "kind": "field", "description": "Part of FormAssociatedMixin for simplicity.\nEnumerability doesn't guarantee checked state will be passed or used.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L145" }, "type": { "text": "boolean" } }, { "name": "form", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L160" }, "type": { "text": "HTMLFormElement" } }, { "name": "validity", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L161" }, "type": { "text": "ValidityState" } }, { "name": "validationMessage", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L162" }, "type": { "text": "string" } }, { "name": "willValidate", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L163" }, "type": { "text": "boolean" } }, { "name": "labels", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L168" }, "type": { "text": "NodeList" } }, { "name": "focusableOnDisabled", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ControlMixin.js#L30" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ControlMixin.js" } }, { "name": "controlTagName", "kind": "field", "description": "Tag name used for the native control element.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/TextArea.js#L34" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ControlMixin.js" } }, { "name": "controlVoidElement", "kind": "field", "description": "Textareas are not void elements.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/TextArea.js#L36" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ControlMixin.js" } }, { "name": "icon", "kind": "field", "description": "Leading icon key/name to render inside the field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/TextFieldMixin.js#L23" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/TextFieldMixin.js" } }, { "name": "iconVariation", "kind": "field", "description": "Variation of the icon display (e.g., filled)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/TextFieldMixin.js#L25" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/TextFieldMixin.js" } }, { "name": "label", "kind": "field", "description": "Floating label text for the field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/TextFieldMixin.js#L27" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/TextFieldMixin.js" } }, { "name": "filled", "kind": "field", "description": "When true, use filled styling", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/TextFieldMixin.js#L29" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/TextFieldMixin.js" } }, { "name": "inputPrefix", "kind": "field", "description": "Prefix text shown before the input", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/TextFieldMixin.js#L33" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/TextFieldMixin.js" } }, { "name": "inputSuffix", "kind": "field", "description": "Suffix text shown after the input", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/TextFieldMixin.js#L35" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/TextFieldMixin.js" } }, { "name": "trailingIcon", "kind": "field", "description": "Trailing icon key/name", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/TextFieldMixin.js#L37" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/TextFieldMixin.js" } }, { "name": "trailingIconInk", "kind": "field", "description": "Ink/color token for the trailing icon", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/TextFieldMixin.js#L39" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/TextFieldMixin.js" } }, { "name": "trailingIconLabel", "kind": "field", "description": "Accessible label for the trailing icon", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/TextFieldMixin.js#L41" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/TextFieldMixin.js" } }, { "name": "supporting", "kind": "field", "description": "Supporting/helper text shown beneath the field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/TextFieldMixin.js#L43" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/TextFieldMixin.js" } }, { "name": "error", "kind": "field", "description": "Error message text", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/TextFieldMixin.js#L45" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/TextFieldMixin.js" } }, { "name": "placeholder", "kind": "field", "description": "Placeholder text (DOMString)\nPlaceholder text forwarded to the native control.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/TextArea.js#L249" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/TextFieldMixin.js" } }, { "name": "supportsCSSLineHeightUnit", "kind": "field", "description": "Whether the UA supports the `lh` CSS unit for line-height.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/TextArea.js#L26" }, "type": { "text": "boolean" } }, { "name": "fixed", "kind": "field", "description": "When true the textarea is fixed-size and will not auto-resize.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/TextArea.js#L40" }, "type": { "text": "boolean" } }, { "name": "minRows", "kind": "field", "description": "Minimum number of rows to display. Mirrors the `minrows` attribute.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/TextArea.js#L42" }, "type": { "text": "number" } }, { "name": "maxRows", "kind": "field", "description": "Maximum number of rows to allow when auto-resizing.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/TextArea.js#L44" }, "type": { "text": "number" } }, { "name": "cols", "kind": "field", "description": "Number of columns (characters) for the control (integer).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/TextArea.js#L245" }, "type": { "text": "number" } }, { "name": "dirName", "kind": "field", "description": "The `dirname` attribute value forwarded to the native control.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/TextArea.js#L50" }, "type": { "text": "string" } }, { "name": "maxLength", "kind": "field", "description": "Maximum allowed characters for the control.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/TextArea.js#L52" }, "type": { "text": "number" } }, { "name": "minLength", "kind": "field", "description": "Minimum required characters for the control.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/TextArea.js#L54" }, "type": { "text": "number" } }, { "name": "rows", "kind": "field", "description": "Number of rows to render; updated when resizing.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/TextArea.js#L58" }, "type": { "text": "number" } }, { "name": "wrap", "kind": "field", "description": "Wrapping behavior token forwarded to the native control.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/TextArea.js#L60" }, "type": { "text": "string" } }, { "name": "defaultValueAttr", "kind": "field", "description": "Forwards a `value` attribute to the internal `defaultValue`.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/TextArea.js#L63" }, "type": { "text": "string" } }, { "name": "textLength", "kind": "field", "description": "Number of characters currently in the textarea.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/TextArea.js#L84" }, "type": { "text": "number" } }, { "name": "select", "kind": "field", "description": "Focus + select helper forwarded to the native control.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/TextArea.js#L86" }, "type": { "text": "() => void" } }, { "name": "selectionDirection", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/TextArea.js#L88" }, "type": { "text": "\"none\" | \"forward\" | \"backward\"" } }, { "name": "selectionStart", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/TextArea.js#L93" }, "type": { "text": "number" } }, { "name": "selectionEnd", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/TextArea.js#L98" }, "type": { "text": "number" } }, { "name": "setRangeText", "kind": "field", "description": "Convenience passthrough to `HTMLTextAreaElement.setRangeText`.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/TextArea.js#L104" }, "type": { "text": "{ (replacement: string): void; (replacement: string, start: number, end: number, selectionMode?: SelectionMode): void; }" } }, { "name": "setSelectionRange", "kind": "field", "description": "Convenience passthrough to `HTMLTextAreaElement.setSelectionRange`.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/TextArea.js#L107" }, "type": { "text": "(start: number, end: number, direction?: \"none\" | \"forward\" | \"backward\") => void" } }, { "name": "resize", "kind": "method", "description": "Resize the textarea to fit content up to `maxRows` and not below\n`minRows`. This updates the `rows` property and internal layout state.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/TextArea.js#L115" }, "return": { "type": { "text": "() => void" } } }, { "name": "prototype", "kind": "field", "static": true, "type": { "text": "CustomElement" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "onValueChangingContentAttribute", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ControlMixin.js#L43" }, "return": { "type": { "text": "() => void" } }, "inheritedFrom": { "name": "default", "module": "mixins/ControlMixin.js" } }, { "name": "computePlaceholder", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/TextFieldMixin.js#L53" }, "return": { "type": { "text": "() => string" } }, "inheritedFrom": { "name": "default", "module": "mixins/TextFieldMixin.js" } }, { "name": "shouldShowSupporting", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/TextFieldMixin.js#L58" }, "return": { "type": { "text": "() => boolean" } }, "inheritedFrom": { "name": "default", "module": "mixins/TextFieldMixin.js" } }, { "name": "computeSupportingText", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/TextFieldMixin.js#L62" }, "return": { "type": { "text": "() => string" } }, "inheritedFrom": { "name": "default", "module": "mixins/TextFieldMixin.js" } }, { "name": "populatedState", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/TextFieldMixin.js#L66" }, "return": { "type": { "text": "() => boolean" } }, "inheritedFrom": { "name": "default", "module": "mixins/TextFieldMixin.js" } }, { "name": "computedIconVariation", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/TextFieldMixin.js#L77" }, "return": { "type": { "text": "() => string" } }, "inheritedFrom": { "name": "default", "module": "mixins/TextFieldMixin.js" } }, { "name": "onResizeObserved", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ResizeObserverMixin.js#L23" }, "return": { "type": { "text": "(entry: ResizeObserverEntry) => void" } }, "inheritedFrom": { "name": "default", "module": "mixins/ResizeObserverMixin.js" } }, { "name": "observeResize", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ResizeObserverMixin.js#L26" }, "return": { "type": { "text": "() => void" } }, "inheritedFrom": { "name": "default", "module": "mixins/ResizeObserverMixin.js" } }, { "name": "unobserveResize", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ResizeObserverMixin.js#L31" }, "return": { "type": { "text": "() => void" } }, "inheritedFrom": { "name": "default", "module": "mixins/ResizeObserverMixin.js" } }, { "name": "compose", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L145" }, "type": { "text": "(parts: CompositionPart[]) => Composition" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#refsProxy", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1145" }, "type": { "text": "Record" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#refsCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1148" }, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#refsCompositionCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1151" }, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#composition", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1154" }, "type": { "text": "Composition" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#patching", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1156" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#pendingPatchRenders", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1159" }, "type": { "text": "[string, any, CustomElement][]" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#propAttributeCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1162" }, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#callbackArguments", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1165" }, "type": { "text": "CallbackArguments" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "elementInternals", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1172" }, "type": { "text": "ElementInternals" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "render", "kind": "field", "description": "Updates nodes based on data\nExpects data in JSON Merge Patch format", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1185" }, "type": { "text": "RenderDraw" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "propChangedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1213" }, "type": { "text": "(this: T, name: K, oldValue: K extends keyof T ? T[K] : unknown, newValue: K extends keyof T ? T[K] : unknown, changes?: K extends keyof T ? T[K] extends object ? Partial : T[K] : unknown) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attributeChangedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1234" }, "type": { "text": "(name: string, oldValue: string, newValue: string) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#template", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1284" }, "type": { "text": "DocumentFragment" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#onObserverPropertyChanged", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1294" }, "type": { "text": "(name: string, oldValue: any, newValue: any, changes: any) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "static", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1330" }, "type": { "text": "typeof CustomElement" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "patch", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1333" }, "type": { "text": "(patch: any) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "refs", "kind": "field", "description": "Proxy object that returns shadow DOM elements by tag.\nIf called before interpolation (eg: on composed), returns from template", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1404" }, "type": { "text": "Record" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attributeCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1391" }, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "callbackArguments", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1400" }, "type": { "text": "CallbackArguments | { composition: Composition; refs: Record; html: any; inline: (fn: (data: Partial) => any) => string; template: DocumentFragment; element: T; }" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "composition", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1403" }, "type": { "text": "Composition" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "connectedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1435" }, "type": { "text": "() => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "disconnectedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1441" }, "type": { "text": "() => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "elementName", "kind": "field", "static": true, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "observedAttributes", "kind": "field", "static": true, "type": { "text": "Iterable" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "interpolatesTemplate", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "supportsElementInternals", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "supportsElementInternalsRole", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "defined", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "registrations", "kind": "field", "static": true, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "expressions", "kind": "method", "static": true, "description": "Expressions are idempotent functions that are selectively called whenever\na render is requested.\nExpressions are constructed exactly as methods though differ in expected\narguments. The first argument should be destructured to ensure each used\nproperty is accessed at least once in order to inspect used properties.\n\nThe Composition API will inspect this function with a proxy for `this` to\ncatalog what observables are used by the expression. This allows the\nComposition API to build a cache as well as selective invoke the expression\nonly when needed.\n\nWhen used with in element templates, the element itself will be passed as\nits first argument.\n````js\n Button\n .prop('filled', 'boolean')\n .prop('outlined', 'boolean')\n .expresssions({\n _isFilledOrOutlined({filled, outlined}) {\n return (filled || outlined)\n },\n })\n .html`
`;\n````\n\nWhen used with external data source, that data source\nwill be passed to the expression with all properties being `null` at first\ninspection.\n````js\n const externalData = {first: 'John', last: 'Doe'};\n ContactCard\n .expresssions({\n _fullName({first, last}) {\n return [first, last].filter(Boolean).join(' ');\n },\n })\n myButton.render(externalData);\n````\n\nExpressions may be support argumentless calls by using default\nparameters with `this`.\n````js\n Button\n .expresssions({\n isFilledOrOutlined({filled, outlined} = this) {\n return (filled || outlined)\n },\n });\n myButton.isFilledorOutlined();\n````", "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends { [K in keyof any]: K extends `_${any}` ? ((data: INSTANCE, state?: Record) => string | boolean | null) : ((data?: INSTANCE, state?: Record) => string | boolean | null); } & ThisType>(this: CLASS, expressions: PROPS & ThisType) => CLASS & Class<{ [K in keyof PROPS]: K extends `_${any}` ? never : () => ReturnType; }, ARGS>" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "methods", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "overrides", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends Partial>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "props", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "idl", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "append", "kind": "field", "static": true, "description": "Append parts to composition", "type": { "text": "(this: T, ...parts: CompositionPart[]) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "recompose", "kind": "field", "static": true, "description": "After composition, invokes callback.\nMay be called multiple times.", "type": { "text": ", T3 extends CompositionCallback[\"composed\"]>(this: T1, callback: T3) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "css", "kind": "field", "static": true, "description": "Appends styles to composition", "type": { "text": "(this: T1, array: T2, ...rest: T2 extends string ? any : T2 extends TemplateStringsArray ? any[] : (HTMLStyleElement | CSSStyleSheet)[]) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "autoRegister", "kind": "field", "static": true, "description": "Registers class with customElements. If class is registered before then,\ndoes nothing.", "type": { "text": "(this: T, elementName: string) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "html", "kind": "field", "static": true, "description": "Appends DocumentFragment to composition", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1405" }, "type": { "text": "(this: T, string: TemplateStringsArray, ...substitutions: (string | Element | ((this: InstanceType, data: InstanceType, injections?: any) => any))[]) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "extend", "kind": "field", "static": true, "description": "Extends base class into a new class.\nUse to avoid mutating base class.", "type": { "text": " T2>(this: T1, customExtender?: T3) => T3 extends null ? T1 : T2" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "setStatic", "kind": "field", "static": true, "description": "Assigns static values to class", "type": { "text": " any) | string | number | boolean | any[] | object); }>(this: T1, source: T2 & ThisType) => T1 & T2" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "readonly", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "set", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "mixin", "kind": "field", "static": true, "description": "Returns result of calling mixin with current class", "type": { "text": " any, RETURN extends ReturnType, SUBCLASS extends ClassOf>(this: BASE, mixin: FN) => SUBCLASS & BASE" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "register", "kind": "field", "static": true, "description": "Registers class with window.customElements synchronously", "type": { "text": "(this: T, elementName?: string, force?: boolean) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "propList", "kind": "field", "static": true, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attrList", "kind": "field", "static": true, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "propChangedCallbacks", "kind": "field", "static": true, "type": { "text": "Map any)[]>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attributeChangedCallbacks", "kind": "field", "static": true, "type": { "text": "Map any)[]>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "prop", "kind": "field", "static": true, "description": "Creates observable property on instances (via prototype)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1007" }, "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "setPrototype", "kind": "field", "static": true, "description": "Creates observable property on instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any)>(this: CLASS, name: KEY, options: OPTIONS) => OPTIONS extends (...args2: any[]) => infer R ? R : OPTIONS extends ObserverPropertyType ? ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? unknown extends R ? object : R : OPTIONS extends { type: ObserverPropertyType; } ? ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? unknown extends R ? string : R : never" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "define", "kind": "field", "static": true, "description": "Define properties on instances via Object.defineProperties().\nAutomatically sets property non-enumerable if name begins with `_`.\nFunctions will be remapped as getters", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends { [P in keyof any]: { enumerable?: boolean; configurable?: boolean; writable?: boolean; value?: any; get?: ((this: INSTANCE) => any); set?: (this: INSTANCE, value: any) => void; } | ((this: INSTANCE, ...args: any[]) => any); }, VALUE extends { [KEY in keyof PROPS]: PROPS[KEY] extends (...args2: any[]) => infer R ? R : PROPS[KEY] extends TypedPropertyDescriptor ? R : never; }>(this: CLASS, props: PROPS & ThisType) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "undefine", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROP extends string, PROPS extends INSTANCE & Record>(this: CLASS, name: PROP) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "observe", "kind": "field", "static": true, "description": "Creates observable properties on instances", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends IDLParameter, VALUE extends { [KEY in keyof PROPS]: PROPS[KEY] extends (...args2: any[]) => infer R ? R : PROPS[KEY] extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : PROPS[KEY] extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : PROPS[KEY] extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : PROPS[KEY] extends ObserverOptions ? (unknown extends R ? string : R) : never; }>(this: CLASS, props: PROPS) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "defineStatic", "kind": "field", "static": true, "type": { "text": ">(this: T1, props: T2) => T1 & ParsedProps" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "events", "kind": "field", "static": true, "type": { "text": "(this: T, listeners?: CompositionEventListenerObject>, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "childEvents", "kind": "field", "static": true, "type": { "text": "(this: T, listenerMap: { [x: string]: CompositionEventListenerObject>; }, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "rootEvents", "kind": "field", "static": true, "type": { "text": "(this: T, listeners?: CompositionEventListenerObject>, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "on", "kind": "field", "static": true, "type": { "text": ", T3 extends CompositionCallback, T4 extends keyof T3>(this: T1, name: T3 | T4, callbacks?: T3[T4] & ThisType) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "off", "kind": "field", "static": true, "type": { "text": ", T3 extends CompositionCallback, T4 extends keyof T3>(this: T1, name: T3 | T4, callbacks?: T3[T4] & ThisType) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "offPropChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: ObjectOrObjectEntries<{ [P in keyof T2]?: (this: T2, oldValue: T2[P], newValue: T2[P], changes: any, element: T2) => void; }>) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "offAttributeChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: { [x: string]: (this: T2, oldValue: string, newValue: string, element: T2) => void; }) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "onPropChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: ObjectOrObjectEntries<{ [P in keyof T2]?: (this: T2, oldValue: T2[P], newValue: T2[P], changes: any, element: T2) => void; }>) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "onAttributeChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: { [x: string]: (this: T2, oldValue: string, newValue: string, element: T2) => void; }) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } } ], "slots": [ { "name": "supporting", "description": "" } ], "cssParts": [ { "name": "control" } ], "events": [], "demos": [ { "url": "demo/components/textarea.html" } ], "superclass": { "module": "core/CustomElement.js", "name": "default" }, "mixins": [ { "module": "mixins/ThemableMixin.js", "name": "default" }, { "module": "mixins/StateMixin.js", "name": "default" }, { "module": "mixins/ControlMixin.js", "name": "default" }, { "module": "mixins/TextFieldMixin.js", "name": "default" }, { "module": "mixins/ResizeObserverMixin.js", "name": "default" } ], "description": "TextArea is a multi-line text input that auto-resizes and integrates with\ntext-field patterns for labels and validation.\nimplements {HTMLTextAreaElement}\n@see https://m3.material.io/components/text-fields/specs\n@see https://html.spec.whatwg.org/multipage/form-elements.html#the-textarea-element" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "default", "module": "components/TextArea.js" } }, { "kind": "custom-element-definition", "name": "mdw-textarea", "declaration": { "name": "default", "module": "components/TextArea.js" } } ] }, { "kind": "javascript-module", "path": "components/Title.js", "declarations": [ { "kind": "class", "name": "Title", "tagName": "mdw-title", "customElement": true, "attributes": [ { "name": "color", "fieldName": "color", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "ink", "fieldName": "ink", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "type-style", "fieldName": "typeStyle", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "block", "fieldName": "block", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "inline", "fieldName": "inline", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "row", "fieldName": "row", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "x", "fieldName": "x", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "y", "fieldName": "y", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "gap", "fieldName": "gap", "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "padding", "fieldName": "padding", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "text-padding", "fieldName": "textPadding", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "text-padding-top", "fieldName": "textPaddingTop", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "text-leading", "fieldName": "textLeading", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "text-padding-bottom", "fieldName": "textPaddingBottom", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "aria-level", "fieldName": "ariaLevel", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "size", "fieldName": "size", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } } ], "members": [ { "name": "delegatesFocus", "kind": "field", "description": "When true, the element delegates focus to an internal focus target.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/DelegatesFocusMixin.js#L15" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "textPadding", "kind": "field", "description": "General vertical padding for text content (css length)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/TypographyMixin.js#L24" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "textPaddingTop", "kind": "field", "description": "Padding-top override for text content (css length)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/TypographyMixin.js#L26" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "textLeading", "kind": "field", "description": "Line-leading (extra top spacing) for text (css length or 'sp' units)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/TypographyMixin.js#L28" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "textPaddingBottom", "kind": "field", "description": "Padding-bottom override for text content (css length)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/TypographyMixin.js#L30" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "readAriaProperty", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/AriaReflectorMixin.js#L28" }, "type": { "text": "(name: \"shadowRoot\" | \"ariaActiveDescendantElement\" | \"ariaAtomic\" | \"ariaAutoComplete\" | \"ariaBrailleLabel\" | \"ariaBrailleRoleDescription\" | \"ariaBusy\" | \"ariaChecked\" | \"ariaColCount\" | \"ariaColIndex\" | \"ariaColIndexText\" | \"ariaColSpan\" | \"ariaControlsElements\" | \"ariaCurrent\" | \"ariaDescribedByElements\" | \"ariaDescription\" | \"ariaDetailsElements\" | \"ariaDisabled\" | \"ariaErrorMessageElements\" | \"ariaExpanded\" | \"ariaFlowToElements\" | \"ariaHasPopup\" | \"ariaHidden\" | \"ariaInvalid\" | \"ariaKeyShortcuts\" | \"ariaLabel\" | \"ariaLabelledByElements\" | \"ariaLevel\" | \"ariaLive\" | \"ariaModal\" | \"ariaMultiLine\" | \"ariaMultiSelectable\" | \"ariaOrientation\" | \"ariaOwnsElements\" | \"ariaPlaceholder\" | \"ariaPosInSet\" | \"ariaPressed\" | \"ariaReadOnly\" | \"ariaRelevant\" | \"ariaRequired\" | \"ariaRoleDescription\" | \"ariaRowCount\" | \"ariaRowIndex\" | \"ariaRowIndexText\" | \"ariaRowSpan\" | \"ariaSelected\" | \"ariaSetSize\" | \"ariaSort\" | \"ariaValueMax\" | \"ariaValueMin\" | \"ariaValueNow\" | \"ariaValueText\" | \"role\") => string | Element | ShadowRoot | readonly Element[]" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "updateAriaProperty", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/AriaReflectorMixin.js#L47" }, "type": { "text": ">(name: K, value: ARIAMixin[K]) => void" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "block", "kind": "field", "description": "Set `display: block` on the host (boolean)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js#L9" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "inline", "kind": "field", "description": "Use inline flex layout: `display: inline-flex` (boolean)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js#L11" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "row", "kind": "field", "description": "Switch main axis to horizontal: `flex-direction: row` (boolean)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js#L13" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "x", "kind": "field", "description": "Main-axis alignment / justification.\nAllowed: 'start'|'center'|'end'|'between'|'around'|'stretch'|'baseline'.\nDefault: 'start'.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js#L19" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "y", "kind": "field", "description": "Cross-axis alignment / alignment of items.\nSame allowed values as `x`. Default: 'start'.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js#L29" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "gap", "kind": "field", "description": "Gap between children. Accepts preset numeric strings (e.g. '8') mapped to px, or floats.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js#L36" }, "type": { "text": "number" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "padding", "kind": "field", "description": "Padding preset or numeric value (e.g. 'pane', '8', '16').", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js#L38" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "color", "kind": "field", "description": "Palette or surface token used to select background/ink tokens.\nExamples: 'primary', 'background', 'surface-container-low'.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L52" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "ink", "kind": "field", "description": "Explicit ink override token (e.g. 'outline', 'on-primary', 'inverse-on-surface', 'inherit').\nMaps to `--mdw-ink`.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L57" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "typeStyle", "kind": "field", "description": "Typographic style shortcut that maps to type scale variables\n(e.g. 'headline-large', 'body-medium').", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L62" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "prototype", "kind": "field", "static": true, "type": { "text": "CustomElement" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "size", "kind": "field", "description": "Display size controlling typographic scale: 'large'|'medium'|'small'.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Display.js#L24" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "compose", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L145" }, "type": { "text": "(parts: CompositionPart[]) => Composition" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "#refsProxy", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1145" }, "type": { "text": "Record" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "#refsCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1148" }, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "#refsCompositionCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1151" }, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "#composition", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1154" }, "type": { "text": "Composition" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "#patching", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1156" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "#pendingPatchRenders", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1159" }, "type": { "text": "[string, any, CustomElement][]" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "#propAttributeCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1162" }, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "#callbackArguments", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1165" }, "type": { "text": "CallbackArguments" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "elementInternals", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1172" }, "type": { "text": "ElementInternals" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "render", "kind": "field", "description": "Updates nodes based on data\nExpects data in JSON Merge Patch format", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1185" }, "type": { "text": "RenderDraw" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "propChangedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1213" }, "type": { "text": "(this: T, name: K, oldValue: K extends keyof T ? T[K] : unknown, newValue: K extends keyof T ? T[K] : unknown, changes?: K extends keyof T ? T[K] extends object ? Partial : T[K] : unknown) => void" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "attributeChangedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1234" }, "type": { "text": "(name: string, oldValue: string, newValue: string) => void" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "#template", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1284" }, "type": { "text": "DocumentFragment" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "#onObserverPropertyChanged", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1294" }, "type": { "text": "(name: string, oldValue: any, newValue: any, changes: any) => void" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "static", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1330" }, "type": { "text": "typeof CustomElement" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "patch", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1333" }, "type": { "text": "(patch: any) => void" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "refs", "kind": "field", "description": "Proxy object that returns shadow DOM elements by tag.\nIf called before interpolation (eg: on composed), returns from template", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1404" }, "type": { "text": "Record" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "attributeCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1391" }, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "callbackArguments", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1400" }, "type": { "text": "CallbackArguments | { composition: Composition; refs: Record; html: any; inline: (fn: (data: Partial) => any) => string; template: DocumentFragment; element: T; }" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "composition", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1403" }, "type": { "text": "Composition" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "connectedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1435" }, "type": { "text": "() => void" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "disconnectedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1441" }, "type": { "text": "() => void" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "elementName", "kind": "field", "static": true, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "observedAttributes", "kind": "field", "static": true, "type": { "text": "Iterable" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "interpolatesTemplate", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "supportsElementInternals", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "supportsElementInternalsRole", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "defined", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "registrations", "kind": "field", "static": true, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "expressions", "kind": "method", "static": true, "description": "Expressions are idempotent functions that are selectively called whenever\na render is requested.\nExpressions are constructed exactly as methods though differ in expected\narguments. The first argument should be destructured to ensure each used\nproperty is accessed at least once in order to inspect used properties.\n\nThe Composition API will inspect this function with a proxy for `this` to\ncatalog what observables are used by the expression. This allows the\nComposition API to build a cache as well as selective invoke the expression\nonly when needed.\n\nWhen used with in element templates, the element itself will be passed as\nits first argument.\n````js\n Button\n .prop('filled', 'boolean')\n .prop('outlined', 'boolean')\n .expresssions({\n _isFilledOrOutlined({filled, outlined}) {\n return (filled || outlined)\n },\n })\n .html`
`;\n````\n\nWhen used with external data source, that data source\nwill be passed to the expression with all properties being `null` at first\ninspection.\n````js\n const externalData = {first: 'John', last: 'Doe'};\n ContactCard\n .expresssions({\n _fullName({first, last}) {\n return [first, last].filter(Boolean).join(' ');\n },\n })\n myButton.render(externalData);\n````\n\nExpressions may be support argumentless calls by using default\nparameters with `this`.\n````js\n Button\n .expresssions({\n isFilledOrOutlined({filled, outlined} = this) {\n return (filled || outlined)\n },\n });\n myButton.isFilledorOutlined();\n````", "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends { [K in keyof any]: K extends `_${any}` ? ((data: INSTANCE, state?: Record) => string | boolean | null) : ((data?: INSTANCE, state?: Record) => string | boolean | null); } & ThisType>(this: CLASS, expressions: PROPS & ThisType) => CLASS & Class<{ [K in keyof PROPS]: K extends `_${any}` ? never : () => ReturnType; }, ARGS>" } }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "methods", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "overrides", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends Partial>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "props", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "idl", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "append", "kind": "field", "static": true, "description": "Append parts to composition", "type": { "text": "(this: T, ...parts: CompositionPart[]) => T" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "recompose", "kind": "field", "static": true, "description": "After composition, invokes callback.\nMay be called multiple times.", "type": { "text": ", T3 extends CompositionCallback[\"composed\"]>(this: T1, callback: T3) => T1" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "css", "kind": "field", "static": true, "description": "Appends styles to composition", "type": { "text": "(this: T1, array: T2, ...rest: T2 extends string ? any : T2 extends TemplateStringsArray ? any[] : (HTMLStyleElement | CSSStyleSheet)[]) => T1" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "autoRegister", "kind": "field", "static": true, "description": "Registers class with customElements. If class is registered before then,\ndoes nothing.", "type": { "text": "(this: T, elementName: string) => T" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "html", "kind": "field", "static": true, "description": "Appends DocumentFragment to composition", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1405" }, "type": { "text": "(this: T, string: TemplateStringsArray, ...substitutions: (string | Element | ((this: InstanceType, data: InstanceType, injections?: any) => any))[]) => T" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "extend", "kind": "field", "static": true, "description": "Extends base class into a new class.\nUse to avoid mutating base class.", "type": { "text": " T2>(this: T1, customExtender?: T3) => T3 extends null ? T1 : T2" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "setStatic", "kind": "field", "static": true, "description": "Assigns static values to class", "type": { "text": " any) | string | number | boolean | any[] | object); }>(this: T1, source: T2 & ThisType) => T1 & T2" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "readonly", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "set", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "mixin", "kind": "field", "static": true, "description": "Returns result of calling mixin with current class", "type": { "text": " any, RETURN extends ReturnType, SUBCLASS extends ClassOf>(this: BASE, mixin: FN) => SUBCLASS & BASE" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "register", "kind": "field", "static": true, "description": "Registers class with window.customElements synchronously", "type": { "text": "(this: T, elementName?: string, force?: boolean) => T" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "propList", "kind": "field", "static": true, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "attrList", "kind": "field", "static": true, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "propChangedCallbacks", "kind": "field", "static": true, "type": { "text": "Map any)[]>" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "attributeChangedCallbacks", "kind": "field", "static": true, "type": { "text": "Map any)[]>" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "prop", "kind": "field", "static": true, "description": "Creates observable property on instances (via prototype)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1007" }, "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "setPrototype", "kind": "field", "static": true, "description": "Creates observable property on instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any)>(this: CLASS, name: KEY, options: OPTIONS) => OPTIONS extends (...args2: any[]) => infer R ? R : OPTIONS extends ObserverPropertyType ? ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? unknown extends R ? object : R : OPTIONS extends { type: ObserverPropertyType; } ? ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? unknown extends R ? string : R : never" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "define", "kind": "field", "static": true, "description": "Define properties on instances via Object.defineProperties().\nAutomatically sets property non-enumerable if name begins with `_`.\nFunctions will be remapped as getters", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends { [P in keyof any]: { enumerable?: boolean; configurable?: boolean; writable?: boolean; value?: any; get?: ((this: INSTANCE) => any); set?: (this: INSTANCE, value: any) => void; } | ((this: INSTANCE, ...args: any[]) => any); }, VALUE extends { [KEY in keyof PROPS]: PROPS[KEY] extends (...args2: any[]) => infer R ? R : PROPS[KEY] extends TypedPropertyDescriptor ? R : never; }>(this: CLASS, props: PROPS & ThisType) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "undefine", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROP extends string, PROPS extends INSTANCE & Record>(this: CLASS, name: PROP) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "observe", "kind": "field", "static": true, "description": "Creates observable properties on instances", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends IDLParameter, VALUE extends { [KEY in keyof PROPS]: PROPS[KEY] extends (...args2: any[]) => infer R ? R : PROPS[KEY] extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : PROPS[KEY] extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : PROPS[KEY] extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : PROPS[KEY] extends ObserverOptions ? (unknown extends R ? string : R) : never; }>(this: CLASS, props: PROPS) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "defineStatic", "kind": "field", "static": true, "type": { "text": ">(this: T1, props: T2) => T1 & ParsedProps" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "events", "kind": "field", "static": true, "type": { "text": "(this: T, listeners?: CompositionEventListenerObject>, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "childEvents", "kind": "field", "static": true, "type": { "text": "(this: T, listenerMap: { [x: string]: CompositionEventListenerObject>; }, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "rootEvents", "kind": "field", "static": true, "type": { "text": "(this: T, listeners?: CompositionEventListenerObject>, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "on", "kind": "field", "static": true, "type": { "text": ", T3 extends CompositionCallback, T4 extends keyof T3>(this: T1, name: T3 | T4, callbacks?: T3[T4] & ThisType) => T1" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "off", "kind": "field", "static": true, "type": { "text": ", T3 extends CompositionCallback, T4 extends keyof T3>(this: T1, name: T3 | T4, callbacks?: T3[T4] & ThisType) => T1" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "offPropChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: ObjectOrObjectEntries<{ [P in keyof T2]?: (this: T2, oldValue: T2[P], newValue: T2[P], changes: any, element: T2) => void; }>) => T1" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "offAttributeChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: { [x: string]: (this: T2, oldValue: string, newValue: string, element: T2) => void; }) => T1" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "onPropChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: ObjectOrObjectEntries<{ [P in keyof T2]?: (this: T2, oldValue: T2[P], newValue: T2[P], changes: any, element: T2) => void; }>) => T1" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } }, { "name": "onAttributeChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: { [x: string]: (this: T2, oldValue: string, newValue: string, element: T2) => void; }) => T1" }, "inheritedFrom": { "name": "default", "module": "components/Display.js" } } ], "slots": [ { "name": "", "description": "" } ], "cssParts": [], "events": [], "demos": [], "superclass": { "module": "components/Display.js", "name": "default" }, "mixins": [], "description": "Material Design Type scale: Title.\n@see https://m3.material.io/styles/typography/type-scale-tokens" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "default", "module": "components/Title.js" } }, { "kind": "custom-element-definition", "name": "mdw-title", "declaration": { "name": "default", "module": "components/Title.js" } } ] }, { "kind": "javascript-module", "path": "components/Tooltip.js", "declarations": [ { "kind": "class", "name": "Tooltip", "tagName": "mdw-tooltip", "customElement": true, "attributes": [ { "name": "color", "fieldName": "color", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "ink", "fieldName": "ink", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "type-style", "fieldName": "typeStyle", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "shape-top", "fieldName": "shapeTop", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shape-bottom", "fieldName": "shapeBottom", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shape-start", "fieldName": "shapeStart", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shape-end", "fieldName": "shapeEnd", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shape-style", "fieldName": "shapeStyle", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "outlined", "fieldName": "outlined", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "open", "description": "When true the tooltip is visible/open. This also updates ARIA\n`aria-hidden` for accessibility.", "fieldName": "open", "type": { "text": "boolean" } } ], "members": [ { "name": "disabled", "kind": "field", "description": "Whether the element is disabled (affects interactive states)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L14" }, "type": { "text": "boolean" } }, { "name": "focused", "kind": "field", "description": "Force focus state (independent of document)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L16" }, "type": { "text": "boolean" } }, { "name": "hovered", "kind": "field", "description": "Force hover state (independent of interaction)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L18" }, "type": { "text": "boolean" } }, { "name": "pressed", "kind": "field", "description": "Force pressed state (independent of interaction)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L20" }, "type": { "text": "boolean" } }, { "name": "stateLayer", "kind": "field", "description": "Show the visual state layer element when true", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L34" }, "type": { "text": "boolean" } }, { "name": "disabledState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L37" }, "type": { "text": "boolean" } }, { "name": "hoveredState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L38" }, "type": { "text": "boolean" } }, { "name": "focusedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L39" }, "type": { "text": "boolean" } }, { "name": "pressedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L40" }, "type": { "text": "boolean" } }, { "name": "touchedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L41" }, "type": { "text": "boolean" } }, { "name": "pointedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L44" }, "type": { "text": "boolean" } }, { "name": "stateTargetElement", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L50" }, "type": { "text": "HTMLElement" } }, { "name": "color", "kind": "field", "description": "Palette or surface token used to select background/ink tokens.\nExamples: 'primary', 'background', 'surface-container-low'.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L52" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "ink", "kind": "field", "description": "Explicit ink override token (e.g. 'outline', 'on-primary', 'inverse-on-surface', 'inherit').\nMaps to `--mdw-ink`.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L57" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "typeStyle", "kind": "field", "description": "Typographic style shortcut that maps to type scale variables\n(e.g. 'headline-large', 'body-medium').", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L62" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "shapeTop", "kind": "field", "description": "Show top cut/shape on the element", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L9" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shapeBottom", "kind": "field", "description": "Show bottom cut/shape on the element", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L11" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shapeStart", "kind": "field", "description": "Show start-side cut/shape (logical start)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L13" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shapeEnd", "kind": "field", "description": "Show end-side cut/shape (logical end)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L15" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shapeStyle", "kind": "field", "description": "Predefined shape size/style name (none|extra-small|small|medium|large|extra-large|full|inherit)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L17" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "outlined", "kind": "field", "description": "When true, an outline is rendered around the element", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L19" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "open", "kind": "field", "description": "When true the tooltip is visible/open. This also updates ARIA\n`aria-hidden` for accessibility.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/Tooltip.js#L24" }, "type": { "text": "boolean" } }, { "name": "prototype", "kind": "field", "static": true, "type": { "text": "CustomElement" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "readAriaProperty", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/AriaReflectorMixin.js#L28" }, "return": { "type": { "text": "(name: \"shadowRoot\" | \"ariaActiveDescendantElement\" | \"ariaAtomic\" | \"ariaAutoComplete\" | \"ariaBrailleLabel\" | \"ariaBrailleRoleDescription\" | \"ariaBusy\" | \"ariaChecked\" | \"ariaColCount\" | \"ariaColIndex\" | \"ariaColIndexText\" | \"ariaColSpan\" | \"ariaControlsElements\" | \"ariaCurrent\" | \"ariaDescribedByElements\" | \"ariaDescription\" | \"ariaDetailsElements\" | \"ariaDisabled\" | \"ariaErrorMessageElements\" | \"ariaExpanded\" | \"ariaFlowToElements\" | \"ariaHasPopup\" | \"ariaHidden\" | \"ariaInvalid\" | \"ariaKeyShortcuts\" | \"ariaLabel\" | \"ariaLabelledByElements\" | \"ariaLevel\" | \"ariaLive\" | \"ariaModal\" | \"ariaMultiLine\" | \"ariaMultiSelectable\" | \"ariaOrientation\" | \"ariaOwnsElements\" | \"ariaPlaceholder\" | \"ariaPosInSet\" | \"ariaPressed\" | \"ariaReadOnly\" | \"ariaRelevant\" | \"ariaRequired\" | \"ariaRoleDescription\" | \"ariaRowCount\" | \"ariaRowIndex\" | \"ariaRowIndexText\" | \"ariaRowSpan\" | \"ariaSelected\" | \"ariaSetSize\" | \"ariaSort\" | \"ariaValueMax\" | \"ariaValueMin\" | \"ariaValueNow\" | \"ariaValueText\" | \"role\") => string | Element | ShadowRoot | readonly Element[]" } }, "inheritedFrom": { "name": "default", "module": "mixins/AriaReflectorMixin.js" } }, { "name": "updateAriaProperty", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/AriaReflectorMixin.js#L47" }, "return": { "type": { "text": ">(name: K, value: ARIAMixin[K]) => void" } }, "inheritedFrom": { "name": "default", "module": "mixins/AriaReflectorMixin.js" } }, { "name": "compose", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L145" }, "type": { "text": "(parts: CompositionPart[]) => Composition" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#refsProxy", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1145" }, "type": { "text": "Record" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#refsCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1148" }, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#refsCompositionCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1151" }, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#composition", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1154" }, "type": { "text": "Composition" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#patching", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1156" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#pendingPatchRenders", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1159" }, "type": { "text": "[string, any, CustomElement][]" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#propAttributeCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1162" }, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#callbackArguments", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1165" }, "type": { "text": "CallbackArguments" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "elementInternals", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1172" }, "type": { "text": "ElementInternals" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "render", "kind": "field", "description": "Updates nodes based on data\nExpects data in JSON Merge Patch format", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1185" }, "type": { "text": "RenderDraw" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "propChangedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1213" }, "type": { "text": "(this: T, name: K, oldValue: K extends keyof T ? T[K] : unknown, newValue: K extends keyof T ? T[K] : unknown, changes?: K extends keyof T ? T[K] extends object ? Partial : T[K] : unknown) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attributeChangedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1234" }, "type": { "text": "(name: string, oldValue: string, newValue: string) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#template", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1284" }, "type": { "text": "DocumentFragment" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#onObserverPropertyChanged", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1294" }, "type": { "text": "(name: string, oldValue: any, newValue: any, changes: any) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "static", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1330" }, "type": { "text": "typeof CustomElement" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "patch", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1333" }, "type": { "text": "(patch: any) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "refs", "kind": "field", "description": "Proxy object that returns shadow DOM elements by tag.\nIf called before interpolation (eg: on composed), returns from template", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1404" }, "type": { "text": "Record" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attributeCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1391" }, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "callbackArguments", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1400" }, "type": { "text": "CallbackArguments | { composition: Composition; refs: Record; html: any; inline: (fn: (data: Partial) => any) => string; template: DocumentFragment; element: T; }" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "composition", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1403" }, "type": { "text": "Composition" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "connectedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1435" }, "type": { "text": "() => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "disconnectedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1441" }, "type": { "text": "() => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "delegatesFocus", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1175" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "elementName", "kind": "field", "static": true, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "observedAttributes", "kind": "field", "static": true, "type": { "text": "Iterable" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "interpolatesTemplate", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "supportsElementInternals", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "supportsElementInternalsRole", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "defined", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "registrations", "kind": "field", "static": true, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "expressions", "kind": "method", "static": true, "description": "Expressions are idempotent functions that are selectively called whenever\na render is requested.\nExpressions are constructed exactly as methods though differ in expected\narguments. The first argument should be destructured to ensure each used\nproperty is accessed at least once in order to inspect used properties.\n\nThe Composition API will inspect this function with a proxy for `this` to\ncatalog what observables are used by the expression. This allows the\nComposition API to build a cache as well as selective invoke the expression\nonly when needed.\n\nWhen used with in element templates, the element itself will be passed as\nits first argument.\n````js\n Button\n .prop('filled', 'boolean')\n .prop('outlined', 'boolean')\n .expresssions({\n _isFilledOrOutlined({filled, outlined}) {\n return (filled || outlined)\n },\n })\n .html`
`;\n````\n\nWhen used with external data source, that data source\nwill be passed to the expression with all properties being `null` at first\ninspection.\n````js\n const externalData = {first: 'John', last: 'Doe'};\n ContactCard\n .expresssions({\n _fullName({first, last}) {\n return [first, last].filter(Boolean).join(' ');\n },\n })\n myButton.render(externalData);\n````\n\nExpressions may be support argumentless calls by using default\nparameters with `this`.\n````js\n Button\n .expresssions({\n isFilledOrOutlined({filled, outlined} = this) {\n return (filled || outlined)\n },\n });\n myButton.isFilledorOutlined();\n````", "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends { [K in keyof any]: K extends `_${any}` ? ((data: INSTANCE, state?: Record) => string | boolean | null) : ((data?: INSTANCE, state?: Record) => string | boolean | null); } & ThisType>(this: CLASS, expressions: PROPS & ThisType) => CLASS & Class<{ [K in keyof PROPS]: K extends `_${any}` ? never : () => ReturnType; }, ARGS>" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "methods", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "overrides", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends Partial>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "props", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "idl", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "append", "kind": "field", "static": true, "description": "Append parts to composition", "type": { "text": "(this: T, ...parts: CompositionPart[]) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "recompose", "kind": "field", "static": true, "description": "After composition, invokes callback.\nMay be called multiple times.", "type": { "text": ", T3 extends CompositionCallback[\"composed\"]>(this: T1, callback: T3) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "css", "kind": "field", "static": true, "description": "Appends styles to composition", "type": { "text": "(this: T1, array: T2, ...rest: T2 extends string ? any : T2 extends TemplateStringsArray ? any[] : (HTMLStyleElement | CSSStyleSheet)[]) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "autoRegister", "kind": "field", "static": true, "description": "Registers class with customElements. If class is registered before then,\ndoes nothing.", "type": { "text": "(this: T, elementName: string) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "html", "kind": "field", "static": true, "description": "Appends DocumentFragment to composition", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1405" }, "type": { "text": "(this: T, string: TemplateStringsArray, ...substitutions: (string | Element | ((this: InstanceType, data: InstanceType, injections?: any) => any))[]) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "extend", "kind": "field", "static": true, "description": "Extends base class into a new class.\nUse to avoid mutating base class.", "type": { "text": " T2>(this: T1, customExtender?: T3) => T3 extends null ? T1 : T2" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "setStatic", "kind": "field", "static": true, "description": "Assigns static values to class", "type": { "text": " any) | string | number | boolean | any[] | object); }>(this: T1, source: T2 & ThisType) => T1 & T2" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "readonly", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "set", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "mixin", "kind": "field", "static": true, "description": "Returns result of calling mixin with current class", "type": { "text": " any, RETURN extends ReturnType, SUBCLASS extends ClassOf>(this: BASE, mixin: FN) => SUBCLASS & BASE" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "register", "kind": "field", "static": true, "description": "Registers class with window.customElements synchronously", "type": { "text": "(this: T, elementName?: string, force?: boolean) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "propList", "kind": "field", "static": true, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attrList", "kind": "field", "static": true, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "propChangedCallbacks", "kind": "field", "static": true, "type": { "text": "Map any)[]>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attributeChangedCallbacks", "kind": "field", "static": true, "type": { "text": "Map any)[]>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "prop", "kind": "field", "static": true, "description": "Creates observable property on instances (via prototype)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1007" }, "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "setPrototype", "kind": "field", "static": true, "description": "Creates observable property on instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any)>(this: CLASS, name: KEY, options: OPTIONS) => OPTIONS extends (...args2: any[]) => infer R ? R : OPTIONS extends ObserverPropertyType ? ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? unknown extends R ? object : R : OPTIONS extends { type: ObserverPropertyType; } ? ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? unknown extends R ? string : R : never" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "define", "kind": "field", "static": true, "description": "Define properties on instances via Object.defineProperties().\nAutomatically sets property non-enumerable if name begins with `_`.\nFunctions will be remapped as getters", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends { [P in keyof any]: { enumerable?: boolean; configurable?: boolean; writable?: boolean; value?: any; get?: ((this: INSTANCE) => any); set?: (this: INSTANCE, value: any) => void; } | ((this: INSTANCE, ...args: any[]) => any); }, VALUE extends { [KEY in keyof PROPS]: PROPS[KEY] extends (...args2: any[]) => infer R ? R : PROPS[KEY] extends TypedPropertyDescriptor ? R : never; }>(this: CLASS, props: PROPS & ThisType) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "undefine", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROP extends string, PROPS extends INSTANCE & Record>(this: CLASS, name: PROP) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "observe", "kind": "field", "static": true, "description": "Creates observable properties on instances", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends IDLParameter, VALUE extends { [KEY in keyof PROPS]: PROPS[KEY] extends (...args2: any[]) => infer R ? R : PROPS[KEY] extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : PROPS[KEY] extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : PROPS[KEY] extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : PROPS[KEY] extends ObserverOptions ? (unknown extends R ? string : R) : never; }>(this: CLASS, props: PROPS) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "defineStatic", "kind": "field", "static": true, "type": { "text": ">(this: T1, props: T2) => T1 & ParsedProps" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "events", "kind": "field", "static": true, "type": { "text": "(this: T, listeners?: CompositionEventListenerObject>, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "childEvents", "kind": "field", "static": true, "type": { "text": "(this: T, listenerMap: { [x: string]: CompositionEventListenerObject>; }, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "rootEvents", "kind": "field", "static": true, "type": { "text": "(this: T, listeners?: CompositionEventListenerObject>, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "on", "kind": "field", "static": true, "type": { "text": ", T3 extends CompositionCallback, T4 extends keyof T3>(this: T1, name: T3 | T4, callbacks?: T3[T4] & ThisType) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "off", "kind": "field", "static": true, "type": { "text": ", T3 extends CompositionCallback, T4 extends keyof T3>(this: T1, name: T3 | T4, callbacks?: T3[T4] & ThisType) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "offPropChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: ObjectOrObjectEntries<{ [P in keyof T2]?: (this: T2, oldValue: T2[P], newValue: T2[P], changes: any, element: T2) => void; }>) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "offAttributeChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: { [x: string]: (this: T2, oldValue: string, newValue: string, element: T2) => void; }) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "onPropChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: ObjectOrObjectEntries<{ [P in keyof T2]?: (this: T2, oldValue: T2[P], newValue: T2[P], changes: any, element: T2) => void; }>) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "onAttributeChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: { [x: string]: (this: T2, oldValue: string, newValue: string, element: T2) => void; }) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } } ], "slots": [ { "name": "", "description": "" } ], "cssParts": [], "events": [], "demos": [ { "url": "demo/components/tooltip.html" } ], "superclass": { "module": "core/CustomElement.js", "name": "default" }, "mixins": [ { "module": "mixins/ThemableMixin.js", "name": "default" }, { "module": "mixins/ShapeMixin.js", "name": "default" }, { "module": "mixins/AriaReflectorMixin.js", "name": "default" } ], "description": "Tooltip displays brief helper text when hovering or focusing an element.\n@see https://m3.material.io/components/tooltips/specs" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "default", "module": "components/Tooltip.js" } }, { "kind": "custom-element-definition", "name": "mdw-tooltip", "declaration": { "name": "default", "module": "components/Tooltip.js" } } ] }, { "kind": "javascript-module", "path": "components/TopAppBar.js", "declarations": [ { "kind": "class", "name": "TopAppBar", "tagName": "mdw-top-app-bar", "customElement": true, "attributes": [ { "name": "color", "description": "Color token name used for ink/background.", "fieldName": "color", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "ink", "fieldName": "ink", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "type-style", "fieldName": "typeStyle", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "shape-top", "fieldName": "shapeTop", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shape-bottom", "fieldName": "shapeBottom", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shape-start", "fieldName": "shapeStart", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shape-end", "fieldName": "shapeEnd", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shape-style", "fieldName": "shapeStyle", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "outlined", "fieldName": "outlined", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "kbd-nav", "fieldName": "kbdNav", "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/AriaToolbarMixin.js" } }, { "name": "sticky-always", "fieldName": "stickyAlways", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/SemiStickyMixin.js" } }, { "name": "sticky-parent", "fieldName": "stickyParent", "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/SemiStickyMixin.js" } }, { "name": "headline", "description": "Headline text displayed in the center area.", "fieldName": "headline", "type": { "text": "string" } }, { "name": "size", "description": "Size variant: 'small' | 'medium' | 'large' or `null` to auto-select.", "fieldName": "size", "type": { "text": "string" } }, { "name": "raised-color", "description": "Color token to use when the bar is raised.", "fieldName": "raisedColor", "type": { "text": "string" } } ], "members": [ { "name": "delegatesFocus", "kind": "field", "description": "When true, the element delegates focus to an internal focus target.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/DelegatesFocusMixin.js#L15" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "stickyAlways", "kind": "field", "description": "When true, element remains always visible", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/SemiStickyMixin.js#L26" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/SemiStickyMixin.js" } }, { "name": "stickyParent", "kind": "field", "description": "Stick to offsetParent instead of window", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/SemiStickyMixin.js#L28" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/SemiStickyMixin.js" } }, { "name": "kbdNav", "kind": "field", "description": "Enable keyboard roving navigation when present (set to 'true').", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/KeyboardNavMixin.js#L23" }, "type": { "text": "string" } }, { "name": "kbdNavQuery", "kind": "field", "description": "Query used to find roving tab index children", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/KeyboardNavMixin.js#L32" }, "type": { "text": "string" } }, { "name": "kbdNavFocusableWhenDisabled", "kind": "field", "description": "Flag whether disabled elements participating in roving tab index\nshould be focusable.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/KeyboardNavMixin.js#L39" }, "type": { "text": "boolean" } }, { "name": "ariaOrientationDefault", "kind": "field", "description": "Default orientation for toolbar: 'horizontal' or 'vertical'.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/AriaToolbarMixin.js#L14" }, "type": { "text": "\"horizontal\" | \"vertical\"" } }, { "name": "kbdNavChildren", "kind": "field", "description": "List of roving tab index participating children", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/KeyboardNavMixin.js#L48" }, "type": { "text": "NodeListOf" } }, { "name": "disabled", "kind": "field", "description": "Whether the element is disabled (affects interactive states)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L14" }, "type": { "text": "boolean" } }, { "name": "focused", "kind": "field", "description": "Force focus state (independent of document)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L16" }, "type": { "text": "boolean" } }, { "name": "hovered", "kind": "field", "description": "Force hover state (independent of interaction)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L18" }, "type": { "text": "boolean" } }, { "name": "pressed", "kind": "field", "description": "Force pressed state (independent of interaction)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L20" }, "type": { "text": "boolean" } }, { "name": "stateLayer", "kind": "field", "description": "Show the visual state layer element when true", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L34" }, "type": { "text": "boolean" } }, { "name": "disabledState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L37" }, "type": { "text": "boolean" } }, { "name": "hoveredState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L38" }, "type": { "text": "boolean" } }, { "name": "focusedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L39" }, "type": { "text": "boolean" } }, { "name": "pressedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L40" }, "type": { "text": "boolean" } }, { "name": "touchedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L41" }, "type": { "text": "boolean" } }, { "name": "pointedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L44" }, "type": { "text": "boolean" } }, { "name": "stateTargetElement", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L50" }, "type": { "text": "HTMLElement" } }, { "name": "color", "kind": "field", "description": "Palette or surface token used to select background/ink tokens.\nExamples: 'primary', 'background', 'surface-container-low'.\nColor token name used for ink/background.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/TopAppBar.js#L40" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "ink", "kind": "field", "description": "Explicit ink override token (e.g. 'outline', 'on-primary', 'inverse-on-surface', 'inherit').\nMaps to `--mdw-ink`.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L57" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "typeStyle", "kind": "field", "description": "Typographic style shortcut that maps to type scale variables\n(e.g. 'headline-large', 'body-medium').", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L62" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ThemableMixin.js" } }, { "name": "shapeTop", "kind": "field", "description": "Show top cut/shape on the element", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L9" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shapeBottom", "kind": "field", "description": "Show bottom cut/shape on the element", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L11" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shapeStart", "kind": "field", "description": "Show start-side cut/shape (logical start)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L13" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shapeEnd", "kind": "field", "description": "Show end-side cut/shape (logical end)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L15" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "shapeStyle", "kind": "field", "description": "Predefined shape size/style name (none|extra-small|small|medium|large|extra-large|full|inherit)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L17" }, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "outlined", "kind": "field", "description": "When true, an outline is rendered around the element", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L19" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "mixins/ShapeMixin.js" } }, { "name": "headline", "kind": "field", "description": "Headline text displayed in the center area.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/TopAppBar.js#L36" }, "type": { "text": "string" } }, { "name": "size", "kind": "field", "description": "Size variant: 'small' | 'medium' | 'large' or `null` to auto-select.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/TopAppBar.js#L38" }, "type": { "text": "\"small\" | \"large\" | \"medium\"" } }, { "name": "raisedColor", "kind": "field", "description": "Color token to use when the bar is raised.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/components/TopAppBar.js#L42" }, "type": { "text": "string" } }, { "name": "prototype", "kind": "field", "static": true, "type": { "text": "CustomElement" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "compose", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L145" }, "type": { "text": "(parts: CompositionPart[]) => Composition" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#refsProxy", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1145" }, "type": { "text": "Record" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#refsCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1148" }, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#refsCompositionCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1151" }, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#composition", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1154" }, "type": { "text": "Composition" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#patching", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1156" }, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#pendingPatchRenders", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1159" }, "type": { "text": "[string, any, CustomElement][]" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#propAttributeCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1162" }, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#callbackArguments", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1165" }, "type": { "text": "CallbackArguments" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "elementInternals", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1172" }, "type": { "text": "ElementInternals" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "render", "kind": "field", "description": "Updates nodes based on data\nExpects data in JSON Merge Patch format", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1185" }, "type": { "text": "RenderDraw" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "propChangedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1213" }, "type": { "text": "(this: T, name: K, oldValue: K extends keyof T ? T[K] : unknown, newValue: K extends keyof T ? T[K] : unknown, changes?: K extends keyof T ? T[K] extends object ? Partial : T[K] : unknown) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attributeChangedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1234" }, "type": { "text": "(name: string, oldValue: string, newValue: string) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#template", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1284" }, "type": { "text": "DocumentFragment" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "#onObserverPropertyChanged", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1294" }, "type": { "text": "(name: string, oldValue: any, newValue: any, changes: any) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "static", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1330" }, "type": { "text": "typeof CustomElement" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "patch", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1333" }, "type": { "text": "(patch: any) => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "refs", "kind": "field", "description": "Proxy object that returns shadow DOM elements by tag.\nIf called before interpolation (eg: on composed), returns from template", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1404" }, "type": { "text": "Record" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attributeCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1391" }, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "callbackArguments", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1400" }, "type": { "text": "CallbackArguments | { composition: Composition; refs: Record; html: any; inline: (fn: (data: Partial) => any) => string; template: DocumentFragment; element: T; }" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "composition", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1403" }, "type": { "text": "Composition" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "connectedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1435" }, "type": { "text": "() => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "disconnectedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1441" }, "type": { "text": "() => void" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "elementName", "kind": "field", "static": true, "type": { "text": "string" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "observedAttributes", "kind": "field", "static": true, "type": { "text": "Iterable" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "interpolatesTemplate", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "supportsElementInternals", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "supportsElementInternalsRole", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "defined", "kind": "field", "static": true, "type": { "text": "boolean" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "registrations", "kind": "field", "static": true, "type": { "text": "Map" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "expressions", "kind": "method", "static": true, "description": "Expressions are idempotent functions that are selectively called whenever\na render is requested.\nExpressions are constructed exactly as methods though differ in expected\narguments. The first argument should be destructured to ensure each used\nproperty is accessed at least once in order to inspect used properties.\n\nThe Composition API will inspect this function with a proxy for `this` to\ncatalog what observables are used by the expression. This allows the\nComposition API to build a cache as well as selective invoke the expression\nonly when needed.\n\nWhen used with in element templates, the element itself will be passed as\nits first argument.\n````js\n Button\n .prop('filled', 'boolean')\n .prop('outlined', 'boolean')\n .expresssions({\n _isFilledOrOutlined({filled, outlined}) {\n return (filled || outlined)\n },\n })\n .html`
`;\n````\n\nWhen used with external data source, that data source\nwill be passed to the expression with all properties being `null` at first\ninspection.\n````js\n const externalData = {first: 'John', last: 'Doe'};\n ContactCard\n .expresssions({\n _fullName({first, last}) {\n return [first, last].filter(Boolean).join(' ');\n },\n })\n myButton.render(externalData);\n````\n\nExpressions may be support argumentless calls by using default\nparameters with `this`.\n````js\n Button\n .expresssions({\n isFilledOrOutlined({filled, outlined} = this) {\n return (filled || outlined)\n },\n });\n myButton.isFilledorOutlined();\n````", "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends { [K in keyof any]: K extends `_${any}` ? ((data: INSTANCE, state?: Record) => string | boolean | null) : ((data?: INSTANCE, state?: Record) => string | boolean | null); } & ThisType>(this: CLASS, expressions: PROPS & ThisType) => CLASS & Class<{ [K in keyof PROPS]: K extends `_${any}` ? never : () => ReturnType; }, ARGS>" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "methods", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "overrides", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends Partial>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "props", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "idl", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" } }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "append", "kind": "field", "static": true, "description": "Append parts to composition", "type": { "text": "(this: T, ...parts: CompositionPart[]) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "recompose", "kind": "field", "static": true, "description": "After composition, invokes callback.\nMay be called multiple times.", "type": { "text": ", T3 extends CompositionCallback[\"composed\"]>(this: T1, callback: T3) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "css", "kind": "field", "static": true, "description": "Appends styles to composition", "type": { "text": "(this: T1, array: T2, ...rest: T2 extends string ? any : T2 extends TemplateStringsArray ? any[] : (HTMLStyleElement | CSSStyleSheet)[]) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "autoRegister", "kind": "field", "static": true, "description": "Registers class with customElements. If class is registered before then,\ndoes nothing.", "type": { "text": "(this: T, elementName: string) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "html", "kind": "field", "static": true, "description": "Appends DocumentFragment to composition", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1405" }, "type": { "text": "(this: T, string: TemplateStringsArray, ...substitutions: (string | Element | ((this: InstanceType, data: InstanceType, injections?: any) => any))[]) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "extend", "kind": "field", "static": true, "description": "Extends base class into a new class.\nUse to avoid mutating base class.", "type": { "text": " T2>(this: T1, customExtender?: T3) => T3 extends null ? T1 : T2" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "setStatic", "kind": "field", "static": true, "description": "Assigns static values to class", "type": { "text": " any) | string | number | boolean | any[] | object); }>(this: T1, source: T2 & ThisType) => T1 & T2" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "readonly", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "set", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "mixin", "kind": "field", "static": true, "description": "Returns result of calling mixin with current class", "type": { "text": " any, RETURN extends ReturnType, SUBCLASS extends ClassOf>(this: BASE, mixin: FN) => SUBCLASS & BASE" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "register", "kind": "field", "static": true, "description": "Registers class with window.customElements synchronously", "type": { "text": "(this: T, elementName?: string, force?: boolean) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "propList", "kind": "field", "static": true, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attrList", "kind": "field", "static": true, "type": { "text": "Map>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "propChangedCallbacks", "kind": "field", "static": true, "type": { "text": "Map any)[]>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "attributeChangedCallbacks", "kind": "field", "static": true, "type": { "text": "Map any)[]>" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "prop", "kind": "field", "static": true, "description": "Creates observable property on instances (via prototype)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1007" }, "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "setPrototype", "kind": "field", "static": true, "description": "Creates observable property on instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any)>(this: CLASS, name: KEY, options: OPTIONS) => OPTIONS extends (...args2: any[]) => infer R ? R : OPTIONS extends ObserverPropertyType ? ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? unknown extends R ? object : R : OPTIONS extends { type: ObserverPropertyType; } ? ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? unknown extends R ? string : R : never" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "define", "kind": "field", "static": true, "description": "Define properties on instances via Object.defineProperties().\nAutomatically sets property non-enumerable if name begins with `_`.\nFunctions will be remapped as getters", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends { [P in keyof any]: { enumerable?: boolean; configurable?: boolean; writable?: boolean; value?: any; get?: ((this: INSTANCE) => any); set?: (this: INSTANCE, value: any) => void; } | ((this: INSTANCE, ...args: any[]) => any); }, VALUE extends { [KEY in keyof PROPS]: PROPS[KEY] extends (...args2: any[]) => infer R ? R : PROPS[KEY] extends TypedPropertyDescriptor ? R : never; }>(this: CLASS, props: PROPS & ThisType) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "undefine", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROP extends string, PROPS extends INSTANCE & Record>(this: CLASS, name: PROP) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "observe", "kind": "field", "static": true, "description": "Creates observable properties on instances", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends IDLParameter, VALUE extends { [KEY in keyof PROPS]: PROPS[KEY] extends (...args2: any[]) => infer R ? R : PROPS[KEY] extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : PROPS[KEY] extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : PROPS[KEY] extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : PROPS[KEY] extends ObserverOptions ? (unknown extends R ? string : R) : never; }>(this: CLASS, props: PROPS) => CLASS & Class" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "defineStatic", "kind": "field", "static": true, "type": { "text": ">(this: T1, props: T2) => T1 & ParsedProps" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "events", "kind": "field", "static": true, "type": { "text": "(this: T, listeners?: CompositionEventListenerObject>, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "childEvents", "kind": "field", "static": true, "type": { "text": "(this: T, listenerMap: { [x: string]: CompositionEventListenerObject>; }, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "rootEvents", "kind": "field", "static": true, "type": { "text": "(this: T, listeners?: CompositionEventListenerObject>, options?: Partial, string>>) => T" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "on", "kind": "field", "static": true, "type": { "text": ", T3 extends CompositionCallback, T4 extends keyof T3>(this: T1, name: T3 | T4, callbacks?: T3[T4] & ThisType) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "off", "kind": "field", "static": true, "type": { "text": ", T3 extends CompositionCallback, T4 extends keyof T3>(this: T1, name: T3 | T4, callbacks?: T3[T4] & ThisType) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "offPropChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: ObjectOrObjectEntries<{ [P in keyof T2]?: (this: T2, oldValue: T2[P], newValue: T2[P], changes: any, element: T2) => void; }>) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "offAttributeChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: { [x: string]: (this: T2, oldValue: string, newValue: string, element: T2) => void; }) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "onPropChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: ObjectOrObjectEntries<{ [P in keyof T2]?: (this: T2, oldValue: T2[P], newValue: T2[P], changes: any, element: T2) => void; }>) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } }, { "name": "onAttributeChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: { [x: string]: (this: T2, oldValue: string, newValue: string, element: T2) => void; }) => T1" }, "inheritedFrom": { "name": "default", "module": "core/CustomElement.js" } } ], "slots": [ { "name": "leading", "description": "" }, { "name": "", "description": "" }, { "name": "trailing", "description": "" }, { "name": "companion", "description": "{headline}\n " } ], "cssParts": [], "events": [], "demos": [ { "url": "demo/components/topappbar.html" } ], "superclass": { "module": "core/CustomElement.js", "name": "default" }, "mixins": [ { "module": "mixins/ThemableMixin.js", "name": "default" }, { "module": "mixins/ShapeMixin.js", "name": "default" }, { "module": "mixins/AriaToolbarMixin.js", "name": "default" }, { "module": "mixins/SemiStickyMixin.js", "name": "default" }, { "module": "mixins/DelegatesFocusMixin.js", "name": "default" } ], "description": "Top App Bars should have a background-color that is identical to\n`transparent`, though an explicit value allows updating the environment's\nto match the app bar (eg: color system bar).\n\nTop corners are shaped when not scrolling to allow matching with pane, but\nremoved when raised" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "default", "module": "components/TopAppBar.js" } }, { "kind": "custom-element-definition", "name": "mdw-top-app-bar", "declaration": { "name": "default", "module": "components/TopAppBar.js" } } ] }, { "kind": "javascript-module", "path": "core/CustomElement.js", "declarations": [ { "kind": "class", "name": "CustomElement", "customElement": true, "attributes": [], "members": [ { "name": "compose", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L145" }, "type": { "text": "(parts: CompositionPart[]) => Composition" } }, { "name": "#refsProxy", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1145" }, "type": { "text": "Record" } }, { "name": "#refsCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1148" }, "type": { "text": "Map>" } }, { "name": "#refsCompositionCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1151" }, "type": { "text": "Map>" } }, { "name": "#composition", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1154" }, "type": { "text": "Composition" } }, { "name": "#patching", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1156" }, "type": { "text": "boolean" } }, { "name": "#pendingPatchRenders", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1159" }, "type": { "text": "[string, any, CustomElement][]" } }, { "name": "#propAttributeCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1162" }, "type": { "text": "Map" } }, { "name": "#callbackArguments", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1165" }, "type": { "text": "CallbackArguments" } }, { "name": "elementInternals", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1172" }, "type": { "text": "ElementInternals" } }, { "name": "render", "kind": "field", "description": "Updates nodes based on data\nExpects data in JSON Merge Patch format", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1185" }, "type": { "text": "RenderDraw" } }, { "name": "propChangedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1213" }, "type": { "text": "(this: T, name: K, oldValue: K extends keyof T ? T[K] : unknown, newValue: K extends keyof T ? T[K] : unknown, changes?: K extends keyof T ? T[K] extends object ? Partial : T[K] : unknown) => void" } }, { "name": "attributeChangedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1234" }, "type": { "text": "(name: string, oldValue: string, newValue: string) => void" } }, { "name": "#template", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1284" }, "type": { "text": "DocumentFragment" } }, { "name": "#onObserverPropertyChanged", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1294" }, "type": { "text": "(name: string, oldValue: any, newValue: any, changes: any) => void" } }, { "name": "static", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1330" }, "type": { "text": "typeof CustomElement" } }, { "name": "patch", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1333" }, "type": { "text": "(patch: any) => void" } }, { "name": "refs", "kind": "field", "description": "Proxy object that returns shadow DOM elements by tag.\nIf called before interpolation (eg: on composed), returns from template", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1404" }, "type": { "text": "Record" } }, { "name": "attributeCache", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1391" }, "type": { "text": "Map" } }, { "name": "callbackArguments", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1400" }, "type": { "text": "CallbackArguments | { composition: Composition; refs: Record; html: any; inline: (fn: (data: Partial) => any) => string; template: DocumentFragment; element: T; }" } }, { "name": "composition", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1403" }, "type": { "text": "Composition" } }, { "name": "connectedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1435" }, "type": { "text": "() => void" } }, { "name": "disconnectedCallback", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1441" }, "type": { "text": "() => void" } }, { "name": "delegatesFocus", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1175" }, "type": { "text": "boolean" } }, { "name": "prototype", "kind": "field", "static": true, "type": { "text": "CustomElement" } }, { "name": "elementName", "kind": "field", "static": true, "type": { "text": "string" } }, { "name": "observedAttributes", "kind": "field", "static": true, "type": { "text": "Iterable" } }, { "name": "interpolatesTemplate", "kind": "field", "static": true, "type": { "text": "boolean" } }, { "name": "supportsElementInternals", "kind": "field", "static": true, "type": { "text": "boolean" } }, { "name": "supportsElementInternalsRole", "kind": "field", "static": true, "type": { "text": "boolean" } }, { "name": "defined", "kind": "field", "static": true, "type": { "text": "boolean" } }, { "name": "registrations", "kind": "field", "static": true, "type": { "text": "Map" } }, { "name": "expressions", "kind": "method", "static": true, "description": "Expressions are idempotent functions that are selectively called whenever\na render is requested.\nExpressions are constructed exactly as methods though differ in expected\narguments. The first argument should be destructured to ensure each used\nproperty is accessed at least once in order to inspect used properties.\n\nThe Composition API will inspect this function with a proxy for `this` to\ncatalog what observables are used by the expression. This allows the\nComposition API to build a cache as well as selective invoke the expression\nonly when needed.\n\nWhen used with in element templates, the element itself will be passed as\nits first argument.\n````js\n Button\n .prop('filled', 'boolean')\n .prop('outlined', 'boolean')\n .expresssions({\n _isFilledOrOutlined({filled, outlined}) {\n return (filled || outlined)\n },\n })\n .html`
`;\n````\n\nWhen used with external data source, that data source\nwill be passed to the expression with all properties being `null` at first\ninspection.\n````js\n const externalData = {first: 'John', last: 'Doe'};\n ContactCard\n .expresssions({\n _fullName({first, last}) {\n return [first, last].filter(Boolean).join(' ');\n },\n })\n myButton.render(externalData);\n````\n\nExpressions may be support argumentless calls by using default\nparameters with `this`.\n````js\n Button\n .expresssions({\n isFilledOrOutlined({filled, outlined} = this) {\n return (filled || outlined)\n },\n });\n myButton.isFilledorOutlined();\n````", "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends { [K in keyof any]: K extends `_${any}` ? ((data: INSTANCE, state?: Record) => string | boolean | null) : ((data?: INSTANCE, state?: Record) => string | boolean | null); } & ThisType>(this: CLASS, expressions: PROPS & ThisType) => CLASS & Class<{ [K in keyof PROPS]: K extends `_${any}` ? never : () => ReturnType; }, ARGS>" } } }, { "name": "methods", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" } } }, { "name": "overrides", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, PROPS extends Partial>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" } } }, { "name": "props", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" } } }, { "name": "idl", "kind": "method", "static": true, "return": { "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" } } }, { "name": "append", "kind": "field", "static": true, "description": "Append parts to composition", "type": { "text": "(this: T, ...parts: CompositionPart[]) => T" } }, { "name": "recompose", "kind": "field", "static": true, "description": "After composition, invokes callback.\nMay be called multiple times.", "type": { "text": ", T3 extends CompositionCallback[\"composed\"]>(this: T1, callback: T3) => T1" } }, { "name": "css", "kind": "field", "static": true, "description": "Appends styles to composition", "type": { "text": "(this: T1, array: T2, ...rest: T2 extends string ? any : T2 extends TemplateStringsArray ? any[] : (HTMLStyleElement | CSSStyleSheet)[]) => T1" } }, { "name": "autoRegister", "kind": "field", "static": true, "description": "Registers class with customElements. If class is registered before then,\ndoes nothing.", "type": { "text": "(this: T, elementName: string) => T" } }, { "name": "html", "kind": "field", "static": true, "description": "Appends DocumentFragment to composition", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1405" }, "type": { "text": "(this: T, string: TemplateStringsArray, ...substitutions: (string | Element | ((this: InstanceType, data: InstanceType, injections?: any) => any))[]) => T" } }, { "name": "extend", "kind": "field", "static": true, "description": "Extends base class into a new class.\nUse to avoid mutating base class.", "type": { "text": " T2>(this: T1, customExtender?: T3) => T3 extends null ? T1 : T2" } }, { "name": "setStatic", "kind": "field", "static": true, "description": "Assigns static values to class", "type": { "text": " any) | string | number | boolean | any[] | object); }>(this: T1, source: T2 & ThisType) => T1 & T2" } }, { "name": "readonly", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" } }, { "name": "set", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends object>(this: CLASS, source: PROPS & ThisType, options?: Partial) => CLASS & Class" } }, { "name": "mixin", "kind": "field", "static": true, "description": "Returns result of calling mixin with current class", "type": { "text": " any, RETURN extends ReturnType, SUBCLASS extends ClassOf>(this: BASE, mixin: FN) => SUBCLASS & BASE" } }, { "name": "register", "kind": "field", "static": true, "description": "Registers class with window.customElements synchronously", "type": { "text": "(this: T, elementName?: string, force?: boolean) => T" } }, { "name": "propList", "kind": "field", "static": true, "type": { "text": "Map>" } }, { "name": "attrList", "kind": "field", "static": true, "type": { "text": "Map>" } }, { "name": "propChangedCallbacks", "kind": "field", "static": true, "type": { "text": "Map any)[]>" } }, { "name": "attributeChangedCallbacks", "kind": "field", "static": true, "type": { "text": "Map any)[]>" } }, { "name": "prop", "kind": "field", "static": true, "description": "Creates observable property on instances (via prototype)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/core/CustomElement.js#L1007" }, "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any), VALUE extends Record infer R ? R : OPTIONS extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : OPTIONS extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? (unknown extends R ? string : R) : never>>(this: CLASS, name: KEY, options: OPTIONS) => CLASS & Class" } }, { "name": "setPrototype", "kind": "field", "static": true, "description": "Creates observable property on instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, KEY extends string, OPTIONS extends ObserverPropertyType | ObserverOptions | ((this: INSTANCE, data: Partial, fn?: () => any) => any)>(this: CLASS, name: KEY, options: OPTIONS) => OPTIONS extends (...args2: any[]) => infer R ? R : OPTIONS extends ObserverPropertyType ? ParsedObserverPropertyType : OPTIONS extends { type: \"object\"; } & ObserverOptions ? unknown extends R ? object : R : OPTIONS extends { type: ObserverPropertyType; } ? ParsedObserverPropertyType : OPTIONS extends ObserverOptions ? unknown extends R ? string : R : never" } }, { "name": "define", "kind": "field", "static": true, "description": "Define properties on instances via Object.defineProperties().\nAutomatically sets property non-enumerable if name begins with `_`.\nFunctions will be remapped as getters", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends { [P in keyof any]: { enumerable?: boolean; configurable?: boolean; writable?: boolean; value?: any; get?: ((this: INSTANCE) => any); set?: (this: INSTANCE, value: any) => void; } | ((this: INSTANCE, ...args: any[]) => any); }, VALUE extends { [KEY in keyof PROPS]: PROPS[KEY] extends (...args2: any[]) => infer R ? R : PROPS[KEY] extends TypedPropertyDescriptor ? R : never; }>(this: CLASS, props: PROPS & ThisType) => CLASS & Class" } }, { "name": "undefine", "kind": "field", "static": true, "description": "Assigns values directly to all instances (via prototype)", "type": { "text": ", INSTANCE extends InstanceType, PROP extends string, PROPS extends INSTANCE & Record>(this: CLASS, name: PROP) => CLASS & Class" } }, { "name": "observe", "kind": "field", "static": true, "description": "Creates observable properties on instances", "type": { "text": ", INSTANCE extends InstanceType, PROPS extends IDLParameter, VALUE extends { [KEY in keyof PROPS]: PROPS[KEY] extends (...args2: any[]) => infer R ? R : PROPS[KEY] extends ObserverPropertyType ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : PROPS[KEY] extends { type: \"object\"; } & ObserverOptions ? (unknown extends R ? object : R) : PROPS[KEY] extends { type: ObserverPropertyType; } ? import(\"/home/runner/work/materialdesignweb/materialdesignweb/core/observe\").ParsedObserverPropertyType : PROPS[KEY] extends ObserverOptions ? (unknown extends R ? string : R) : never; }>(this: CLASS, props: PROPS) => CLASS & Class" } }, { "name": "defineStatic", "kind": "field", "static": true, "type": { "text": ">(this: T1, props: T2) => T1 & ParsedProps" } }, { "name": "events", "kind": "field", "static": true, "type": { "text": "(this: T, listeners?: CompositionEventListenerObject>, options?: Partial, string>>) => T" } }, { "name": "childEvents", "kind": "field", "static": true, "type": { "text": "(this: T, listenerMap: { [x: string]: CompositionEventListenerObject>; }, options?: Partial, string>>) => T" } }, { "name": "rootEvents", "kind": "field", "static": true, "type": { "text": "(this: T, listeners?: CompositionEventListenerObject>, options?: Partial, string>>) => T" } }, { "name": "on", "kind": "field", "static": true, "type": { "text": ", T3 extends CompositionCallback, T4 extends keyof T3>(this: T1, name: T3 | T4, callbacks?: T3[T4] & ThisType) => T1" } }, { "name": "off", "kind": "field", "static": true, "type": { "text": ", T3 extends CompositionCallback, T4 extends keyof T3>(this: T1, name: T3 | T4, callbacks?: T3[T4] & ThisType) => T1" } }, { "name": "offPropChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: ObjectOrObjectEntries<{ [P in keyof T2]?: (this: T2, oldValue: T2[P], newValue: T2[P], changes: any, element: T2) => void; }>) => T1" } }, { "name": "offAttributeChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: { [x: string]: (this: T2, oldValue: string, newValue: string, element: T2) => void; }) => T1" } }, { "name": "onPropChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: ObjectOrObjectEntries<{ [P in keyof T2]?: (this: T2, oldValue: T2[P], newValue: T2[P], changes: any, element: T2) => void; }>) => T1" } }, { "name": "onAttributeChanged", "kind": "field", "static": true, "type": { "text": ">(this: T1, options: { [x: string]: (this: T2, oldValue: string, newValue: string, element: T2) => void; }) => T1" } } ], "slots": [], "cssParts": [], "events": [ { "name": "prop-changed", "type": { "text": "Event" } }, { "name": "attribute-changed", "type": { "text": "Event" } } ], "demos": [], "superclass": { "module": "global:", "name": "HTMLElement" }, "mixins": [], "description": "Web Component that can cache templates for minification or performance" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "default", "module": "core/CustomElement.js" } } ] }, { "kind": "javascript-module", "path": "mixins/AriaReflectorMixin.js", "declarations": [ { "kind": "mixin", "customElement": true, "name": "default", "parameters": [ { "name": "Base", "type": { "text": "typeof CustomElement" } } ], "return": { "type": { "text": "typeof CustomElement & Class<{ _ariaRole: string; }, any[]> & Class<{ _onConnectAriaValues: Map<\"ariaAtomic\" | \"ariaAutoComplete\" | \"ariaBrailleLabel\" | \"ariaBrailleRoleDescription\" | \"ariaBusy\" | \"ariaChecked\" | \"ariaColCount\" | \"ariaColIndex\" | \"ariaColIndexText\" | \"ariaColSpan\" | \"ariaCurrent\" | \"ariaDescription\" | \"ariaDisabled\" | \"ariaExpanded\" | \"ariaHasPopup\" | \"ariaHidden\" | \"ariaInvalid\" | \"ariaKeyShortcuts\" | \"ariaLabel\" | \"ariaLevel\" | \"ariaLive\" | \"ariaModal\" | \"ariaMultiLine\" | \"ariaMultiSelectable\" | \"ariaOrientation\" | \"ariaPlaceholder\" | \"ariaPosInSet\" | \"ariaPressed\" | \"ariaReadOnly\" | \"ariaRelevant\" | \"ariaRequired\" | \"ariaRoleDescription\" | \"ariaRowCount\" | \"ariaRowIndex\" | \"ariaRowIndexText\" | \"ariaRowSpan\" | \"ariaSelected\" | \"ariaSetSize\" | \"ariaSort\" | \"ariaValueMax\" | \"ariaValueMin\" | \"ariaValueNow\" | \"ariaValueText\" | \"role\", string>; }, any[]> & Class<{ readAriaProperty(name: \"shadowRoot\" | \"ariaActiveDescendantElement\" | \"ariaAtomic\" | \"ariaAutoComplete\" | \"ariaBrailleLabel\" | \"ariaBrailleRoleDescription\" | \"ariaBusy\" | \"ariaChecked\" | \"ariaColCount\" | \"ariaColIndex\" | \"ariaColIndexText\" | \"ariaColSpan\" | \"ariaControlsElements\" | \"ariaCurrent\" | \"ariaDescribedByElements\" | \"ariaDescription\" | \"ariaDetailsElements\" | \"ariaDisabled\" | \"ariaErrorMessageElements\" | \"ariaExpanded\" | \"ariaFlowToElements\" | \"ariaHasPopup\" | \"ariaHidden\" | \"ariaInvalid\" | \"ariaKeyShortcuts\" | \"ariaLabel\" | \"ariaLabelledByElements\" | \"ariaLevel\" | \"ariaLive\" | \"ariaModal\" | \"ariaMultiLine\" | \"ariaMultiSelectable\" | \"ariaOrientation\" | \"ariaOwnsElements\" | \"ariaPlaceholder\" | \"ariaPosInSet\" | \"ariaPressed\" | \"ariaReadOnly\" | \"ariaRelevant\" | \"ariaRequired\" | \"ariaRoleDescription\" | \"ariaRowCount\" | \"ariaRowIndex\" | \"ariaRowIndexText\" | \"ariaRowSpan\" | \"ariaSelected\" | \"ariaSetSize\" | \"ariaSort\" | \"ariaValueMax\" | \"ariaValueMin\" | \"ariaValueNow\" | \"ariaValueText\" | \"role\"): string | Element | ShadowRoot | readonly Element[]; updateAriaProperty>(name: K, value: ARIAMixin[K]): void; }, any[]>" } }, "members": [ { "name": "readAriaProperty", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/AriaReflectorMixin.js#L28" }, "return": { "type": { "text": "(name: \"shadowRoot\" | \"ariaActiveDescendantElement\" | \"ariaAtomic\" | \"ariaAutoComplete\" | \"ariaBrailleLabel\" | \"ariaBrailleRoleDescription\" | \"ariaBusy\" | \"ariaChecked\" | \"ariaColCount\" | \"ariaColIndex\" | \"ariaColIndexText\" | \"ariaColSpan\" | \"ariaControlsElements\" | \"ariaCurrent\" | \"ariaDescribedByElements\" | \"ariaDescription\" | \"ariaDetailsElements\" | \"ariaDisabled\" | \"ariaErrorMessageElements\" | \"ariaExpanded\" | \"ariaFlowToElements\" | \"ariaHasPopup\" | \"ariaHidden\" | \"ariaInvalid\" | \"ariaKeyShortcuts\" | \"ariaLabel\" | \"ariaLabelledByElements\" | \"ariaLevel\" | \"ariaLive\" | \"ariaModal\" | \"ariaMultiLine\" | \"ariaMultiSelectable\" | \"ariaOrientation\" | \"ariaOwnsElements\" | \"ariaPlaceholder\" | \"ariaPosInSet\" | \"ariaPressed\" | \"ariaReadOnly\" | \"ariaRelevant\" | \"ariaRequired\" | \"ariaRoleDescription\" | \"ariaRowCount\" | \"ariaRowIndex\" | \"ariaRowIndexText\" | \"ariaRowSpan\" | \"ariaSelected\" | \"ariaSetSize\" | \"ariaSort\" | \"ariaValueMax\" | \"ariaValueMin\" | \"ariaValueNow\" | \"ariaValueText\" | \"role\") => string | Element | ShadowRoot | readonly Element[]" } } }, { "name": "updateAriaProperty", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/AriaReflectorMixin.js#L47" }, "return": { "type": { "text": ">(name: K, value: ARIAMixin[K]) => void" } } } ], "mixins": [], "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/AriaReflectorMixin.js" }, "description": "Reflects ARIA-like properties to attributes/ElementInternals and vice versa." } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "default", "module": "mixins/AriaReflectorMixin.js" } } ] }, { "kind": "javascript-module", "path": "mixins/AriaToolbarMixin.js", "declarations": [ { "kind": "mixin", "customElement": true, "name": "default", "parameters": [ { "name": "Base", "type": { "text": "typeof CustomElement" } } ], "return": { "type": { "text": "typeof CustomElement & Class<{ _ariaRole: string; }, any[]> & Class<{ _onConnectAriaValues: Map<\"ariaAtomic\" | \"ariaAutoComplete\" | \"ariaBrailleLabel\" | \"ariaBrailleRoleDescription\" | \"ariaBusy\" | \"ariaChecked\" | \"ariaColCount\" | \"ariaColIndex\" | \"ariaColIndexText\" | \"ariaColSpan\" | \"ariaCurrent\" | \"ariaDescription\" | \"ariaDisabled\" | \"ariaExpanded\" | \"ariaHasPopup\" | \"ariaHidden\" | \"ariaInvalid\" | \"ariaKeyShortcuts\" | \"ariaLabel\" | \"ariaLevel\" | \"ariaLive\" | \"ariaModal\" | \"ariaMultiLine\" | \"ariaMultiSelectable\" | \"ariaOrientation\" | \"ariaPlaceholder\" | \"ariaPosInSet\" | \"ariaPressed\" | \"ariaReadOnly\" | \"ariaRelevant\" | \"ariaRequired\" | \"ariaRoleDescription\" | \"ariaRowCount\" | \"ariaRowIndex\" | \"ariaRowIndexText\" | \"ariaRowSpan\" | \"ariaSelected\" | \"ariaSetSize\" | \"ariaSort\" | \"ariaValueMax\" | \"ariaValueMin\" | \"ariaValueNow\" | \"ariaValueText\" | \"role\", string>; }, any[]> & Class<{ readAriaProperty(name: \"shadowRoot\" | \"ariaActiveDescendantElement\" | \"ariaAtomic\" | \"ariaAutoComplete\" | \"ariaBrailleLabel\" | \"ariaBrailleRoleDescription\" | \"ariaBusy\" | \"ariaChecked\" | \"ariaColCount\" | \"ariaColIndex\" | \"ariaColIndexText\" | \"ariaColSpan\" | \"ariaControlsElements\" | \"ariaCurrent\" | \"ariaDescribedByElements\" | \"ariaDescription\" | \"ariaDetailsElements\" | \"ariaDisabled\" | \"ariaErrorMessageElements\" | \"ariaExpanded\" | \"ariaFlowToElements\" | \"ariaHasPopup\" | \"ariaHidden\" | \"ariaInvalid\" | \"ariaKeyShortcuts\" | \"ariaLabel\" | \"ariaLabelledByElements\" | \"ariaLevel\" | \"ariaLive\" | \"ariaModal\" | \"ariaMultiLine\" | \"ariaMultiSelectable\" | \"ariaOrientation\" | \"ariaOwnsElements\" | \"ariaPlaceholder\" | \"ariaPosInSet\" | \"ariaPressed\" | \"ariaReadOnly\" | \"ariaRelevant\" | \"ariaRequired\" | \"ariaRoleDescription\" | \"ariaRowCount\" | \"ariaRowIndex\" | \"ariaRowIndexText\" | \"ariaRowSpan\" | \"ariaSelected\" | \"ariaSetSize\" | \"ariaSort\" | \"ariaValueMax\" | \"ariaValueMin\" | \"ariaValueNow\" | \"ariaValueText\" | \"role\"): string | Element | ShadowRoot | readonly Element[]; updateAriaProperty>(name: K, value: ARIAMixin[K]): void; }, any[]> & Class<{ kbdNav: string; _kbdFocusable: boolean; }, any[]> & Class<{ kbdNavQuery: string; kbdNavFocusableWhenDisabled: boolean; ariaOrientationDefault: \"horizontal\" | \"vertical\"; }, any[]> & Class<{ kbdNavChildren: NodeListOf; }, any[]> & Class<{ _ariaOrientationIsVertical(): boolean; focusCurrentOrFirst(): HTMLElement; focusNext(current?: HTMLElement, loop?: boolean, reverse?: boolean): HTMLElement; focusPrevious(current?: HTMLElement, loop?: boolean): HTMLElement; focus(options?: FocusOptions): void; refreshTabIndexes(): void; }, any[]> & Class<{ ariaOrientationDefault: string; _ariaRole: string; }, any[]>" } }, "members": [], "mixins": [ { "module": "mixins/KeyboardNavMixin.js", "name": "default" }, { "module": "mixins/AriaReflectorMixin.js", "name": "default" } ], "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/AriaToolbarMixin.js" }, "description": "Provides ARIA toolbar semantics and keyboard navigation defaults.", "attributes": [ { "name": "kbd-nav", "type": { "text": "string" }, "fieldName": "kbdNav" } ] } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "default", "module": "mixins/AriaToolbarMixin.js" } } ] }, { "kind": "javascript-module", "path": "mixins/ControlMixin.js", "declarations": [ { "kind": "mixin", "customElement": true, "name": "default", "parameters": [ { "name": "Base", "type": { "text": "typeof CustomElement & Class<{ disabled: boolean; focused: boolean; hovered: boolean; pressed: boolean; _lastInteraction: \"mouse\" | \"touch\" | \"key\" | \"pen\"; _hovered: boolean; _focused: boolean; _focusedSynthetic: boolean; _keyPressed: boolean; _keyReleased: boolean; _pointerPressed: boolean; stateLayer: boolean; }, any[]> & Class<{ disabledState: boolean; hoveredState: boolean; focusedState: boolean; pressedState: boolean; touchedState: boolean; pointedState: boolean; }, any[]> & Class<{ stateTargetElement: HTMLElement; }, any[]>" } } ], "return": { "type": { "text": "typeof CustomElement & Class<{ delegatesFocus: boolean; }, any[]> & Class<{ disabled: boolean; focused: boolean; hovered: boolean; pressed: boolean; _lastInteraction: \"mouse\" | \"touch\" | \"key\" | \"pen\"; _hovered: boolean; _focused: boolean; _focusedSynthetic: boolean; _keyPressed: boolean; _keyReleased: boolean; _pointerPressed: boolean; stateLayer: boolean; }, any[]> & Class<{ disabledState: boolean; hoveredState: boolean; focusedState: boolean; pressedState: boolean; touchedState: boolean; pointedState: boolean; }, any[]> & Class<{ stateTargetElement: HTMLElement; }, any[]> & { formAssociated: true; } & Class<{ _ipcListener: EventListener; _ipcTarget: EventTarget; _files: FileList; }, any[]> & Class<{ ariaControls: string; autocomplete: string; name: string; readOnly: boolean; formNoValidate: boolean; defaultChecked: boolean; _checkedDirty: boolean; _checked: boolean; required: boolean; type: string; _defaultValue: string; _value: string; _valueDirty: boolean; _userInteracted: boolean; _invalid: boolean; _badInput: boolean; _validationMessage: string; _formDisabled: boolean; _formReset: boolean; }, any[]> & Class<{ erroredState: boolean; defaultValue: string; _valueBehavior: \"value\" | \"default/on\" | \"default\" | \"filename\"; }, any[]> & Class<{ _onSetValue(value: string): void; _onSetChecked(checked: boolean): void; }, any[]> & Class<{ value: string; checked: boolean; }, any[]> & Class<{ form: HTMLFormElement; validity: ValidityState; validationMessage: string; willValidate: boolean; labels: NodeList; }, any[]> & Class<{ disabledState: boolean; }, any[]> & Class<{ checkValidity(): boolean; reportValidity(): boolean; setCustomValidity(error: string): void; _notifyRadioChange(key: string, value: string): void; refreshFormAssociation(): void; formAssociatedCallback(form: HTMLFormElement): void; formIPCEvent(event: CustomEvent<[string, string]>): void; formDisabledCallback(disabled: boolean): void; formResetCallback(): void; formStateRestoreCallback(state: string | FormData, mode: \"autocomplete\" | \"restore\"): void; _updateFormAssociatedValue(): void; }, any[]> & Class<{ ariaLabel: string; _slotInnerText: string; }, any[]> & Class<{ focusableOnDisabled: boolean; controlTagName: string; controlVoidElement: boolean; _slotMutationObserver: any; }, any[]> & Class<{ _onControlValue(value: string): void; onValueChangingContentAttribute(): void; focus(options?: FocusOptions): void; click(): void; }, any[]> & Class<{ stateTargetElement: HTMLElement; }, any[]> & Class<{ checkValidity(): boolean; reportValidity(): boolean; setCustomValidity(error: string): void; }, any[]> & Class<{ _computedAriaLabel: string; }, any[]> & Class<{ _computedAriaLabelledby: never; }, any[]>" } }, "members": [ { "name": "focusableOnDisabled", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ControlMixin.js#L30" }, "type": { "text": "boolean" } }, { "name": "controlTagName", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ControlMixin.js#L31" }, "type": { "text": "input" } }, { "name": "controlVoidElement", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ControlMixin.js#L32" }, "type": { "text": "boolean" } }, { "name": "onValueChangingContentAttribute", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ControlMixin.js#L43" }, "return": { "type": { "text": "() => void" } } } ], "mixins": [ { "module": "mixins/FormAssociatedMixin.js", "name": "default" }, { "module": "mixins/DelegatesFocusMixin.js", "name": "default" } ], "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ControlMixin.js" }, "description": "Adds form-control behavior and wiring to an internal control element.", "attributes": [ { "name": "aria-controls", "type": { "text": "string" }, "fieldName": "ariaControls" }, { "name": "autocomplete", "type": { "text": "string" }, "fieldName": "autocomplete" }, { "name": "name", "type": { "text": "string" }, "fieldName": "name" }, { "name": "readonly", "type": { "text": "boolean" }, "fieldName": "readOnly" }, { "name": "formnovalidate", "type": { "text": "boolean" }, "fieldName": "formNoValidate" }, { "name": "checked", "type": { "text": "boolean" }, "fieldName": "defaultChecked" }, { "name": "required", "type": { "text": "boolean" }, "fieldName": "required" }, { "name": "type", "type": { "text": "string" }, "fieldName": "type" }, { "name": "value", "type": { "text": "string" }, "fieldName": "_defaultValue" }, { "name": "aria-label", "type": { "text": "string" }, "description": "Optional aria-label applied to the internal control (string).", "fieldName": "ariaLabel" } ] } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "default", "module": "mixins/ControlMixin.js" } } ] }, { "kind": "javascript-module", "path": "mixins/DelegatesFocusMixin.js", "declarations": [ { "kind": "mixin", "customElement": true, "name": "default", "parameters": [ { "name": "Base", "type": { "text": "typeof CustomElement" } } ], "return": { "type": { "text": "typeof CustomElement & Class<{ delegatesFocus: boolean; }, any[]>" } }, "members": [], "mixins": [], "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/DelegatesFocusMixin.js" }, "description": "Adds delegated focus behavior to the element's internals for keyboard navigation." } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "default", "module": "mixins/DelegatesFocusMixin.js" } } ] }, { "kind": "javascript-module", "path": "mixins/DensityMixin.js", "declarations": [ { "kind": "mixin", "customElement": true, "name": "default", "parameters": [ { "name": "Base", "type": { "text": "typeof CustomElement" } } ], "return": { "type": { "text": "typeof CustomElement & Class<{ density: number; }, any[]>" } }, "members": [ { "name": "density", "kind": "field", "description": "Density level affecting spacing and compactness. Integer from -4 (dense) to 4 (spacious).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/DensityMixin.js#L9" }, "type": { "text": "integer" } } ], "mixins": [], "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/DensityMixin.js" }, "description": "Adds a `density` property to control component spacing and compactness.", "attributes": [ { "name": "density", "type": { "text": "integer" }, "description": "Density level affecting spacing and compactness. Integer from -4 (dense) to 4 (spacious).", "fieldName": "density" } ] } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "default", "module": "mixins/DensityMixin.js" } } ] }, { "kind": "javascript-module", "path": "mixins/ElevationMixin.js", "declarations": [ { "kind": "mixin", "customElement": true, "name": "default", "parameters": [ { "name": "Base", "type": { "text": "typeof CustomElement & Class<{ disabled: boolean; focused: boolean; hovered: boolean; pressed: boolean; _lastInteraction: \"mouse\" | \"touch\" | \"key\" | \"pen\"; _hovered: boolean; _focused: boolean; _focusedSynthetic: boolean; _keyPressed: boolean; _keyReleased: boolean; _pointerPressed: boolean; stateLayer: boolean; }, any[]> & Class<{ disabledState: boolean; hoveredState: boolean; focusedState: boolean; pressedState: boolean; touchedState: boolean; pointedState: boolean; }, any[]> & Class<{ stateTargetElement: HTMLElement; }, any[]> & Class<{ color: string; ink: string; typeStyle: string; }, any[]>" } } ], "return": { "type": { "text": "typeof CustomElement & Class<{ disabled: boolean; focused: boolean; hovered: boolean; pressed: boolean; _lastInteraction: \"mouse\" | \"touch\" | \"key\" | \"pen\"; _hovered: boolean; _focused: boolean; _focusedSynthetic: boolean; _keyPressed: boolean; _keyReleased: boolean; _pointerPressed: boolean; stateLayer: boolean; }, any[]> & Class<{ disabledState: boolean; hoveredState: boolean; focusedState: boolean; pressedState: boolean; touchedState: boolean; pointedState: boolean; }, any[]> & Class<{ stateTargetElement: HTMLElement; }, any[]> & Class<{ color: string; ink: string; typeStyle: string; }, any[]>" } }, "members": [], "mixins": [], "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ElevationMixin.js" }, "description": "Adds CSS properties for elevation via shadows or underlighting." } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "default", "module": "mixins/ElevationMixin.js" } } ] }, { "kind": "javascript-module", "path": "mixins/FlexboxMixin.js", "declarations": [ { "kind": "mixin", "customElement": true, "name": "default", "parameters": [ { "name": "Base", "type": { "text": "typeof CustomElement" } } ], "return": { "type": { "text": "typeof CustomElement & Class<{ block: boolean; inline: boolean; row: boolean; x: string; y: string; gap: number; padding: string; }, any[]>" } }, "members": [ { "name": "block", "kind": "field", "description": "Set `display: block` on the host (boolean)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js#L9" }, "type": { "text": "boolean" } }, { "name": "inline", "kind": "field", "description": "Use inline flex layout: `display: inline-flex` (boolean)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js#L11" }, "type": { "text": "boolean" } }, { "name": "row", "kind": "field", "description": "Switch main axis to horizontal: `flex-direction: row` (boolean)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js#L13" }, "type": { "text": "boolean" } }, { "name": "x", "kind": "field", "description": "Main-axis alignment / justification.\nAllowed: 'start'|'center'|'end'|'between'|'around'|'stretch'|'baseline'.\nDefault: 'start'.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js#L19" }, "type": { "text": "string" } }, { "name": "y", "kind": "field", "description": "Cross-axis alignment / alignment of items.\nSame allowed values as `x`. Default: 'start'.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js#L29" }, "type": { "text": "string" } }, { "name": "gap", "kind": "field", "description": "Gap between children. Accepts preset numeric strings (e.g. '8') mapped to px, or floats.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js#L36" }, "type": { "text": "float" } }, { "name": "padding", "kind": "field", "description": "Padding preset or numeric value (e.g. 'pane', '8', '16').", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js#L38" }, "type": { "text": "string" } } ], "mixins": [], "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FlexboxMixin.js" }, "description": "Layout helper mixin providing flexbox utilities (gap, padding, axis).", "attributes": [ { "name": "block", "type": { "text": "boolean" }, "description": "Set `display: block` on the host (boolean)", "fieldName": "block" }, { "name": "inline", "type": { "text": "boolean" }, "description": "Use inline flex layout: `display: inline-flex` (boolean)", "fieldName": "inline" }, { "name": "row", "type": { "text": "boolean" }, "description": "Switch main axis to horizontal: `flex-direction: row` (boolean)", "fieldName": "row" }, { "name": "x", "type": { "text": "string" }, "description": "Main-axis alignment / justification.\nAllowed: 'start'|'center'|'end'|'between'|'around'|'stretch'|'baseline'.\nDefault: 'start'.", "fieldName": "x" }, { "name": "y", "type": { "text": "string" }, "description": "Cross-axis alignment / alignment of items.\nSame allowed values as `x`. Default: 'start'.", "fieldName": "y" }, { "name": "gap", "type": { "text": "float" }, "description": "Gap between children. Accepts preset numeric strings (e.g. '8') mapped to px, or floats.", "fieldName": "gap" }, { "name": "padding", "type": { "text": "string" }, "description": "Padding preset or numeric value (e.g. 'pane', '8', '16').", "fieldName": "padding" } ] } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "default", "module": "mixins/FlexboxMixin.js" } } ] }, { "kind": "javascript-module", "path": "mixins/FormAssociatedMixin.js", "declarations": [ { "kind": "mixin", "customElement": true, "name": "default", "parameters": [ { "name": "Base", "type": { "text": "typeof CustomElement & Class<{ disabled: boolean; focused: boolean; hovered: boolean; pressed: boolean; _lastInteraction: \"mouse\" | \"touch\" | \"key\" | \"pen\"; _hovered: boolean; _focused: boolean; _focusedSynthetic: boolean; _keyPressed: boolean; _keyReleased: boolean; _pointerPressed: boolean; stateLayer: boolean; }, any[]> & Class<{ disabledState: boolean; hoveredState: boolean; focusedState: boolean; pressedState: boolean; touchedState: boolean; pointedState: boolean; }, any[]> & Class<{ stateTargetElement: HTMLElement; }, any[]>" } } ], "return": { "type": { "text": "typeof CustomElement & Class<{ disabled: boolean; focused: boolean; hovered: boolean; pressed: boolean; _lastInteraction: \"mouse\" | \"touch\" | \"key\" | \"pen\"; _hovered: boolean; _focused: boolean; _focusedSynthetic: boolean; _keyPressed: boolean; _keyReleased: boolean; _pointerPressed: boolean; stateLayer: boolean; }, any[]> & Class<{ disabledState: boolean; hoveredState: boolean; focusedState: boolean; pressedState: boolean; touchedState: boolean; pointedState: boolean; }, any[]> & Class<{ stateTargetElement: HTMLElement; }, any[]> & { formAssociated: true; } & Class<{ _ipcListener: EventListener; _ipcTarget: EventTarget; _files: FileList; }, any[]> & Class<{ ariaControls: string; autocomplete: string; name: string; readOnly: boolean; formNoValidate: boolean; defaultChecked: boolean; _checkedDirty: boolean; _checked: boolean; required: boolean; type: string; _defaultValue: string; _value: string; _valueDirty: boolean; _userInteracted: boolean; _invalid: boolean; _badInput: boolean; _validationMessage: string; _formDisabled: boolean; _formReset: boolean; }, any[]> & Class<{ erroredState: boolean; defaultValue: string; _valueBehavior: \"value\" | \"default/on\" | \"default\" | \"filename\"; }, any[]> & Class<{ _onSetValue(value: string): void; _onSetChecked(checked: boolean): void; }, any[]> & Class<{ value: string; checked: boolean; }, any[]> & Class<{ form: HTMLFormElement; validity: ValidityState; validationMessage: string; willValidate: boolean; labels: NodeList; }, any[]> & Class<{ disabledState: boolean; }, any[]> & Class<{ checkValidity(): boolean; reportValidity(): boolean; setCustomValidity(error: string): void; _notifyRadioChange(key: string, value: string): void; refreshFormAssociation(): void; formAssociatedCallback(form: HTMLFormElement): void; formIPCEvent(event: CustomEvent<[string, string]>): void; formDisabledCallback(disabled: boolean): void; formResetCallback(): void; formStateRestoreCallback(state: string | FormData, mode: \"autocomplete\" | \"restore\"): void; _updateFormAssociatedValue(): void; }, any[]>" } }, "members": [ { "name": "ariaControls", "kind": "field", "description": "ARIA 'controls' attribute (string).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L32" }, "type": { "text": "string" } }, { "name": "autocomplete", "kind": "field", "description": "Autocomplete token for the associated control (string).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L34" }, "type": { "text": "string" } }, { "name": "name", "kind": "field", "description": "Name attribute for the control used in forms.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L36" }, "type": { "text": "string" } }, { "name": "readOnly", "kind": "field", "description": "Read-only state reflected to control via 'readonly' attribute.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L38" }, "type": { "text": "boolean" } }, { "name": "formNoValidate", "kind": "field", "description": "When true, form validation is skipped for this control (formnovalidate).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L40" }, "type": { "text": "boolean" } }, { "name": "defaultChecked", "kind": "field", "description": "Default checked state for checkable controls (checkbox/radio).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L42" }, "type": { "text": "boolean" } }, { "name": "required", "kind": "field", "description": "Whether the control is required for form submission.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L47" }, "type": { "text": "boolean" } }, { "name": "type", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L147" }, "type": { "text": "boolean" } }, { "name": "erroredState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L65" }, "type": { "text": "boolean" } }, { "name": "defaultValue", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L66" }, "type": { "text": "string" } }, { "name": "value", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L108" }, "type": { "text": "string" } }, { "name": "checked", "kind": "field", "description": "Part of FormAssociatedMixin for simplicity.\nEnumerability doesn't guarantee checked state will be passed or used.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L145" }, "type": { "text": "boolean" } }, { "name": "form", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L160" }, "type": { "text": "HTMLFormElement" } }, { "name": "validity", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L161" }, "type": { "text": "ValidityState" } }, { "name": "validationMessage", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L162" }, "type": { "text": "string" } }, { "name": "willValidate", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L163" }, "type": { "text": "boolean" } }, { "name": "labels", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L168" }, "type": { "text": "NodeList" } }, { "name": "checkValidity", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L177" }, "return": { "type": { "text": "() => boolean" } } }, { "name": "reportValidity", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L179" }, "return": { "type": { "text": "() => boolean" } } }, { "name": "setCustomValidity", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L185" }, "return": { "type": { "text": "(error: string) => void" } } }, { "name": "refreshFormAssociation", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L203" }, "return": { "type": { "text": "() => void" } } }, { "name": "formIPCEvent", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js#L234" }, "return": { "type": { "text": "(event: CustomEvent<[string, string]>) => void" } } } ], "mixins": [], "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/FormAssociatedMixin.js" }, "description": "Implements form-associated element behavior (internals, validity, files, value handling).", "attributes": [ { "name": "aria-controls", "type": { "text": "string" }, "description": "ARIA 'controls' attribute (string).", "fieldName": "ariaControls" }, { "name": "autocomplete", "type": { "text": "string" }, "description": "Autocomplete token for the associated control (string).", "fieldName": "autocomplete" }, { "name": "name", "type": { "text": "string" }, "description": "Name attribute for the control used in forms.", "fieldName": "name" }, { "name": "readonly", "type": { "text": "boolean" }, "description": "Read-only state reflected to control via 'readonly' attribute.", "fieldName": "readOnly" }, { "name": "formnovalidate", "type": { "text": "boolean" }, "description": "When true, form validation is skipped for this control (formnovalidate).", "fieldName": "formNoValidate" }, { "name": "checked", "type": { "text": "boolean" }, "description": "Default checked state for checkable controls (checkbox/radio).", "fieldName": "defaultChecked" }, { "name": "required", "type": { "text": "boolean" }, "description": "Whether the control is required for form submission.", "fieldName": "required" }, { "name": "type", "type": { "text": "string" }, "fieldName": "type" }, { "name": "value", "type": { "text": "string" }, "description": "Reflected default value backing field (attr: value).", "fieldName": "_defaultValue" } ] } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "default", "module": "mixins/FormAssociatedMixin.js" } } ] }, { "kind": "javascript-module", "path": "mixins/HyperlinkMixin.js", "declarations": [ { "kind": "mixin", "customElement": true, "name": "default", "parameters": [ { "name": "Base", "type": { "text": "typeof CustomElement" } } ], "return": { "type": { "text": "typeof CustomElement & Class<{ href: string; target: string; download: string; ping: string; rel: string; hreflang: string; referrerPolicy: string; }, any[]> & Class<{ origin: string; protocol: string; username: string; password: string; host: string; hostname: string; port: string; pathname: string; search: string; hash: string; }, any[]> & Class" } }, "members": [ { "name": "href", "kind": "field", "description": "The URL that the hyperlink points to.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L34" }, "type": { "text": "string" } }, { "name": "target", "kind": "field", "description": "The browsing context in which to open the linked resource (e.g. '_blank').", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L36" }, "type": { "text": "string" } }, { "name": "download", "kind": "field", "description": "Suggested filename for download.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L38" }, "type": { "text": "string" } }, { "name": "ping", "kind": "field", "description": "URLs to be pinged when the link is followed.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L40" }, "type": { "text": "string" } }, { "name": "rel", "kind": "field", "description": "Link relationship tokens (e.g. 'noopener', 'noreferrer').", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L42" }, "type": { "text": "string" } }, { "name": "hreflang", "kind": "field", "description": "Language of the linked resource.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L44" }, "type": { "text": "string" } }, { "name": "referrerPolicy", "kind": "field", "description": "Referrer policy for the link (serialized to 'referrerpolicy' attribute).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L46" }, "type": { "text": "string" } }, { "name": "origin", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L49" }, "type": { "text": "string" } }, { "name": "protocol", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L50" }, "type": { "text": "string" } }, { "name": "username", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L51" }, "type": { "text": "string" } }, { "name": "password", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L52" }, "type": { "text": "string" } }, { "name": "host", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L53" }, "type": { "text": "string" } }, { "name": "hostname", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L54" }, "type": { "text": "string" } }, { "name": "port", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L55" }, "type": { "text": "string" } }, { "name": "pathname", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L56" }, "type": { "text": "string" } }, { "name": "search", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L57" }, "type": { "text": "string" } }, { "name": "hash", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js#L58" }, "type": { "text": "string" } } ], "mixins": [], "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/HyperlinkMixin.js" }, "description": "Adds hyperlink-related properties and URL helpers (href, target, rel, etc.).", "attributes": [ { "name": "href", "type": { "text": "string" }, "description": "The URL that the hyperlink points to.", "fieldName": "href" }, { "name": "target", "type": { "text": "string" }, "description": "The browsing context in which to open the linked resource (e.g. '_blank').", "fieldName": "target" }, { "name": "download", "type": { "text": "string" }, "description": "Suggested filename for download.", "fieldName": "download" }, { "name": "ping", "type": { "text": "string" }, "description": "URLs to be pinged when the link is followed.", "fieldName": "ping" }, { "name": "rel", "type": { "text": "string" }, "description": "Link relationship tokens (e.g. 'noopener', 'noreferrer').", "fieldName": "rel" }, { "name": "hreflang", "type": { "text": "string" }, "description": "Language of the linked resource.", "fieldName": "hreflang" }, { "name": "referrerpolicy", "type": { "text": "string" }, "description": "Referrer policy for the link (serialized to 'referrerpolicy' attribute).", "fieldName": "referrerPolicy" } ] } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "default", "module": "mixins/HyperlinkMixin.js" } } ] }, { "kind": "javascript-module", "path": "mixins/InputMixin.js", "declarations": [ { "kind": "mixin", "customElement": true, "name": "default", "parameters": [ { "name": "Base", "type": { "text": "typeof CustomElement & Class<{ disabled: boolean; focused: boolean; hovered: boolean; pressed: boolean; _lastInteraction: \"mouse\" | \"touch\" | \"key\" | \"pen\"; _hovered: boolean; _focused: boolean; _focusedSynthetic: boolean; _keyPressed: boolean; _keyReleased: boolean; _pointerPressed: boolean; stateLayer: boolean; }, any[]> & Class<{ disabledState: boolean; hoveredState: boolean; focusedState: boolean; pressedState: boolean; touchedState: boolean; pointedState: boolean; }, any[]> & Class<{ stateTargetElement: HTMLElement; }, any[]>" } } ], "return": { "type": { "text": "typeof CustomElement & Class<{ delegatesFocus: boolean; }, any[]> & Class<{ disabled: boolean; focused: boolean; hovered: boolean; pressed: boolean; _lastInteraction: \"mouse\" | \"touch\" | \"key\" | \"pen\"; _hovered: boolean; _focused: boolean; _focusedSynthetic: boolean; _keyPressed: boolean; _keyReleased: boolean; _pointerPressed: boolean; stateLayer: boolean; }, any[]> & Class<{ disabledState: boolean; hoveredState: boolean; focusedState: boolean; pressedState: boolean; touchedState: boolean; pointedState: boolean; }, any[]> & Class<{ stateTargetElement: HTMLElement; }, any[]> & { formAssociated: true; } & Class<{ _ipcListener: EventListener; _ipcTarget: EventTarget; _files: FileList; }, any[]> & Class<{ ariaControls: string; autocomplete: string; name: string; readOnly: boolean; formNoValidate: boolean; defaultChecked: boolean; _checkedDirty: boolean; _checked: boolean; required: boolean; type: string; _defaultValue: string; _value: string; _valueDirty: boolean; _userInteracted: boolean; _invalid: boolean; _badInput: boolean; _validationMessage: string; _formDisabled: boolean; _formReset: boolean; }, any[]> & Class<{ erroredState: boolean; defaultValue: string; _valueBehavior: \"value\" | \"default/on\" | \"default\" | \"filename\"; }, any[]> & Class<{ _onSetValue(value: string): void; _onSetChecked(checked: boolean): void; }, any[]> & Class<{ value: string; checked: boolean; }, any[]> & Class<{ form: HTMLFormElement; validity: ValidityState; validationMessage: string; willValidate: boolean; labels: NodeList; }, any[]> & Class<{ disabledState: boolean; }, any[]> & Class<{ checkValidity(): boolean; reportValidity(): boolean; setCustomValidity(error: string): void; _notifyRadioChange(key: string, value: string): void; refreshFormAssociation(): void; formAssociatedCallback(form: HTMLFormElement): void; formIPCEvent(event: CustomEvent<[string, string]>): void; formDisabledCallback(disabled: boolean): void; formResetCallback(): void; formStateRestoreCallback(state: string | FormData, mode: \"autocomplete\" | \"restore\"): void; _updateFormAssociatedValue(): void; }, any[]> & Class<{ ariaLabel: string; _slotInnerText: string; }, any[]> & Class<{ focusableOnDisabled: boolean; controlTagName: string; controlVoidElement: boolean; _slotMutationObserver: any; }, any[]> & Class<{ _onControlValue(value: string): void; onValueChangingContentAttribute(): void; focus(options?: FocusOptions): void; click(): void; }, any[]> & Class<{ stateTargetElement: HTMLElement; }, any[]> & Class<{ checkValidity(): boolean; reportValidity(): boolean; setCustomValidity(error: string): void; }, any[]> & Class<{ _computedAriaLabel: string; }, any[]> & Class<{ _computedAriaLabelledby: never; }, any[]> & Class<{ accept: string; alt: string; dirName: string; _formAction: string; formEnctype: string; formMethod: string; formTarget: string; _height: number; _indeterminate: boolean; max: string; maxLength: number; min: string; minLength: number; multiple: boolean; pattern: string; placeholder: string; size: number; src: string; step: string; _width: number; }, any[]> & Class<{ _useFormImplicitSubmission: boolean; }, any[]> & Class<{ _input: HTMLInputElement; }, any[]> & Class<{ indeterminate: boolean; }, any[]> & Class<{ controlTagName: string; }, any[]> & Class<{ _onSetChecked(checked: boolean): void; _onSetValue(value: string): void; }, any[]> & Class<{ performImplicitSubmission(event: Event): void; _redispatchControlClickEvent(event: Event): boolean; _handleInputClick(event: MouseEvent): void; }, any[]> & Class<{ setRangeText(replacement: string): void; setRangeText(replacement: string, start: number, end: number, selectionMode?: SelectionMode): void; setSelectionRange(start: number, end: number, direction?: \"none\" | \"forward\" | \"backward\"): void; showPicker(): void; stepDown(n?: number): void; stepUp(n?: number): void; select(): void; }, any[]> & Class<{ files: FileList; selectionDirection: \"none\" | \"forward\" | \"backward\"; selectionEnd: number; selectionStart: number; valueAsDate: Date; valueAsNumber: number; height: number; formAction: string; width: number; }, any[]>" } }, "members": [ { "name": "accept", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L137" }, "type": { "text": "string" } }, { "name": "alt", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L138" }, "type": { "text": "string" } }, { "name": "dirName", "kind": "field", "description": "Directionality for form submission name (dirname attribute).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L45" }, "type": { "text": "string" } }, { "name": "formEnctype", "kind": "field", "description": "Form encoding type (formenctype).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L49" }, "type": { "text": "string" } }, { "name": "formMethod", "kind": "field", "description": "Form method when associated with a submit input (formmethod).", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L51" }, "type": { "text": "string" } }, { "name": "formTarget", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L143" }, "type": { "text": "string" } }, { "name": "max", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L144" }, "type": { "text": "string" } }, { "name": "maxLength", "kind": "field", "description": "Maximum length for text-like inputs.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L60" }, "type": { "text": "number" } }, { "name": "min", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L146" }, "type": { "text": "string" } }, { "name": "minLength", "kind": "field", "description": "Minimum length for text-like inputs.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L64" }, "type": { "text": "number" } }, { "name": "multiple", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L148" }, "type": { "text": "boolean" } }, { "name": "pattern", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L149" }, "type": { "text": "string" } }, { "name": "placeholder", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L150" }, "type": { "text": "string" } }, { "name": "size", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L151" }, "type": { "text": "number" } }, { "name": "src", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L152" }, "type": { "text": "string" } }, { "name": "step", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L153" }, "type": { "text": "string" } }, { "name": "indeterminate", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L89" }, "type": { "text": "boolean" } }, { "name": "performImplicitSubmission", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L175" }, "return": { "type": { "text": "(event: Event) => void" } } }, { "name": "setRangeText", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L345" }, "return": { "type": { "text": "{ (replacement: string): void; (replacement: string, start: number, end: number, selectionMode?: SelectionMode): void; }" } } }, { "name": "setSelectionRange", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L348" }, "return": { "type": { "text": "(start: number, end: number, direction?: \"none\" | \"forward\" | \"backward\") => void" } } }, { "name": "showPicker", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L351" }, "return": { "type": { "text": "() => void" } } }, { "name": "stepDown", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L354" }, "return": { "type": { "text": "(n?: number) => void" } } }, { "name": "stepUp", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L360" }, "return": { "type": { "text": "(n?: number) => void" } } }, { "name": "select", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L366" }, "return": { "type": { "text": "() => void" } } }, { "name": "files", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L371" }, "type": { "text": "FileList" } }, { "name": "selectionDirection", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L384" }, "type": { "text": "\"none\" | \"forward\" | \"backward\"" } }, { "name": "selectionEnd", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L389" }, "type": { "text": "number" } }, { "name": "selectionStart", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L394" }, "type": { "text": "number" } }, { "name": "valueAsDate", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L399" }, "type": { "text": "Date" } }, { "name": "valueAsNumber", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L407" }, "type": { "text": "number" } }, { "name": "height", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L415" }, "type": { "text": "number" } }, { "name": "formAction", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L423" }, "type": { "text": "string" } }, { "name": "width", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js#L431" }, "type": { "text": "number" } } ], "mixins": [ { "module": "mixins/ControlMixin.js", "name": "default" }, { "module": "mixins/FormAssociatedMixin.js", "name": "default" }, { "module": "mixins/DelegatesFocusMixin.js", "name": "default" } ], "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/InputMixin.js" }, "description": "Enhances a component with input-like attributes and behaviors (value, step, min/max, etc.).", "attributes": [ { "name": "aria-controls", "type": { "text": "string" }, "fieldName": "ariaControls" }, { "name": "autocomplete", "type": { "text": "string" }, "fieldName": "autocomplete" }, { "name": "name", "type": { "text": "string" }, "fieldName": "name" }, { "name": "readonly", "type": { "text": "boolean" }, "fieldName": "readOnly" }, { "name": "formnovalidate", "type": { "text": "boolean" }, "fieldName": "formNoValidate" }, { "name": "checked", "type": { "text": "boolean" }, "fieldName": "defaultChecked" }, { "name": "required", "type": { "text": "boolean" }, "fieldName": "required" }, { "name": "type", "type": { "text": "string" }, "fieldName": "type" }, { "name": "value", "type": { "text": "string" }, "fieldName": "_defaultValue" }, { "name": "aria-label", "type": { "text": "string" }, "fieldName": "ariaLabel" }, { "name": "accept", "type": { "text": "string" }, "fieldName": "accept" }, { "name": "alt", "type": { "text": "string" }, "fieldName": "alt" }, { "name": "dirname", "type": { "text": "string" }, "description": "Directionality for form submission name (dirname attribute).", "fieldName": "dirName" }, { "name": "formenctype", "type": { "text": "string" }, "description": "Form encoding type (formenctype).", "fieldName": "formEnctype" }, { "name": "formmethod", "type": { "text": "string" }, "description": "Form method when associated with a submit input (formmethod).", "fieldName": "formMethod" }, { "name": "formtarget", "type": { "text": "string" }, "fieldName": "formTarget" }, { "name": "max", "type": { "text": "string" }, "fieldName": "max" }, { "name": "maxlength", "type": { "text": "integer" }, "description": "Maximum length for text-like inputs.", "fieldName": "maxLength" }, { "name": "min", "type": { "text": "string" }, "fieldName": "min" }, { "name": "minlength", "type": { "text": "integer" }, "description": "Minimum length for text-like inputs.", "fieldName": "minLength" }, { "name": "multiple", "type": { "text": "boolean" }, "fieldName": "multiple" }, { "name": "pattern", "type": { "text": "string" }, "fieldName": "pattern" }, { "name": "placeholder", "type": { "text": "string" }, "fieldName": "placeholder" }, { "name": "size", "type": { "text": "integer" }, "fieldName": "size" }, { "name": "src", "type": { "text": "string" }, "fieldName": "src" }, { "name": "step", "type": { "text": "string" }, "fieldName": "step" }, { "name": "indeterminate", "type": { "text": "boolean" }, "fieldName": "indeterminate" } ] } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "default", "module": "mixins/InputMixin.js" } } ] }, { "kind": "javascript-module", "path": "mixins/KeyboardNavMixin.js", "declarations": [ { "kind": "mixin", "customElement": true, "name": "default", "parameters": [ { "name": "Base", "type": { "text": "typeof CustomElement" } } ], "return": { "type": { "text": "typeof CustomElement & Class<{ _ariaRole: string; }, any[]> & Class<{ _onConnectAriaValues: Map<\"ariaAtomic\" | \"ariaAutoComplete\" | \"ariaBrailleLabel\" | \"ariaBrailleRoleDescription\" | \"ariaBusy\" | \"ariaChecked\" | \"ariaColCount\" | \"ariaColIndex\" | \"ariaColIndexText\" | \"ariaColSpan\" | \"ariaCurrent\" | \"ariaDescription\" | \"ariaDisabled\" | \"ariaExpanded\" | \"ariaHasPopup\" | \"ariaHidden\" | \"ariaInvalid\" | \"ariaKeyShortcuts\" | \"ariaLabel\" | \"ariaLevel\" | \"ariaLive\" | \"ariaModal\" | \"ariaMultiLine\" | \"ariaMultiSelectable\" | \"ariaOrientation\" | \"ariaPlaceholder\" | \"ariaPosInSet\" | \"ariaPressed\" | \"ariaReadOnly\" | \"ariaRelevant\" | \"ariaRequired\" | \"ariaRoleDescription\" | \"ariaRowCount\" | \"ariaRowIndex\" | \"ariaRowIndexText\" | \"ariaRowSpan\" | \"ariaSelected\" | \"ariaSetSize\" | \"ariaSort\" | \"ariaValueMax\" | \"ariaValueMin\" | \"ariaValueNow\" | \"ariaValueText\" | \"role\", string>; }, any[]> & Class<{ readAriaProperty(name: \"shadowRoot\" | \"ariaActiveDescendantElement\" | \"ariaAtomic\" | \"ariaAutoComplete\" | \"ariaBrailleLabel\" | \"ariaBrailleRoleDescription\" | \"ariaBusy\" | \"ariaChecked\" | \"ariaColCount\" | \"ariaColIndex\" | \"ariaColIndexText\" | \"ariaColSpan\" | \"ariaControlsElements\" | \"ariaCurrent\" | \"ariaDescribedByElements\" | \"ariaDescription\" | \"ariaDetailsElements\" | \"ariaDisabled\" | \"ariaErrorMessageElements\" | \"ariaExpanded\" | \"ariaFlowToElements\" | \"ariaHasPopup\" | \"ariaHidden\" | \"ariaInvalid\" | \"ariaKeyShortcuts\" | \"ariaLabel\" | \"ariaLabelledByElements\" | \"ariaLevel\" | \"ariaLive\" | \"ariaModal\" | \"ariaMultiLine\" | \"ariaMultiSelectable\" | \"ariaOrientation\" | \"ariaOwnsElements\" | \"ariaPlaceholder\" | \"ariaPosInSet\" | \"ariaPressed\" | \"ariaReadOnly\" | \"ariaRelevant\" | \"ariaRequired\" | \"ariaRoleDescription\" | \"ariaRowCount\" | \"ariaRowIndex\" | \"ariaRowIndexText\" | \"ariaRowSpan\" | \"ariaSelected\" | \"ariaSetSize\" | \"ariaSort\" | \"ariaValueMax\" | \"ariaValueMin\" | \"ariaValueNow\" | \"ariaValueText\" | \"role\"): string | Element | ShadowRoot | readonly Element[]; updateAriaProperty>(name: K, value: ARIAMixin[K]): void; }, any[]> & Class<{ kbdNav: string; _kbdFocusable: boolean; }, any[]> & Class<{ kbdNavQuery: string; kbdNavFocusableWhenDisabled: boolean; ariaOrientationDefault: \"horizontal\" | \"vertical\"; }, any[]> & Class<{ kbdNavChildren: NodeListOf; }, any[]> & Class<{ _ariaOrientationIsVertical(): boolean; focusCurrentOrFirst(): HTMLElement; focusNext(current?: HTMLElement, loop?: boolean, reverse?: boolean): HTMLElement; focusPrevious(current?: HTMLElement, loop?: boolean): HTMLElement; focus(options?: FocusOptions): void; refreshTabIndexes(): void; }, any[]>" } }, "members": [ { "name": "kbdNav", "kind": "field", "description": "Enable keyboard roving navigation when present (set to 'true').", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/KeyboardNavMixin.js#L23" }, "type": { "text": "string" } }, { "name": "kbdNavQuery", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/KeyboardNavMixin.js#L32" }, "type": { "text": "string" } }, { "name": "kbdNavFocusableWhenDisabled", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/KeyboardNavMixin.js#L39" }, "type": { "text": "boolean" } }, { "name": "ariaOrientationDefault", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/KeyboardNavMixin.js#L41" }, "type": { "text": "\"horizontal\" | \"vertical\"" } }, { "name": "kbdNavChildren", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/KeyboardNavMixin.js#L48" }, "type": { "text": "NodeListOf" } }, { "name": "focusCurrentOrFirst", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/KeyboardNavMixin.js#L57" }, "return": { "type": { "text": "() => HTMLElement" } } }, { "name": "focusNext", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/KeyboardNavMixin.js#L78" }, "return": { "type": { "text": "(current?: HTMLElement, loop?: boolean, reverse?: boolean) => HTMLElement" } } }, { "name": "focusPrevious", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/KeyboardNavMixin.js#L133" }, "return": { "type": { "text": "(current?: HTMLElement, loop?: boolean) => HTMLElement" } } }, { "name": "refreshTabIndexes", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/KeyboardNavMixin.js#L156" }, "return": { "type": { "text": "() => void" } } } ], "mixins": [ { "module": "mixins/AriaReflectorMixin.js", "name": "default" } ], "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/KeyboardNavMixin.js" }, "description": "Adds keyboard roving navigation utilities for focus management within a list.", "attributes": [ { "name": "kbd-nav", "type": { "text": "string" }, "description": "Enable keyboard roving navigation when present (set to 'true').", "fieldName": "kbdNav" } ] } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "default", "module": "mixins/KeyboardNavMixin.js" } } ] }, { "kind": "javascript-module", "path": "mixins/PopupMixin.js", "declarations": [ { "kind": "mixin", "customElement": true, "name": "default", "parameters": [ { "name": "Base", "type": { "text": "typeof CustomElement" } } ], "return": { "type": { "text": "typeof CustomElement & Class<{ _resizeObserverEnabled: boolean; }, any[]> & Class<{ onResizeObserved(entry: ResizeObserverEntry): void; observeResize(): void; unobserveResize(): void; }, any[]> & Class<{ delegatesFocus: boolean; }, any[]> & Class<{ open: boolean; modal: boolean; native: boolean; scrollable: boolean; matchSourceWidth: boolean; _currentFlow: string; flow: string; popupMargin: number; }, any[]> & Class<{ useHistory: boolean; returnValue: string; _closing: boolean; _useScrim: boolean; _source: HTMLElement | Event | PointerEvent | MouseEvent; _anchor: HTMLElement | Event | PointerEvent | MouseEvent; }, any[]> & Class<{ _dialog: HTMLDialogElement; }, any[]> & Class<{ _ariaHidden: never; }, any[]> & Class<{ updatePopupPosition(anchor?: Element | DOMRectLike): void; onSlotChange({ currentTarget }: Event & { currentTarget: HTMLSlotElement; }): void; showPopup(source?: HTMLElement | Event | PointerEvent | MouseEvent, focus?: boolean, flow?: string): boolean; showModal(source?: HTMLElement | Event | PointerEvent | MouseEvent, focus?: boolean, flow?: string): boolean; show(source?: HTMLElement | Event | PointerEvent | MouseEvent, focus?: boolean, flow?: string): boolean; close(returnValue?: any, returnFocus?: boolean): boolean; }, any[]> & Class<{ onResizeObserved(entry: ResizeObserverEntry): void; }, any[]>" } }, "members": [ { "name": "open", "kind": "field", "description": "Whether the popup is currently open", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/PopupMixin.js#L84" }, "type": { "text": "boolean" } }, { "name": "modal", "kind": "field", "description": "When true the popup behaves as a blocking modal", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/PopupMixin.js#L86" }, "type": { "text": "boolean" } }, { "name": "native", "kind": "field", "description": "Use the native HTMLDialogElement when available", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/PopupMixin.js#L88" }, "type": { "text": "boolean" } }, { "name": "scrollable", "kind": "field", "description": "Allow internal content to scroll when true", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/PopupMixin.js#L90" }, "type": { "text": "boolean" } }, { "name": "matchSourceWidth", "kind": "field", "description": "When true, match the popup width to the source element", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/PopupMixin.js#L92" }, "type": { "text": "boolean" } }, { "name": "flow", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/PopupMixin.js#L95" }, "type": { "text": "string" } }, { "name": "popupMargin", "kind": "field", "description": "Margin between popup and viewport/anchor (px)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/PopupMixin.js#L101" }, "type": { "text": "float" } }, { "name": "useHistory", "kind": "field", "description": "Whether to push/pop history entries when opening the popup", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/PopupMixin.js#L105" }, "type": { "text": "boolean" } }, { "name": "returnValue", "kind": "field", "description": "Optional return value for dialog-like popups", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/PopupMixin.js#L107" }, "type": { "text": "string" } }, { "name": "updatePopupPosition", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/PopupMixin.js#L138" }, "return": { "type": { "text": "(anchor?: Element | DOMRectLike) => void" } } }, { "name": "onSlotChange", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/PopupMixin.js#L290" }, "return": { "type": { "text": "({ currentTarget }: Event & { currentTarget: HTMLSlotElement; }) => void" } } }, { "name": "showPopup", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/PopupMixin.js#L303" }, "return": { "type": { "text": "(source?: HTMLElement | Event | PointerEvent | MouseEvent, focus?: boolean, flow?: string) => boolean" } } }, { "name": "showModal", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/PopupMixin.js#L389" }, "return": { "type": { "text": "(source?: HTMLElement | Event | PointerEvent | MouseEvent, focus?: boolean, flow?: string) => boolean" } } }, { "name": "show", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/PopupMixin.js#L404" }, "return": { "type": { "text": "(source?: HTMLElement | Event | PointerEvent | MouseEvent, focus?: boolean, flow?: string) => boolean" } } }, { "name": "close", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/PopupMixin.js#L417" }, "return": { "type": { "text": "(returnValue?: any, returnFocus?: boolean) => boolean" } } } ], "mixins": [ { "module": "mixins/DelegatesFocusMixin.js", "name": "default" }, { "module": "mixins/ResizeObserverMixin.js", "name": "default" } ], "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/PopupMixin.js" }, "description": "Provides positioning, modal behavior, and history-aware popup/dialog support.", "attributes": [ { "name": "open", "type": { "text": "boolean" }, "description": "Whether the popup is currently open", "fieldName": "open" }, { "name": "modal", "type": { "text": "boolean" }, "description": "When true the popup behaves as a blocking modal", "fieldName": "modal" }, { "name": "native", "type": { "text": "boolean" }, "description": "Use the native HTMLDialogElement when available", "fieldName": "native" }, { "name": "scrollable", "type": { "text": "boolean" }, "description": "Allow internal content to scroll when true", "fieldName": "scrollable" }, { "name": "match-source-width", "type": { "text": "boolean" }, "description": "When true, match the popup width to the source element", "fieldName": "matchSourceWidth" }, { "name": "flow", "type": { "text": "string" }, "fieldName": "flow" }, { "name": "popup-margin", "type": { "text": "float" }, "description": "Margin between popup and viewport/anchor (px)", "fieldName": "popupMargin" } ] } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "default", "module": "mixins/PopupMixin.js" } } ] }, { "kind": "javascript-module", "path": "mixins/RTLObserverMixin.js", "declarations": [ { "kind": "mixin", "customElement": true, "name": "default", "parameters": [ { "name": "Base", "type": { "text": "typeof CustomElement" } } ], "return": { "type": { "text": "typeof CustomElement & Class<{ pageIsRTL: boolean; }, any[]>" } }, "members": [ { "name": "pageIsRTL", "kind": "field", "description": "Whether the page/document direction is RTL; kept in sync", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/RTLObserverMixin.js#L14" }, "type": { "text": "boolean" } } ], "mixins": [], "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/RTLObserverMixin.js" }, "description": "Observes document `dir` changes and updates `pageIsRTL` on hosts.", "attributes": [ { "name": "page-is-r-t-l", "type": { "text": "boolean" }, "description": "Whether the page/document direction is RTL; kept in sync", "fieldName": "pageIsRTL" } ] } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "default", "module": "mixins/RTLObserverMixin.js" } } ] }, { "kind": "javascript-module", "path": "mixins/ResizeObserverMixin.js", "declarations": [ { "kind": "mixin", "customElement": true, "name": "default", "parameters": [ { "name": "Base", "type": { "text": "typeof CustomElement" } } ], "return": { "type": { "text": "typeof CustomElement & Class<{ _resizeObserverEnabled: boolean; }, any[]> & Class<{ onResizeObserved(entry: ResizeObserverEntry): void; observeResize(): void; unobserveResize(): void; }, any[]>" } }, "members": [ { "name": "onResizeObserved", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ResizeObserverMixin.js#L23" }, "return": { "type": { "text": "(entry: ResizeObserverEntry) => void" } } }, { "name": "observeResize", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ResizeObserverMixin.js#L26" }, "return": { "type": { "text": "() => void" } } }, { "name": "unobserveResize", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ResizeObserverMixin.js#L31" }, "return": { "type": { "text": "() => void" } } } ], "mixins": [], "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ResizeObserverMixin.js" }, "description": "Attaches a shared ResizeObserver to the element and provides lifecycle helpers." } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "default", "module": "mixins/ResizeObserverMixin.js" } } ] }, { "kind": "javascript-module", "path": "mixins/RippleMixin.js", "declarations": [ { "kind": "mixin", "customElement": true, "name": "default", "parameters": [ { "name": "Base", "type": { "text": "typeof CustomElement & Class<{ disabled: boolean; focused: boolean; hovered: boolean; pressed: boolean; _lastInteraction: \"mouse\" | \"touch\" | \"key\" | \"pen\"; _hovered: boolean; _focused: boolean; _focusedSynthetic: boolean; _keyPressed: boolean; _keyReleased: boolean; _pointerPressed: boolean; stateLayer: boolean; }, any[]> & Class<{ disabledState: boolean; hoveredState: boolean; focusedState: boolean; pressedState: boolean; touchedState: boolean; pointedState: boolean; }, any[]> & Class<{ stateTargetElement: HTMLElement; }, any[]>" } } ], "return": { "type": { "text": "typeof CustomElement & Class<{ disabled: boolean; focused: boolean; hovered: boolean; pressed: boolean; _lastInteraction: \"mouse\" | \"touch\" | \"key\" | \"pen\"; _hovered: boolean; _focused: boolean; _focusedSynthetic: boolean; _keyPressed: boolean; _keyReleased: boolean; _pointerPressed: boolean; stateLayer: boolean; }, any[]> & Class<{ disabledState: boolean; hoveredState: boolean; focusedState: boolean; pressedState: boolean; touchedState: boolean; pointedState: boolean; }, any[]> & Class<{ stateTargetElement: HTMLElement; }, any[]> & Class<{ _lastRippleWeakRef: WeakRef; _rippleAdded: boolean; }, any[]> & Class<{ _lastRipple: CustomElement & { hadRippleHeld: boolean; hadRippleReleased: boolean; rippleStarted: boolean; } & { rippleState: string; keepAlive: boolean; _positionX: number; _positionY: number; _radius: number; holdRipple: boolean; } & { _positionStyle: ElementStylerOptions | { styles: { minHeight: string; minWidth: string; boxShadow: string; top: string; left: string; }; }; } & { updatePosition(x?: number, y?: number, size?: number): void; handleRippleComplete(): void; }; }, any[]> & Class<{ addRipple(x?: number, y?: number, hold?: boolean): CustomElement & { hadRippleHeld: boolean; hadRippleReleased: boolean; rippleStarted: boolean; } & { rippleState: string; keepAlive: boolean; _positionX: number; _positionY: number; _radius: number; holdRipple: boolean; } & { _positionStyle: ElementStylerOptions | { styles: { minHeight: string; minWidth: string; boxShadow: string; top: string; left: string; }; }; } & { updatePosition(x?: number, y?: number, size?: number): void; handleRippleComplete(): void; }; }, any[]>" } }, "members": [ { "name": "addRipple", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/RippleMixin.js#L37" }, "return": { "type": { "text": "(x?: number, y?: number, hold?: boolean) => CustomElement & { hadRippleHeld: boolean; hadRippleReleased: boolean; rippleStarted: boolean; } & { rippleState: string; keepAlive: boolean; _positionX: number; _positionY: number; _radius: number; holdRipple: boolean; } & { _positionStyle: ElementStylerOptions | { styles: { minHeight: string; minWidth: string; boxShadow: string; top: string; left: string; }; }; } & { updatePosition(x?: number, y?: number, size?: number): void; handleRippleComplete(): void; }" } } } ], "mixins": [], "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/RippleMixin.js" }, "description": "Provides visual ripple effects (pointer/press ripples) and helpers to add/remove them." } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "default", "module": "mixins/RippleMixin.js" } } ] }, { "kind": "javascript-module", "path": "mixins/ScrollListenerMixin.js", "declarations": [ { "kind": "mixin", "customElement": true, "name": "default", "parameters": [ { "name": "Base", "type": { "text": "typeof CustomElement" } } ], "return": { "type": { "text": "typeof CustomElement & Class<{ _scrollListenerPositionX: number; _scrollListenerPositionY: number; _scrollListenerLastIdle: number; _scrollListenerLastScroll: number; _scrollListenerLastResize: number; }, any[]> & Class<{ _scroller: WeakRef; _scrollerScrollListener: EventListener; _scrollerResizeListener: EventListener; _scrollDebounce: any; }, any[]> & Class<{ _scrollListenerOnScrollIdle(): void; _scrollListenerOnScrollerScroll(event: Event): void; _scrollListenerOnScrollerResize(event: Event): void; startScrollListener(scroller?: EventTarget): boolean; }, any[]> & Class<{ _scrollListenerScroller: HTMLElement | Window; }, any[]> & Class<{ _scrollListenerScrollerScrollHeight: any; _scrollListenerScrollerClientHeight: any; }, any[]> & Class<{ _scrollListenerClear(scroller?: EventTarget): boolean; }, any[]>" } }, "members": [ { "name": "startScrollListener", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ScrollListenerMixin.js#L63" }, "return": { "type": { "text": "(scroller?: EventTarget) => boolean" } } } ], "mixins": [], "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ScrollListenerMixin.js" }, "description": "Tracks scroll/resize positions and exposes scroll-related lifecycle helpers." } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "default", "module": "mixins/ScrollListenerMixin.js" } } ] }, { "kind": "javascript-module", "path": "mixins/SemiStickyMixin.js", "declarations": [ { "kind": "mixin", "customElement": true, "name": "default", "parameters": [ { "name": "Base", "type": { "text": "typeof CustomElement" } } ], "return": { "type": { "text": "typeof CustomElement & Class<{ _scrollListenerPositionX: number; _scrollListenerPositionY: number; _scrollListenerLastIdle: number; _scrollListenerLastScroll: number; _scrollListenerLastResize: number; }, any[]> & Class<{ _scroller: WeakRef; _scrollerScrollListener: EventListener; _scrollerResizeListener: EventListener; _scrollDebounce: any; }, any[]> & Class<{ _scrollListenerOnScrollIdle(): void; _scrollListenerOnScrollerScroll(event: Event): void; _scrollListenerOnScrollerResize(event: Event): void; startScrollListener(scroller?: EventTarget): boolean; }, any[]> & Class<{ _scrollListenerScroller: HTMLElement | Window; }, any[]> & Class<{ _scrollListenerScrollerScrollHeight: any; _scrollListenerScrollerClientHeight: any; }, any[]> & Class<{ _scrollListenerClear(scroller?: EventTarget): boolean; }, any[]> & Class<{ _semiStickyHeight: number; _semiStickyOffsetY: number; _semiStickyTranslateY: number; _semiStickyDuration: number; _semiStickyEasing: string; _semiStickyMeasured: boolean; stickyAlways: boolean; stickyParent: boolean; }, any[]> & Class<{ _refreshSemiStickyMetrics(): void; }, any[]> & Class<{ _semiStickyStyleStyle: ElementStylerOptions | { styles: { transform: string; }; timing: { duration: number; easing: string; }; }; }, any[]>" } }, "members": [ { "name": "stickyAlways", "kind": "field", "description": "When true, element remains always visible", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/SemiStickyMixin.js#L26" }, "type": { "text": "boolean" } }, { "name": "stickyParent", "kind": "field", "description": "Stick to offsetParent instead of window", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/SemiStickyMixin.js#L28" }, "type": { "text": "boolean" } } ], "mixins": [ { "module": "mixins/ScrollListenerMixin.js", "name": "default" } ], "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/SemiStickyMixin.js" }, "description": "Hides sticky element when scrolling down", "attributes": [ { "name": "sticky-always", "type": { "text": "boolean" }, "description": "When true, element remains always visible", "fieldName": "stickyAlways" }, { "name": "sticky-parent", "type": { "text": "boolean" }, "description": "Stick to offsetParent instead of window", "fieldName": "stickyParent" } ] } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "default", "module": "mixins/SemiStickyMixin.js" } } ] }, { "kind": "javascript-module", "path": "mixins/ShapeMaskedMixin.js", "declarations": [ { "kind": "mixin", "customElement": true, "name": "default", "parameters": [ { "name": "Base", "type": { "text": "typeof CustomElement" } } ], "return": { "type": { "text": "typeof CustomElement & Class<{ shapeTop: boolean; shapeBottom: boolean; shapeStart: boolean; shapeEnd: boolean; shapeStyle: string; }, any[]>" } }, "members": [ { "name": "shapeTop", "kind": "field", "description": "Show top cut/shape on the element", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMaskedMixin.js#L9" }, "type": { "text": "boolean" } }, { "name": "shapeBottom", "kind": "field", "description": "Show bottom cut/shape on the element", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMaskedMixin.js#L11" }, "type": { "text": "boolean" } }, { "name": "shapeStart", "kind": "field", "description": "Show start-side cut/shape (logical start)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMaskedMixin.js#L13" }, "type": { "text": "boolean" } }, { "name": "shapeEnd", "kind": "field", "description": "Show end-side cut/shape (logical end)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMaskedMixin.js#L15" }, "type": { "text": "boolean" } }, { "name": "shapeStyle", "kind": "field", "description": "Predefined shape size/style name (none|extra-small|small|medium|large|extra-large|full|inherit)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMaskedMixin.js#L17" }, "type": { "text": "string" } } ], "mixins": [], "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMaskedMixin.js" }, "description": "Provides shape masking utilities and logical shape attributes (shape-top/start/end/bottom).", "attributes": [ { "name": "shape-top", "type": { "text": "boolean" }, "description": "Show top cut/shape on the element", "fieldName": "shapeTop" }, { "name": "shape-bottom", "type": { "text": "boolean" }, "description": "Show bottom cut/shape on the element", "fieldName": "shapeBottom" }, { "name": "shape-start", "type": { "text": "boolean" }, "description": "Show start-side cut/shape (logical start)", "fieldName": "shapeStart" }, { "name": "shape-end", "type": { "text": "boolean" }, "description": "Show end-side cut/shape (logical end)", "fieldName": "shapeEnd" }, { "name": "shape-style", "type": { "text": "string" }, "description": "Predefined shape size/style name (none|extra-small|small|medium|large|extra-large|full|inherit)", "fieldName": "shapeStyle" } ] } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "default", "module": "mixins/ShapeMaskedMixin.js" } } ] }, { "kind": "javascript-module", "path": "mixins/ShapeMixin.js", "declarations": [ { "kind": "mixin", "customElement": true, "name": "default", "parameters": [ { "name": "Base", "type": { "text": "typeof CustomElement & Class<{ disabled: boolean; focused: boolean; hovered: boolean; pressed: boolean; _lastInteraction: \"mouse\" | \"touch\" | \"key\" | \"pen\"; _hovered: boolean; _focused: boolean; _focusedSynthetic: boolean; _keyPressed: boolean; _keyReleased: boolean; _pointerPressed: boolean; stateLayer: boolean; }, any[]> & Class<{ disabledState: boolean; hoveredState: boolean; focusedState: boolean; pressedState: boolean; touchedState: boolean; pointedState: boolean; }, any[]> & Class<{ stateTargetElement: HTMLElement; }, any[]> & Class<{ color: string; ink: string; typeStyle: string; }, any[]>" } } ], "return": { "type": { "text": "typeof CustomElement & Class<{ disabled: boolean; focused: boolean; hovered: boolean; pressed: boolean; _lastInteraction: \"mouse\" | \"touch\" | \"key\" | \"pen\"; _hovered: boolean; _focused: boolean; _focusedSynthetic: boolean; _keyPressed: boolean; _keyReleased: boolean; _pointerPressed: boolean; stateLayer: boolean; }, any[]> & Class<{ disabledState: boolean; hoveredState: boolean; focusedState: boolean; pressedState: boolean; touchedState: boolean; pointedState: boolean; }, any[]> & Class<{ stateTargetElement: HTMLElement; }, any[]> & Class<{ color: string; ink: string; typeStyle: string; }, any[]> & Class<{ shapeTop: boolean; shapeBottom: boolean; shapeStart: boolean; shapeEnd: boolean; shapeStyle: string; outlined: boolean; }, any[]>" } }, "members": [ { "name": "shapeTop", "kind": "field", "description": "Show top cut/shape on the element", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L9" }, "type": { "text": "boolean" } }, { "name": "shapeBottom", "kind": "field", "description": "Show bottom cut/shape on the element", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L11" }, "type": { "text": "boolean" } }, { "name": "shapeStart", "kind": "field", "description": "Show start-side cut/shape (logical start)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L13" }, "type": { "text": "boolean" } }, { "name": "shapeEnd", "kind": "field", "description": "Show end-side cut/shape (logical end)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L15" }, "type": { "text": "boolean" } }, { "name": "shapeStyle", "kind": "field", "description": "Predefined shape size/style name (none|extra-small|small|medium|large|extra-large|full|inherit)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L17" }, "type": { "text": "string" } }, { "name": "outlined", "kind": "field", "description": "When true, an outline is rendered around the element", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js#L19" }, "type": { "text": "boolean" } } ], "mixins": [], "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ShapeMixin.js" }, "description": "Adds shape sizing and outline support for components (shape-style, shape-top, etc.).", "attributes": [ { "name": "shape-top", "type": { "text": "boolean" }, "description": "Show top cut/shape on the element", "fieldName": "shapeTop" }, { "name": "shape-bottom", "type": { "text": "boolean" }, "description": "Show bottom cut/shape on the element", "fieldName": "shapeBottom" }, { "name": "shape-start", "type": { "text": "boolean" }, "description": "Show start-side cut/shape (logical start)", "fieldName": "shapeStart" }, { "name": "shape-end", "type": { "text": "boolean" }, "description": "Show end-side cut/shape (logical end)", "fieldName": "shapeEnd" }, { "name": "shape-style", "type": { "text": "string" }, "description": "Predefined shape size/style name (none|extra-small|small|medium|large|extra-large|full|inherit)", "fieldName": "shapeStyle" }, { "name": "outlined", "type": { "text": "boolean" }, "description": "When true, an outline is rendered around the element", "fieldName": "outlined" } ] } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "default", "module": "mixins/ShapeMixin.js" } } ] }, { "kind": "javascript-module", "path": "mixins/StateMixin.js", "declarations": [ { "kind": "mixin", "customElement": true, "name": "default", "parameters": [ { "name": "Base", "type": { "text": "typeof CustomElement" } } ], "return": { "type": { "text": "typeof CustomElement & Class<{ disabled: boolean; focused: boolean; hovered: boolean; pressed: boolean; _lastInteraction: \"mouse\" | \"touch\" | \"key\" | \"pen\"; _hovered: boolean; _focused: boolean; _focusedSynthetic: boolean; _keyPressed: boolean; _keyReleased: boolean; _pointerPressed: boolean; stateLayer: boolean; }, any[]> & Class<{ disabledState: boolean; hoveredState: boolean; focusedState: boolean; pressedState: boolean; touchedState: boolean; pointedState: boolean; }, any[]> & Class<{ stateTargetElement: HTMLElement; }, any[]>" } }, "members": [ { "name": "disabled", "kind": "field", "description": "Whether the element is disabled (affects interactive states)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L14" }, "type": { "text": "boolean" } }, { "name": "focused", "kind": "field", "description": "Force focus state (independent of document)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L16" }, "type": { "text": "boolean" } }, { "name": "hovered", "kind": "field", "description": "Force hover state (independent of interaction)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L18" }, "type": { "text": "boolean" } }, { "name": "pressed", "kind": "field", "description": "Force pressed state (independent of interaction)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L20" }, "type": { "text": "boolean" } }, { "name": "stateLayer", "kind": "field", "description": "Show the visual state layer element when true", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L34" }, "type": { "text": "boolean" } }, { "name": "disabledState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L37" }, "type": { "text": "boolean" } }, { "name": "hoveredState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L38" }, "type": { "text": "boolean" } }, { "name": "focusedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L39" }, "type": { "text": "boolean" } }, { "name": "pressedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L40" }, "type": { "text": "boolean" } }, { "name": "touchedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L41" }, "type": { "text": "boolean" } }, { "name": "pointedState", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L44" }, "type": { "text": "boolean" } }, { "name": "stateTargetElement", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js#L50" }, "type": { "text": "HTMLElement" } } ], "mixins": [], "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/StateMixin.js" }, "description": "Manages interactive state flags (disabled, focused, hovered, pressed, touch)\nand derived state expressions used by components.", "attributes": [ { "name": "disabled", "type": { "text": "boolean" }, "description": "Whether the element is disabled (affects interactive states)", "fieldName": "disabled" }, { "name": "focused", "type": { "text": "boolean" }, "description": "Force focus state (independent of document)", "fieldName": "focused" }, { "name": "hovered", "type": { "text": "boolean" }, "description": "Force hover state (independent of interaction)", "fieldName": "hovered" }, { "name": "pressed", "type": { "text": "boolean" }, "description": "Force pressed state (independent of interaction)", "fieldName": "pressed" }, { "name": "state-layer", "type": { "text": "boolean" }, "description": "Show the visual state layer element when true", "fieldName": "stateLayer" } ] } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "default", "module": "mixins/StateMixin.js" } } ] }, { "kind": "javascript-module", "path": "mixins/TextFieldMixin.js", "declarations": [ { "kind": "mixin", "customElement": true, "name": "default", "parameters": [ { "name": "Base", "type": { "text": "typeof CustomElement & Class<{ delegatesFocus: boolean; }, any[]> & Class<{ disabled: boolean; focused: boolean; hovered: boolean; pressed: boolean; _lastInteraction: \"mouse\" | \"touch\" | \"key\" | \"pen\"; _hovered: boolean; _focused: boolean; _focusedSynthetic: boolean; _keyPressed: boolean; _keyReleased: boolean; _pointerPressed: boolean; stateLayer: boolean; }, any[]> & Class<{ disabledState: boolean; hoveredState: boolean; focusedState: boolean; pressedState: boolean; touchedState: boolean; pointedState: boolean; }, any[]> & Class<{ stateTargetElement: HTMLElement; }, any[]> & { formAssociated: true; } & Class<{ _ipcListener: EventListener; _ipcTarget: EventTarget; _files: FileList; }, any[]> & Class<{ ariaControls: string; autocomplete: string; name: string; readOnly: boolean; formNoValidate: boolean; defaultChecked: boolean; _checkedDirty: boolean; _checked: boolean; required: boolean; type: string; _defaultValue: string; _value: string; _valueDirty: boolean; _userInteracted: boolean; _invalid: boolean; _badInput: boolean; _validationMessage: string; _formDisabled: boolean; _formReset: boolean; }, any[]> & Class<{ erroredState: boolean; defaultValue: string; _valueBehavior: \"value\" | \"default/on\" | \"default\" | \"filename\"; }, any[]> & Class<{ _onSetValue(value: string): void; _onSetChecked(checked: boolean): void; }, any[]> & Class<{ value: string; checked: boolean; }, any[]> & Class<{ form: HTMLFormElement; validity: ValidityState; validationMessage: string; willValidate: boolean; labels: NodeList; }, any[]> & Class<{ disabledState: boolean; }, any[]> & Class<{ checkValidity(): boolean; reportValidity(): boolean; setCustomValidity(error: string): void; _notifyRadioChange(key: string, value: string): void; refreshFormAssociation(): void; formAssociatedCallback(form: HTMLFormElement): void; formIPCEvent(event: CustomEvent<[string, string]>): void; formDisabledCallback(disabled: boolean): void; formResetCallback(): void; formStateRestoreCallback(state: string | FormData, mode: \"autocomplete\" | \"restore\"): void; _updateFormAssociatedValue(): void; }, any[]> & Class<{ ariaLabel: string; _slotInnerText: string; }, any[]> & Class<{ focusableOnDisabled: boolean; controlTagName: string; controlVoidElement: boolean; _slotMutationObserver: any; }, any[]> & Class<{ _onControlValue(value: string): void; onValueChangingContentAttribute(): void; focus(options?: FocusOptions): void; click(): void; }, any[]> & Class<{ stateTargetElement: HTMLElement; }, any[]> & Class<{ checkValidity(): boolean; reportValidity(): boolean; setCustomValidity(error: string): void; }, any[]> & Class<{ _computedAriaLabel: string; }, any[]> & Class<{ _computedAriaLabelledby: never; }, any[]>" } } ], "return": { "type": { "text": "typeof CustomElement & Class<{ disabled: boolean; focused: boolean; hovered: boolean; pressed: boolean; _lastInteraction: \"mouse\" | \"touch\" | \"key\" | \"pen\"; _hovered: boolean; _focused: boolean; _focusedSynthetic: boolean; _keyPressed: boolean; _keyReleased: boolean; _pointerPressed: boolean; stateLayer: boolean; }, any[]> & Class<{ disabledState: boolean; hoveredState: boolean; focusedState: boolean; pressedState: boolean; touchedState: boolean; pointedState: boolean; }, any[]> & Class<{ stateTargetElement: HTMLElement; }, any[]> & Class<{ color: string; ink: string; typeStyle: string; }, any[]> & Class<{ shapeTop: boolean; shapeBottom: boolean; shapeStart: boolean; shapeEnd: boolean; shapeStyle: string; outlined: boolean; }, any[]> & Class<{ density: number; }, any[]> & Class<{ delegatesFocus: boolean; }, any[]> & { formAssociated: true; } & Class<{ _ipcListener: EventListener; _ipcTarget: EventTarget; _files: FileList; }, any[]> & Class<{ ariaControls: string; autocomplete: string; name: string; readOnly: boolean; formNoValidate: boolean; defaultChecked: boolean; _checkedDirty: boolean; _checked: boolean; required: boolean; type: string; _defaultValue: string; _value: string; _valueDirty: boolean; _userInteracted: boolean; _invalid: boolean; _badInput: boolean; _validationMessage: string; _formDisabled: boolean; _formReset: boolean; }, any[]> & Class<{ erroredState: boolean; defaultValue: string; _valueBehavior: \"value\" | \"default/on\" | \"default\" | \"filename\"; }, any[]> & Class<{ _onSetValue(value: string): void; _onSetChecked(checked: boolean): void; }, any[]> & Class<{ value: string; checked: boolean; }, any[]> & Class<{ form: HTMLFormElement; validity: ValidityState; validationMessage: string; willValidate: boolean; labels: NodeList; }, any[]> & Class<{ disabledState: boolean; }, any[]> & Class<{ checkValidity(): boolean; reportValidity(): boolean; setCustomValidity(error: string): void; _notifyRadioChange(key: string, value: string): void; refreshFormAssociation(): void; formAssociatedCallback(form: HTMLFormElement): void; formIPCEvent(event: CustomEvent<[string, string]>): void; formDisabledCallback(disabled: boolean): void; formResetCallback(): void; formStateRestoreCallback(state: string | FormData, mode: \"autocomplete\" | \"restore\"): void; _updateFormAssociatedValue(): void; }, any[]> & Class<{ ariaLabel: string; _slotInnerText: string; }, any[]> & Class<{ focusableOnDisabled: boolean; controlTagName: string; controlVoidElement: boolean; _slotMutationObserver: any; }, any[]> & Class<{ _onControlValue(value: string): void; onValueChangingContentAttribute(): void; focus(options?: FocusOptions): void; click(): void; }, any[]> & Class<{ stateTargetElement: HTMLElement; }, any[]> & Class<{ checkValidity(): boolean; reportValidity(): boolean; setCustomValidity(error: string): void; }, any[]> & Class<{ _computedAriaLabel: string; }, any[]> & Class<{ _computedAriaLabelledby: never; }, any[]> & Class<{ stateLayer: boolean; }, any[]> & Class<{ type: string; icon: string; iconVariation: string; label: string; filled: boolean; outlined: boolean; inputPrefix: string; inputSuffix: string; trailingIcon: string; trailingIconInk: string; trailingIconLabel: string; supporting: string; error: string; placeholder: string; }, any[]> & Class<{ erroredState: boolean; }, any[]> & Class<{ computePlaceholder: () => string; shouldShowSupporting: () => boolean; computeSupportingText: () => string; populatedState: () => boolean; _showLabelText: never; }, any[]> & Class<{ _shapeShapeTop: never; computedIconVariation: () => string; }, any[]>" } }, "members": [ { "name": "icon", "kind": "field", "description": "Leading icon key/name to render inside the field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/TextFieldMixin.js#L23" }, "type": { "text": "string" } }, { "name": "iconVariation", "kind": "field", "description": "Variation of the icon display (e.g., filled)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/TextFieldMixin.js#L25" }, "type": { "text": "string" } }, { "name": "label", "kind": "field", "description": "Floating label text for the field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/TextFieldMixin.js#L27" }, "type": { "text": "string" } }, { "name": "filled", "kind": "field", "description": "When true, use filled styling", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/TextFieldMixin.js#L29" }, "type": { "text": "boolean" } }, { "name": "inputPrefix", "kind": "field", "description": "Prefix text shown before the input", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/TextFieldMixin.js#L33" }, "type": { "text": "string" } }, { "name": "inputSuffix", "kind": "field", "description": "Suffix text shown after the input", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/TextFieldMixin.js#L35" }, "type": { "text": "string" } }, { "name": "trailingIcon", "kind": "field", "description": "Trailing icon key/name", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/TextFieldMixin.js#L37" }, "type": { "text": "string" } }, { "name": "trailingIconInk", "kind": "field", "description": "Ink/color token for the trailing icon", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/TextFieldMixin.js#L39" }, "type": { "text": "string" } }, { "name": "trailingIconLabel", "kind": "field", "description": "Accessible label for the trailing icon", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/TextFieldMixin.js#L41" }, "type": { "text": "string" } }, { "name": "supporting", "kind": "field", "description": "Supporting/helper text shown beneath the field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/TextFieldMixin.js#L43" }, "type": { "text": "string" } }, { "name": "error", "kind": "field", "description": "Error message text", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/TextFieldMixin.js#L45" }, "type": { "text": "string" } }, { "name": "placeholder", "kind": "field", "description": "Placeholder text (DOMString)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/TextFieldMixin.js#L47" }, "type": { "text": "string" } }, { "name": "computePlaceholder", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/TextFieldMixin.js#L53" }, "return": { "type": { "text": "() => string" } } }, { "name": "shouldShowSupporting", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/TextFieldMixin.js#L58" }, "return": { "type": { "text": "() => boolean" } } }, { "name": "computeSupportingText", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/TextFieldMixin.js#L62" }, "return": { "type": { "text": "() => string" } } }, { "name": "populatedState", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/TextFieldMixin.js#L66" }, "return": { "type": { "text": "() => boolean" } } }, { "name": "computedIconVariation", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/TextFieldMixin.js#L77" }, "return": { "type": { "text": "() => string" } } } ], "mixins": [ { "module": "mixins/ControlMixin.js", "name": "default" }, { "module": "mixins/FormAssociatedMixin.js", "name": "default" }, { "module": "mixins/DelegatesFocusMixin.js", "name": "default" } ], "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/TextFieldMixin.js" }, "description": "Composes a text field with label, supporting text, icons and control wiring.", "attributes": [ { "name": "density", "type": { "text": "integer" }, "fieldName": "density" }, { "name": "shape-top", "type": { "text": "boolean" }, "fieldName": "shapeTop" }, { "name": "shape-bottom", "type": { "text": "boolean" }, "fieldName": "shapeBottom" }, { "name": "shape-start", "type": { "text": "boolean" }, "fieldName": "shapeStart" }, { "name": "shape-end", "type": { "text": "boolean" }, "fieldName": "shapeEnd" }, { "name": "shape-style", "type": { "text": "string" }, "fieldName": "shapeStyle" }, { "name": "outlined", "type": { "text": "boolean" }, "description": "When true, use outlined styling", "fieldName": "outlined" }, { "name": "type", "type": { "text": "string" }, "description": "Input type (text, password, email, etc.)", "fieldName": "type" }, { "name": "icon", "type": { "text": "string" }, "description": "Leading icon key/name to render inside the field", "fieldName": "icon" }, { "name": "icon-variation", "type": { "text": "string" }, "description": "Variation of the icon display (e.g., filled)", "fieldName": "iconVariation" }, { "name": "label", "type": { "text": "string" }, "description": "Floating label text for the field", "fieldName": "label" }, { "name": "filled", "type": { "text": "boolean" }, "description": "When true, use filled styling", "fieldName": "filled" }, { "name": "input-prefix", "type": { "text": "string" }, "description": "Prefix text shown before the input", "fieldName": "inputPrefix" }, { "name": "input-suffix", "type": { "text": "string" }, "description": "Suffix text shown after the input", "fieldName": "inputSuffix" }, { "name": "trailing-icon", "type": { "text": "string" }, "description": "Trailing icon key/name", "fieldName": "trailingIcon" }, { "name": "trailing-icon-ink", "type": { "text": "string" }, "description": "Ink/color token for the trailing icon", "fieldName": "trailingIconInk" }, { "name": "trailing-icon-label", "type": { "text": "string" }, "description": "Accessible label for the trailing icon", "fieldName": "trailingIconLabel" }, { "name": "supporting", "type": { "text": "string" }, "description": "Supporting/helper text shown beneath the field", "fieldName": "supporting" }, { "name": "error", "type": { "text": "string" }, "description": "Error message text", "fieldName": "error" }, { "name": "placeholder", "type": { "text": "string" }, "description": "Placeholder text (DOMString)", "fieldName": "placeholder" } ] } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "default", "module": "mixins/TextFieldMixin.js" } } ] }, { "kind": "javascript-module", "path": "mixins/ThemableMixin.js", "declarations": [ { "kind": "mixin", "customElement": true, "name": "default", "parameters": [ { "name": "Base", "type": { "text": "typeof CustomElement" } } ], "return": { "type": { "text": "typeof CustomElement & Class<{ color: string; ink: string; typeStyle: string; }, any[]>" } }, "members": [ { "name": "color", "kind": "field", "description": "Palette or surface token used to select background/ink tokens.\nExamples: 'primary', 'background', 'surface-container-low'.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L52" }, "type": { "text": "string" } }, { "name": "ink", "kind": "field", "description": "Explicit ink override token (e.g. 'outline', 'on-primary', 'inverse-on-surface', 'inherit').\nMaps to `--mdw-ink`.", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L57" }, "type": { "text": "string" } }, { "name": "typeStyle", "kind": "field", "description": "Typographic style shortcut that maps to type scale variables\n(e.g. 'headline-large', 'body-medium').", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js#L62" }, "type": { "text": "string" } } ], "mixins": [], "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/ThemableMixin.js" }, "description": "Adds theming attributes (`color`, `ink`, `typeStyle`) that map to CSS tokens.", "attributes": [ { "name": "color", "type": { "text": "string" }, "description": "Palette or surface token used to select background/ink tokens.\nExamples: 'primary', 'background', 'surface-container-low'.", "fieldName": "color" }, { "name": "ink", "type": { "text": "string" }, "description": "Explicit ink override token (e.g. 'outline', 'on-primary', 'inverse-on-surface', 'inherit').\nMaps to `--mdw-ink`.", "fieldName": "ink" }, { "name": "type-style", "type": { "text": "string" }, "description": "Typographic style shortcut that maps to type scale variables\n(e.g. 'headline-large', 'body-medium').", "fieldName": "typeStyle" } ] } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "default", "module": "mixins/ThemableMixin.js" } } ] }, { "kind": "javascript-module", "path": "mixins/TooltipTriggerMixin.js", "declarations": [ { "kind": "mixin", "customElement": true, "name": "default", "parameters": [ { "name": "Base", "type": { "text": "typeof CustomElement & Class<{ disabled: boolean; focused: boolean; hovered: boolean; pressed: boolean; _lastInteraction: \"mouse\" | \"touch\" | \"key\" | \"pen\"; _hovered: boolean; _focused: boolean; _focusedSynthetic: boolean; _keyPressed: boolean; _keyReleased: boolean; _pointerPressed: boolean; stateLayer: boolean; }, any[]> & Class<{ disabledState: boolean; hoveredState: boolean; focusedState: boolean; pressedState: boolean; touchedState: boolean; pointedState: boolean; }, any[]> & Class<{ stateTargetElement: HTMLElement; }, any[]>" } } ], "return": { "type": { "text": "typeof CustomElement & Class<{ disabled: boolean; focused: boolean; hovered: boolean; pressed: boolean; _lastInteraction: \"mouse\" | \"touch\" | \"key\" | \"pen\"; _hovered: boolean; _focused: boolean; _focusedSynthetic: boolean; _keyPressed: boolean; _keyReleased: boolean; _pointerPressed: boolean; stateLayer: boolean; }, any[]> & Class<{ disabledState: boolean; hoveredState: boolean; focusedState: boolean; pressedState: boolean; touchedState: boolean; pointedState: boolean; }, any[]> & Class<{ stateTargetElement: HTMLElement; }, any[]> & Class<{ TOOLTIP_MOUSE_IDLE_MS: number; TOOLTIP_TOUCH_IDLE_MS: number; _idleDebounce: any; _watchedParents: HTMLElement[]; _resizeObserver: ResizeObserver; _intersectObserver: IntersectionObserver; _parentScrollListener: any; tooltipSlotId: string; }, any[]> & Class<{ tooltip: string; autoTooltip: boolean; }, any[]> & Class<{ cancelShowTooltip(): void; scheduleHideTooltip(type: \"mouse\" | \"touch\" | \"keyboard\"): void; scheduleShowTooltip(type: \"mouse\" | \"touch\" | \"keyboard\"): void; showTooltip(): void; hideTooltip(cancelSchedule?: boolean): void; updateTooltipPosition(domRect?: DOMRect): void; recloneTooltip(): void; closeIfNotHovered(): void; }, any[]>" } }, "members": [ { "name": "TOOLTIP_MOUSE_IDLE_MS", "kind": "field", "description": "Idle delay before showing tooltip for mouse (ms)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/TooltipTriggerMixin.js#L15" }, "type": { "text": "number" } }, { "name": "TOOLTIP_TOUCH_IDLE_MS", "kind": "field", "description": "Idle delay before showing tooltip for touch (ms)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/TooltipTriggerMixin.js#L17" }, "type": { "text": "number" } }, { "name": "tooltipSlotId", "kind": "field", "description": "Slot id to use when cloning tooltip content", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/TooltipTriggerMixin.js#L33" }, "type": { "text": "slot" } }, { "name": "tooltip", "kind": "field", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/TooltipTriggerMixin.js#L233" }, "type": { "text": "string" } }, { "name": "autoTooltip", "kind": "field", "description": "When true, show tooltip automatically on hover/focus", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/TooltipTriggerMixin.js#L39" }, "type": { "text": "boolean" } }, { "name": "cancelShowTooltip", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/TooltipTriggerMixin.js#L48" }, "return": { "type": { "text": "() => void" } } }, { "name": "scheduleHideTooltip", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/TooltipTriggerMixin.js#L53" }, "return": { "type": { "text": "(type: \"mouse\" | \"touch\" | \"keyboard\") => void" } } }, { "name": "scheduleShowTooltip", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/TooltipTriggerMixin.js#L78" }, "return": { "type": { "text": "(type: \"mouse\" | \"touch\" | \"keyboard\") => void" } } }, { "name": "showTooltip", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/TooltipTriggerMixin.js#L100" }, "return": { "type": { "text": "() => void" } } }, { "name": "hideTooltip", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/TooltipTriggerMixin.js#L127" }, "return": { "type": { "text": "(cancelSchedule?: boolean) => void" } } }, { "name": "updateTooltipPosition", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/TooltipTriggerMixin.js#L148" }, "return": { "type": { "text": "(domRect?: DOMRect) => void" } } }, { "name": "recloneTooltip", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/TooltipTriggerMixin.js#L201" }, "return": { "type": { "text": "() => void" } } }, { "name": "closeIfNotHovered", "kind": "method", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/TooltipTriggerMixin.js#L214" }, "return": { "type": { "text": "() => void" } } } ], "mixins": [], "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/TooltipTriggerMixin.js" }, "description": "Adds tooltip scheduling, positioning, and show/hide behavior for host elements.", "attributes": [ { "name": "tooltip", "type": { "text": "string" }, "fieldName": "tooltip" }, { "name": "auto-tooltip", "type": { "text": "boolean" }, "description": "When true, show tooltip automatically on hover/focus", "fieldName": "autoTooltip" } ] } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "default", "module": "mixins/TooltipTriggerMixin.js" } } ] }, { "kind": "javascript-module", "path": "mixins/TouchTargetMixin.js", "declarations": [ { "kind": "mixin", "customElement": true, "name": "default", "parameters": [ { "name": "Base", "type": { "text": "typeof CustomElement" } } ], "return": { "type": { "text": "typeof CustomElement" } }, "members": [], "mixins": [], "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/TouchTargetMixin.js" }, "description": "Provides a visually hidden touch target area to meet touch size recommendations." } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "default", "module": "mixins/TouchTargetMixin.js" } } ] }, { "kind": "javascript-module", "path": "mixins/TypographyMixin.js", "declarations": [ { "kind": "mixin", "customElement": true, "name": "default", "parameters": [ { "name": "Base", "type": { "text": "typeof CustomElement" } } ], "return": { "type": { "text": "typeof CustomElement & Class<{ delegatesFocus: boolean; }, any[]> & Class<{ textPadding: string; textPaddingTop: string; textLeading: string; textPaddingBottom: string; }, any[]> & Class<{ _computedTextPaddingTop: string; _computedTextPaddingBottom: string; _computedTextLeading: string; }, any[]> & Class<{ _beforeStyle: string; _afterStyle: string; }, any[]>" } }, "members": [ { "name": "textPadding", "kind": "field", "description": "General vertical padding for text content (css length)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/TypographyMixin.js#L24" }, "type": { "text": "string" } }, { "name": "textPaddingTop", "kind": "field", "description": "Padding-top override for text content (css length)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/TypographyMixin.js#L26" }, "type": { "text": "string" } }, { "name": "textLeading", "kind": "field", "description": "Line-leading (extra top spacing) for text (css length or 'sp' units)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/TypographyMixin.js#L28" }, "type": { "text": "string" } }, { "name": "textPaddingBottom", "kind": "field", "description": "Padding-bottom override for text content (css length)", "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/TypographyMixin.js#L30" }, "type": { "text": "string" } } ], "mixins": [ { "module": "mixins/DelegatesFocusMixin.js", "name": "default" } ], "source": { "href": "https://github.com/clshortfuse/materialdesignweb/blob/main/mixins/TypographyMixin.js" }, "description": "Provides typographic padding and leading helpers for text content.", "attributes": [ { "name": "text-padding", "type": { "text": "string" }, "description": "General vertical padding for text content (css length)", "fieldName": "textPadding" }, { "name": "text-padding-top", "type": { "text": "string" }, "description": "Padding-top override for text content (css length)", "fieldName": "textPaddingTop" }, { "name": "text-leading", "type": { "text": "string" }, "description": "Line-leading (extra top spacing) for text (css length or 'sp' units)", "fieldName": "textLeading" }, { "name": "text-padding-bottom", "type": { "text": "string" }, "description": "Padding-bottom override for text content (css length)", "fieldName": "textPaddingBottom" } ] } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "default", "module": "mixins/TypographyMixin.js" } } ] } ] }