{
"schemaVersion": "1.0.0",
"readme": "",
"modules": [
{
"kind": "javascript-module",
"path": "utilities/base-path.js",
"declarations": [
{
"kind": "function",
"name": "setBasePath",
"parameters": [
{
"name": "path",
"type": {
"text": "string"
}
}
],
"description": "Sets the library's base path to the specified directory or URL."
},
{
"kind": "function",
"name": "getBasePath",
"parameters": [
{
"name": "subpath",
"default": "''",
"description": "An optional path to append to the base path."
}
],
"description": "Gets the library's base path.\n\nThe base path is used to load assets such as icons and images, so it needs to be set for components to work properly.\nBy default, this script will look for a script ending in webawesome.js or webawesome.loader.js and set the base path\nto the directory that contains that file. To override this behavior, you can add the data-webawesome attribute to any\nelement on the page to point to a local path or a CORS-enabled endpoint, such as a CDN.\n\n \n\nAlternatively, you can set the base path manually using the exported setBasePath() function."
},
{
"kind": "function",
"name": "setIconPath",
"parameters": [
{
"name": "path",
"type": {
"text": "string"
}
}
],
"description": "Sets the path where the default icon library resolves SVG icons from. When set, the default icon library will load\nicons from this path instead of the Font Awesome CDN. The expected directory structure mirrors the Font Awesome SVG\ndownload, e.g. `{path}/solid/house.svg` or `{path}/brands/github.svg`.\n\nThis should be called before Web Awesome components are loaded."
},
{
"kind": "function",
"name": "getIconPath",
"description": "Gets the path where the default icon library resolves SVG icons from. When set, the default icon library will load\nicons from this path instead of the Font Awesome CDN."
},
{
"kind": "function",
"name": "setKitCode",
"parameters": [
{
"name": "code",
"type": {
"text": "string"
}
}
],
"description": "Sets the library's Web Awesome kit code."
},
{
"kind": "function",
"name": "getKitCode",
"description": "Gets the library's Web Awesome kit code.\n\nThe kit code is used to fetch premium assets, so it needs to be set for certain components to work correctly. This\nisn't something we can infer, so the user will need to provide it using the `data-fa-kit-code` attribute. This can\nbe on any element, but ideally it should exist on the script that imports Web Awesome.\n\n \n\nAlternatively, you can set the kit code manually using the exported `setKitCode()` function."
}
],
"exports": [
{
"kind": "js",
"name": "setBasePath",
"declaration": {
"name": "setBasePath",
"module": "utilities/base-path.js"
}
},
{
"kind": "js",
"name": "getBasePath",
"declaration": {
"name": "getBasePath",
"module": "utilities/base-path.js"
}
},
{
"kind": "js",
"name": "setIconPath",
"declaration": {
"name": "setIconPath",
"module": "utilities/base-path.js"
}
},
{
"kind": "js",
"name": "getIconPath",
"declaration": {
"name": "getIconPath",
"module": "utilities/base-path.js"
}
},
{
"kind": "js",
"name": "setKitCode",
"declaration": {
"name": "setKitCode",
"module": "utilities/base-path.js"
}
},
{
"kind": "js",
"name": "getKitCode",
"declaration": {
"name": "getKitCode",
"module": "utilities/base-path.js"
}
}
]
},
{
"kind": "javascript-module",
"path": "events/error.js",
"declarations": [
{
"kind": "class",
"description": "",
"name": "WaErrorEvent",
"superclass": {
"name": "Event",
"module": "src/events/error.ts"
}
}
],
"exports": [
{
"kind": "js",
"name": "WaErrorEvent",
"declaration": {
"name": "WaErrorEvent",
"module": "events/error.js"
}
}
]
},
{
"kind": "javascript-module",
"path": "events/load.js",
"declarations": [
{
"kind": "class",
"description": "",
"name": "WaLoadEvent",
"superclass": {
"name": "Event",
"module": "src/events/load.ts"
}
}
],
"exports": [
{
"kind": "js",
"name": "WaLoadEvent",
"declaration": {
"name": "WaLoadEvent",
"module": "events/load.js"
}
}
]
},
{
"kind": "javascript-module",
"path": "internal/watch.js",
"declarations": [
{
"kind": "function",
"name": "watch",
"parameters": [
{
"name": "propertyName",
"type": {
"text": "string | string[]"
}
},
{
"name": "options",
"optional": true,
"type": {
"text": "WatchOptions"
}
}
],
"description": "Runs when observed properties change, e.g."
}
],
"exports": [
{
"kind": "js",
"name": "watch",
"declaration": {
"name": "watch",
"module": "internal/watch.js"
}
}
]
},
{
"kind": "javascript-module",
"path": "internal/webawesome-element.js",
"declarations": [
{
"kind": "class",
"description": "",
"name": "WebAwesomeElement",
"members": [
{
"kind": "field",
"name": "css",
"type": {
"text": "CSSResultGroup | undefined"
},
"static": true,
"description": "One or more CSSResultGroup to include in the component's shadow root. Host styles are automatically prepended."
},
{
"kind": "field",
"name": "#hasRecordedInitialProperties",
"privacy": "private",
"type": {
"text": "boolean"
},
"default": "false"
},
{
"kind": "field",
"name": "initialReflectedProperties",
"type": {
"text": "Map"
},
"default": "new Map()"
},
{
"kind": "field",
"name": "internals",
"type": {
"text": "ElementInternals"
}
},
{
"kind": "field",
"name": "dir",
"type": {
"text": "string"
},
"attribute": "dir"
},
{
"kind": "field",
"name": "lang",
"type": {
"text": "string"
},
"attribute": "lang"
},
{
"kind": "field",
"name": "didSSR",
"attribute": "did-ssr",
"reflects": true
}
],
"attributes": [
{
"name": "dir",
"type": {
"text": "string"
},
"fieldName": "dir"
},
{
"name": "lang",
"type": {
"text": "string"
},
"fieldName": "lang"
},
{
"name": "did-ssr",
"fieldName": "didSSR"
}
],
"superclass": {
"name": "LitElement",
"package": "lit"
},
"customElement": true,
"modulePath": "internal/webawesome-element.js"
}
],
"exports": [
{
"kind": "js",
"name": "default",
"declaration": {
"name": "WebAwesomeElement",
"module": "internal/webawesome-element.js"
}
}
]
},
{
"kind": "javascript-module",
"path": "components/icon/icon.js",
"declarations": [
{
"kind": "class",
"description": "",
"name": "WaIcon",
"cssProperties": [
{
"description": "Sets when the animation will start.",
"name": "--animation-delay",
"default": "0"
},
{
"description": "Defines whether or not the animation should play in reverse on alternate cycles.",
"name": "--animation-direction",
"default": "normal"
},
{
"description": "Defines the length of time that an animation takes to complete one cycle.",
"name": "--animation-duration",
"default": "1s"
},
{
"description": "Defines the number of times an animation cycle is played.",
"name": "--animation-iteration-count",
"default": "infinite"
},
{
"description": "Describes how the animation will progress over one cycle of its duration.",
"name": "--animation-timing"
},
{
"description": "Set lowest opacity value an icon with `beat-fade` animation will fade to and from.",
"name": "--beat-fade-opacity"
},
{
"description": "Set max value that an icon with `beat-fade` animation will scale.",
"name": "--beat-fade-scale"
},
{
"description": "Set max value that an icon with `beat` animation will scale.",
"name": "--beat-scale"
},
{
"description": "Set the max height an icon with `bounce` animation will jump to when bouncing.",
"name": "--bounce-height"
},
{
"description": "Set the icon’s horizontal distortion (“squish”) at the top of the jump.",
"name": "--bounce-jump-scale-x"
},
{
"description": "Set the icon’s vertical distortion (“squish”) at the top of the jump.",
"name": "--bounce-jump-scale-y"
},
{
"description": "Set the icon’s horizontal distortion (“squish”) when landing after the jump.",
"name": "--bounce-land-scale-x"
},
{
"description": "Set the icon’s vertical distortion (“squish”) when landing after the jump.",
"name": "--bounce-land-scale-y"
},
{
"description": "Set the amount of rebound an icon with `bounce` animation has when landing after the jump.",
"name": "--bounce-rebound"
},
{
"description": "Set the icon’s horizontal distortion (“squish”) when starting to bounce.",
"name": "--bounce-start-scale-x"
},
{
"description": "Set the icon’s vertical distortion (“squish”) when starting to bounce.",
"name": "--bounce-start-scale-y"
},
{
"description": "Set lowest opacity value an icon with `fade` animation will fade to and from.",
"name": "--fade-opacity"
},
{
"description": "Set rotation angle of flip for an icon with `flip` animation. A positive angle denotes a clockwise rotation, a negative angle a counter-clockwise one.",
"name": "--flip-angle"
},
{
"description": "Set x-coordinate of the vector denoting the axis of rotation (between 0 and 1) for an icon with `flip` animation.",
"name": "--flip-x"
},
{
"description": "Set y-coordinate of the vector denoting the axis of rotation (between 0 and 1) for an icon with `flip` animation.",
"name": "--flip-y"
},
{
"description": "Set z-coordinate of the vector denoting the axis of rotation (between 0 and 1) for an icon with `flip` animation.",
"name": "--flip-z"
},
{
"description": "Sets a duotone icon's primary color.",
"name": "--primary-color",
"default": "currentColor"
},
{
"description": "Sets a duotone icon's primary opacity.",
"name": "--primary-opacity",
"default": "1"
},
{
"description": "Sets a duotone icon's secondary color.",
"name": "--secondary-color",
"default": "currentColor"
},
{
"description": "Sets a duotone icon's secondary opacity.",
"name": "--secondary-opacity",
"default": "0.4"
}
],
"cssParts": [
{
"description": "The internal SVG element.",
"name": "svg"
},
{
"description": "The `` element generated when using `spriteSheet: true`",
"name": "use"
}
],
"members": [
{
"kind": "field",
"name": "css",
"type": {
"text": "CSSResultGroup | undefined"
},
"static": true,
"description": "One or more CSSResultGroup to include in the component's shadow root. Host styles are automatically prepended.",
"default": "styles",
"inheritedFrom": {
"name": "WebAwesomeElement",
"module": "internal/webawesome-element.js"
}
},
{
"kind": "field",
"name": "svg",
"type": {
"text": "SVGElement | HTMLTemplateResult | null"
},
"privacy": "private",
"default": "null"
},
{
"kind": "field",
"name": "name",
"type": {
"text": "string | undefined"
},
"description": "The name of the icon to draw. Available names depend on the icon library being used.",
"attribute": "name",
"reflects": true
},
{
"kind": "field",
"name": "family",
"type": {
"text": "string"
},
"description": "The family of icons to choose from. For Font Awesome Free, valid options include `classic` and `brands`. For\nFont Awesome Pro subscribers, valid options include, `classic`, `sharp`, `duotone`, `sharp-duotone`, and `brands`.\nA valid kit code must be present to show pro icons via CDN. You can set `` to provide\none.",
"attribute": "family",
"reflects": true
},
{
"kind": "field",
"name": "variant",
"type": {
"text": "string"
},
"description": "The name of the icon's variant. For Font Awesome, valid options include `thin`, `light`, `regular`, and `solid` for\nthe `classic` and `sharp` families. Some variants require a Font Awesome Pro subscription. Custom icon libraries\nmay or may not use this property.",
"attribute": "variant",
"reflects": true
},
{
"kind": "field",
"name": "autoWidth",
"type": {
"text": "boolean"
},
"default": "false",
"description": "Sets the width of the icon to match the cropped SVG viewBox. This operates like the Font `fa-width-auto` class.",
"attribute": "auto-width",
"reflects": true
},
{
"kind": "field",
"name": "swapOpacity",
"type": {
"text": "boolean"
},
"default": "false",
"description": "Swaps the opacity of duotone icons.",
"attribute": "swap-opacity",
"reflects": true
},
{
"kind": "field",
"name": "src",
"type": {
"text": "string | undefined"
},
"description": "An external URL of an SVG file. Be sure you trust the content you are including, as it will be executed as code and\ncan result in XSS attacks.",
"attribute": "src"
},
{
"kind": "field",
"name": "label",
"type": {
"text": "string"
},
"default": "''",
"description": "An alternate description to use for assistive devices. If omitted, the icon will be considered presentational and\nignored by assistive devices.",
"attribute": "label"
},
{
"kind": "field",
"name": "library",
"type": {
"text": "string"
},
"default": "'default'",
"description": "The name of a registered custom icon library.",
"attribute": "library",
"reflects": true
},
{
"kind": "field",
"name": "rotate",
"type": {
"text": "number"
},
"default": "0",
"description": "Sets the rotation degree of the icon",
"attribute": "rotate",
"reflects": true
},
{
"kind": "field",
"name": "flip",
"type": {
"text": "'x' | 'y' | 'both' | undefined"
},
"description": "Sets the flip direction of the icon along the 'x' (horizontal), 'y' (vertical), or 'both' axes.",
"attribute": "flip",
"reflects": true
},
{
"kind": "field",
"name": "animation",
"type": {
"text": "IconAnimation | undefined"
},
"description": "Sets the animation for the icon",
"attribute": "animation",
"reflects": true,
"parsedType": {
"text": "'beat' | 'fade' | 'beat-fade' | 'bounce' | 'flip' | 'shake' | 'spin' | 'spin-pulse' | 'spin-reverse' | undefined"
}
},
{
"kind": "method",
"name": "getIconSource",
"privacy": "private",
"return": {
"type": {
"text": "Promise"
}
}
},
{
"kind": "field",
"name": "resolveIcon",
"privacy": "private",
"description": "Given a URL, this function returns the resulting SVG element or an appropriate error symbol."
},
{
"kind": "method",
"name": "handleLabelChange",
"type": {
"text": "handleLabelChange() => void"
}
},
{
"kind": "method",
"name": "setIcon",
"type": {
"text": "setIcon() => void"
}
},
{
"kind": "field",
"name": "#hasRecordedInitialProperties",
"privacy": "private",
"type": {
"text": "boolean"
},
"default": "false",
"inheritedFrom": {
"name": "WebAwesomeElement",
"module": "internal/webawesome-element.js"
}
},
{
"kind": "field",
"name": "initialReflectedProperties",
"type": {
"text": "Map"
},
"default": "new Map()",
"inheritedFrom": {
"name": "WebAwesomeElement",
"module": "internal/webawesome-element.js"
}
},
{
"kind": "field",
"name": "internals",
"type": {
"text": "ElementInternals"
},
"inheritedFrom": {
"name": "WebAwesomeElement",
"module": "internal/webawesome-element.js"
}
},
{
"kind": "field",
"name": "dir",
"type": {
"text": "string"
},
"attribute": "dir",
"inheritedFrom": {
"name": "WebAwesomeElement",
"module": "internal/webawesome-element.js"
}
},
{
"kind": "field",
"name": "lang",
"type": {
"text": "string"
},
"attribute": "lang",
"inheritedFrom": {
"name": "WebAwesomeElement",
"module": "internal/webawesome-element.js"
}
},
{
"kind": "field",
"name": "didSSR",
"attribute": "did-ssr",
"reflects": true,
"inheritedFrom": {
"name": "WebAwesomeElement",
"module": "internal/webawesome-element.js"
}
}
],
"events": [
{
"description": "Emitted when the icon has loaded. When using `spriteSheet: true` this will not emit.",
"name": "wa-load",
"reactName": "onWaLoad",
"eventName": "WaLoadEvent"
},
{
"description": "Emitted when the icon fails to load due to an error. When using `spriteSheet: true` this will not emit.",
"name": "wa-error",
"reactName": "onWaError",
"eventName": "WaErrorEvent"
}
],
"attributes": [
{
"name": "name",
"type": {
"text": "string | undefined"
},
"description": "The name of the icon to draw. Available names depend on the icon library being used.",
"fieldName": "name"
},
{
"name": "family",
"type": {
"text": "string"
},
"description": "The family of icons to choose from. For Font Awesome Free, valid options include `classic` and `brands`. For\nFont Awesome Pro subscribers, valid options include, `classic`, `sharp`, `duotone`, `sharp-duotone`, and `brands`.\nA valid kit code must be present to show pro icons via CDN. You can set `` to provide\none.",
"fieldName": "family"
},
{
"name": "variant",
"type": {
"text": "string"
},
"description": "The name of the icon's variant. For Font Awesome, valid options include `thin`, `light`, `regular`, and `solid` for\nthe `classic` and `sharp` families. Some variants require a Font Awesome Pro subscription. Custom icon libraries\nmay or may not use this property.",
"fieldName": "variant"
},
{
"name": "auto-width",
"type": {
"text": "boolean"
},
"default": "false",
"description": "Sets the width of the icon to match the cropped SVG viewBox. This operates like the Font `fa-width-auto` class.",
"fieldName": "autoWidth"
},
{
"name": "swap-opacity",
"type": {
"text": "boolean"
},
"default": "false",
"description": "Swaps the opacity of duotone icons.",
"fieldName": "swapOpacity"
},
{
"name": "src",
"type": {
"text": "string | undefined"
},
"description": "An external URL of an SVG file. Be sure you trust the content you are including, as it will be executed as code and\ncan result in XSS attacks.",
"fieldName": "src"
},
{
"name": "label",
"type": {
"text": "string"
},
"default": "''",
"description": "An alternate description to use for assistive devices. If omitted, the icon will be considered presentational and\nignored by assistive devices.",
"fieldName": "label"
},
{
"name": "library",
"type": {
"text": "string"
},
"default": "'default'",
"description": "The name of a registered custom icon library.",
"fieldName": "library"
},
{
"name": "rotate",
"type": {
"text": "number"
},
"default": "0",
"description": "Sets the rotation degree of the icon",
"fieldName": "rotate"
},
{
"name": "flip",
"type": {
"text": "'x' | 'y' | 'both' | undefined"
},
"description": "Sets the flip direction of the icon along the 'x' (horizontal), 'y' (vertical), or 'both' axes.",
"fieldName": "flip"
},
{
"name": "animation",
"type": {
"text": "IconAnimation | undefined"
},
"description": "Sets the animation for the icon",
"fieldName": "animation",
"parsedType": {
"text": "'beat' | 'fade' | 'beat-fade' | 'bounce' | 'flip' | 'shake' | 'spin' | 'spin-pulse' | 'spin-reverse' | undefined"
}
},
{
"name": "dir",
"type": {
"text": "string"
},
"fieldName": "dir",
"inheritedFrom": {
"name": "WebAwesomeElement",
"module": "src/internal/webawesome-element.ts"
}
},
{
"name": "lang",
"type": {
"text": "string"
},
"fieldName": "lang",
"inheritedFrom": {
"name": "WebAwesomeElement",
"module": "src/internal/webawesome-element.ts"
}
},
{
"name": "did-ssr",
"fieldName": "didSSR",
"inheritedFrom": {
"name": "WebAwesomeElement",
"module": "src/internal/webawesome-element.ts"
}
}
],
"superclass": {
"name": "WebAwesomeElement",
"module": "/src/internal/webawesome-element.js"
},
"summary": "Icons are scalable vector symbols that represent actions, content, or status throughout your application.\nThey support Font Awesome and custom icon libraries with animation presets.",
"jsDoc": "/**\n * @summary Icons are scalable vector symbols that represent actions, content, or status throughout your application.\n * They support Font Awesome and custom icon libraries with animation presets.\n * @documentation https://webawesome.com/docs/components/icon\n * @status stable\n * @since 2.0\n *\n * @event wa-load - Emitted when the icon has loaded. When using `spriteSheet: true` this will not emit.\n * @event wa-error - Emitted when the icon fails to load due to an error. When using `spriteSheet: true` this will not emit.\n *\n * @csspart svg - The internal SVG element.\n * @csspart use - The `` element generated when using `spriteSheet: true`\n *\n * @cssproperty [--animation-delay=0] Sets when the animation will start.\n * @cssproperty [--animation-direction=normal] Defines whether or not the animation should play in reverse on alternate cycles.\n * @cssproperty [--animation-duration=1s] Defines the length of time that an animation takes to complete one cycle.\n * @cssproperty [--animation-iteration-count=infinite] Defines the number of times an animation cycle is played.\n * @cssproperty [--animation-timing] Describes how the animation will progress over one cycle of its duration.\n * @cssproperty [--beat-fade-opacity] Set lowest opacity value an icon with `beat-fade` animation will fade to and from.\n * @cssproperty [--beat-fade-scale] Set max value that an icon with `beat-fade` animation will scale.\n * @cssproperty [--beat-scale] Set max value that an icon with `beat` animation will scale.\n * @cssproperty [--bounce-height] Set the max height an icon with `bounce` animation will jump to when bouncing.\n * @cssproperty [--bounce-jump-scale-x] Set the icon’s horizontal distortion (“squish”) at the top of the jump.\n * @cssproperty [--bounce-jump-scale-y] Set the icon’s vertical distortion (“squish”) at the top of the jump.\n * @cssproperty [--bounce-land-scale-x] Set the icon’s horizontal distortion (“squish”) when landing after the jump.\n * @cssproperty [--bounce-land-scale-y] Set the icon’s vertical distortion (“squish”) when landing after the jump.\n * @cssproperty [--bounce-rebound] Set the amount of rebound an icon with `bounce` animation has when landing after the jump.\n * @cssproperty [--bounce-start-scale-x] Set the icon’s horizontal distortion (“squish”) when starting to bounce.\n * @cssproperty [--bounce-start-scale-y] Set the icon’s vertical distortion (“squish”) when starting to bounce.\n * @cssproperty [--fade-opacity] Set lowest opacity value an icon with `fade` animation will fade to and from.\n * @cssproperty [--flip-angle] Set rotation angle of flip for an icon with `flip` animation. A positive angle denotes a clockwise rotation, a negative angle a counter-clockwise one.\n * @cssproperty [--flip-x] Set x-coordinate of the vector denoting the axis of rotation (between 0 and 1) for an icon with `flip` animation.\n * @cssproperty [--flip-y] Set y-coordinate of the vector denoting the axis of rotation (between 0 and 1) for an icon with `flip` animation.\n * @cssproperty [--flip-z] Set z-coordinate of the vector denoting the axis of rotation (between 0 and 1) for an icon with `flip` animation.\n * @cssproperty [--primary-color=currentColor] - Sets a duotone icon's primary color.\n * @cssproperty [--primary-opacity=1] - Sets a duotone icon's primary opacity.\n * @cssproperty [--secondary-color=currentColor] - Sets a duotone icon's secondary color.\n * @cssproperty [--secondary-opacity=0.4] - Sets a duotone icon's secondary opacity.\n */",
"documentation": "https://webawesome.com/docs/components/icon",
"status": "stable",
"since": "2.0",
"tagName": "wa-icon",
"customElement": true,
"modulePath": "components/icon/icon.js",
"definitionPath": "components/icon/icon.js",
"cssStates": [],
"slots": []
}
],
"exports": [
{
"kind": "js",
"name": "default",
"declaration": {
"name": "WaIcon",
"module": "components/icon/icon.js"
}
},
{
"kind": "custom-element-definition",
"name": "wa-icon",
"declaration": {
"name": "WaIcon",
"module": "components/icon/icon.js"
}
}
]
},
{
"kind": "javascript-module",
"path": "components/icon/library.system.js",
"declarations": [
{
"kind": "variable",
"name": "icons",
"type": {
"text": "{ [key: string]: { [key: string]: string } }"
},
"default": "{ // // Solid variant // solid: { backward: `"
}
}
],
"description": "Adds an icon library to the registry, or overrides an existing one."
},
{
"kind": "function",
"name": "unregisterIconLibrary",
"parameters": [
{
"name": "name",
"type": {
"text": "string"
}
}
],
"description": "Removes an icon library from the registry."
},
{
"kind": "function",
"name": "setDefaultIconFamily",
"parameters": [
{
"name": "family",
"type": {
"text": "string"
}
}
],
"description": "Sets the default icon family."
},
{
"kind": "function",
"name": "getDefaultIconFamily",
"description": "Gets the default icon family."
}
],
"exports": [
{
"kind": "js",
"name": "watchIcon",
"declaration": {
"name": "watchIcon",
"module": "components/icon/library.js"
}
},
{
"kind": "js",
"name": "unwatchIcon",
"declaration": {
"name": "unwatchIcon",
"module": "components/icon/library.js"
}
},
{
"kind": "js",
"name": "getIconLibrary",
"declaration": {
"name": "getIconLibrary",
"module": "components/icon/library.js"
}
},
{
"kind": "js",
"name": "registerIconLibrary",
"declaration": {
"name": "registerIconLibrary",
"module": "components/icon/library.js"
}
},
{
"kind": "js",
"name": "unregisterIconLibrary",
"declaration": {
"name": "unregisterIconLibrary",
"module": "components/icon/library.js"
}
},
{
"kind": "js",
"name": "setDefaultIconFamily",
"declaration": {
"name": "setDefaultIconFamily",
"module": "components/icon/library.js"
}
},
{
"kind": "js",
"name": "getDefaultIconFamily",
"declaration": {
"name": "getDefaultIconFamily",
"module": "components/icon/library.js"
}
}
]
},
{
"kind": "javascript-module",
"path": "components/icon/library.default.js",
"declarations": [
{
"kind": "function",
"name": "getIconFolder",
"parameters": [
{
"name": "_name",
"type": {
"text": "string"
}
},
{
"name": "family",
"type": {
"text": "string"
}
},
{
"name": "variant",
"type": {
"text": "string"
}
}
],
"description": "Returns the folder name used by Font Awesome for a given icon family and variant combination."
},
{
"kind": "variable",
"name": "library",
"type": {
"text": "IconLibrary"
},
"default": "{ name: 'default', resolver: (name: string, family = 'classic', variant = 'solid') => { return getIconUrl(name, family, variant); }, mutator: (svg, hostEl) => { // Duotone families if (hostEl?.family && !svg.hasAttribute('data-duotone-initialized')) { const { family, variant } = hostEl; if ( // Duotone family === 'duotone' || // Sharp duotone family === 'sharp-duotone' || // Notdog duo (correct usage: family=\"notdog-duo\") family === 'notdog-duo' || // NOTE: family=\"notdog\" variant=\"duo-solid\" is deprecated (family === 'notdog' && variant === 'duo-solid') || // Jelly duo (correct usage: family=\"jelly-duo\") family === 'jelly-duo' || // NOTE: family=\"jelly\" variant=\"duo-regular\" is deprecated (family === 'jelly' && variant === 'duo-regular') || // Utility duo (correct usage: family=\"utility-duo\") family === 'utility-duo' || // Thumbprint family === 'thumbprint' ) { // Identify the primary and secondary paths. The secondary path is the one that has an opacity attribute. const paths = [...svg.querySelectorAll('path')]; const primaryPath = paths.find(p => !p.hasAttribute('opacity')); const secondaryPath = paths.find(p => p.hasAttribute('opacity')); if (!primaryPath || !secondaryPath) return; primaryPath.setAttribute('data-duotone-primary', ''); secondaryPath.setAttribute('data-duotone-secondary', ''); // Swap the primary and secondary opacity using CSS custom properties if (hostEl.swapOpacity && primaryPath && secondaryPath) { const originalOpacity = secondaryPath.getAttribute('opacity') || '0.4'; // Set path-specific opacity custom properties primaryPath.style.setProperty('--path-opacity', originalOpacity); secondaryPath.style.setProperty('--path-opacity', '1'); } svg.setAttribute('data-duotone-initialized', ''); } } }, }"
}
],
"exports": [
{
"kind": "js",
"name": "getIconFolder",
"declaration": {
"name": "getIconFolder",
"module": "components/icon/library.default.js"
}
},
{
"kind": "js",
"name": "default",
"declaration": {
"name": "library",
"module": "components/icon/library.default.js"
}
}
]
},
{
"kind": "javascript-module",
"path": "utilities/autoloader.js",
"declarations": [
{
"kind": "function",
"name": "startLoader",
"description": "Starts the autoloader."
},
{
"kind": "function",
"name": "stopLoader",
"description": "Stops the autoloader"
},
{
"kind": "function",
"name": "discover",
"parameters": [
{
"name": "root",
"type": {
"text": "Document | Element | ShadowRoot"
}
}
],
"description": "Checks a node for undefined elements and attempts to register them."
},
{
"kind": "function",
"name": "preventTurboFouce",
"parameters": [
{
"name": "timeout",
"default": "2000"
}
],
"description": "Acts as a middleware for Turbo's `turbo:before-render` event to ensure components are auto-loaded before showing the\nnext page, eliminating page-to-page FOUCE in a Turbo environment."
}
],
"exports": [
{
"kind": "js",
"name": "startLoader",
"declaration": {
"name": "startLoader",
"module": "utilities/autoloader.js"
}
},
{
"kind": "js",
"name": "stopLoader",
"declaration": {
"name": "stopLoader",
"module": "utilities/autoloader.js"
}
},
{
"kind": "js",
"name": "discover",
"declaration": {
"name": "discover",
"module": "utilities/autoloader.js"
}
},
{
"kind": "js",
"name": "preventTurboFouce",
"declaration": {
"name": "preventTurboFouce",
"module": "utilities/autoloader.js"
}
}
]
},
{
"kind": "javascript-module",
"path": "utilities/defined.js",
"declarations": [
{
"kind": "function",
"name": "allDefined",
"parameters": [
{
"name": "options",
"optional": true,
"type": {
"text": "Partial"
}
}
],
"description": "Waits for custom elements that are currently on the page to be registered before resolving. This is sugar for\nawaiting `customElements.whenDefined()` multiple times. By default, the function waits for all undefined Web Awesome\nelements, but you can pass a custom match function to wait for other custom elements instead.\n\nThe function returns with `Promise.all()`, so any loading errors will cause it to reject. Make sure you handle errors\naccordingly using a try/catch block or a `.catch()`."
}
],
"exports": [
{
"kind": "js",
"name": "allDefined",
"declaration": {
"name": "allDefined",
"module": "utilities/defined.js"
}
}
]
},
{
"kind": "javascript-module",
"path": "translations/en.js",
"declarations": [
{
"kind": "variable",
"name": "translation",
"type": {
"text": "Translation"
},
"default": "{ $code: 'en', $name: 'English', $dir: 'ltr', carousel: 'Carousel', captions: 'Captions', clearEntry: 'Clear entry', close: 'Close', createOption: value => `Create \"${value}\"`, copied: 'Copied', copy: 'Copy', currentValue: 'Current value', dropFileHere: 'Drop file here or click to browse', decrement: 'Decrement', dropFilesHere: 'Drop files here or click to browse', error: 'Error', enterFullscreen: 'Enter fullscreen', exitFullscreen: 'Exit fullscreen', goToSlide: (slide, count) => `Go to slide ${slide} of ${count}`, hidePassword: 'Hide password', increment: 'Increment', loading: 'Loading', moreOptions: 'More Options', mute: 'Mute', nextSlide: 'Next slide', nextVideo: 'Next Video', numCharacters: num => { if (num === 1) return '1 character'; return `${num} characters`; }, numCharactersRemaining: num => { if (num === 1) return '1 character remaining'; return `${num} characters remaining`; }, numOptionsSelected: num => { if (num === 0) return 'No options selected'; if (num === 1) return '1 option selected'; return `${num} options selected`; }, pause: 'Pause', pauseAnimation: 'Pause animation', pictureInPicture: 'Picture in picture', play: 'Play', playbackSpeed: 'Playback speed', playlist: 'Playlist', playAnimation: 'Play animation', previousSlide: 'Previous slide', previousVideo: 'Previous video', progress: 'Progress', remove: 'Remove', resize: 'Resize', scrollableRegion: 'Scrollable region', scrollToEnd: 'Scroll to end', scrollToStart: 'Scroll to start', selectAColorFromTheScreen: 'Select a color from the screen', showPassword: 'Show password', slideNum: slide => `Slide ${slide}`, toggleColorFormat: 'Toggle color format', seek: 'Seek', seekProgress: (current, duration) => `${current} of ${duration}`, currentlyPlaying: 'currently playing', unmute: 'Unmute', videoPlayer: 'Video player', volume: 'Volume', zoomIn: 'Zoom in', zoomOut: 'Zoom out', }"
}
],
"exports": [
{
"kind": "js",
"name": "default",
"declaration": {
"name": "translation",
"module": "translations/en.js"
}
}
]
},
{
"kind": "javascript-module",
"path": "utilities/localize.js",
"declarations": [
{
"kind": "class",
"description": "",
"name": "LocalizeController",
"superclass": {
"name": "DefaultLocalizationController",
"package": "@shoelace-style/localize"
}
}
],
"exports": [
{
"kind": "js",
"name": "LocalizeController",
"declaration": {
"name": "LocalizeController",
"module": "utilities/localize.js"
}
},
{
"kind": "js",
"name": "registerTranslation",
"declaration": {
"name": "registerTranslation",
"package": "@shoelace-style/localize"
}
}
]
},
{
"kind": "javascript-module",
"path": "components/animation/animations.js",
"declarations": [
{
"kind": "function",
"name": "getAnimationNames",
"description": "Gets a list of all supported animation names."
},
{
"kind": "function",
"name": "getEasingNames",
"description": "Gets a list of all supported easing function names."
}
],
"exports": [
{
"kind": "js",
"name": "animations",
"declaration": {
"name": "animations",
"module": "components/animation/animations.js"
}
},
{
"kind": "js",
"name": "getAnimationNames",
"declaration": {
"name": "getAnimationNames",
"module": "components/animation/animations.js"
}
},
{
"kind": "js",
"name": "getEasingNames",
"declaration": {
"name": "getEasingNames",
"module": "components/animation/animations.js"
}
}
]
},
{
"kind": "javascript-module",
"path": "utilities/animation.js",
"declarations": [],
"exports": [
{
"kind": "js",
"name": "getAnimationNames",
"declaration": {
"name": "getAnimationNames",
"module": "../components/animation/animations.js"
}
},
{
"kind": "js",
"name": "getEasingNames",
"declaration": {
"name": "getEasingNames",
"module": "../components/animation/animations.js"
}
}
]
},
{
"kind": "javascript-module",
"path": "utilities/form.js",
"declarations": [
{
"kind": "function",
"name": "serialize",
"parameters": [
{
"name": "form",
"type": {
"text": "HTMLFormElement"
}
}
],
"description": "Serializes a form and returns a plain object. If a form control with the same name appears more than once, the\nproperty will be converted to an array."
}
],
"exports": [
{
"kind": "js",
"name": "serialize",
"declaration": {
"name": "serialize",
"module": "utilities/form.js"
}
}
]
},
{
"kind": "javascript-module",
"path": "events/after-collapse.js",
"declarations": [
{
"kind": "class",
"description": "",
"name": "WaAfterCollapseEvent",
"superclass": {
"name": "Event",
"module": "src/events/after-collapse.ts"
}
}
],
"exports": [
{
"kind": "js",
"name": "WaAfterCollapseEvent",
"declaration": {
"name": "WaAfterCollapseEvent",
"module": "events/after-collapse.js"
}
}
]
},
{
"kind": "javascript-module",
"path": "events/after-expand.js",
"declarations": [
{
"kind": "class",
"description": "",
"name": "WaAfterExpandEvent",
"superclass": {
"name": "Event",
"module": "src/events/after-expand.ts"
}
}
],
"exports": [
{
"kind": "js",
"name": "WaAfterExpandEvent",
"declaration": {
"name": "WaAfterExpandEvent",
"module": "events/after-expand.js"
}
}
]
},
{
"kind": "javascript-module",
"path": "events/after-hide.js",
"declarations": [
{
"kind": "class",
"description": "",
"name": "WaAfterHideEvent",
"superclass": {
"name": "Event",
"module": "src/events/after-hide.ts"
}
}
],
"exports": [
{
"kind": "js",
"name": "WaAfterHideEvent",
"declaration": {
"name": "WaAfterHideEvent",
"module": "events/after-hide.js"
}
}
]
},
{
"kind": "javascript-module",
"path": "events/after-show.js",
"declarations": [
{
"kind": "class",
"description": "",
"name": "WaAfterShowEvent",
"superclass": {
"name": "Event",
"module": "src/events/after-show.ts"
}
}
],
"exports": [
{
"kind": "js",
"name": "WaAfterShowEvent",
"declaration": {
"name": "WaAfterShowEvent",
"module": "events/after-show.js"
}
}
]
},
{
"kind": "javascript-module",
"path": "events/cancel.js",
"declarations": [
{
"kind": "class",
"description": "",
"name": "WaCancelEvent",
"superclass": {
"name": "Event",
"module": "src/events/cancel.ts"
}
}
],
"exports": [
{
"kind": "js",
"name": "WaCancelEvent",
"declaration": {
"name": "WaCancelEvent",
"module": "events/cancel.js"
}
}
]
},
{
"kind": "javascript-module",
"path": "events/clear.js",
"declarations": [
{
"kind": "class",
"description": "",
"name": "WaClearEvent",
"superclass": {
"name": "Event",
"module": "src/events/clear.ts"
}
}
],
"exports": [
{
"kind": "js",
"name": "WaClearEvent",
"declaration": {
"name": "WaClearEvent",
"module": "events/clear.js"
}
}
]
},
{
"kind": "javascript-module",
"path": "events/collapse.js",
"declarations": [
{
"kind": "class",
"description": "",
"name": "WaCollapseEvent",
"superclass": {
"name": "Event",
"module": "src/events/collapse.ts"
}
}
],
"exports": [
{
"kind": "js",
"name": "WaCollapseEvent",
"declaration": {
"name": "WaCollapseEvent",
"module": "events/collapse.js"
}
}
]
},
{
"kind": "javascript-module",
"path": "events/copy.js",
"declarations": [
{
"kind": "class",
"description": "",
"name": "WaCopyEvent",
"members": [
{
"kind": "field",
"name": "detail",
"type": {
"text": "WaCopyErrorEventDetail"
},
"readonly": true,
"default": "detail"
}
],
"superclass": {
"name": "Event",
"module": "src/events/copy.ts"
}
}
],
"exports": [
{
"kind": "js",
"name": "WaCopyEvent",
"declaration": {
"name": "WaCopyEvent",
"module": "events/copy.js"
}
}
]
},
{
"kind": "javascript-module",
"path": "events/create.js",
"declarations": [
{
"kind": "class",
"description": "",
"name": "WaCreateEvent",
"members": [
{
"kind": "field",
"name": "detail",
"readonly": true,
"default": "detail"
}
],
"superclass": {
"name": "Event",
"module": "src/events/create.ts"
}
}
],
"exports": [
{
"kind": "js",
"name": "WaCreateEvent",
"declaration": {
"name": "WaCreateEvent",
"module": "events/create.js"
}
}
]
},
{
"kind": "javascript-module",
"path": "events/expand.js",
"declarations": [
{
"kind": "class",
"description": "",
"name": "WaExpandEvent",
"superclass": {
"name": "Event",
"module": "src/events/expand.ts"
}
}
],
"exports": [
{
"kind": "js",
"name": "WaExpandEvent",
"declaration": {
"name": "WaExpandEvent",
"module": "events/expand.js"
}
}
]
},
{
"kind": "javascript-module",
"path": "events/finish.js",
"declarations": [
{
"kind": "class",
"description": "",
"name": "WaFinishEvent",
"superclass": {
"name": "Event",
"module": "src/events/finish.ts"
}
}
],
"exports": [
{
"kind": "js",
"name": "WaFinishEvent",
"declaration": {
"name": "WaFinishEvent",
"module": "events/finish.js"
}
}
]
},
{
"kind": "javascript-module",
"path": "events/hide.js",
"declarations": [
{
"kind": "class",
"description": "",
"name": "WaHideEvent",
"members": [
{
"kind": "field",
"name": "detail",
"type": {
"text": "WaHideEventDetails | undefined"
},
"readonly": true,
"default": "detail"
}
],
"superclass": {
"name": "Event",
"module": "src/events/hide.ts"
}
}
],
"exports": [
{
"kind": "js",
"name": "WaHideEvent",
"declaration": {
"name": "WaHideEvent",
"module": "events/hide.js"
}
}
]
},
{
"kind": "javascript-module",
"path": "events/hover.js",
"declarations": [
{
"kind": "class",
"description": "",
"name": "WaHoverEvent",
"members": [
{
"kind": "field",
"name": "detail",
"type": {
"text": "WaHoverEventDetail"
},
"readonly": true,
"default": "detail"
}
],
"superclass": {
"name": "Event",
"module": "src/events/hover.ts"
}
}
],
"exports": [
{
"kind": "js",
"name": "WaHoverEvent",
"declaration": {
"name": "WaHoverEvent",
"module": "events/hover.js"
}
}
]
},
{
"kind": "javascript-module",
"path": "events/include-error.js",
"declarations": [
{
"kind": "class",
"description": "",
"name": "WaIncludeErrorEvent",
"members": [
{
"kind": "field",
"name": "detail",
"type": {
"text": "WaIncludeErrorDetail"
},
"readonly": true,
"default": "detail"
}
],
"superclass": {
"name": "Event",
"module": "src/events/include-error.ts"
}
}
],
"exports": [
{
"kind": "js",
"name": "WaIncludeErrorEvent",
"declaration": {
"name": "WaIncludeErrorEvent",
"module": "events/include-error.js"
}
}
]
},
{
"kind": "javascript-module",
"path": "events/intersect.js",
"declarations": [
{
"kind": "class",
"description": "Emitted when an element's intersection state changes.",
"name": "WaIntersectEvent",
"members": [
{
"kind": "field",
"name": "detail",
"type": {
"text": "WaIntersectEventDetail | undefined"
},
"readonly": true,
"default": "detail"
}
],
"superclass": {
"name": "Event",
"module": "src/events/intersect.ts"
},
"jsDoc": "/** Emitted when an element's intersection state changes. */"
}
],
"exports": [
{
"kind": "js",
"name": "WaIntersectEvent",
"declaration": {
"name": "WaIntersectEvent",
"module": "events/intersect.js"
}
}
]
},
{
"kind": "javascript-module",
"path": "events/invalid.js",
"declarations": [
{
"kind": "class",
"description": "",
"name": "WaInvalidEvent",
"superclass": {
"name": "Event",
"module": "src/events/invalid.ts"
}
}
],
"exports": [
{
"kind": "js",
"name": "WaInvalidEvent",
"declaration": {
"name": "WaInvalidEvent",
"module": "events/invalid.js"
}
}
]
},
{
"kind": "javascript-module",
"path": "events/lazy-change.js",
"declarations": [
{
"kind": "class",
"description": "",
"name": "WaLazyChangeEvent",
"superclass": {
"name": "Event",
"module": "src/events/lazy-change.ts"
}
}
],
"exports": [
{
"kind": "js",
"name": "WaLazyChangeEvent",
"declaration": {
"name": "WaLazyChangeEvent",
"module": "events/lazy-change.js"
}
}
]
},
{
"kind": "javascript-module",
"path": "events/lazy-load.js",
"declarations": [
{
"kind": "class",
"description": "",
"name": "WaLazyLoadEvent",
"superclass": {
"name": "Event",
"module": "src/events/lazy-load.ts"
}
}
],
"exports": [
{
"kind": "js",
"name": "WaLazyLoadEvent",
"declaration": {
"name": "WaLazyLoadEvent",
"module": "events/lazy-load.js"
}
}
]
},
{
"kind": "javascript-module",
"path": "events/mutation.js",
"declarations": [
{
"kind": "class",
"description": "",
"name": "WaMutationEvent",
"members": [
{
"kind": "field",
"name": "detail",
"type": {
"text": "WaMutationEventDetail"
},
"readonly": true,
"default": "detail"
}
],
"superclass": {
"name": "Event",
"module": "src/events/mutation.ts"
}
}
],
"exports": [
{
"kind": "js",
"name": "WaMutationEvent",
"declaration": {
"name": "WaMutationEvent",
"module": "events/mutation.js"
}
}
]
},
{
"kind": "javascript-module",
"path": "events/remove.js",
"declarations": [
{
"kind": "class",
"description": "",
"name": "WaRemoveEvent",
"superclass": {
"name": "Event",
"module": "src/events/remove.ts"
}
}
],
"exports": [
{
"kind": "js",
"name": "WaRemoveEvent",
"declaration": {
"name": "WaRemoveEvent",
"module": "events/remove.js"
}
}
]
},
{
"kind": "javascript-module",
"path": "events/reposition.js",
"declarations": [
{
"kind": "class",
"description": "",
"name": "WaRepositionEvent",
"superclass": {
"name": "Event",
"module": "src/events/reposition.ts"
}
}
],
"exports": [
{
"kind": "js",
"name": "WaRepositionEvent",
"declaration": {
"name": "WaRepositionEvent",
"module": "events/reposition.js"
}
}
]
},
{
"kind": "javascript-module",
"path": "events/resize.js",
"declarations": [
{
"kind": "class",
"description": "",
"name": "WaResizeEvent",
"members": [
{
"kind": "field",
"name": "detail",
"type": {
"text": "WaResizeEventDetail"
},
"readonly": true,
"default": "detail"
}
],
"superclass": {
"name": "Event",
"module": "src/events/resize.ts"
}
}
],
"exports": [
{
"kind": "js",
"name": "WaResizeEvent",
"declaration": {
"name": "WaResizeEvent",
"module": "events/resize.js"
}
}
]
},
{
"kind": "javascript-module",
"path": "events/select.js",
"declarations": [
{
"kind": "class",
"description": "",
"name": "WaSelectEvent",
"members": [
{
"kind": "field",
"name": "detail",
"readonly": true,
"default": "detail"
}
],
"superclass": {
"name": "Event",
"module": "src/events/select.ts"
}
}
],
"exports": [
{
"kind": "js",
"name": "WaSelectEvent",
"declaration": {
"name": "WaSelectEvent",
"module": "events/select.js"
}
}
]
},
{
"kind": "javascript-module",
"path": "internal/animate.js",
"declarations": [
{
"kind": "function",
"name": "animate",
"parameters": [
{
"name": "el",
"type": {
"text": "Element"
}
},
{
"name": "keyframes",
"type": {
"text": "Keyframe[]"
}
},
{
"name": "options",
"optional": true,
"type": {
"text": "KeyframeAnimationOptions"
}
}
],
"description": "Same as `el.animate()`, except returns a promise that doesn't throw an error when the animation is canceled."
},
{
"kind": "function",
"name": "animateWithClass",
"parameters": [
{
"name": "el",
"type": {
"text": "Element"
}
},
{
"name": "className",
"type": {
"text": "string"
}
}
],
"description": "Applies a class to the specified element to animate it. The class is removed after the animation finishes and then\nthe promise resolves. If a timeout is provided, the class will be removed and the animation will"
},
{
"kind": "function",
"name": "parseDuration",
"parameters": [
{
"name": "duration",
"type": {
"text": "number | string"
}
}
],
"description": "Parses a CSS duration and returns the number of milliseconds."
},
{
"kind": "function",
"name": "prefersReducedMotion",
"description": "Tells if the user has enabled the \"reduced motion\" setting in their browser or OS."
}
],
"exports": [
{
"kind": "js",
"name": "animate",
"declaration": {
"name": "animate",
"module": "internal/animate.js"
}
},
{
"kind": "js",
"name": "animateWithClass",
"declaration": {
"name": "animateWithClass",
"module": "internal/animate.js"
}
},
{
"kind": "js",
"name": "parseDuration",
"declaration": {
"name": "parseDuration",
"module": "internal/animate.js"
}
},
{
"kind": "js",
"name": "prefersReducedMotion",
"declaration": {
"name": "prefersReducedMotion",
"module": "internal/animate.js"
}
}
]
},
{
"kind": "javascript-module",
"path": "internal/size.js",
"declarations": [
{
"kind": "function",
"name": "normalizeSize",
"return": {
"type": {
"text": "Size"
}
},
"parameters": [
{
"name": "size",
"type": {
"text": "SizeWithDeprecated"
}
}
],
"description": "Normalizes a size value, mapping deprecated long forms to short forms. Returns the value unchanged if already canonical."
},
{
"kind": "function",
"name": "warnDeprecatedSize",
"return": {
"type": {
"text": "void"
}
},
"parameters": [
{
"name": "tagName",
"type": {
"text": "string"
}
},
{
"name": "value",
"type": {
"text": "string"
}
}
],
"description": "Emits a one-time console warning for deprecated size values."
}
],
"exports": [
{
"kind": "js",
"name": "normalizeSize",
"declaration": {
"name": "normalizeSize",
"module": "internal/size.js"
}
},
{
"kind": "js",
"name": "warnDeprecatedSize",
"declaration": {
"name": "warnDeprecatedSize",
"module": "internal/size.js"
}
}
]
},
{
"kind": "javascript-module",
"path": "internal/slot.js",
"declarations": [
{
"kind": "class",
"description": "A reactive controller that determines when slots exist.",
"name": "HasSlotController",
"members": [
{
"kind": "field",
"name": "host",
"type": {
"text": "ReactiveControllerHost & Element"
}
},
{
"kind": "field",
"name": "slotNames",
"type": {
"text": "string[]"
},
"default": "slotNames"
},
{
"kind": "method",
"name": "hasDefaultSlot",
"privacy": "private"
},
{
"kind": "method",
"name": "hasNamedSlot",
"privacy": "private",
"parameters": [
{
"name": "name",
"type": {
"text": "string"
}
}
]
},
{
"kind": "method",
"name": "test",
"parameters": [
{
"name": "slotName",
"type": {
"text": "string"
}
}
]
},
{
"kind": "method",
"name": "hostConnected"
},
{
"kind": "method",
"name": "hostDisconnected"
},
{
"kind": "field",
"name": "handleSlotChange",
"privacy": "private"
}
],
"jsDoc": "/** A reactive controller that determines when slots exist. */"
},
{
"kind": "function",
"name": "getInnerHTML",
"return": {
"type": {
"text": "string"
}
},
"parameters": [
{
"name": "nodes",
"type": {
"text": "Iterable"
},
"description": "The list of nodes to iterate over."
},
{
"name": "callback",
"optional": true,
"type": {
"text": "(node: Node) => string | undefined"
},
"description": "A function that can be used to customize the HTML output for specific types of nodes. If the function returns undefined, the default HTML output will be used."
}
],
"description": "Given a list of nodes, this function iterates over all of them and returns the concatenated\nHTML as a string. This is useful for getting the HTML that corresponds to a slot’s assigned nodes (since we can't use slot.innerHTML as an alternative)."
}
],
"exports": [
{
"kind": "js",
"name": "HasSlotController",
"declaration": {
"name": "HasSlotController",
"module": "internal/slot.js"
}
},
{
"kind": "js",
"name": "getInnerHTML",
"declaration": {
"name": "getInnerHTML",
"module": "internal/slot.js"
}
}
]
},
{
"kind": "javascript-module",
"path": "internal/validators/custom-error-validator.js",
"declarations": [
{
"kind": "function",
"name": "CustomErrorValidator",
"return": {
"type": {
"text": "Validator"
}
},
"description": "This validator is for if you have an exact copy of your element in the shadow DOM. Rather than needing\ncustom translations and error messages, you can simply rely on the element \"formControl\" in your shadow dom."
}
],
"exports": [
{
"kind": "js",
"name": "CustomErrorValidator",
"declaration": {
"name": "CustomErrorValidator",
"module": "internal/validators/custom-error-validator.js"
}
}
]
},
{
"kind": "javascript-module",
"path": "internal/webawesome-form-associated-element.js",
"declarations": [
{
"kind": "class",
"description": "",
"name": "WebAwesomeFormAssociatedElement",
"members": [
{
"kind": "field",
"name": "formAssociated",
"type": {
"text": "boolean"
},
"static": true,
"default": "true"
},
{
"kind": "field",
"name": "validators",
"type": {
"text": "Validator[]"
},
"static": true,
"description": "Validators are static because they have `observedAttributes`, essentially attributes to \"watch\"\nfor changes. Whenever these attributes change, we want to be notified and update the validator.",
"readonly": true
},
{
"kind": "field",
"name": "name",
"type": {
"text": "string | null"
},
"default": "null",
"description": "The name of the input, submitted as a name/value pair with form data.",
"attribute": "name",
"reflects": true
},
{
"kind": "field",
"name": "disabled",
"type": {
"text": "boolean"
},
"default": "false",
"description": "Disables the form control.",
"attribute": "disabled"
},
{
"kind": "field",
"name": "required",
"type": {
"text": "boolean"
},
"default": "false"
},
{
"kind": "field",
"name": "assumeInteractionOn",
"type": {
"text": "string[]"
},
"default": "['input']"
},
{
"kind": "field",
"name": "input",
"type": {
"text": "(HTMLElement & { value: unknown }) | HTMLInputElement | HTMLTextAreaElement | undefined"
}
},
{
"kind": "field",
"name": "validators",
"type": {
"text": "Validator[]"
},
"default": "[]"
},
{
"kind": "field",
"name": "valueHasChanged",
"type": {
"text": "boolean"
},
"default": "false"
},
{
"kind": "field",
"name": "hasInteracted",
"type": {
"text": "boolean"
},
"default": "false"
},
{
"kind": "field",
"name": "customError",
"type": {
"text": "string | null"
},
"default": "null",
"attribute": "custom-error",
"reflects": true
},
{
"kind": "field",
"name": "emittedEvents",
"type": {
"text": "string[]"
},
"privacy": "private",
"default": "[]"
},
{
"kind": "field",
"name": "states",
"type": {
"text": "CustomStateSet"
}
},
{
"kind": "field",
"name": "emitInvalid"
},
{
"kind": "field",
"name": "handleInteraction",
"privacy": "private"
},
{
"kind": "field",
"name": "labels",
"readonly": true
},
{
"kind": "method",
"name": "getForm"
},
{
"kind": "field",
"name": "form",
"description": "By default, form controls are associated with the nearest containing `