@playcanvas/web-components 0.10.1 → 0.11.1

package/dist/components/render-component.d.ts

@@ -1,4 +1,4 @@
-import { RenderComponent, StandardMaterial } from 'playcanvas';
+import type { RenderComponent, StandardMaterial } from 'playcanvas';
 import { ComponentElement } from './component';
 /**
  * The RenderComponentElement interface provides properties and methods for manipulating
@@ -19,7 +19,7 @@ declare class RenderComponentElement extends ComponentElement {
     private _type;
     /** @ignore */
     constructor();
-    getInitialComponentData(): {
+    protected getInitialComponentData(): {
         type: "box" | "capsule" | "cone" | "cylinder" | "sphere" | "plane";
         castShadows: boolean;
         material: StandardMaterial | null | undefined;
@@ -73,9 +73,4 @@ declare class RenderComponentElement extends ComponentElement {
     static get observedAttributes(): string[];
     attributeChangedCallback(name: string, _oldValue: string | null, newValue: string | null): void;
 }
-declare global {
-    interface HTMLElementTagNameMap {
-        'pc-render': RenderComponentElement;
-    }
-}
 export { RenderComponentElement };

package/dist/components/rigidbody-component.d.ts

@@ -1,4 +1,5 @@
-import { RigidBodyComponent, Vec3 } from 'playcanvas';
+import type { RigidBodyComponent } from 'playcanvas';
+import { Vec3 } from 'playcanvas';
 import { ComponentElement } from './component';
 /**
  * The RigidBodyComponentElement interface provides properties and methods for manipulating
@@ -47,7 +48,7 @@ declare class RigidBodyComponentElement extends ComponentElement {
     private _type;
     /** @ignore */
     constructor();
-    getInitialComponentData(): {
+    protected getInitialComponentData(): {
         angularDamping: number;
         angularFactor: Vec3;
         friction: number;
@@ -84,9 +85,4 @@ declare class RigidBodyComponentElement extends ComponentElement {
     static get observedAttributes(): string[];
     attributeChangedCallback(name: string, _oldValue: string | null, newValue: string | null): void;
 }
-declare global {
-    interface HTMLElementTagNameMap {
-        'pc-rigidbody': RigidBodyComponentElement;
-    }
-}
 export { RigidBodyComponentElement };

package/dist/components/screen-component.d.ts

@@ -1,4 +1,5 @@
-import { ScreenComponent, Vec2 } from 'playcanvas';
+import type { ScreenComponent } from 'playcanvas';
+import { Vec2 } from 'playcanvas';
 import { ComponentElement } from './component';
 /**
  * The ScreenComponentElement interface provides properties and methods for manipulating
@@ -13,16 +14,16 @@ declare class ScreenComponentElement extends ComponentElement {
     private _resolution;
     private _referenceResolution;
     private _priority;
-    private _blend;
+    private _scaleMode;
     private _scaleBlend;
     /** @ignore */
     constructor();
-    getInitialComponentData(): {
+    protected getInitialComponentData(): {
         priority: number;
         referenceResolution: Vec2;
         resolution: Vec2;
         scaleBlend: number;
-        scaleMode: "none" | "blend";
+        scaleMode: string;
         screenSpace: boolean;
     };
     /**
@@ -36,18 +37,34 @@ declare class ScreenComponentElement extends ComponentElement {
     get referenceResolution(): Vec2;
     set resolution(value: Vec2);
     get resolution(): Vec2;
+    /**
+     * Sets how the screen's `resolution` and `referenceResolution` are weighted against each other
+     * when `scaleMode` is `blend`, from 0 (follow the resolution) to 1 (follow the reference
+     * resolution). Ignored while `scaleMode` is `none`.
+     * @param value - The scale blend factor.
+     */
     set scaleBlend(value: number);
+    /**
+     * Gets how the screen's resolutions are weighted against each other.
+     * @returns The scale blend factor.
+     */
     get scaleBlend(): number;
-    set blend(value: boolean);
-    get blend(): boolean;
+    /**
+     * Sets how the screen scales its contents. `none` renders at `resolution` and ignores
+     * `referenceResolution`; `blend` scales between the two, weighted by `scaleBlend`, which is what
+     * keeps a UI laid out at one resolution usable at another. Requires `screenSpace` - the engine
+     * forces `none` on a world-space screen, which does not support scaling.
+     * @param value - The scale mode ('none' or 'blend').
+     */
+    set scaleMode(value: 'none' | 'blend');
+    /**
+     * Gets how the screen scales its contents.
+     * @returns The scale mode.
+     */
+    get scaleMode(): "none" | "blend";
     set screenSpace(value: boolean);
     get screenSpace(): boolean;
     static get observedAttributes(): string[];
     attributeChangedCallback(name: string, _oldValue: string | null, newValue: string | null): void;
 }
-declare global {
-    interface HTMLElementTagNameMap {
-        'pc-screen': ScreenComponentElement;
-    }
-}
 export { ScreenComponentElement };

package/dist/components/script-component.d.ts

@@ -1,28 +1,21 @@
-import { ScriptComponent } from 'playcanvas';
+import type { ScriptComponent } from 'playcanvas';
 import { ComponentElement } from './component';
-interface ScriptAttributesChangeEvent extends CustomEvent {
+export type ScriptAttributesChangeEvent = {
     detail: {
         attributes: Record<string, any>;
     };
-}
-interface ScriptEnableChangeEvent extends CustomEvent {
+} & CustomEvent;
+export type ScriptEnableChangeEvent = {
     detail: {
         enabled: boolean;
     };
-}
-interface ScriptNameChangeEvent extends CustomEvent {
+} & CustomEvent;
+export type ScriptNameChangeEvent = {
     detail: {
         oldName: string;
         newName: string;
     };
-}
-declare global {
-    interface HTMLElementEventMap {
-        'scriptattributeschange': ScriptAttributesChangeEvent;
-        'scriptenablechange': ScriptEnableChangeEvent;
-        'scriptnamechange': ScriptNameChangeEvent;
-    }
-}
+} & CustomEvent;
 /**
  * The ScriptComponentElement interface provides properties and methods for manipulating
  * {@link https://developer.playcanvas.com/user-manual/web-components/tags/pc-scripts/ | `<pc-scripts>`} elements.
@@ -36,7 +29,7 @@ declare class ScriptComponentElement extends ComponentElement {
     /** @ignore */
     constructor();
     connectedCallback(): Promise<void>;
-    initComponent(): void;
+    protected initComponent(): void;
     /**
      * Recursively converts raw attribute data into proper PlayCanvas types. Supported conversions:
      * - "asset:id" → the Asset created by the `pc-asset` element with that id
@@ -167,9 +160,4 @@ declare class ScriptComponentElement extends ComponentElement {
      */
     get component(): ScriptComponent;
 }
-declare global {
-    interface HTMLElementTagNameMap {
-        'pc-scripts': ScriptComponentElement;
-    }
-}
 export { ScriptComponentElement };

package/dist/components/script.d.ts

@@ -1,4 +1,4 @@
-import { Script } from 'playcanvas';
+import type { Script } from 'playcanvas';
 import { AsyncElement } from '../async-element';
 /**
  * The ScriptElement interface provides properties and methods for manipulating
@@ -36,17 +36,6 @@ import { AsyncElement } from '../async-element';
 declare class ScriptElement extends AsyncElement {
     private _attributes;
     private _enabled;
-    /**
-     * Whether readiness has been signalled. Creation can happen more than once over an
-     * element's life (a runtime `name` change recreates the instance), but `ready` is a
-     * one-shot signal, so only the first successful creation fires it.
-     */
-    private _readySignalled;
-    /**
-     * The Script instance created for this element by its parent `<pc-scripts>` element.
-     * @ignore
-     */
-    _script: Script | null;
     /**
      * Sets the attributes of the script as an object. Values are converted with the same rules
      * as the `attributes` attribute: `asset:`/`entity:` references and `vec2:`/`vec3:`/`vec4:`/
@@ -98,17 +87,8 @@ declare class ScriptElement extends AsyncElement {
      */
     get script(): Script | null;
     connectedCallback(): void;
-    /**
-     * Called by the parent `<pc-scripts>` element when the script instance has been created.
-     * @ignore
-     */
-    _onScriptCreated(): void;
+    disconnectedCallback(): void;
     static get observedAttributes(): string[];
     attributeChangedCallback(name: string, oldValue: string | null, newValue: string | null): void;
 }
-declare global {
-    interface HTMLElementTagNameMap {
-        'pc-script': ScriptElement;
-    }
-}
 export { ScriptElement };

package/dist/components/scrollbar-component.d.ts

@@ -1,4 +1,4 @@
-import { ScrollbarComponent } from 'playcanvas';
+import type { ScrollbarComponent } from 'playcanvas';
 import { ComponentElement } from './component';
 /**
  * The ScrollbarComponentElement interface provides properties and methods for manipulating
@@ -15,7 +15,7 @@ declare class ScrollbarComponentElement extends ComponentElement {
     private _handle;
     /** @ignore */
     constructor();
-    getInitialComponentData(): Record<string, any>;
+    protected getInitialComponentData(): Record<string, any>;
     /**
      * Gets the underlying PlayCanvas scrollbar component.
      * @returns The scrollbar component.
@@ -66,9 +66,4 @@ declare class ScrollbarComponentElement extends ComponentElement {
     static get observedAttributes(): string[];
     attributeChangedCallback(name: string, _oldValue: string | null, newValue: string | null): void;
 }
-declare global {
-    interface HTMLElementTagNameMap {
-        'pc-scrollbar': ScrollbarComponentElement;
-    }
-}
 export { ScrollbarComponentElement };

package/dist/components/scrollview-component.d.ts

@@ -1,4 +1,5 @@
-import { ScrollViewComponent, Vec2 } from 'playcanvas';
+import type { ScrollViewComponent } from 'playcanvas';
+import { Vec2 } from 'playcanvas';
 import { ComponentElement } from './component';
 /**
  * The ScrollViewComponentElement interface provides properties and methods for manipulating
@@ -24,29 +25,31 @@ declare class ScrollViewComponentElement extends ComponentElement {
     private _verticalScrollbar;
     /** @ignore */
     constructor();
-    getInitialComponentData(): Record<string, any>;
+    protected getInitialComponentData(): Record<string, any>;
     /**
      * Gets the underlying PlayCanvas scroll view component.
      * @returns The scroll view component.
      */
     get component(): ScrollViewComponent;
     /**
-     * Sets whether horizontal scrolling is enabled.
+     * Sets whether scrolling along the horizontal axis is enabled. This is a toggle, unlike the
+     * `orientation` of a `<pc-scrollbar>`, for which `horizontal` is one of the accepted values.
      * @param value - Whether horizontal scrolling is enabled.
      */
     set horizontal(value: boolean);
     /**
-     * Gets whether horizontal scrolling is enabled.
+     * Gets whether scrolling along the horizontal axis is enabled.
      * @returns Whether horizontal scrolling is enabled.
      */
     get horizontal(): boolean;
     /**
-     * Sets whether vertical scrolling is enabled.
+     * Sets whether scrolling along the vertical axis is enabled. This is a toggle, unlike the
+     * `orientation` of a `<pc-scrollbar>`, for which `vertical` is one of the accepted values.
      * @param value - Whether vertical scrolling is enabled.
      */
     set vertical(value: boolean);
     /**
-     * Gets whether vertical scrolling is enabled.
+     * Gets whether scrolling along the vertical axis is enabled.
      * @returns Whether vertical scrolling is enabled.
      */
     get vertical(): boolean;
@@ -172,9 +175,4 @@ declare class ScrollViewComponentElement extends ComponentElement {
     static get observedAttributes(): string[];
     attributeChangedCallback(name: string, _oldValue: string | null, newValue: string | null): void;
 }
-declare global {
-    interface HTMLElementTagNameMap {
-        'pc-scrollview': ScrollViewComponentElement;
-    }
-}
 export { ScrollViewComponentElement };

package/dist/components/sound-component.d.ts

@@ -1,4 +1,4 @@
-import { SoundComponent } from 'playcanvas';
+import type { SoundComponent } from 'playcanvas';
 import { ComponentElement } from './component';
 /**
  * The SoundComponentElement interface provides properties and methods for manipulating
@@ -18,7 +18,7 @@ declare class SoundComponentElement extends ComponentElement {
     private _volume;
     /** @ignore */
     constructor();
-    getInitialComponentData(): {
+    protected getInitialComponentData(): {
         distanceModel: "linear" | "exponential" | "inverse";
         maxDistance: number;
         pitch: number;
@@ -105,9 +105,4 @@ declare class SoundComponentElement extends ComponentElement {
     static get observedAttributes(): string[];
     attributeChangedCallback(name: string, _oldValue: string | null, newValue: string | null): void;
 }
-declare global {
-    interface HTMLElementTagNameMap {
-        'pc-sounds': SoundComponentElement;
-    }
-}
 export { SoundComponentElement };

package/dist/components/sound-slot.d.ts

@@ -1,4 +1,4 @@
-import { SoundSlot } from 'playcanvas';
+import type { SoundSlot } from 'playcanvas';
 import { AsyncElement } from '../async-element';
 import { SoundComponentElement } from './sound-component';
 /**
@@ -24,6 +24,13 @@ declare class SoundSlotElement extends AsyncElement {
      * emit a misleading "must be a direct child" warning for what is an ordinary removal.
      */
     private _soundElement;
+    /**
+     * Incremented on every connect and disconnect, and captured by connectedCallback on entry —
+     * a resume from an await abandons itself if the value has moved on, so a stale callback can
+     * neither act on a torn-down tree nor add its slot alongside a re-inserted element's own
+     * callback.
+     */
+    private _connectionGeneration;
     /**
      * The sound slot.
      */
@@ -124,9 +131,4 @@ declare class SoundSlotElement extends AsyncElement {
     static get observedAttributes(): string[];
     attributeChangedCallback(name: string, _oldValue: string | null, newValue: string | null): void;
 }
-declare global {
-    interface HTMLElementTagNameMap {
-        'pc-sound': SoundSlotElement;
-    }
-}
 export { SoundSlotElement };