@playcanvas/web-components 0.15.0 → 0.16.0

package/dist/custom-elements.json

@@ -1554,6 +1554,22 @@
             "module": "src/index.ts"
           }
         },
+        {
+          "kind": "js",
+          "name": "AnimComponentElement",
+          "declaration": {
+            "name": "AnimComponentElement",
+            "module": "src/index.ts"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "AnimClipElement",
+          "declaration": {
+            "name": "AnimClipElement",
+            "module": "src/index.ts"
+          }
+        },
         {
           "kind": "js",
           "name": "ButtonComponentElement",
@@ -5378,6 +5394,522 @@
         }
       ]
     },
+    {
+      "kind": "javascript-module",
+      "path": "src/components/anim-clip.ts",
+      "declarations": [
+        {
+          "kind": "class",
+          "description": "The AnimClipElement interface provides properties and methods for manipulating\n[`<pc-anim-clip>`](https://developer.playcanvas.com/user-manual/web-components/tags/pc-anim-clip/)\nelements. The AnimClipElement interface also inherits the properties and methods of the\nHTMLElement interface.\n\nA clip declares one named animation on its parent `<pc-anim>`. `name` is both the clip's name\nand the track looked up in the clip's source: an explicit `asset` (a `container`, an\n`animation` `.glb`, or an `animclip` JSON), or, without one, the container of the `<pc-model>`\nenclosing the parent `<pc-anim>`. A source holding a single track supplies it whatever it is\nnamed; in a multi-track source the track named `name` is chosen, falling back to the first\nwith a warning. The element becomes ready once its resolved track is assigned.\n",
+          "name": "AnimClipElement",
+          "members": [
+            {
+              "kind": "field",
+              "name": "asset",
+              "description": "Gets the id of the `pc-asset` supplying the clip's track.",
+              "parameters": [
+                {
+                  "description": "The asset id.",
+                  "name": "value"
+                }
+              ],
+              "return": {
+                "type": {
+                  "text": ""
+                }
+              }
+            },
+            {
+              "kind": "field",
+              "name": "closestApp",
+              "type": {
+                "text": "AppElement | null"
+              },
+              "description": "The nearest ancestor `<pc-app>` element, or `null` if this element has no `<pc-app>`\nancestor. The search starts at the parent, so an element never resolves to itself.",
+              "return": {
+                "type": {
+                  "text": ""
+                }
+              },
+              "readonly": true,
+              "inheritedFrom": {
+                "name": "AsyncElement",
+                "module": "src/async-element.ts"
+              }
+            },
+            {
+              "kind": "field",
+              "name": "closestEntity",
+              "type": {
+                "text": "EntityBaseElement | null"
+              },
+              "description": "The nearest ancestor element that fronts an entity — `<pc-entity>` or `<pc-node>` — or\n`null` if this element has no such ancestor. The search starts at the parent, so an element\nnever resolves to itself.",
+              "return": {
+                "type": {
+                  "text": ""
+                }
+              },
+              "readonly": true,
+              "inheritedFrom": {
+                "name": "AsyncElement",
+                "module": "src/async-element.ts"
+              }
+            },
+            {
+              "kind": "field",
+              "name": "loop",
+              "description": "Gets whether the clip loops.",
+              "parameters": [
+                {
+                  "description": "Whether the clip loops.",
+                  "name": "value"
+                }
+              ],
+              "return": {
+                "type": {
+                  "text": ""
+                }
+              }
+            },
+            {
+              "kind": "field",
+              "name": "name",
+              "description": "Gets the name of the clip.",
+              "parameters": [
+                {
+                  "description": "The clip name.",
+                  "name": "value"
+                }
+              ],
+              "return": {
+                "type": {
+                  "text": ""
+                }
+              }
+            },
+            {
+              "kind": "method",
+              "name": "ready",
+              "return": {
+                "type": {
+                  "text": ""
+                }
+              },
+              "description": "Returns a promise that resolves with this element when it's ready. This is the low-level\nprimitive underlying whenReady, which is the recommended way to wait for elements.\n\nReadiness tracks the element's current lifecycle: once a ready element is torn down (for\nexample by removing it from the document), this returns a fresh promise that resolves when\nthe element is next ready. A promise obtained earlier stays resolved — call this again\nafter re-inserting an element rather than reusing a promise from before its removal.",
+              "inheritedFrom": {
+                "name": "AsyncElement",
+                "module": "src/async-element.ts"
+              }
+            },
+            {
+              "kind": "field",
+              "name": "speed",
+              "description": "Gets the playback speed of the clip.",
+              "parameters": [
+                {
+                  "description": "The playback speed.",
+                  "name": "value"
+                }
+              ],
+              "return": {
+                "type": {
+                  "text": ""
+                }
+              }
+            }
+          ],
+          "attributes": [
+            {
+              "name": "asset",
+              "type": {
+                "text": "string"
+              },
+              "fieldName": "asset",
+              "description": "The id of the `pc-asset` supplying the clip's track."
+            },
+            {
+              "name": "loop",
+              "type": {
+                "text": "boolean"
+              },
+              "fieldName": "loop",
+              "default": "true",
+              "description": "Whether the clip loops."
+            },
+            {
+              "name": "name",
+              "type": {
+                "text": "string"
+              },
+              "fieldName": "name",
+              "description": "The name of the clip."
+            },
+            {
+              "name": "speed",
+              "type": {
+                "text": "number"
+              },
+              "fieldName": "speed",
+              "default": "1",
+              "description": "The playback speed of the clip."
+            }
+          ],
+          "superclass": {
+            "name": "AsyncElement",
+            "module": "/src/async-element"
+          },
+          "tagName": "pc-anim-clip",
+          "customElement": true,
+          "events": [
+            {
+              "name": "ready",
+              "type": {
+                "text": "CustomEvent"
+              },
+              "description": "Fired when the element is fully initialized — once per readiness cycle, so an element that is torn down and re-initialized (for example by removing and re-inserting it) fires it again. Bubbles and is composed.",
+              "inheritedFrom": {
+                "name": "AsyncElement",
+                "module": "src/async-element.ts"
+              }
+            }
+          ]
+        }
+      ],
+      "exports": [
+        {
+          "kind": "custom-element-definition",
+          "name": "pc-anim-clip",
+          "declaration": {
+            "name": "AnimClipElement",
+            "module": "src/components/anim-clip.ts"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "AnimClipElement",
+          "declaration": {
+            "name": "AnimClipElement",
+            "module": "src/components/anim-clip.ts"
+          }
+        }
+      ]
+    },
+    {
+      "kind": "javascript-module",
+      "path": "src/components/anim-component.ts",
+      "declarations": [
+        {
+          "kind": "class",
+          "description": "The AnimComponentElement interface provides properties and methods for manipulating\n[`<pc-anim>`](https://developer.playcanvas.com/user-manual/web-components/tags/pc-anim/) elements.\nThe AnimComponentElement interface also inherits the properties and methods of the\nHTMLElement interface.\n\nThe element drives animation clips over the host entity's hierarchy. Clips come from\n`<pc-anim-clip>` children — or, when the element is a direct child of a `<pc-model>` and\ndeclares no clips, every animation of that model's container asset is assigned, named by track\nname, in container order. The first clip plays automatically (opt out with `activate=\"false\"`);\nswitch clips declaratively through the `clip` attribute, or imperatively through play\nand transition. Tracks bind to scene nodes by name, so any hierarchy whose node names\nmatch a clip's curves can be animated — a model's skeleton is simply the common case.\n\nThe engine reports no clip completion: a non-looping clip holds its last pose silently. Poll\nthe underlying AnimComponent (via component) for playback state beyond what\nthis element exposes.\n",
+          "name": "AnimComponentElement",
+          "members": [
+            {
+              "kind": "field",
+              "name": "activate",
+              "description": "Gets whether playback starts automatically once a clip is assigned.",
+              "parameters": [
+                {
+                  "description": "Whether playback starts automatically.",
+                  "name": "value"
+                }
+              ],
+              "return": {
+                "type": {
+                  "text": ""
+                }
+              }
+            },
+            {
+              "kind": "field",
+              "name": "clip",
+              "description": "Gets the name of the active clip.",
+              "parameters": [
+                {
+                  "description": "The name of the active clip.",
+                  "name": "value"
+                }
+              ],
+              "return": {
+                "type": {
+                  "text": ""
+                }
+              }
+            },
+            {
+              "kind": "field",
+              "name": "clips",
+              "type": {
+                "text": "string[]"
+              },
+              "description": "Gets the names of the assigned clips.",
+              "return": {
+                "type": {
+                  "text": ""
+                }
+              },
+              "readonly": true
+            },
+            {
+              "kind": "field",
+              "name": "closestApp",
+              "type": {
+                "text": "AppElement | null"
+              },
+              "description": "The nearest ancestor `<pc-app>` element, or `null` if this element has no `<pc-app>`\nancestor. The search starts at the parent, so an element never resolves to itself.",
+              "return": {
+                "type": {
+                  "text": ""
+                }
+              },
+              "readonly": true,
+              "inheritedFrom": {
+                "name": "AsyncElement",
+                "module": "src/async-element.ts"
+              }
+            },
+            {
+              "kind": "field",
+              "name": "closestEntity",
+              "type": {
+                "text": "EntityBaseElement | null"
+              },
+              "description": "The nearest ancestor element that fronts an entity — `<pc-entity>` or `<pc-node>` — or\n`null` if this element has no such ancestor. The search starts at the parent, so an element\nnever resolves to itself.",
+              "return": {
+                "type": {
+                  "text": ""
+                }
+              },
+              "readonly": true,
+              "inheritedFrom": {
+                "name": "AsyncElement",
+                "module": "src/async-element.ts"
+              }
+            },
+            {
+              "kind": "field",
+              "name": "component",
+              "type": {
+                "text": "Component | null"
+              },
+              "description": "Gets the underlying PlayCanvas anim component.",
+              "return": {
+                "type": {
+                  "text": ""
+                }
+              },
+              "readonly": true,
+              "inheritedFrom": {
+                "name": "ComponentElement",
+                "module": "src/components/component.ts"
+              }
+            },
+            {
+              "kind": "field",
+              "name": "enabled",
+              "description": "Gets the enabled state of the component.",
+              "parameters": [
+                {
+                  "description": "The enabled state of the component.",
+                  "name": "value"
+                }
+              ],
+              "return": {
+                "type": {
+                  "text": ""
+                }
+              },
+              "inheritedFrom": {
+                "name": "ComponentElement",
+                "module": "src/components/component.ts"
+              }
+            },
+            {
+              "kind": "method",
+              "name": "pause",
+              "description": "Pauses playback, preserving the playhead — play resumes from where it stopped."
+            },
+            {
+              "kind": "method",
+              "name": "play",
+              "parameters": [
+                {
+                  "name": "name",
+                  "optional": true,
+                  "type": {
+                    "text": "string"
+                  },
+                  "description": "The name of the clip to play. Resumes the current clip when omitted."
+                }
+              ],
+              "description": "Resumes playback, optionally switching to a named clip first (a hard cut). A name that\nmatches no clip leaves the selection unchanged."
+            },
+            {
+              "kind": "method",
+              "name": "ready",
+              "return": {
+                "type": {
+                  "text": ""
+                }
+              },
+              "description": "Returns a promise that resolves with this element when it's ready. This is the low-level\nprimitive underlying whenReady, which is the recommended way to wait for elements.\n\nReadiness tracks the element's current lifecycle: once a ready element is torn down (for\nexample by removing it from the document), this returns a fresh promise that resolves when\nthe element is next ready. A promise obtained earlier stays resolved — call this again\nafter re-inserting an element rather than reusing a promise from before its removal.",
+              "inheritedFrom": {
+                "name": "AsyncElement",
+                "module": "src/async-element.ts"
+              }
+            },
+            {
+              "kind": "field",
+              "name": "speed",
+              "description": "Gets the playback speed multiplier applied across all clips.",
+              "parameters": [
+                {
+                  "description": "The playback speed multiplier.",
+                  "name": "value"
+                }
+              ],
+              "return": {
+                "type": {
+                  "text": ""
+                }
+              }
+            },
+            {
+              "kind": "method",
+              "name": "transition",
+              "parameters": [
+                {
+                  "name": "name",
+                  "type": {
+                    "text": "string"
+                  },
+                  "description": "The name of the clip to fade to."
+                },
+                {
+                  "name": "time",
+                  "optional": true,
+                  "type": {
+                    "text": "number"
+                  },
+                  "description": "The fade duration in seconds. Defaults to the `transition-time` attribute."
+                }
+              ],
+              "description": "Cross-fades to a named clip and ensures playback is running. A name that matches no clip\nleaves the selection unchanged."
+            },
+            {
+              "kind": "field",
+              "name": "transitionTime",
+              "description": "Gets the cross-fade duration of clip switches made through the `clip` attribute.",
+              "parameters": [
+                {
+                  "description": "The cross-fade duration in seconds.",
+                  "name": "value"
+                }
+              ],
+              "return": {
+                "type": {
+                  "text": ""
+                }
+              }
+            }
+          ],
+          "attributes": [
+            {
+              "name": "activate",
+              "type": {
+                "text": "boolean"
+              },
+              "fieldName": "activate",
+              "default": "true",
+              "description": "Whether playback starts automatically once a clip is assigned."
+            },
+            {
+              "name": "clip",
+              "type": {
+                "text": "string"
+              },
+              "fieldName": "clip",
+              "description": "The name of the active clip."
+            },
+            {
+              "name": "enabled",
+              "type": {
+                "text": "boolean"
+              },
+              "fieldName": "enabled",
+              "default": "true",
+              "description": "The enabled state of the component.",
+              "inheritedFrom": {
+                "name": "ComponentElement",
+                "module": "src/components/component.ts"
+              }
+            },
+            {
+              "name": "speed",
+              "type": {
+                "text": "number"
+              },
+              "fieldName": "speed",
+              "default": "1",
+              "description": "The playback speed multiplier applied across all clips."
+            },
+            {
+              "name": "transition-time",
+              "type": {
+                "text": "number"
+              },
+              "fieldName": "transitionTime",
+              "default": "0",
+              "description": "The cross-fade duration of clip switches made through the `clip` attribute."
+            }
+          ],
+          "superclass": {
+            "name": "ComponentElement",
+            "module": "/src/components/component"
+          },
+          "tagName": "pc-anim",
+          "customElement": true,
+          "events": [
+            {
+              "name": "ready",
+              "type": {
+                "text": "CustomEvent"
+              },
+              "description": "Fired when the element is fully initialized — once per readiness cycle, so an element that is torn down and re-initialized (for example by removing and re-inserting it) fires it again. Bubbles and is composed.",
+              "inheritedFrom": {
+                "name": "AsyncElement",
+                "module": "src/async-element.ts"
+              }
+            }
+          ]
+        }
+      ],
+      "exports": [
+        {
+          "kind": "custom-element-definition",
+          "name": "pc-anim",
+          "declaration": {
+            "name": "AnimComponentElement",
+            "module": "src/components/anim-component.ts"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "AnimComponentElement",
+          "declaration": {
+            "name": "AnimComponentElement",
+            "module": "src/components/anim-component.ts"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "ContainerWithAnimations",
+          "declaration": {
+            "name": "ContainerWithAnimations",
+            "module": "src/components/anim-component.ts"
+          }
+        }
+      ]
+    },
     {
       "kind": "javascript-module",
       "path": "src/components/button-component.ts",

package/dist/index.d.cts

@@ -11,6 +11,8 @@ import { ModuleElement } from './module.cjs';
 import { AppElement } from './app.cjs';
 import { EntityElement } from './entity.cjs';
 import { AssetElement } from './asset.cjs';
+import { AnimComponentElement } from './components/anim-component.cjs';
+import { AnimClipElement } from './components/anim-clip.cjs';
 import { ListenerComponentElement } from './components/listener-component.cjs';
 import { ButtonComponentElement } from './components/button-component.cjs';
 import { CameraComponentElement } from './components/camera-component.cjs';
@@ -47,6 +49,8 @@ declare global {
         scriptnamechange: ScriptNameChangeEvent;
     }
     interface HTMLElementTagNameMap {
+        'pc-anim': AnimComponentElement;
+        'pc-anim-clip': AnimClipElement;
         'pc-app': AppElement;
         'pc-asset': AssetElement;
         'pc-button': ButtonComponentElement;
@@ -78,7 +82,7 @@ declare global {
         'pc-sounds': SoundComponentElement;
     }
 }
-export { AsyncElement, ModuleElement, AppElement, EntityElement, AssetElement, ButtonComponentElement, CameraComponentElement, CollisionComponentElement, ComponentElement, ElementComponentElement, JointComponentElement, LayoutChildComponentElement, LayoutGroupComponentElement, ParticleSystemComponentElement, LightComponentElement, ListenerComponentElement, RenderComponentElement, RigidBodyComponentElement, ScreenComponentElement, ScrollbarComponentElement, ScrollViewComponentElement, ScriptComponentElement, ScriptElement, SoundComponentElement, SoundSlotElement, GSplatComponentElement, EntityBaseElement, MaterialElement, ModelElement, NodeElement, SceneElement, SkyElement, whenReady };
+export { AsyncElement, ModuleElement, AppElement, EntityElement, AssetElement, AnimComponentElement, AnimClipElement, ButtonComponentElement, CameraComponentElement, CollisionComponentElement, ComponentElement, ElementComponentElement, JointComponentElement, LayoutChildComponentElement, LayoutGroupComponentElement, ParticleSystemComponentElement, LightComponentElement, ListenerComponentElement, RenderComponentElement, RigidBodyComponentElement, ScreenComponentElement, ScrollbarComponentElement, ScrollViewComponentElement, ScriptComponentElement, ScriptElement, SoundComponentElement, SoundSlotElement, GSplatComponentElement, EntityBaseElement, MaterialElement, ModelElement, NodeElement, SceneElement, SkyElement, whenReady };
 export type { AsyncElementTagName } from './async-element.cjs';
 export type { HierarchyMaterial, HierarchyNode } from './model.cjs';
 export type { MaterialOverrides } from './node.cjs';

package/dist/index.d.ts

@@ -11,6 +11,8 @@ import { ModuleElement } from './module.js';
 import { AppElement } from './app.js';
 import { EntityElement } from './entity.js';
 import { AssetElement } from './asset.js';
+import { AnimComponentElement } from './components/anim-component.js';
+import { AnimClipElement } from './components/anim-clip.js';
 import { ListenerComponentElement } from './components/listener-component.js';
 import { ButtonComponentElement } from './components/button-component.js';
 import { CameraComponentElement } from './components/camera-component.js';
@@ -47,6 +49,8 @@ declare global {
         scriptnamechange: ScriptNameChangeEvent;
     }
     interface HTMLElementTagNameMap {
+        'pc-anim': AnimComponentElement;
+        'pc-anim-clip': AnimClipElement;
         'pc-app': AppElement;
         'pc-asset': AssetElement;
         'pc-button': ButtonComponentElement;
@@ -78,7 +82,7 @@ declare global {
         'pc-sounds': SoundComponentElement;
     }
 }
-export { AsyncElement, ModuleElement, AppElement, EntityElement, AssetElement, ButtonComponentElement, CameraComponentElement, CollisionComponentElement, ComponentElement, ElementComponentElement, JointComponentElement, LayoutChildComponentElement, LayoutGroupComponentElement, ParticleSystemComponentElement, LightComponentElement, ListenerComponentElement, RenderComponentElement, RigidBodyComponentElement, ScreenComponentElement, ScrollbarComponentElement, ScrollViewComponentElement, ScriptComponentElement, ScriptElement, SoundComponentElement, SoundSlotElement, GSplatComponentElement, EntityBaseElement, MaterialElement, ModelElement, NodeElement, SceneElement, SkyElement, whenReady };
+export { AsyncElement, ModuleElement, AppElement, EntityElement, AssetElement, AnimComponentElement, AnimClipElement, ButtonComponentElement, CameraComponentElement, CollisionComponentElement, ComponentElement, ElementComponentElement, JointComponentElement, LayoutChildComponentElement, LayoutGroupComponentElement, ParticleSystemComponentElement, LightComponentElement, ListenerComponentElement, RenderComponentElement, RigidBodyComponentElement, ScreenComponentElement, ScrollbarComponentElement, ScrollViewComponentElement, ScriptComponentElement, ScriptElement, SoundComponentElement, SoundSlotElement, GSplatComponentElement, EntityBaseElement, MaterialElement, ModelElement, NodeElement, SceneElement, SkyElement, whenReady };
 export type { AsyncElementTagName } from './async-element.js';
 export type { HierarchyMaterial, HierarchyNode } from './model.js';
 export type { MaterialOverrides } from './node.js';